whatis

Section: Manual pager utils (1)
Updated: July 12th, 1995
Index JM Home Page roff page
 

名前

whatis - マニュアルページの要約を表示する  

書式

[-dhV] [-r|-w] [-m system[,...]] [-M path] name ...  

説明

それぞれのマニュアルページには、先頭に短い要約文が書かれている。 whatis はマニュアルページの名前を検索し、 name にマッチしたすべてのマニュアルから、この要約文を取り出して表示する。

name にはワイルドカード (-w) や正規表現 (-r) を用いることができる。 これらのオプションを用いた際には、 name をクォートするか、特殊キャラクタをエスケープ (\) して、 シェルによって解釈されないようにする必要があるかもしれない。

index データベースが検索の際に用いられる。古いスタイルの whatis テキストデータベースを、対応する index データベースから作りたい場合には、以下のようなコマンドを実行すればよい。

whatis -M manpath -w '*' | sort > manpath/whatis

ここで manpath には /usr/man のような、マニュアルページの階層 (hierarchy) を指定する。  

オプション

-d, --debug
デバッグ情報を表示する。
-r, --regex
name を正規表現として解釈する。 name がページ名の一部分にマッチすれば、マッチしたとみなされる。 このオプションを指定すると、データベース検索の性質上、 whatis の動作が多少遅くなる。
-w, --wildcard
name をシェル形式のワイルドカードを含むパターンとして解釈する。 マッチするためには、展開された name がページ名の全体にマッチしなければならない。 このオプションを指定すると、データベース検索の性質上、 whatis の動作が多少遅くなる。

-m system [,...], --systems=system[,...]

現在のシステムから、他のオペレーティングシステムについてのマニュアルに アクセスできる場合には、このオプションをつけるとそれらのマニュアルが 検索される。 NewOS のマニュアルページを検索する場合には、 -m NewOS のようなオプションを指定する。

system には複数のオペレーティングシステムをコンマで区切った形式で指定できる。 ネイティブのオペレーティングシステムの マニュアルページ名を検索の対象に含めるためには、システム名 man を引き数文字列に加える。 このオプションは $SYSTEM 環境変数を上書きする。

-M path, --manpath=path
検索対象にするマニュアルページの階層を変えたい場合、それらをコロンで 区切った形式で指定する。 デフォルトでは、 whatis は環境変数 $MANPATH を用いる。これが空だったり設定されていなかった場合には、 $PATH 環境変数に基づいて、適切な manpath を決めようと試みる。 このオプションは $MANPATH の内容を上書きする。
-h, --help
ヘルプメッセージを表示して終了する。
-V, --version
バージョンと著者に関する情報を表示する。
 

返り値

0
プログラムの実行に成功した。
1
使用法、文法、設定ファイルのいずれかにエラーがある。
2
実行時エラー。
16
指定したキーワードにマッチするものが見つからなかった。
 

環境変数

SYSTEM
$SYSTEM 環境変数が設定されている場合には、その内容が -m オプションの引き数として指定された場合と同じ効力を持つ。
MANPATH
$MANPATH が設定されていると、その内容は、検索対象とするマニュアルの階層を コロンで区切ったリストとみなされる。
 

ファイル

/usr/man/index.(bt|db|dir|pag)
従来形式の、 global なデータベースキャッシュの インデックス。
/var/catman/index.(bt|db|dir|pag)
新しい (FSSTND 準拠の)、 global なデータベースキャッシュのインデックス。
/usr/man/.../whatis
従来形式の、 whatis テキストデータベース。
 

関連項目

apropos(1), man(1)  

著者

Wilf. (G.Wilford@ee.surrey.ac.uk)


 

Index

名前
書式
説明
オプション
返り値
環境変数
ファイル
関連項目
著者

This document was created by man2html, using the manual pages.
Time: 15:33:32 GMT, March 14, 2017