名称

catman − マニュアル作成用 catファイルを作る

形式

/etc/catman [ −p ] [ −n ] [ −w ] [ −M path ] [ sections ]

解説

catman は、 オンラインマニュアルの nroff ファイルを入力として、 そのプレフォーマットバージョンを作成します。 各マニュアルページが検査され、プレフォーマットバージョンがなかったり、 日付が古いものは、作成しなおされます。 これらの変更がなされると、 catman は whatis データベースを作成します。

− で開始しないパラメータがあると、 参照するマニュアルのリストであるとみなされます。たとえば、

catman 123 と入力すると、マニュアルの 1、2、3 章だけが更新されます。

オプション

−n whatis データベースを作成しません。

−p 実行は行わず、その代わり何をするかを表示します。

−w whatis データベースだけが作られます。マニュアルの再フォーマットは行いません。

−M path (デフォルトは /usr/man) で指定されたディレクトリに置かれている マニュアルページを更新します。 path は、いくつかのディレクトリ名をコロン(:)で区切って並べたものです。 たとえば、/usr/local/man:/usr/man の形式です。 環境変数“MANPATH” がセットされると、 その値がデフォルトパスとして使用されます。

nroff ソースファイル内に“.so manx/yyy.x” 形式の 1行だけが入っている場合は、 catx ディレクトリの中に、 適正にプリフォーマットした マニュアルページへのシンボリックリンクが作成されます。 この機能により、プリフォーマットされた マニュアルページを rdist(1) を用いて 関連マシンのグループ内に容易に分散させることができます。 nroff ソースは、すべてのマシンに持たせる必要はないので、 その分ディスクスペースを節約できます。 たとえば、mach1〜mach5 と呼ばれるマシン 5台が接続された ローカルネットワークにおいて、mach3 は、 マニュアルページの nroff ソースを持っているとします。 mach3 は毎晩、 cron(8) を介して catman を実行し、その後、次のような distfile を用いて rdist を実行します。

 MANSLAVES = ( mach1 mach2 mach4 mach5 )
 MANUALS = (/usr/man/cat[1−8no] /usr/man/whatis)
 ${MANUALS} −> ${MANSLAVES}
install −R;
notify root;
 

ファイル

/usr/manデフォルトのマニュアルディレクトリ位置
/usr/man/man?/∗.∗マニュアルの原稿(nroffの入力)セクション
/usr/man/cat?/∗.∗プレフォーマットされたマニュアルページ
/usr/man/whatiswhatis データベース
/usr/lib/makewhatiswhatis データベース作るコマンドスクリプト

関連コマンド

man(1), cron(8), rdist(1)

バグ

満月の夜、おかしな動きをするかもしれませんよ。catman だから :-)

NEWS-OSRelease 3.3