catman - リファレンスマニュアル用の書式付きファイルの作成
/usr/bin/catman [-c] [-n
] [-p] [-t] [-w] [
-M directory]
[-T macro-package] [
sections]
/usr/bin/catman [-M directory] -w
catman ユーティリティーは、groff(1) 入力ファイルから、オンラインマニュアルの事前整形されたバージョンを作成します。事前整形されたマニュアルページのディレクトリは、自己完結的にかつ書式なしエントリから独立して作成されるので、一群のマシンの間でそれらのマニュアルページを容易に配布できます。
また、–w オプションを使用すると、catman は MANPATH または –M オプションで指定されたディレクトリにインデックスファイルを作成します。MANPATH または –M オプションが指定されていない場合、–n を指定しなければ、catman はデフォルトで /usr/share/man/ および /usr/gnu/share/man/ ディレクトリにインデックスファイルを作成します。指定されたディレクトリまたはデフォルトのディレクトリが読み取り専用の場合、catman は失敗し、そのディレクトリへの書き込みが許可されていないことを示すエラーメッセージを標準エラー出力に表示します。
各マニュアルページが検査され、事前整形されたバージョンが見つからないもの、または最新ではないものについては再作成されます。なんらかの変更が行われた場合、catman はインデックスファイルを再作成します。
マニュアルページが shadow (シャドウ) ページである場合、つまりその内容が書かれた別のマニュアルページをソースとしている場合、該当する事前整形されたマニュアルページへのシンボリックリンクが catx または fmtx ディレクトリに作成されます。
書式なし nroff のソースファイルにあるシャドウファイルは、最初の行に .so manx/yyy.x という形式の行があることで識別できます。
サポートしているオプションは、次のとおりです。
インデックスファイルを作成 (再作成) しません。–n オプションが指定されている場合、インデックスファイルは作成されず、apropos(1) および whatis(1) コマンドの実行速度が、それ以外の場合よりも低下する可能性があります。
予行演習オプション。つまり、実行するのではなく何が行われるのかを表示します。
cat サブディレクトリへの nroff を行う代わりに、該当する fmt サブディレクトリ内に troff 処理後のエントリを作成します。
apropos(1)、whatis(1)、および man(1) の –f、–k、および –K オプションで使用されるインデックスファイルを、MANPATH 環境変数または –M オプションで指定されるディレクトリに作成します。MANPATH または –M オプションを指定しない場合、インデックスファイルはデフォルトで /usr/share/man/ および /usr/gnu/share/man/ ディレクトリに作成されます。マニュアルの再整形は実行されません。
指定された directory (デフォルトでは /usr/share/man) にあるマニュアルページを更新します。コンマは、マニュアルセクションの番号を示すために使用されているので、–M オプションの引数として指定するディレクトリ名には `,' (コンマ) が含まれないようにしてください。man(1) を参照してください。
標準のマニュアルページマクロの代わりに macro-package を使用します。
次のオペランドを指定できます。
先頭文字が `–' でないパラメータは、catman によって処理されるマニュアルセクションと見なします。各セクションはスペースで区切ります。このオペランドが指定されると、指定するマニュアルセクションだけが処理されます。たとえば、
catman 1 2 3
前述のコマンドは、セクション 1、2、3 だけを更新します。セクションが指定されない場合、環境変数 MANPATH に指定された man ディレクトリにあるすべてのセクションが処理されます。
–t オプションが指定された場合に用いるフォーマッタの名前。
catman と man(1) で処理されるディレクトリの、コロンで区切られたリスト。各ディレクトリは、コンマで区切られたセクションのリストの後に続いて指定できます。この環境変数に値を設定すると、デフォルトのディレクトリ検索パスである /usr/share/man と、デフォルトのセクション検索パスである man.cf を無効にします。–M および –s フラグはそれぞれこれらの値を無効にします。
次のコマンドは、インデックスファイルを /usr/local/share/man ディレクトリに作成します。
# catman -M /usr/local/share/man -w
マニュアルページのデフォルトのディレクトリ
nroff 入力ファイル (未処理)
事前整形された nroff 処理後のマニュアルページ
groff のデフォルトのマクロパッケージ
事前整形された troff 処理後のマニュアルページ
–K クエリー用のインデックスファイル
属性についての詳細は、マニュアルページの attributes(7) を参照してください。
|
apropos(1)、groff(1)、man(1)、rm(1)、whatis(1)、attributes(7)
以前に catman コマンドを実行して cat* ディレクトリがすでにインストールされている場合に、オペレーティングシステムをアップグレードした場合は、catman コマンドを実行する前に cat* ディレクトリ構造全体を削除してください。詳細は、rm(1) のマニュアルページを参照してください。
すべての man* ディレクトリがそろっていない場合は、インデックスファイルを再作成するために catman を再度実行しないでください。catman は、man* ディレクトリに基づいてインデックスファイルを作成します。
windex データベースはインデックスファイルに置き換えられました。windex を使用した場合と異なり、インデックスファイルの生成では、インデックスを作成できる対象について特定の制限や前提条件は課せられません。