名称

man − キーワードによってマニュアルを検索したり、マニュアルを出力する

形式

man [ − ] [ −a ] [ −t ] [ −M path ] [ section ] title ... 
man [ −a ] −k keyword ... 
man [ −a ] −f file ... 

解説

man は、 プログラマーズマニュアルから情報を引き出すプログラムです。 指定した名前のコマンドの概要を求めたり、 すべてのコマンドについて指定したキーワードの何等かを その概要に含むものを求めることができます。 また、 マニュアルのオンラインアクセスもできます。

−k オプションとキーワード(複数可)を指定すると、 man 各マニュアルの概要にキーワードを１つでも含む マニュアルのタイトルと概要を出力します。

−f オプションとファイル名のリストを指定すると、 man はそれらのファイルに関連するマニュアルを捜し、 そのタイトルと概要を出力します。

−k も −f も指定しない場合には、 man は指定されたマニュアルページをフォーマットし、表示します。 section 指定をした場合、 man は指定された title についてそのマニュアルセクション内を調べます。 section とは、 アラビア数字のセクション番号 (例えば、3)か、 または語句“new”、 “local”、 “old”、 “pds”のうちの一つのいずれかを指します。 セクション番号には、 一文字の分類符 (例えば、 セクション 1 におけるグラフィックプログラムを表す 1g など)を 付ける事ができます。 section が省略されると、 man はマニュアルの全てのセクションを検索します。 この時、 システムライブラリ内のサブルーチンよりもコマンドが優先され、 もしあれば、 発見した最初のセクションを出力します。 −t オプションが指定された場合は、 フォーマッタとして ditroff を使用します。

標準出力が端末でない、または − フラグが指定された場合には、 man は more(1) を通さず cat(1) を使用します。 それ以外の場合は、 more(1) を通りますので、 出力が停止した時に、 継続するにはスペースを、 次の 11行をスクロールするには control-D を 入力します。

通常 man は、 マニュアル情報について標準的な位置 ( /usr/jman と /usr/man) を 検索します。 ‘/usr/jman’は日本語マニュアルで、‘/usr/man’が英語マニュアルです。 −a オプションによって‘usr/man’だけのチェックになります。 ASCII端末に表示させるときは −a オプションを付ける必要はありません。

検索する位置は、 −M フラグによって (shell を 通じて) 検索パスを与えることにより、 変更することができます。 検索パスは、 マニュアルのサブディレクトリが存在するディレクトリを コロン (：) で区切ってリストしたもので、 たとえば“/usr/local:/usr/man”です。 環境変数‘MANPATH’および‘JMANPATH’が設定されている場合には、 その値がデフォルトパスとして用いられます。 検索パスを −k オプションまたは −f オプションとともに与えるときは、 最初に指定しなければなりません。

man は、 nroff ソースと既にフォーマットされたページ(cat?)  の 2つの形式についてマニュアルページの検索を行います。 どちらかのバージョンが存在すれば、 マニュアルページが表示されます。 既にフォーマットされたバージョンが存在して、 nroff ソースよりも修正時刻が新しければ、 マニュアルページは即座に表示されます。 そうでない場合には、 マニュアルページは nroff でフォーマットされてから表示されます。 ユーザが許可を持っている場合は、 フォーマットされたマニュアルページは適当な場所に保管されるので、 次回の man の呼び出しの際、 もう一度ページがフォーマットされることはありません。

関連ファイル

/usr/man標準英語マニュアル領域
/usr/jman標準日本語マニュアル領域
/usr/{man, jman}/man?/∗マニュアルのソースを含むディレクトリ
/usr/{man, jman}/cat?/∗フォーマット済みページを含むディレクトリ
/usr/{man, jman}/whatisキーワードデータベース

関連事項

apropos(1), more(1), whereis(1), catman(8), whatis(1)

バグ

マニュアルは、 レーザビームプリンタまたはタイプライタのどちらででも 出力できるようになっています。 しかし、 タイプライタの場合、 いくつかの情報が失われます。
man コマンドでも、 eqn(1) や tbl(1) が一緒に実行されるべきです。

NEWS-OSRelease 3.3