WHATIS
Section: Manual pager utils (1)
Updated: 2019-10-23
Index
Return to Main Contents
名前
whatis - マニュアルページの要約を表示する
書式
whatis
[-dlv?V]
[-r|-w]
[-s
list]
[-m
system[,...]]
[-M
path]
[-L
locale]
[-C
file]
name
...
説明
それぞれのマニュアルページには、先頭に短い要約文が書かれている。
whatis
はマニュアルページの名前を検索し、
name
にマッチしたすべてのマニュアルから、この要約文を取り出して表示する。
name
にはワイルドカード
(-w)
や正規表現
(-r)
を用いることができる。
これらのオプションを用いた際には、
name
をクォートするか、特殊キャラクタをエスケープ (\) して、
シェルによって解釈されないようにする必要があるかもしれない。
index
データベースが検索の際に用いられ、これは
mandb
プログラムで更新される。
インストール方法によるが、
mandb
が定期的な cron ジョブで実行されているかもしれないし、
新しいマニュアルページをインストールしたときに
mandb
を手動で実行する必要があるかもしれない。
古いスタイルの
whatis
テキストデータベースを、対応する
index
データベースから作りたい場合には、以下のようなコマンドを実行すればよい。
whatis -M
manpath
-w '*' | sort >
manpath/whatis
ここで
manpath
には
/usr/man
のような、マニュアルページの階層 (hierarchy) を指定する。
オプション
- -d, --debug
-
デバッグ情報を表示する。
- -v, --verbose
-
詳細な警告メッセージを表示する。
- -r, --regex
-
name
を正規表現として解釈する。
name
がページ名の一部分にマッチすれば、マッチしたとみなされる。
このオプションを指定すると、データベース検索の性質上、
whatis
の動作が多少遅くなる。
- -w, --wildcard
-
name
をシェル形式のワイルドカードを含むパターンとして解釈する。
マッチするためには、展開された
name
がページ名の全体にマッチしなければならない。
このオプションを指定すると、データベース検索の性質上、
whatis
の動作が多少遅くなる。
- -l, --long
-
出力を端末幅で切り詰めない。
通常は、適切に書かれていない
名前
セクションの見にくさを避けるため、端末幅で切り詰める。
- -s list/, --sections=list/, --section=list
-
指定したマニュアルセクションのみを検索する。
list
はコロンまたはコンマ区切りのセクションのリストである。
list
のエントリが単純なセクション、例えば "3" である場合、
表示される要約文のリストには、"3", "3perl", "3x" などの
セクションのページが含まれる。
一方で
list
のエントリに拡張部分がある場合、例えば "3perl" の場合、
表示される要約文のリストには、マニュアルセクションに厳密にマッチ
したページのみが含まれる。
- -m system[,...], --systems=system[,...]
-
現在のシステムから、他のオペレーティングシステムについてのマニュアルに
アクセスできる場合には、このオプションをつけるとそれらのマニュアルが
検索される。
NewOS のマニュアルページを検索する場合には、
-m
NewOS
のようなオプションを指定する。
system
には複数のオペレーティングシステムをコンマで区切った形式で指定できる。
ネイティブのオペレーティングシステムの
マニュアルページ名を検索の対象に含めるためには、システム名
man
を引き数文字列に加える。
このオプションは
$SYSTEM
環境変数を上書きする。
- -M path, --manpath=path
-
検索対象にするマニュアルページの階層を変えたい場合、それらをコロンで
区切った形式で指定する。
デフォルトでは、
whatis
は環境変数
$MANPATH
を用いる。これが空だったり設定されていなかった場合には、
$PATH
環境変数に基づいて、適切な manpath を決めようと試みる。
このオプションは
$MANPATH
の内容を上書きする。
- -L locale, --locale=locale
-
whatis
は通常、カレント・ロケールを C 関数
setlocale(3)
を呼ぶことによって決定しようとする。
この関数は
$LC_MESSAGES
や
$LANG
などを含む様々な環境変数を調べる。
この値を一時的に上書きするには、このオプションを使って
whatis
に直接
locale
文字列を渡せば良い。
このオプションが効力を持つのは、実際のページの検索が始まってから
であることに注意すること。
ヘルプメッセージなどの出力は、起動前に定まっていたロケールで
出力される。
- -C file, --config-file=file
-
デフォルトの
~/.manpath
ではなく、ユーザー設定ファイルを使用する。
- -?, --help
-
ヘルプメッセージを表示して、終了する。
- --usage
-
簡単な使用法のメッセージを表示して、終了する。
- -V, --version
-
バージョン情報を表示する。
返り値
- 0
-
プログラムの実行に成功した。
- 1
-
使用法、文法、設定ファイルのいずれかにエラーがある。
- 2
-
実行時エラー。
- 16
-
指定したキーワードにマッチするものが見つからなかった。
環境変数
- SYSTEM
-
$SYSTEM
環境変数が設定されている場合には、その内容が
-m
オプションの引き数として指定された場合と同じ効力を持つ。
- MANPATH
-
$MANPATH
が設定されていると、その内容は、検索対象とするマニュアルの階層を
コロンで区切ったリストとみなされる。
- MANWIDTH
-
$MANWIDTH
が設定されると、端末幅として使われる
(--long
オプションを参照)。
この環境変数が設定されない場合、端末幅は、利用可能であれば、
$COLUMNS
の値と
ioctl(2)
を使って計算され、利用可能でない場合は、80 文字にされる。
ファイル
- /usr/share/man/index.(bt|db|dir|pag)
-
従来形式のグローバルな
index
データベースキャッシュ。
- /var/cache/man/index.(bt|db|dir|pag)
-
FHS 互換のグローバルな
index
データベースキャッシュ。
- /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).
Index
- 名前
-
- 書式
-
- 説明
-
- オプション
-
- 返り値
-
- 環境変数
-
- ファイル
-
- 関連項目
-
- 著者
-
This document was created by
man2html,
using the manual pages.
Time: 14:31:24 GMT, July 01, 2020