Provided by: man-db_2.6.7.1-1ubuntu1_amd64 bug

名前

       apropos - マニュアルページの名前と要約文を検索する

書式

       apropos  [-dalv?V]  [-e|-w|-r] [-s list] [-m system[,...]] [-M path] [-L locale] [-C file]
       keyword ...

説明

       各マニュアルページには短い要約文が含まれています。 apropos  はそのマニュアルページの要約内
       にある keyword を検索します。

       keyword  は通常は (-r を指定した時のように) 正規表現として扱われますが、 -w を指定してワイ
       ルドカードを含めたり、 -e を指定して厳密に keyword  に一致させたりすることもできます。これ
       らのオプションを使用する場合には、シェルの解釈を抑止するために    keyword   を引用符で囲む
       か、特殊文字をエスケープ (\) する必要があります。

       標準の一致処理ルールではページ名や要約文内の単語境界にも一致させることができます。

       apropos によって検索されるデータベースは mandb  プログラムによって更新されます。インストー
       ル方法によりますが、cron  ジョブとして  mandb が定期的に実行されているかもしれませんし、マ
       ニュアルページをインストール時に mandb を手動で実行する必要があるかもしれません。

オプション

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

       -v, --verbose
              冗長な警告メッセージを表示します。

       -r, --regex
              各 keyword を正規表現として解釈します。これはデフォルトの動作です。ページ名と要約文
              に対してそれぞれ独立して keyword の一致処理が行われます。一致処理は両者のどの部分も
              対象になります。一致処理は単語境界に限定されません。

       -w, --wildcard
              各 keyword をシェル形式のワイルドカードを含むパターンとして解釈します。ページ名と要
              約文に対してそれぞれ独立して一致処理が行われます。 --exact も併せて指定した場合、展
              開された  keyword  が要約文またはページ名全体に一致した場合のみ一致したと判定されま
              す。指定しない場合、 keyword は要約文内の単語境界に対しても一致処理が行われます。

       -e, --exact
              各 keyword はページ名と要約文に対して厳密に一致処理が行われます。

       -a, --and
              与えた  keyword  全てに一致したページのみ表示します。デフォルトはいずれかに一致する
              ページを表示します。

       -l, --long
              出力を端末幅で切り詰めません。通常は、適切に書かれていない 名前 (NAME) 節による見に
              くさを避けるために出力が端末の幅に切り詰められます。

       -s list, --sections list, --section list
              指定したマニュアルセクションのみ検索します。  list はコロンまたはコンマで区切られた
              セクションのリストです。もし、 list の項目が単純なセクション、例えば "3" ならば、表
              示される説明のリストには   "3"、  "3perl"、  "3x"  等のセクションのページが含まれま
              す。一方 list に拡張部分も含める、例えば "3perl" ならば、表示される説明のリストはマ
              ニュアルセクションに厳密に一致したページのみ含まれるようになります。

       -m system[,...], --systems=system[,...]
              現在のシステムが他のオペレーティングシステムのマニュアルページにアクセスできる場
              合、このオプションを使用するとそれらが検索されます。例えば、 NewOS のマニュアルペー
              ジの説明を検索する場合には、 -m NewOS を使用します。

              system にはコンマで区切ったオペレーティングシステム名の組み合わせを指定できます。現
              在のオペレーティングシステムの whatis を検索に含めるためにはシステム名として man を
              引数に含めます。このオプションは $SYSTEM 環境変数を上書きします。

       -M path, --manpath=path
              検索するマニュアルページ階層を変更する場合、その集合をコロンで区切って指定しま
              す。デフォルトでは、apropos は $MANPATH 環境変数を使用します。 $MANPATH  環境変数が
              空であるか、設定されていない場合、$PATH  環境変数に応じて適切なマニュアルページのパ
              スが決定されます。このオプションは $MANPATH の内容を上書きします。

       -L locale, --locale=locale
              apropos は通常、現在のロケールを C の関数 setlocale(3) を呼び出すことによって決定し
              ます。これはおそらく  $LC_MESSAGES  や $LANG などを含むさまざまな環境変数を使用しま
              す。一時的にこの値を上書きしたい場合には、このオプションを使用して  apropos  に直接
              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
              $MANWIDTH が設定されている場合、その値が端末幅として使用されます (--long オプション
              参照)。設定されていない場合、端末幅は  ioctl(2)  が使用可能な場合は  ioctl(2)  の結
              果、$COLUMNS   が設定されている場合はその値が順に使用され、いずれも使用出来ない場合
              は、最終的に 80 が使用されます。

       POSIXLY_CORRECT
              $POSIXLY_CORRECT  が設定されている場合、値が空であったとしても、 apropos はデフォル
              トで拡張正規表現 (-r) を使用して検索します。今日ではこの動作が常にデフォルトです。

ファイル

       /usr/share/man/index.(bt|db|dir|pag)
              伝統的な大域インデックス型データベースキャッシュです。

       /var/cache/man/index.(bt|db|dir|pag)
              FHS 準拠の大域インデックス型データベースキャッシュです。

       /usr/share/man/.../whatis
              伝統的な whatis テキスト型データベースです。

関連項目

       man(1), whatis(1), mandb(8)

著者

       Wilf. (G.Wilford@ee.surrey.ac.uk).
       Fabrizio Polacco (fpolacco@debian.org).
       Colin Watson (cjwatson@debian.org).