.\" Man page for man .\" .\" Copyright (c) 1990, 1991, John W. Eaton. .\" .\" You may distribute under the terms of the GNU General Public .\" License as specified in the README file that comes with the man 1.0 .\" distribution. .\" .\" John W. Eaton .\" jwe@che.utexas.edu .\" Department of Chemical Engineering .\" The University of Texas at Austin .\" Austin, Texas 78712 .\" .\" %FreeBSD: src/gnu/usr.bin/man/man/man.man,v 1.10.2.2 2000/04/23 16:57:02 mpp Exp % .\" .\" jpman %Id: man.1,v 1.2 1997/04/01 14:17:54 horikawa Stab % .Dd Jan 5, 1991 .Dt MAN 1 .Os .Sh 名称 .Nm man .Nd オンラインマニュアルのフォーマット、表示を行なう .Sh 書式 .Nm man .Op Fl adfhkotw .Op Fl m Ar system .Op Fl p Ar string .Op Fl M Ar path .Op Fl P Ar pager .Op Fl S Ar list .Op Ar section .Ar name ... .Sh 解説 .Nm man はオンラインマニュアルをフォーマットし、表示します。 このバージョンでは、環境変数 .Ev MANPATH と .Ev PAGER を参照するので、 各ユーザが固有のオンラインマニュアルを持つ事や、画面で見る際のページャを 選ぶ事が可能です。 セクションを指定した場合、man はそのセクションのみを探します。 また、コマンドラインオプションや環境変数によって、 検索するセクションの順序や、ソースファイルを処理するプリプロセッサを 指定することもできます。 システム管理者の設定によっては、 ディスクスペースを節約するために、フォーマット済みのオンライン マニュアルを `/usr/bin/gzip -c' コマンドにより 圧縮し格納するようにすることも出来ます。 .Pp オプションを以下に示します: .Bl -tag -width Fl .It Fl M Ar path 別の manpath を指定します。通常、man は .Nm manpath を使い、検索するパスを決めます。このオプションは環境変数 .Ev MANPATH よりも優先されます。 .It Fl P Ar pager 使用するページャを指定します。通常、man は、 .Nm more -s を使用します。 このオプションは環境変数 .Ev PAGER よりも優先されます。 .It Fl S Ar list list はコロンで区切られた検索するマニュアルのセクションのリストです。 このオプションは環境変数 .Ev MANSECT よりも優先されます。 .It Fl a 通常、man は最初にみつかったマニュアルページを表示した後終了しますが、 このオプションを使用すると、最初にみつかったマニュアルページだけでなく、 .Ar name にマッチしたマニュアルページを全て表示します。 .It Fl d マニュアルページは表示せず、デバッグ用の情報を表示します。 .It Fl f .Nm whatis と同じです。 .It Fl h 一行のヘルプメッセージを表示して終了します。 .It Fl k .Nm apropos と同じです。 .It Fl m Ar system 与えられたシステム名をもとに検索する別のマニュアルセットを指定します。 .It Fl o 元の、非ローカライズ版マニュアルページを使用します。 デフォルトでは、man は、 各 manpath 構成要素毎にローカライズ版サブディレクトリを検索します。 サブディレクトリ名は、環境変数 .Ev LANG または .Ev LC_CTYPE から決定されます。 ローカライズ版ディレクトリ名は、次の規則により構築されます: 環境変数 .Ev LC_CTYPE または .Ev LANG の値をマージしたディレクトリ名。 .Ev LC_CTYPE が値無しの場合、 .Ev LANG 変数値が使用されます。 両方の変数が値無しの場合、なにも行いません。 .Nm は、長い形式および短い形式の両方のローカライズ版ディレクトリ名を扱えます。 長い形式とは、"path/_." の形式であり、 例えば ".../man/ru_RU.KOI8-R" です。 短い形式とは、"path/." の形式であり、 例えば ".../man/ru.KOI8-R" です。 短い形式が、長い形式に優先します。 .It Fl p Ar string nroff や troff を行う前に実行するプリプロセッサの順序を指定します。 全てのプリプロセッサがインストールされているとはかぎりません。 プリプロセッサとそれを指定するのに使われる文字は以下の通りです。 eqn (e), grap (g), pic (p), tbl (t), vgrind (v), refer (r). このオプションは環境変数 .Ev MANROFFSEQ よりも優先されます。 .It Fl t マニュアルページをフォーマットするのに .Nm /usr/bin/groff -S -man を使い、標準出力に出力します。 .Nm /usr/bin/groff -S -man の出力は表示する前に何らかのフィルタを通す必要があるでしょう。 .It Fl w マニュアルページの表示は行わず、フォーマットや表示を行なうべきファイルの 場所を表示します。 .Sh 環境変数 .Bl -tag -width MANROFFSEQ -compact .It Ev MANPATH .Ev MANPATH がセットされていれば、その値はマニュアルページを検索するパスとして使われます。 .It Ev MANROFFSEQ .Ev MANROFFSEQ がセットされていれば、その値は nroff や troff を行う前に実行される プリプロセッサの順序を示すのに使われます。 デフォルトでは、nroff の前に tbl プリプロセッサが実行されます。 .It Ev MANSECT .Ev MANSECT がセットされていれば、その値はどのマニュアルセクションを検索するのかを 決定するのに使われます。 .It Ev PAGER .Ev PAGER がセットされていれば、その値はマニュアルページを表示するのに使われる プログラムの名前を指定するのに使われます。セットされていなければ、 .Nm more -s が使われます。 .El .Sh 使用例 .Pp 通常、getopt の適切なマニュアルページ情報を検索するには、次のようにします: .Dl man getopt .Pp 一方、特定のマニュアルセクション、例えば .Xr getopt 3 を検索するには、次のようにします: .Dl man 3 getopt .Sh 関連項目 .Xr apropos 1 , .Xr groff 1 , .Xr manpath 1 , .Xr more 1 , .Xr whatis 1 , .Xr man 7 , .Xr mdoc 7 , .Xr mdoc.samples 7 .Sh バグ .Fl t オプションは troff ライクなプログラムがインストールされている場合のみ有効です。