catman(1M)

構文

/usr/sbin/catman [-A alt-path] [-p] [-m] [-n] [-w] [-z] [sections]

説明

catman コマンドは、 nroff(1) と互換性があるソースファイルから、フォーマットの整ったオンライン マニュアルを作成します。ディレクトリ man*.Z およびディレクトリ man* 内の各マニュアルエントリーを調べて、フォーマットの整っていない マニュアルエントリーおよび古いマニュアルエントリーを再作成します。 catman は、複数のエントリーの中から一番新しいエントリーをフォーマットの整った マニュアルにし、それを圧縮した後、適切な cat*.Z ディレクトリに入れます。

変更があった場合、 catman はデータベース /usr/share/lib/whatis を再作成します。デフォルトでは、データベース /usr/share/lib/whatis はオーバーライトされます。 MANPATH 環境変数がデフォルト以外のパスに設定されている場合、 古いデータベースファイルは /usr/share/lib/whatis.old に保存されます。システム管理者はこれを利用して、必要に応じて新旧 2 つのファイルをマージすることができます。

デフォルトでは、 catman は、以下の man ディレクトリの下のサブディレクトリ man*.Z および man* を検索します。

MANPATH が環境中に設定されている場合は、デフォルトのディレクトリの代わりに MANPATH に設定されているディレクトリがチェックされます。 MANPATH 環境変数の説明は environ(5) を参照してください。

catman を実行する前に、既存のディレクトリ cat* はすべて削除してください。 -z オプションを使用するときは、その代わりにディレクトリ cat*.Z を削除してください。ディレクトリ cat*.Z と cat* の両方がすでに存在する場合、 man(1) はその両方をアップデートするため、使用されるスペースは大きくなります。

先頭に - が指定されていないコマンド行パラメータはすべて、検索するマニュアル セクション (ディレクトリ) のリストであると解釈されます。例えば、

は、アップデートするマニュアルセクションを 1, 2, および 3 (ディレクトリ man1 , man2 , および man3 ) だけに制限します。

多言語化対応

警告

最後に catman が実行された後で、フォーマットの整っていないマニュアルエントリー (サブディレクトリ ../man* 内にあるマニュアルエントリー) が削除された場合、データベース /usr/share/lib/whatis 内の情報が失われることがあります。これを防ぐには -m が使用できますが、その結果、データベース内に同じマニュアルエントリーが重複して存在することがあります。

例

マニュアルのセクション 1 および 1m の、 圧縮されていない cat* ファイルを作成しますが、/usr/share/lib/whatis データベースは作成しません。

サーバから catman を実行し、 代替ルートのディスクレスクライアント /export/shared_roots/OS_700 に対して cat* エントリーを作成します。

以下の場所に cat* マンページを作成します。

また、以下の場所に whatis ファイルを作成します。

アプリケーションに対して cat* エントリーを作成し、その情報を /usr/share/lib/whatis データベースとマージします。

この処理を行う前に、 MANPATH を保存して、現在の MANPATH が失われないようにすることもできます。

著者

catman は、HP およびカリフォルニア州立大学バークレー校が開発しました。

ファイル

参照

compress(1), fixman(1M), man(1), environ(5)