catman(8)

名前
catman - フォーマットされたマニュアルページを生成・更新する

書式
catman [-dhV] [-M path] [section] ...

説明
catman は、フォーマット済みマニュアルページ (cat ページと呼ばれる) の最新の セットを生成するために用いられる。 通常 cat ページはオリジナルの man ページよりもずっと速く表示できるが、 余分な保存領域が必要とされる。 cat ページをサポートするかどうかは、 ローカルな管理者 (cat ページを保存するディレクトリに関する権限を持って いる人) の判断による。 catman に与えることのできるオプションは、フォーマットを行うマニュアルページの 階層 (hierarchy) とセクションである。デフォルトの階層は、 man_db の設 定ファイルで `global' 指定されているものである。デフォルトのセクションは、環境変数 $MANSECT が与えられていれば、その内容をコロン区切りでパースしたものになり、 与えられていなければ man のコンパイル時に指定されている標準的なセットとなる。 catman の実行時にセクションの名前をスペースで区切って与えれば、 これらの両方を上書きする。 catman はそれぞれの階層における index データベースキャッシュを利用して、どのファイルをフォーマットすべきかを 決定する。

オプション

-d, --debug
    デバッグ情報を表示する。

-M path, --manpath=path
    マニュアルページ階層のサーチパスとして用いるコロン区切りのリストを指定する。 デフォルトでは、 man_db 設定ファイルで `global' 指定されているすべてのパ スを対象とする。

-h, --help
    ヘルプメッセージを表示して終了する。

-V, --version
    バージョンと著者に関する情報を表示する。

環境変数

MANSECT
    $MANSECT が設定されていると、その値はセクションのリスト (コロン区切り) として扱われ、 マニュアルのどのセクションを検索するかを決定する際に用いられる。セクショ ンは指定された順序で検索される。

MANPATH
    $MANPATH が設定されていると、その内容は検索対象とするマニュアルの階層を コロンで区切ったリストとみなされる。

ファイル

/etc/manpath.config
    man_db の設定ファイル。

/usr/man/index.(bt|db|dir|pag)
    従来形式の、 global なデータベースキャッシュの インデックス。

/var/catman/index.(bt|db|dir|pag)
    新しい (FSSTND 準拠の)、 global なデータベースキャッシュの インデックス。

関連項目
man(1), manpath(5), mandb(8)

著者
Wilf. (G.Wilford@ee.surrey.ac.uk)