APROPOS
Section: Manual pager utils (1)
Updated: 2019-10-23
Index
Return to Main Contents
名前
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
を引用符で囲むか、特殊文字をエスケープする (\) 必要があるかもしれない。
標準的なマッチングパターンを指定すれば、
要約文中の単語の境界やページの名前もマッチの対象となる。
apropos
によって検索されるデータベースは、
mandb
プログラムによって更新される。
インストール方法によるが、
mandb
が定期的な cron ジョブで実行されているかもしれないし、
新しいマニュアルページをインストールしたときに
mandb
を手動で実行する必要があるかもしれない。
オプション
- -d, --debug
-
デバッグ情報を表示する。
- -v, --verbose
-
詳細な警告メッセージを表示する。
- -r, --regex
-
キーワードをそれぞれ正規表現として扱う。
これがデフォルトの動作である。
ページの名前と要約文とが、それぞれ独立にキーワードマッチの対象に
なる。
キーワードは各々のあらゆる部分にマッチする。
マッチは単語の境界に影響されない。
- -w, --wildcard
-
それぞれのキーワードを、シェル形式のワイルドカードを含んだパターン
として扱う。
ページの名前と要約文とが、それぞれ独立にキーワードマッチの対象に
なる。
--exact
も指定された場合、展開されたキーワードが要約文またはページ名の
全体に一致した場合にのみ、一致したと判断される。
指定されない場合、キーワードは要約文の単語境界に対しても一致処理が
行われる。
- -e, --exact
-
各キーワードはページ名と要約文に対して厳密に一致処理が行われる。
- -a, --and
-
指定したキーワードすべてにマッチしたページのみを表示する。
デフォルトでは、いずれかのキーワードにマッチしたページを表示する。
- -l, --long
-
出力を端末幅で切り詰めない。
通常は、適切に書かれていない
名前
セクションの見にくさを避けるため、端末幅で切り詰める。
- -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
-
検索対象にするマニュアルページの階層 (hierarchy) を変えたい場合、
それらをコロンで区切った形式で指定する。
デフォルトでは、
apropos
は環境変数
$MANPATH
を用いる。
これが空だったり設定されていなかった場合には、
$PATH
環境変数に基づいて、適切な manpath を決めようと試みる。
このオプションは
$MANPATH
の内容を上書きする。
- -L locale, --locale=locale
-
apropos
は通常、カレント・ロケールを C 関数
setlocale(3)
を呼ぶことによって決定しようとする。
この関数は
$LC_MESSAGES
や
$LANG
などを含む様々な環境変数を調べる。
この値を一時的に上書きするには、このオプションを使って
apropos
に直接
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 文字にされる。
- POSIXLY_CORRECT
-
$POSIXLY_CORRECT
が設定されていると (内容が空であっても)、デフォルトの
apropos
の検索は拡張正規表現形式
(-r)
で行われる。
現在では、これがデフォルトの動作である。
ファイル
- /usr/share/man/index.(bt|db|dir|pag)
-
従来形式のグローバルな
index
データベースキャッシュ。
- /var/cache/man/index.(bt|db|dir|pag)
-
FHS 互換のグローバルな
index
データベースキャッシュ。
- /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).
Index
- 名前
-
- 書式
-
- 説明
-
- オプション
-
- 返り値
-
- 環境変数
-
- ファイル
-
- 関連項目
-
- 著者
-
This document was created by
man2html,
using the manual pages.
Time: 13:46:28 GMT, July 01, 2020