CATMAN(8) — NEWS-OS Programmer’s Manual

名称

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 は、デフォルトでは、環境変数 LANG で設定される多国語マニュアルの位置 (たとえば /usr/man/ja_JP.SJIS) にあるマニュアルページを更新します。ただし、 LANG で指定されたディレクトリがない場合は /usr/man にあるマニュアルページを更新します。 path は、いくつかのディレクトリ名をコロン (:) で区切って並べたものです。たとえば、 /usr/local/man:/usr/man の形式です。環境変数 MANPATH がセットされると、その値に LANG の文字列を追加したものがデフォルトパスとして使用されます。たとえば、 LANG が ja_JP.SJIS の場合、 /usr/local/man/ja_JP.SJIS と /usr/man/ja_JP.SJIS にあるマニュアルページを更新します。このとき LANG で指定されたディレクトリがない場合は、 /usr/local/man と /usr/man にあるマニュアルページを更新します。

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;

バグ

英語のマニュアルを作る場合は、 LANG を C にしてください。日本語 EUC のマニュアルページを更新するには、 LANG を ja_JP.EUC にして catman(8) を実行してください。

LANG が ja_JP.EUC で /usr/man/ja_JP.EUC がない場合 /usr/man のマニュアルページを更新します。これはユーザが期待した動作でないかもしれません。日本語 Shift JIS から日本語 EUC のマニュアルの作成は mkmaneuc(8) で行うことができます。

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

NEWS-OSRelease 4.2.1R

Museum

Related Articles

CATMAN(8) — NEWS-OS Programmer’s Manual

名称

形式

解説

オプション

関連ファイル

関連事項

バグ