apropos(1)

名前
apropos - マニュアルページの名前と内容を検索する

書式
apropos [-dhV] [-e|-w|-r ] [-m system[,...]] [-M path] keyword ...

説明
それぞれのマニュアルページには、内容を説明する要約文が含まれている。 apropos は、この要約文を対象にして keyword を検索する。 keyword は、通常は正規表現とみなされるが (あるいは -r 指定時) 、ワイルドカードを含めたり (-w 指定時) 、 keyword に厳密に一致する (-e 指定時) ように指定することができる。 これらのオプションを用いるときには、シェルによる解釈を防ぐために、 keyword を引用符で囲むか、特殊文字をエスケープする (\) 必要があるだろう。 標準的なマッチングパターンを指定すれば、 要約文中の単語の境界やページの名前もマッチの対象となる。

オプション

-d, --debug
    デバッグ情報を表示する。

-r, --regex
    キーワードをそれぞれ正規表現として扱う。 これがデフォルトの動作である。 ページの名前と 要約文とが、それぞれ独立にキーワードマッチの対象になる。キーワードは ページ名と要約文のあらゆる部分にマッチすることができる。 マッチは単語の境界部分に限定されない。

-w, --wildcard
    それぞれのキーワードを、シェル形式のワイルドカードを含んだパターン として扱う。ページの名前と 要約文とが、それぞれ独立にキーワードマッチの対象になる。 展開されたキーワードが要約文の全体またはページの名前にマッチする場合にのみ、 マッチしたと判定される。

-e, --exact
    それぞれのキーワードは、ページの名前と要約文に対して厳密にマッチする。

-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/share/man/index.(bt|db|dir|pag)
    従来形式の、 global なデータベースキャッシュの インデックス。

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

/var/cache/man/index.(bt|db|dir|pag)
    新しい (FHS 準拠の)、 global なデータベースキャッシュのインデックス。

/usr/share/man/.../whatis
    従来形式の、 whatis テキストデータベース。

関連項目
whatis(1), man(1)

著者
Wilf. (G.Wilford@ee.surrey.ac.uk). Fabrizio Polacco (fpolacco@debian.org).