man コマンド

目的

マニュアルの項目をオンラインで表示します。

構文

man [ [ [ -c ] [ -t ] [ section ] ] | [ -k | -f ] ] [ -F ] [ -m ] [ -Mpath ] [ -r ] [ -a ] title ...

説明

man コマンドは、コマンド、サブルーチン、ファイルなどのトピックに関する情報を提供します。man コマンドは、名前で指定したコマンドの説明を 1 行で表示します。また、man コマンドは、説明にユーザー指定キーワードのセットを含むすべてのコマンドの情報も表示します。

man コマンドは、指定されたマニュアル・ページ・セットをフォーマットします。section パラメーターでセクションを指定すると、man コマンドは、マニュアル・ページのそのセクション内で、title パラメーターで指定されたタイトルを検索します。section パラメーターの値は、1 から 8 までのアラビア数字か、1 文字です。

セクションの文字は、次のとおりです。

項目 説明
C コマンド (システム管理コマンドを含む) を指定します。
F ファイル・タイプのマニュアル・ページを指定します。
L ライブラリー関数を指定します。
n 新規を指定します。
l ローカルを指定します。
o 旧を指定します。
p 共用を指定します。
注: n、 l、o、および p セクション指定子は、 オペレーティング・システム文書の入ったハイパーテキスト情報ベースを読み取る場合は有効ではありません。

セクションの数字は次のとおりです。

項目 説明
1 ユーザー・コマンドとデーモンを示します。
2 システム・コールとカーネル・サービスを示します。
3 サブルーチンを示します。
4 スペシャル・ファイル、デバイス・ドライバー、ハードウェアを示します。
5 構成ファイルを示します。
6 ゲームを示します。
7 その他のコマンドを示します。
8 管理コマンドおよびデーモンを示します。
注: ハイパーテキスト情報データベースに含まれるオペレーティング・システム文書は、 コマンド・マニュアル・ページ (セクション 1。セクション C に相当)、サブルーチン・マニュアル・ページ (セクション 3。セクション L に相当)、 およびファイル・マニュアル・ページ (セクション 4。セクション F に相当) の 3 つのセクションに区分されています。ハイパーテキスト情報の検索時に、セクション 1、6、7、または 8 を指定すると、コマンド・マニュアル・ページ、 セクション 2 または 3 を指定すると、サブルーチン・マニュアル・ページ、 セクション 4 または 5 を指定すると、ファイル・マニュアル・ページのデフォルトが取られます。

section パラメーターが指定されないと、man コマンドはマニュアルのすべてのセクションを検索します。

man コマンドで使用する検索パスは、マニュアル・サブディレクトリーが入っている各ディレクトリーを : (コロン) で区切ったリストです。

man コマンドは、マニュアル・ページを次のように表示します。

  1. man コマンドは、 /usr/share/man ディレクトリーの下の nroff ディレクトリー (man?) を検索します。
  2. man コマンドは、 /usr/share/man ディレクトリーの下のフォーマット済みバージョン・ディレクトリー (cat?) を検索します。フォーマット済みバージョンが使用可能であり、 その変更時間が nroff コマンド・ソースよりも新しい場合、 man コマンドはフォーマット済みバージョンを表示します。 それ以外の場合、マニュアル・ページは nroff コマンドによってフォーマットされ、表示されます。 ユーザーが許可を持っていれば、以後 man コマンドを呼び出すときにページを再びフォーマットしなくてもすむように、 フォーマット済みのマニュアル・ページが適切な場所に置かれます。
    注: 提供されたマニュアル・ページの nroff ソースはありません。しかし、マニュアル・ページの nroff ソースを man ディレクトリーに入れると、man コマンドで nroff ソースを探し出し、処理できます。
  3. man コマンドが /usr/share/man/man ディレクトリーまたは /usr/share/man/cat ディレクトリーでマニュアル・ページを検出しない場合、man コマンドは、-M オプションまたは MANPATH 環境変数を介して指定されたパスを検索して、nroff ディレクトリー (man?) およびフォーマット済みバージョン・ディレクトリー (cat?) を調べます。
  4. man コマンドが /usr/share/man/man ディレクトリーまたは /usr/share/man/cat ディレクトリーあるいはユーザー指定の man/cat ディレクトリーでマニュアル・ページを検出しない場合、man コマンドはハイパーテキスト情報ベースから読み取ります。ハイパーテキスト情報ベースは、/usr/share/man/info ディレクトリー構造にあり、オペレーティング・システム文書が入っています。 ハイパーテキスト・データベースから読み取る場合、man コマンドは、/usr/share/man/cat ディレクトリー構造にマニュアル・ページを入れません。 man コマンドは、ディスプレイにフィットするように、HTML ファイルを定形式テキスト・ファイルに変換し、PAGER 環境変数で記述されているコマンドを使用してマニュアル・ページを表示します。
  5. man コマンドは、/usr/share/man/info ディレクトリー構造にあるハイパーテキスト情報ベースでマニュアル・ページが見つからない場合、(-M または MANPATH を通じて) ユーザー指定のハイパーテキスト情報ベースを検索します。ユーザー定義のハイパーテキスト情報ベースは、次のディレクトリー構造に従う必要があります。 
    BasePath[/%{ L | l }]/DocLibraryname/Section/command_or_routine_or_filename.htm
    ここで、
    • %L は、LC_MESSAGES を使用して指定された ISO 言語表記を表し、 %l は、LC_MESSAGES を使用して指定された ISO 言語表記の最初の 2 文字を表します。 例えば、LC_MESSAGES=en_US である場合、 ドキュメントは Path/en_US または Path/en に入れることができます。
    • DocLibraryname は文書ライブラリーの名前を表します。
    • Section はセクション名を表し、次のいずれかでなければなりません。
      • cmds — コマンド・セクションを表す
      • libs — ライブラリー・セクションを表す
      • files — ファイル・セクションを表す
    注: -m オプションが指定された場合は、 マニュアル・ページの検索は、-M または MANPATH 環境変数を使用して指定されたパスの順序でのみ行われます。

HTML データベースにアクセスする場合、 man は他の LPP ライブラリーに進む前に、オペレーティング・システム・ライブラリーを探します。 これらのライブラリーの中では、次の順序で情報が処理されます。

項目 説明
cmds コマンド・リファレンス
libs サブルーチン、システム・コール
files ファイル・リファレンス

標準出力が tty である場合、man コマンドは、 -s および -v フラグを指定した more コマンドを使用して、 その出力をパイピングします。 -s フラグにより、複数のブランク行は削除され、ページごとに画面上で停止します。-v フラグにより、非印刷文字の画面への表示が抑制されます。スクロールを続けるには、スペース・バーを押します。 出力が停止したときさらに 11 行スクロールするには、Ctrl-D キー・シーケンスを押します。

PAGER 環境変数は、任意のページ編集に設定できます。 デフォルト値は more コマンドです。 デフォルトのページ編集を変更するには、次のように入力します。 

PAGER=Somepager
export PAGER

例えば、逆改行または部分改行を使用してフォーマットされたカスタマイズ・マニュアル・ページがある場合に、 PAGER 環境変数を /usr/bin/pg に設定して、 改行が制御文字として出力されないようにすることができます。 この手順は、マニュアル・ページには必要ありません。

man コマンドがハイパーテキスト・データベースを使用すると、複数の項目を取り出すことがあります。例えば、「man open」と入力すると、複数の項目が表示されます。 SIGINT (Ctrl-C) を使用すると、man コマンドが完全に終了します。一方、「man open close」と入力した場合も複数の項目が表示されますが、SIGINT (Ctrl-C) を使用すると、man は終了しないで close コマンド情報が表示されます。再度 SIGINT (Ctrl-C) を使用すると、man コマンドを完全に終了させることができます。

名前に $ (ドル記号) が入っているネットワーク・コンピューティング・システムのライブラリー・ルーチンを 1 つ指定するには、 $ の前に ¥ (円記号) を入力します。

フラグ

項目 説明
-a 一致するエントリーをすべて表示します。
-c cat コマンドを使用してマニュアル情報を表示します。
-f 最後のパラメーターとして指定されたコマンド名にのみ関連するキーワード・データベース内のエントリーを表示します。複数のコマンド名をそれぞれスペースで区切って入力できます。このフラグは、コマンド項目の検索にのみ使用します。-f フラグを使用するには、root ユーザーは前もって 「catman -w」を入力して、/usr/share/man/whatis ファイルを作成しておかなければなりません。
-F 一致する最初のエントリーのみを表示します。
-k 最後のパラメーターとして指定されたタイトルと一致する文字列が入っているキーワード・データベース内の各行を表示します。複数のタイトルをそれぞれスペースで区切って入力できます。-k フラグを使用するには、root ユーザーは前もって 「catman -w」を入力して、/usr/share/man/whatis ファイルを作成しておかなければなりません。
-m MANPATH または -M で指定されたパスの中のみを検索します。
-Mpath man コマンドがマニュアル情報を検索する標準ロケーションを変更します。 パスは、コロンで区切られたパスのリストで、以下の特殊シンボルが使用できます。
  • %D –
  • マニュアル・ページ用のデフォルトの AIX® パス。
  • %L – 現行ロケールの LC_MESSAGES カテゴリーに対応するロケール固有のディレクトリー・ロケーション。
  • %l - 現行ロケールの LC_MESSAGES カテゴリーの最初の 2 文字に対応するロケール固有のディレクトリー・ロケーション。
-r マニュアル情報をリモートに検索します。 何らかの理由によってリモート検索が失敗すると、man は、要求されたマニュアル・ページを見つけるためにローカル検索を実行します。 下記に示す条件は、いずれもリモート検索が失敗する原因になる場合があります。
  • リモート・マシンに到達できない。
  • URL の読み取りに問題がある。
  • Java™ アプレットがインストールされていないか、または PATH 環境変数で指定されたユーザーの検索パスに発見できない。
注: 使用する文書検索サーバー・マシンの名前に DOCUMENT_SERVER_MACHINE_NAME 環境変数を設定してください。ホストのロケールに対して AIX ベースの文書がサポートされていない場合、man コマンドは代替ロケールの文書を検索します。 検索が正常に終了すると、ローカル・ホストのロケールに変換された後、文書ページが表示されます。 ローカル・ホストに代替ロケールがインストールされていない場合、 man コマンドは、文書ページの表示に失敗します。
-t troff コマンドを使用してマニュアル情報をフォーマットします。このフラグは、マニュアル・ページがハイパーテキスト情報ベースにある場合は無視されます。

終了状況

このコマンドは次の終了値を戻します。

項目 説明
0 正常終了。
>0 エラーが発生しました。

例

  1. grep コマンドに関する情報を表示するには、次のコマンドを入力します。
    
man grep
  2. rpc_$register ライブラリー・ルーチンに関する情報を表示するには、次のコマンドを入力します。
    man rpc_¥$register
  3. /usr/share/man/whatis キーワード・データベース内で、文字列「mkdir」を含むエントリーをすべて表示するには、次のコマンドを入力します。
    
man -k mkdir
    この出力は、apropos コマンドと同じです。-k フラグからの出力は、/usr/share/man/whatis キーワード・データベースが存在している場合にのみ表示されます。
  4. キーワード・データベースから nroff および troff コマンドに関連するエントリーをすべて表示するには、次のコマンドを入力します。
    man -f nroff troff
    この出力は、whatis コマンドと同じです。-f フラグからの出力は、/usr/share/man/whatis キーワード・データベースが存在している場合にのみ表示されます。
  5. /usr/share/man または/usr/share/man/local パス内で、ftp コマンドに関連するエントリーをすべて表示するには、次のコマンドを入力します。
    man -M/usr/share/man:/usr/share/man/local ftp
  6. 一致するエントリーをすべて表示するには、次のコマンドを入力します。
    man –a title
  7. 一致する最初のエントリーのみを表示するには、次のコマンドを入力します。
    man –F title
  8. MANPATH または –M で指定されたパスの中のみを検索するには、次のコマンドを入力します。 
    man -m –M PATH title
  9. ユーザー定義のパスの中で検索するには、次のコマンドを入力します。
    man –M PATH title

ファイル

項目 説明
/usr/bin/man man コマンドが入っています。
/usr/share/man 標準のマニュアル・ディレクトリー構造
/usr/share/man/cat?/* 事前フォーマット済みのページが入ったディレクトリー
/usr/share/man/whatis キーワード・データベースが入っています。
/usr/share/man/man?/* nroff フォーマットのマニュアル・ページが入ったディレクトリー