makewhatis(1)

makewhatis − whatis databaseを作る

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

解説

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

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

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

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

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

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

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

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

環境変数

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

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

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

関連ファイル

MANPATH 環境変数未設定時に処理するデフォルトディレクト リ。
*/man/whatis
デフォルト出力ファイル。

診断

ユーティリティ makewhatis は、成功すると 0 で、エラーがあった場合は >0 で 終了します。

apropos(1), whatis(1)

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

Wolfram Schneider がオリジナルの Perl バージョンを書き、提供しました。元 バージョンは、 John Rochester が C で書き直したものです。

FreeBSD 10.0 May 12, 2002 FreeBSD 10.0