MAN(1)

名称
man - オンラインマニュアルのフォーマット、表示を行なう

書式
man [-adfhkotw] [-m machine] [-p string] [-M path] [-P pager] [-S list] [section] name ...

解説
man はオンラインマニュアルをフォーマットし、表示します。 このバージョンでは、環境変数 MANPATH と PAGER を参照するので、 各ユーザが固有のオンラインマニュアルを持つ事や、画面で見る際のページャを 選ぶ事が可能です。 セクションを指定した場合、 man はそのセクションのみを探します。 また、コマンドラインオプションや環境変数によって、 検索するセクションの順序や、ソースファイルを処理するプリプロセッサを 指定することもできます。 システム管理者の設定によっては、 ディスクスペースを節約するために、フォーマット済みのオンライン マニュアルを `/usr/bin/gzip -c' コマンドにより 圧縮し格納するようにすることも出来ます。

オプションを以下に示します:

-M path
    別の manpath を指定します。通常、 man は manpath(1) ( man バイナリに組み込まれています) を使い、検索するパスを決めます。 このオプションは環境変数 MANPATH よりも優先されます。

-P pager
    使用するページャを指定します。通常、 man は、 more -s を使用します。 このオプションは環境変数 PAGER よりも優先されます。

-S list
    list はコロンで区切られた検索するマニュアルのセクションのリストです。 このオプションは環境変数 MANSECT よりも優先されます。

-a  通常、 man は最初にみつかったマニュアルページを表示した後終了しますが、 このオプションを使用すると、最初にみつかったマニュアルページだけでなく、 name にマッチしたマニュアルページを全て表示します。

-d  マニュアルページは表示せず、デバッグ用の情報を表示します。

-f  whatis と同じです。

-h  一行のヘルプメッセージを表示して終了します。

-k  apropos と同じです。

-m machine
    マニュアルページによっては、特定のアーキテクチャに特化したものがあります。 man は、検索対象のすべてのディレクトリ中で、 現在のアーキテクチャと同じ名前のサブディレクトリを検索します。 マシン固有の検索範囲が、一般的な検索範囲の前に検索されます。 現在のマシンタイプは、環境変数 MACHINE を特定のアーキテクチャ名に設定することで変えられます。 本オプションは、 MACHINE 環境変数に優先します。

-o  元の、非ローカライズ版マニュアルページのみを検索します。

    デフォルトでは、 man は、 各 manpath(1) 構成要素毎にローカライズ版サブディレクトリを検索します。

    ロケール名は、3 個の環境変数 LC_ALL, LC_CTYPE, LANG のうち、この順番における最初の空ではないものから得られます。

    値を決定できない場合か、無効なロケール名である場合、 ローカライズされていないマニュアルページのみが検索されます。

    そうでない場合、 man は次のサブディレクトリを、次の優先順位で検索します:

    <lang>_<country>.<charset>
    <lang>.<charset>
    en.<charset>

    例えば “de_DE.ISO8859-1” ロケールの場合、 /usr/share/man manpath 構成要素中の次のサブディレクトリを man は検索します:

    /usr/share/man/de_DE.ISO8859-1
    /usr/share/man/de.ISO8859-1
    /usr/share/man/en.ISO8859-1

    最後に、ローカライズされたマニュアルページが見付からなかった場合、 デフォルトの /usr/share/man ディレクトリを検索します。

-p string
    nroff や troff を行う前に実行するプリプロセッサの順序を指定します。 全てのプリプロセッサがインストールされているとはかぎりません。 プリプロセッサとそれを指定するのに使われる文字は以下の通りです。 eqn (e), grap (g), pic (p), tbl (t), vgrind (v), refer (r). このオプションは環境変数 MANROFFSEQ よりも優先されます。

-t  マニュアルページをフォーマットするのに /usr/bin/groff -S -man を使い、標準出力に出力します。 /usr/bin/groff -S -man の出力は表示する前に何らかのフィルタを通す必要があるでしょう。

-w  マニュアルページの表示は行わず、フォーマットや表示を行なうべきファイルの 場所を表示します。

環境変数

LC_ALL, LC_CTYPE, LANG
    これらの環境変数は、マニュアルページの好みの言語を指定します (前述の -o オプションを参照してください)。

MACHINE
    MACHINE が設定されると、マシン固有のサブディレクトリを検索するときに、 この値が現在のマシンタイプに優先します。

MANPATH
    MANPATH がセットされていれば、その値はマニュアルページを検索するパスとして使われます。

MANROFFSEQ
    MANROFFSEQ がセットされていれば、その値は nroff や troff を行う前に実行される プリプロセッサの順序を示すのに使われます。 デフォルトでは、nroff の前に tbl プリプロセッサが実行されます。

MANSECT
    MANSECT がセットされていれば、その値はどのマニュアルセクションを検索するのかを 決定するのに使われます。

PAGER
    PAGER がセットされていれば、その値はマニュアルページを表示するのに使われる プログラムの名前を指定するのに使われます。セットされていなければ、 more -s が使われます。

使用例
通常、getopt の適切なマニュアルページ情報を検索するには、次のようにします:

    man getopt

一方、特定のマニュアルセクション、例えば getopt(3) を検索するには、次のようにします:

    man 3 getopt

関連項目
apropos(1), groff(1), manpath(1), more(1), whatis(1), man(7), mdoc(7)

バグ
-t オプションは troff(1) ライクなプログラムがインストールされている場合のみ有効です。