日本語 man コマンド類 (ja-man-1.1j_5) と日本語 man ドキュメント (ja-man-doc-5.4 (5.4-RELEASE 用) など) をインストールすると、以下のような man コマンド閲覧、キーワード検索が コンソールからできるようになります。
4.11-RELEASE-K, 5.4-RELEASE-K, 5.5-RELEASE-K, 6.0-RELEASE-K から 6.4-RELEASE-K, 7.0-RELEASE-K から 7.4-RELEASE-K, 8.0-RELEASE-K から 8.4-RELEASE-K, 9.0-RELEASE-K から 9.3-RELEASE-K, 10.0-RELEASE-K から 10.3-RELEASE-K, 11.0-RELEASE-K から 11.4-RELEASE-K, 12.0-RELEASE-K, 12.1-RELEASE-K は、 プライベート版 (小金丸が編集してまとめたもの) ですが、 より多くの翻訳したファイルが含まれています。 (5.4-RELEASE-K から 6.4-RELEASE-K, 7.0-RELEASE-K から 7.4-RELEASE-K, 8.0-RELEASE-K から 8.4-RELEASE-K, 9.0-RELEASE-K から 9.3-RELEASE-K, 10.0-RELEASE-K から 10.3-RELEASE-K, 11.0-RELEASE-K から 11.4-RELEASE-K, 12.0-RELEASE-K から 12.4-RELEASE-K, 13.0-RELEASE-K から 13.3-RELEASE-K, 14.0-RELEASE-K から 14.1-RELEASE-K は、全翻訳済み)
13.3-STABLE-K, 15.0-CURRENT-K は現在、作成中で日々更新されています。
Table of Contents
APROPOS(1) FreeBSD 一般コマンドマニュアル APROPOS(1)
名称
apropos, whatis -- マニュアルページデータベースを検索する
書式
apropos [-afk] [-C file] [-M path] [-m path] [-O outkey] [-S arch]
[-s section] expression ...
解説
apropos と whatis ユーティリティは、各データベースのファイルごとに
expression を評価して、makewhatis(8) によって生成されたマニュアルページ
データベースに問い合わせます。デフォルトで、それらは、すべての一致するマ
ニュアルの名前、セクション数、と説明行を表示します。
デフォルトで、apropos は、man(1) によって規定されるデフォルトパスの
makewhatis(8) データベースを検索し、マニュアルの名前と説明 (the Nm and Nd
macro keys) を越えて (the = operator) と一致している大文字と小文字を区別
しな部分文字列を使用します。複数の用語は、-o ペアを意味しています。
whatis は、apropos -f と同義語です。
オプションは、次の通りです:
-a タイトル行だけを表示する代わりに、ちょうど man(1) -a のように、完
全なマニュアルページを表示します。標準出力が端末デバイスであり、
-c が指定されないなら、それらをページ付けするるために、more(1) を
使用します。-a モードで、mandoc(1) マニュアルに記述されたオプショ
ン -IKOTW も利用可能です。
-C file
man.conf(5) 形式で、代わりの設定 file を指定します。
-f マニュアルページ名だけで expression のすべての単語を検索します。
検索は、大文字と小文字を区別しないで、全体の単語だけと照合しま
す。このモードで、マクロのキー、比較演算子、と論理演算子は、利用
可能ではありません。
-k 完全な expression 構文をサポートします。それは、apropos のデフォ
ルトです。
-M path
makewhatis(8) データベースを検索するパスのデフォルトリストの代わ
りに、コロンで区切られたパスを使用します。無効のパス、またはマ
ニュアルのデータベースなしのパスは、無視されます。
-m path
makewhatis(8) データベースを検索するパスのリストにコロンで区切ら
れたパスを前に追加します。無効のパス、またはマニュアルのデータ
ベースなしのパスは、無視されます。
-O outkey
マニュアルの説明の代わりにキー outkey と関連した値を表示します。
-S arch
指定された machine(1) アーキテクチャのためのページの検索に制限し
ます。arch は、大文字と小文字を区別しません。デフォルトで、すべて
のアーキテクチャのためのページが表示されます。
-s section
マニュアルの指定されたセクションの検索に制限します。デフォルト
で、すべてのセクションからのページが表示されます。セクションのリ
ストについては、man(1) を参照してください。
オプション -chlw は、また、サポートされ、man(1) で文書化されています。オ
プション -fkl は、相互に排他的であり、お互いに上書きします。
expression は、論理演算子 -a (and) と -o (or) によって結合された検索単語
から成ります。-a 演算子は、-o より優先され、両方は、左から右に評価されま
す。
( expr )
部分式 expr が真であるなら、真です。
expr1 -a expr2
expr1 と expr2 の両方が真 (論理的な `and') であるなら、真。
expr1 [-o] expr2
expr1 and/or expr2 が真 (論理的な `or') と評価されるなら、真。
term term が満足されるなら、真。これは、構文 [[key[,key...]](=|~)]val,
があり、ここで、key は、問い合わせる mdoc(7) マクロであり、val
は、その値です。利用可能なキーのリストについては、「マクロキー」
を参照してください。演算子 = は、部分もじれて鵜を評価し、一方 ~
は、正規表現を評価します。
-i term
term が正規表現であるなら、それは、大文字と小文字を区別しないで評
価されます。部分文字列の単語で効果がありません。
結果は、次の基準にしたがってソートされます:
1. manpath ディレクトリツリーのページは、-M, -m, MANPATH 環境変数、
man.conf(5) 設定ファイル、または man.conf(5) で文書化されたデフォル
トで指定された順序にしたがって、見つけられます。
2. 数値の上昇の順序のセクション番号。
3. 大文字と小文字を区別しない、ascii(7) アルファベットの上昇順のページ
名。
各出力行は、次のように書式化されます。
name[, name...](sec) - description
ここで、``name'' は、マニュアルの名前であり、``sec'' は、マニュアルのセク
ションであり、``description'' は、マニュアルの短い説明です。アーキテク
チャがマニュアルのために指定されるなら、それは、つぎのように表示されま
す。
name(sec/arch) - description
結果のマニュアルは、次のようにアクセスされます。
$ man -s sec name
アーキテクチャが出力で指定されるなら、次を使用します。
$ man -s sec -S arch name
マクロキー
問い合わせは、makewhatis(8) によってインデックス付けられた mdoc(7) マクロ
のサブセットで評価します。下記にリストされたマクロのキーに加えて特別な
キー any は、あらゆる利用可能なマクロキーを照合するために使用されます。
名前と説明:
Nm マニュアルの名前
Nd 1 行マニュアルの説明
arch マシンアーキテクチャ (大文字と小文字を区別しない)
sec マニュアルのセクション番号
セクションとクロスリファレンス (相互参照):
Sh セクションヘッダ (標準のセクションを除いて)
Ss サブセクションヘッダ
Xr 別のマニュアルページへのクロスリファレンス (相互参照)
Rs 文献の参照
コマンド行ユーティリティのための意味的なマークアップ:
Fl コマンド行オプション (フラグ)
Cm コマンド修飾子
Ar コマンド引数
Ic 内部または対話型のコマンド
Ev 環境の変数
Pa ファイルシステムのパス
関数ライブラリのための意味的なマークアップ:
Lb 関数ライブラリ名
In ファイルをインクルード
Ft 関数の返りタイプ
Fn 関数名
Fa 関数引数タイプと名前
Vt 変数タイプ
Va 変数名
Dv 定義された変数またはプリプロセッサの定数
Er エラー定数
Ev 環境変数
様々な意味的なマークアップ:
An 作者名
Lk ハイパーリンク
Mt ``mailto'' ハイパーリンク
Cd カーネル設定宣言
Ms 数学的シンボル
Tn 商標
物理的なマークアップ:
Em イタリックのフォントまたは下線
Sy ボールド体のフォント
Li タイプライタフォント
テキスト生成:
St 標準文書への参照
At AT&T UNIX バージョン参照
Bx BSD バージョン参照
Bsx BSD/OS バージョン参照
Nx NetBSD バージョン参照
Fx FreeBSD バージョン参照
Ox OpenBSD バージョン参照
Dx Dx バージョン参照
環境変数
MANPAGER 環境変数 MANPAGER のあらゆる空でない値は、標準のページ付けプロ
グラム more(1) の代わりに使用されます。詳細については、man(1)
を参照してください。-a または -l が指定される場合のみ、使用され
ます。
MANPATH マニュアルページを検索するディレクトリの、コロンで区切られたリ
スト。詳細については、man(1) を参照してください。-M によって上
書きされ、-l が指定されるなら、無視されます。
PAGER MANPAGER が定義されないとき、使用するページ付けプログラムを指定
します。PAGER も MANPAGER も定義されないなら、more(1) -s が使用
されます。-a または -l が指定される場合のみ、使用されます。
関連ファイル
mandoc.db makewhatis(8) キーワードデータベースの名前
/etc/man.conf デフォルトの man(1) 設定ファイル
終了ステータス
ユーティリティ apropos は、成功すると 0 で、エラーがあった場合は >0 で終
了します。
使用例
マニュアルの名前と説明の部分文字列として ".cf" を検索します:
$ apropos .cf
同様に、".cnf" と ".conf" のための照合をインクルードします:
$ apropos .cf .cnf .conf
正規表現を使用して名前と説明を検索します:
$ apropos '~set.?[ug]id'
"optind" と "optarg" 変数の両方に言及しているライブラリセクションでマニュ
アルを検索します:
$ apropos -s 3 Va=optind -a Va=optarg
引数 "ssh" を付けて whatis を呼び出すのとまったく同じことを行います:
$ apropos -- -i 'Nm~[[:<:]]ssh[[:>:]]'
次の 2 回の呼び出しは、同等です:
$ apropos -S arch -s section expression
$ apropos \( expression \) -a arch~^(arch|any)$ -a sec~^section$
関連項目
man(1), re_format(7), makewhatis(8)
歴史
whatis の機能の一部は、既に 1BSD の以前の manwhere ユーティリティによって
提供されていました。apropos と whatis ユーティリティは、2BSD ではじめて登
場しました。それらは、OpenBSD 5.6 のためのスクラッチから書き直されまし
た。
-M オプションと MANPATH 変数は、4.3BSD ではじめて登場しました。
4.3BSD-Reno の -m。4.4BSD Lite1 の -C。と apropos のための OpenBSD 4.5 の
-S と -s whatis のための OpenBSD 5.6。オプション -acfhIKklOTWw は、
OpenBSD 5.7 で登場しました。
作者
Bill Joy は、1977 年に manwhere、そして 1979 年 2 月にオリジナルの BSD
apropos と whatis を書きました。現在のバージョンは、Kristaps Dzonsons
<kristaps@bsd.lv> と Ingo Schwarze <schwarze@openbsd.org> によって書かれ
ました。
FreeBSD 11.4 July 4, 2017 FreeBSD 11.4