名称

catman — マニュアルページを前もって書式化する

書式

catman

[ -fLnrv][ directories ...]

解説

catman ユーティリティは、 nroff -man コマンドを使用して、 directories 中のすべてのマニュアルページを前もって書式化します。ディレクトリは、空白の代りにコロンで区切られます。 directories が指定されなかったなら、 MANPATH 環境変数の内容が使用されるか、またはそれが設定されていないなら、デフォルトのディレクトリ /usr/share/man が処理されます。

オプションは、次の通りです:

-f

たとえ、対応する cat ページが新しくても、すべてのマニュアルページを強制的に再書式化します。

-L

標準の環境変数で指定されたロケールに対応するローカライズされたサブディレクトリのみを処理します。

-n

あらゆる書式化を実行する代わりに行われることを印刷 (表示) します。

-r

マニュアルページも、それらの対応する書式化された cat ページでもない“junk”ファイルをスキャンして、削除します。

-v

catman は、何を行っているかに関してより冗長にします。

環境変数

LC_ALL, LC_CTYPE, LANG

これらの変数は、 -L オプションが使用されるなら、サブディレクトリが処理されるものを制御します。

MACHINE

設定されるなら、マシン固有のマニュアルページのサブディレクトリを検索するとき、現在のマシンタイプを上書きします。

MACHINE_ARCH

設定されるなら、アーキテクチャ固有のマニュアルページのサブディレクトリを検索するとき、現在のアーキテクチャを上書きします。

MANPATH

コマンド行に何も与えられないなら、処理されるディレクトリの組を決定します。

関連ファイル

/usr/share/man

MANPATH 環境変数が設定されていないなら、処理されるデフォルトのディレクトリ。

終了ステータス

The catman utility exits 0 on success, and >0 if an error occurs.

関連項目

makewhatis(1), man(1), nroff(1)

歴史

catman コマンドの以前のバージョンは、 FreeBSD 2.1 で登場しました。

作者

John Rochester