Provided by: man-db_2.9.1-1_amd64 
名前
whatis - display one-line manual page descriptions
書式
whatis [-dlv?V] [-r|-w] [-s list] [-m system[,...]] [-M path] [-L locale] [-C file] name
...
説明
各マニュアルページには短い要約文が含まれています。 whatis はマニュアルページ名を検索し、
name に一致するすべてのマニュアルページの要約文を表示します。
name はワイルドカード (-w を指定した場合) または正規表現 (-r を指定した場合) で指定できま
す。これらのオプションを使用した場合、シェルが特殊文字を解釈するのを防ぐために、 name を引
用符でくくるか、エスケープ (\) しなければいけない場合があります。
検索にはインデックス型データベースが使用されます。これは mandb プログラムによって更新しま
す。インストール方法によっては、 mandb は cron ジョブとして定期的に実行されているかもしれ
ませんし、新しいマニュアルページをインストールした時に手動で実行する必要があるかもしれませ
ん。古いテキスト型 whatis データベースから対応するインデックス型データベースを生成するに
は、次のコマンドを実行してください。
whatis -M manpath -w '*' | sort > manpath/whatis
ここで、 manpath は /usr/man のようなマニュアルページ階層を指定します。
オプション
-d, --debug
デバッグ情報を表示します。
-v, --verbose
冗長な警告メッセージを表示します。
-r, --regex
各 name を正規表現として解釈します。 name はマニュアルページ名のどの部分に対しても
一致処理が行われ、一致処理結果が生成されます。この処理は、データベース検索の特性に
より、通常の whatis 処理より幾分遅くなります。
-w, --wildcard
各 name をシェル形式のワイルドカードとして解釈します。name はマニュアルページ名のど
の部分に対しても一致処理が行われ、一致処理結果が生成されます。この処理は、データ
ベース検索の特性により、通常の whatis 処理より幾分遅くなります。
-l, --long
出力を端末幅で切り詰めません。通常は、適切に書かれていない 名前 (NAME) 節による見に
くさを避けるために出力が端末の幅に切り詰められます。
-s list, --sections=list, --section=list
指定したマニュアルセクションのみ検索します。 list はコロンまたはコンマで区切られた
セクションのリストです。もし、 list の項目が単純なセクション、例えば "3" ならば、表
示される説明のリストには "3"、 "3perl"、 "3x" 等のセクションのページが含まれま
す。一方 list に拡張部分も含める、例えば "3perl" ならば、表示される説明のリストはマ
ニュアルセクションに厳密に一致したページのみ含まれるようになります。
-m system[,...], --systems=system[,...]
このシステム上で他の OS のマニュアルページにアクセスできる場合、このオプションを使
用してアクセスします。 NewOS のマニュアルページを検索する場合、 -m NewOS オプション
を指定します。
system はコンマ区切りの OS 名で指定します。現在使用しているオペレーティングシステム
を検索に含める場合は、システム名の引数文字列に man を含めます。このオプションは
$SYSTEM 環境変数を上書きします。
-M path, --manpath=path
検索するマニュアルページ階層を変更する場合、その集合をコロンで区切って指定しま
す。デフォルトでは、whatis は $MANPATH 環境変数を使用します。 $MANPATH 環境変数が空
であるか、設定されていない場合、$PATH 環境変数に応じて適切なマニュアルページのパス
が決定されます。このオプションは $MANPATH の内容を上書きします。
-L locale, --locale=locale
whatis は通常、現在のロケールを C の関数 setlocale(3) を呼び出すことによって決定し
ます。これはおそらく $LC_MESSAGES や $LANG などを含むさまざまな環境変数を使用しま
す。一時的にこの値を上書きしたい場合には、このオプションを使用して whatis に直接
locale 文字列を渡します。これはページの検索が実際に開始されるまでは効果が無いことに
注意してください。ヘルプメッセージなどは常に初期に決定されたロケールによって表示さ
れます。
-C file, --config-file=file
デフォルトの ~/.manpath ではなく指定したユーザ設定ファイルを使用します。
-?, --help
ヘルプメッセージを表示して終了します。
--usage
Print a short usage message and exit.
-V, --version
バージョン情報を表示します。
終了ステータス
0 プログラムが正常に実行されました。
1 使用法、構文または設定ファイルのエラーです。
2 操作のエラーです。
16 指定したキーワードにマッチしたページが見つかりませんでした。
環境変数
SYSTEM $SYSTEM が設定されている場合、 -m オプションで指定した引数と同様の効果があります。
MANPATH
$MANPATH が設定されている場合、その値はコロン区切りのマニュアルページ階層の検索パス
として使用されます。
MANWIDTH
If $MANWIDTH is set, its value is used as the terminal width (see the --long
option). If it is not set, the terminal width will be calculated using the value
of $COLUMNS, and ioctl(2) if available, or falling back to 80 characters if all
else fails.
ファイル
/usr/share/man/index.(bt|db|dir|pag)
伝統的な大域インデックス型データベースキャッシュです。
/var/cache/man/index.(bt|db|dir|pag)
FHS 準拠の大域インデックス型データベースキャッシュです。
/usr/share/man/.../whatis
伝統的な whatis テキスト型データベースです。
関連項目
apropos(1), man(1), mandb(8)
著者
Wilf. (G.Wilford@ee.surrey.ac.uk).
Fabrizio Polacco (fpolacco@debian.org).
Colin Watson (cjwatson@debian.org).