CATMAN(1)

名称
catman - オンラインマニュアルを事前にフォーマットする

書式
catman [-f | -force] [-h | -help] [-L | -locale] [-p | -print] [-r | -remove] [-v | -verbose] [directories ...]

解説
catman はマニュアルを ASCII 形式にフォーマットします。これは directories で全てのマニュアルについて ‘man program’ とタイプするのと似ています。 directories はマニュアルの格納されているディレクトリやサブディレクトリを スペースかコロンで区切ったものです。 directories が指定されなかった場合、デフォルトとして /usr/share/man が使われます。

オプション

-f, -force
    既にある cat 形式のマニュアルへの上書きを強制します。 普通は、マニュアルが古くなったときだけ、 フォーマットしなおされるべきものです。 このオプションは時間と CPU と RAM の無駄使いです。

-h, -help
    オプションを表示して終了します。

-L, -locale
    ロケール環境変数を調査し、 ローカライズされたマニュアルサブディレクトリと 本エントリのみに使用する処理を調べます。

-p, -print
    実際にはマニュアルのフォーマットを行わず、何を行うかのみを表示します。

-r, -remove
    不要ファイルを削除します。例えば、 man 形式の無い cat 形式、 圧縮された cat 形式がある非圧縮の cat 形式、 英数字で構成されていないファイル名を持つファイル、 圧縮された man 形式がある非圧縮の man 形式です。

-v, -verbose
    より多くの警告を表示します。

使用例
    $ catman

/usr/share/man 以下のマニュアルを、必要な分だけフォーマットします。

    $ catman $MANPATH

ユーザの全てのマニュアルパス以下の マニュアルを、必要な分だけフォーマットします。

    $ catman -f /usr/local/man/man1 /usr/local/man/manl

/usr/local/man/man1 と /usr/local/man/manl 以下のマニュアルを強制的にフォーマットしなおします。

    $ catman -p /usr/X11/man

何が行われるかを表示するだけです。

関連ファイル

/etc/periodic/weekly/330.catman
    このプログラムを起動します

特徴
既に全てのマニュアルがフォーマットされている場合、 動作が非常に速くなります。 いくつかのシステムで採用されている -w はサポートされていません。 ‘whatis’ データベースを再構築するには makewhatis(1) を使って下さい。

バグ
man(1) は setuid プログラムです。ユーザ ‘man’ が cat 形式のマニュアルを格納するディレクトリに 対して書き込み権限を持つように注意して下さい。 catman は ‘.so’ というマニュアルをチェックしません。 マニュアルの必要以上のフォーマットを避けるには ハードリンク、シンボリックリンクを使って下さい。

関連項目
makewhatis(1), man(1), manpath(1)

歴史
このバージョンの catman は FreeBSD 2.1 から付属されました。

作者
Wolfram Schneider <wosch@FreeBSD.org>, Berlin.