名称

man − マニュアルを表示したり、キーワードによるマニュアルの検索を行う

形式

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

解説

man は、リファレンスマニュアルから情報を引き出すプログラムです。 指定方法により、マニュアルの全文または概要を表示します。

−k keyword ... 
マニュアルの概要に、指定したキーワードを１つでも含むものを探し、 そのタイトルと概要を出力します。

−f file ... 
指定したファイル名、 すなわち、そのコマンド名あるいはライブラリ関数名のマニュアルを探し、 そのタイトルと概要を出力します。

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

−t オプションが指定された場合は、 フォーマッタとして ditroff(1) を使用します。

標準出力が端末でない、または − フラグが指定された場合には、 man は more(1) を通さず cat(1) を使用します。 それ以外の場合は、 環境変数 MANPAGER または環境変数 PAGER で指定された画面表示プログラムを使用します。 これらの環境変数がない場合は、 “more −si ” が使用されますので、 出力が停止した時に、 継続するにはスペースを、 画面の半分をスクロールするには control-D を入力します。

通常 man は、 マニュアル情報について環境変数 LANG で設定される多国語マニュアルの位置 (例えば /usr/man/ja_JP.SJIS)と 標準的な位置 (/usr/man/C) を検索します。 /usr/man/C のディレクトリがない場合は /usr/man を検索します。 LANG が、‘ja_JP.SJIS’ または ‘ja_JP.EUC’ で、 該当する漢字コードのディレクトリがない場合のみ、別の漢字コードの ディレクトリを検索します。 このとき man は、Shift JIS から 日本語 EUC、またはその逆のコード変換を行います。 /usr/man/ja_JP.SJIS は Shift JIS の日本語マニュアル、 /usr/man/ja_JP.EUC は EUC の日本語マニュアル、 /usr/man/C は英語マニュアルです。 −a オプションによって /usr/man/C のみを検索することができます。

マニュアルを検索する位置は、 MANPATH が設定されている場合には、 その値がデフォルトパスとして用いられます。 これは、 −M フラグで検索パスリストを与えることにより、 変更することができます。 検索パスリストは、 多国語のマニュアルの入っているサブディレクトリ (C、ja_JP.SJIS、ja_JP.EUC など) が存在するディレクトリを コロン(:)で区切って並べたものです。 例えば、検索パスリストを “/usr/local:/usr/man” と指定すると、 LANG が ja_JP.SJIS のときは、 /usr/local/ja_JP.SJIS、 /usr/local/C、 /usr/man/ja_JP.SJIS と、 /usr/man/C を検索します。 ただし、‘∗/ja_JP.SJIS’ がない場合は ‘∗/ja_JP.EUC’ を 検索し漢字コードの変換をします。 ‘∗/C’ がない場合は /usr/local と /usr/man を検索します。 このとき漢字コードの変換はしません。 検索パスを −k オプションまたは −f オプションとともに与えるときは、 最初に指定しなければなりません。

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

man は、nroff でのフォーマットのためと、日本語の漢字コードの 変換のために ‘/tmp’ に一時ファイルを作成します。 −T フラグで一時ファイルを作るディレクトリを指定できます。

ソースファイルの形式

man は、ソースファイルの最初の行に ’\" string があると nroff(1) または ditroff(1) での処理の前にフィルタを通します。

stringfilter
ppic
ttbl
eeqn

−t オプションがない場合は tbl(1) の処理のみを実行します。
 

関連ファイル

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

関連事項

apropos(1), whatis(1), more(1), nroff(1), ditroff(1), whereis(1), catman(8) eqn(1), tbl(1), pic(1), mkmaneuc(8), setlocale(3)

バグ

マニュアルは、 レーザビームプリンタまたはタイプライタのどちらででも 出力できるようになっています。 しかし、 タイプライタの場合、 いくつかの情報が失われます。

pic(1) や eqn(1) で処理されるコマンドは、 −t オプションがない場合、そのまま出力されます。

環境変数 MANPAGER または PAGER で指定するコマンドは、標準入力だけでなく、 引数を入力ファイルとして受け付けるものでなければなりません。 したがって、“cat −s | more” のようにパイプを含むものであっても いけません。また、環境変数 PAGER は、他のコマンドでも使用されることがあるので、 man 特有の指定、たとえば “less −s” などの使用には 注意が必要です。

インストール時は、/usr/man/ja_JP.SJIS しかありません。 /usr/man/ja_JP.EUC の作成は mkmaneuc(8) を使ってください。

/usr/man/ja_JP.SJIS と /usr/man/ja_JP.EUC の両方の ディレクトリがある場合は、両方に全てのマニュアルを入れてください。

NEWS-OSRelease 4.1C