MAN(1) | FreeBSD General Commands Manual | MAN(1) |
名称
man — オンラインマニュアル文書ページを表示する書式
man | [ -adho][ -t | -w][ -M manpath][ -P pager][ -S mansect][ -m arch[ : machine]][ -p [ eprtv]][ mansect] page ... |
man | -f keyword ... |
man | -k keyword ... |
解説
man ユーティリティは、オンラインマニュアル文書ページを見つけて、表示します。 mansect が提供されているなら、 man は、マニュアルの特定のセクションの検索を制限します。man が理解しているオプションは、次の通りです:
- -M manpath
- デフォルト検索パスの代わりに特定のコロンで区切られたマニュアルパスを強制します。 manpath(1) を参照してください。 MANPATH 環境変数を上書きします。
- -P pager
-
指定されたページャを使用します。デフォルトは、カラー (色) のサポートが有効であるなら、“
less -sR
”か、または、“more -s
”です。 MANPAGER 環境変数を上書きし、順に PAGER 環境変数を上書きします。 - -S mansect
-
指定されたコロンで区切られたリストとして検索されるマニュアルセクションを制限します。デフォルトは、“
1:8:2:3:n:4:5:6:7:9:l
”です。 MANSECT 環境変数を上書きします。 - -a
- 各 page 引数に対して最初に見つけられたもの代わりにすべてのマニュアルページを表示します。
- -d
- 追加のデバッグ情報を印刷 (表示) します。冗長さを増加するには、繰り返します。マニュアルページを表示しません。
- -f
- whatis(1) をエミュレートします。
- -h
- 短いヘルプメッセージを表示して、終了します。
- -k
- apropos(1) をエミュレートします。
- -m arch[ : machine]
- 他のプラットフォーム特定のマニュアルページの検索を許可するデフォルトのアーキテクチャとマシンの設定を上書きします。このオプションのデフォルトの振る舞いを変更するためには、 「実装に関する注」 を参照してくさい。 MACHINE_ARCH と MACHINE 環境変数を上書きします。
- -o
- ローカルでないマニュアルページの使用を強制します。ロケール特有の検索が動作する方法については、 「実装に関する注」 を参照してくさい。 LC_ALL, LC_CTYPE と LANG 環境変数を上書きします。
- -p [ eprtv]
-
nroff(1) または
troff(1) を実行する前に、与えられたプリプロセッサのリストを使用します。有効なプリプロセッサの引数は、次の通りです:
MANROFFSEQ 環境変数を上書きします。
- -t
- 他の形式にマニュアルページの変換を許可する troff(1) を通してマニュアルページのソースを送ります。
- -w
- マニュアルページの内容の代わりにマニュアルページの位置を表示します。
実装に関する注
ロケール特有の検索
man ユーティリティは、異なったロケールのマニュアルページをサポートしています。検索の振る舞いは、次の空でない文字列がある 3 つの環境変数の最初のものによって指示されます: LC_ALL, LC_CTYPE または LANG です。設定されるなら、 man は、次の論理を使用してロケール特有のマニュアルページを検索します:
- lang_ country. charset
- lang. charset
-
en
. charset
例えば、 LC_ALL が“ ja_JP.eucJP
”に設定されるなら、 man は、セクション 1 のマニュアルページが /usr/share/man にあると見なされるとき、次のパスを検索します:
- /usr/share/man/ja_JP.eucJP/man1
- /usr/share/man/ja.eucJP/man1
- /usr/share/man/en.eucJP/man1
- /usr/share/man/man1
プラットフォーム特有の検索
man ユーティリティは、プラットフォーム特有のマニュアルページをサポートします。検索の振る舞いは、 -m オプションまたは MACHINE_ARCH と MACHINE 環境変数によって決定されます。例えば、 MACHINE_ARCH が“i386
”に設定され、
MACHINE が“
pc98
”に設定されているなら、
man は、セクション 4 のマニュアルページが
/usr/share/man にあると見なされるとき、次のパスを検索します:
- /usr/share/man/man4/pc98
- /usr/share/man/man4/i386
- /usr/share/man/man4
特定のマニュアルファイルを表示する
また、 man ユーティリティは、渡されたファイルへのパスが‘/
’文字を含んでいさえすれば、特定のマニュアルページの表示をサポートします。
環境変数
次の環境変数は、 man の実行に影響します:- LC_ALL, LC_CTYPE, LANG
- ロケール特有のマニュアルページを見つけるために使用されます。 locale(1) コマンドを実行することによって有効な値を見つけることができます。詳細については、 「実装に関する注」 を参照してください。 -o オプションによって影響されます。
- MACHINE_ARCH, MACHINE
-
プラットフォーム特有のマニュアルページを見つけるために使用されます。設定されていないなら、“
sysctl hw.machine_arch
”と“sysctl hw.machine
”の出力は、それぞれ使用されます。詳細については、 「実装に関する注」 を参照してください。 -m オプションに対応しています。 - MANPATH
- マニュアルファイルの位置を見つけるために使用されます。追加情報については、 manpath(1) を参照してください。 -M オプションに対応しています。
- MANROFFSEQ
- nroff(1) または troff(1) を実行する前にマニュアルソースのためのプリプロセッサを決定するために使用されます。設定されていないなら、デフォルトは、 tbl(1) です。 -p オプションに対応しています。
- MANSECT
- 指定されたコロンで区切られたリストとして検索されるマニュアルセクションを制限します。 -S オプションに対応しています。
- MANWIDTH
-
数値に設定するなら、表示されるマニュアルページの幅として使用します。そうでなければ、特別な値“
tty
”に設定され、出力が端末であるなら、ページは、画面の全体の幅を越えて表示されます。 - MANCOLOR
- 設定されるなら、カラー (色) のサポートを有効にします。
- MANPAGER
-
ファイルを表示するために使用されるプログラム。
設定されず、カラー (色) のサポートが有効にされているなら、“
less -sR
”が使用されます。設定されず、カラー (色) のサポートが無効にされているなら、 PAGER が使用されます。値が何もないなら、“
more -s
”が使用されます。
関連ファイル
- /etc/man.conf
- システムの設定ファイル。
- /usr/local/etc/man.d/*.conf
- ローカルの設定ファイル。
June 3, 2011 | FreeBSD |