名称

makewhatis — whatis データベースを作成する

書式

makewhatis

[ -a][ -i column][ -n name][ -o file][ -v][ -L][ directories ...]

解説

makewhatis ユーティリティは directories 中のフォーマットされていないマニュアルページから名称と短い記述を抽出し、 whatis(1) と apropos(1) が使用するファイルを作成します。ディレクトリはコロンか空白で区切ります。 directories を指定しない場合、環境変数 MANPATH の内容が使用されるか、これが設定されていない場合はデフォルトの /usr/share/man が処理されます。

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

-a

出力ファイルを置き換えるのではなく追加します。出力中では重複する行は削除されますが、無くなったエントリが残るかもしれません。

-i column

解説の文字列を column に揃えます。デフォルトは 24 です。

-n name

whatis の代わりに name を使用します。

-o file

*/man/whatis の代わりに全ての出力を file に書き込みます。

-v

なにをしているかに関し makewhatis は冗長表示します。

-L

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

環境変数

LC_ALL, LC_CTYPE, LANG

これらの変数は、 -L オプション指定時にどのサブディレクトリを処理するかを制御します。

MACHINE

設定された場合、マシン固有サブディレクトリを検索する時に、この値で現在のマシンタイプを上書きします。

MACHINE_ARCH

設定されるなら、値は、アーキテクチャの特定のサブディレクトリを検索するとき、現在のアーキテクチャを上書きするために使用されます。

MANPATH

コマンドラインで指定しないときに処理するディレクトリ集合を決定します。

関連ファイル

/usr/share/man

MANPATH 環境変数未設定時に処理するデフォルトディレクトリ。

*/man/whatis

デフォルト出力ファイル。

終了ステータス

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

関連項目

apropos(1), whatis(1)

歴史

makewhatis コマンドは、 FreeBSD 2.1 で登場しました。

作者

makewhatis プログラムは、最初は Perl で書かれ、 Wolfram Schneider によって寄贈されました。 makewhatis の現在のバージョンは、 John Rochester によって C で書き直されました。