Manpages

名 前

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[,...]

If this system has access to other operating systems’ manual page descriptions, they can be searched using this option. To search NewOS’s manual page descriptions, use the option -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

Use this user configuration file rather than the default of ~/.manpath.

-?, --help ヘ ル プ メ ッ セ ー ジ を 表 示 し て 終 了 し ま す 。
--usage

Print a short usage message and exit.

-V, --version バ ー ジ ョ ン 情 報 を 表 示 し ま す 。

終 了 ス テ ー タ ス

環 境 変 数

MANPATH

$MANPATH が 設 定 さ れ て い る 場 合 、 そ の 値 は コ ロ ン 区 切 り の マ ニ ュ ア ル ペ ー ジ 階 層 の 検 索 パ ス と し て 使 用 さ れ ま す 。

See the SEARCH PATH section of manpath(5) for the default behaviour and details of how this environment variable is handled.

MANWIDTH

If $MANWIDTH is set, its value is used as the terminal width (see the --long option). If it is not set, the terminal width will be calculated using the value of $COLUMNS, and ioctl(2) if available, or falling back to 80 characters if all else fails.

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 [AT] ee.uk).
Fabrizio Polacco (fpolacco [AT] debian.org).
Colin Watson (cjwatson [AT] debian.org).

バ グ

https://gitlab.com/man-db/man-db/-/issues
https://savannah.nongnu.org/bugs/?group=man-db