| apropos(1) | Manual pager utils | apropos(1) |
名前
apropos -マニュアルページの名前と内容を検索する書式
apropos [ -dhV] [ -r| -w] [ -m system[,...]] [ -M path] keyword ...説明
それぞれのマニュアルページには、内容を説明する要約文が含まれている。 apropos は、この要約文を対象にして keyword を検索する。 keyword にはワイルドカード ( -w) や正規表現 ( -r) を用いることもできる。これらのオプションを用いるときには、シェルによる解釈を防ぐために、 keyword を引用符で囲むか、特殊文字をエスケープする (\) 必要があるかもしれない。オプション
- -d, --debug
- デバッグ情報を表示する。
- -r, --regex
- キーワードをそれぞれ正規表現として扱う。ページの名前と要約文とが、それぞれ独立にキーワードマッチの対象になる。キーワードは各々のあらゆる部分にマッチする。マッチは単語の境界に影響されない。
- -w, --wildcard
- それぞれのキーワードを、シェル形式のワイルドカードを含んだパターンとして扱う。ページの名前と要約文とが、それぞれ独立にキーワードマッチの対象になる。展開されたキーワードがページまたは記述の全体にマッチする場合にのみ、マッチしたと判定される。
-m system[,...] , --systems=system[,...]
現在のシステムから、他のオペレーティングシステムについてのマニュアルにアクセスできる場合には、このオプションをつけるとそれらのマニュアルが検索される。 NewOS のマニュアルページを検索する場合には、
-m
NewOS のようなオプションを指定する。
system には複数のオペレーティングシステムをコンマで区切った形式で指定できる。ネイティブのオペレーティングシステムの
whatis 要約文を検索の対象に含めるためには、システム名
man を引き数文字列に加える。このオプションは $
SYSTEM 環境変数を上書きする。
- -M path , --manpath= path
- 検索対象にするマニュアルページの階層 (hierarchy) を変えたい場合、それらをコロンで区切った形式で指定する。デフォルトでは、 apropos は環境変数 $ MANPATH を用いる。これが空だったり設定されていなかった場合には、 $ PATH 環境変数に基づいて、適切な manpath を決めようと試みる。このオプションは $ MANPATH の内容を上書きする。
- -h, --help
- ヘルプメッセージを表示して終了する。
- -V, --version
- バージョンと著者に関する情報を表示する。
返り値
- 0
- プログラムの実行に成功した。
- 1
- 使用法、文法、設定ファイルのいずれかにエラーがある。
- 2
- 実行時エラー。
- 16
- 指定したキーワードにマッチするものが見つからなかった。
環境変数
- SYSTEM
- $ SYSTEM 環境変数が設定されている場合には、その内容が -m オプションの引き数として指定された場合と同じ効力を持つ。
- MANPATH
- $ MANPATH が設定されている場合には、その内容は検索対象とするマニュアルの階層をコロンで区切ったリストとみなされる。
- POSIXLY_CORRECT
- $ POSIXLY_CORRECT が設定されていると (内容が空であっても)、デフォルトの apropos の検索は拡張正規表現形式 ( -r) で行われる。
ファイル
- /usr/man/index.(bt|db|dir|pag)
- 従来形式の、 global なデータベースキャッシュのインデックス。
- /var/catman/index.(bt|db|dir|pag)
- 新しい (FSSTND 準拠の)、 global なデータベースキャッシュのインデックス。
- /usr/man/.../whatis
- 従来形式の、 whatis テキストデータベース。
関連項目
whatis(1), man(1)著者
Wilf. (G.Wilford@ee.surrey.ac.uk)| July 12th, 1995 | 2.3.10 |