UNIX および Linux ディストリビューションでは、コマンド ライン プログラムにはマニュアル ページまたはマニュアル ページと呼ばれる独自のドキュメントが付属しています。
man ページは、通常、対応するプログラムの開発者によって作成されます。通常、man ページはいくつかのセクションに分かれています。
以下は、利用可能なすべての man セクションのリストです。各セクションには固有の番号があり、特定の種類のマニュアル ページのみが含まれています。たとえば、man セクション番号 3 には、ライブラリ呼び出しの man ページのみが含まれています。
- 1 – 実行可能なプログラムまたはコマンド
- 2 – システム コール (カーネルが提供する関数)
- 3 – ライブラリ呼び出し (ライブラリが提供する関数)
- 4 – 特殊ファイル
- 5 – ファイル形式と規則 (構成ファイル)
- 6 – ゲーム
- 7 – その他
- 8 – システム管理コマンド
構文:
man <TOPICNAME>
1. UNIX コマンドのマニュアル ページを表示
UNIX コマンドの man ページを読むには、コマンド名を引数として man に渡します。以下は、passwd コマンドの man ページを表示します。
$ man passwd
PASSWD(1) User Commands PASSWD(1)
NAME
passwd - change user password
... 一部のトピックでは、複数のセクションにマニュアル ページが含まれている場合もあります。このような場合、man コマンドは、セクション番号が小さいページを表示します。
この例では、passwd コマンドのマニュアル ページが複数のセクションに分かれています。ただし、デフォルトでは、セクション 1 のマニュアル ページが表示されます。
man コマンド出力の 1 行目に示されている「PASSWD(1)」は、セクション 1 の man ページが表示されていることを示しています。man ページ出力には、コマンド名、コマンドの構文、コマンドの動作の説明、コマンドが提供するオプションなど…
2.特定のセクションからマニュアル ページを表示
特定のセクションから man ページを読むには、次のようにセクション番号を指定します。 passwd コマンドには、セクション 1 とセクション 5 の両方に man ページがあります。デフォルトでは、セクション番号を指定しない場合、セクション 1 から man ページが表示されます。
セクション 5 から man ページを表示するには、以下に示すようにセクション番号を指定します。
$ man 5 passwd
セクション番号 5 はファイル形式と変換に関するものであるため、/etc/passwd 構成ファイルのマニュアル ページが表示されます。
3.コマンドで使用可能な man セクションの一覧表示
-aw オプションを使用して、特定のトピックに関する利用可能なすべてのセクションを一覧表示することもできます。
$ man -aw printf /usr/share/man/man1/printf.1.gz /usr/share/man/man3/printf.3.gz
上記の出力から、2 つの printf マニュアルがあり、1 つは「コマンド」セクションに、もう 1 つは「ライブラリ呼び出し」セクションにあることがわかります。したがって、次の man コマンドを実行して両方の man ページを表示できます。
$ man printf $ man 3 printf
4.コマンドのすべてのマニュアル ページを表示 – すべてのセクションを表示
特定のトピックのマニュアル ページをすべて表示するには、「-a」オプションを使用します。番号が最も小さい man ページが最初に表示されます。そのページを終了して「Enter」を押すと、次の man ページが表示されます。
$ man -a printf
上記のコマンドは、最初に printf(1) コマンドの man ページを表示します。 「q」を押して「Enter」を押すと、printf(3) ライブラリ関数の man ページが表示されます。
5.ブラウザで HTML 形式のマニュアル ページを表示
「-H」引数を使用して任意のブラウザを使用して HTML 形式のマニュアル ページを表示することもできます。これにより、Firefox の printf コマンドの man ページが HTML ページとして開きます。
$ export BROWSER=/usr/bin/firefox $ man -H printf
6. Man Command が使用するデフォルトのポケットベルを変更する
デフォルトでは、man コマンドは $PAGER 環境変数を使用して、出力の表示に使用するページャーを識別します。ユーザーは、「-P」オプションを使用して、man ページを表示するページャーを変更できます。
次のコマンドは、more コマンド ページャーを使用してマニュアル ページを表示します。
$ man -P more printf
7. NAME セクションに対して man ページを検索
man ページを NAME セクションで検索するには、以下に示すように「-f」オプションを使用します。
$ man -f printf printf (3) - formatted output conversion printf (1) - format and print data
これは、whatis シェル コマンドを使用するのと同じです。
上記のコマンドは、マニュアル ページ名を検索し、マニュアル ページ名が指定されたトピックと一致する場合、指定されたトピックの説明を表示します。同じコマンド ラインで複数のトピックを渡すこともできます。
8. MAN ページを NAME および DESCRIPTION セクションで検索
NAME &DESCRIPTION セクションに対して man ページを検索するには、「-k」オプションを使用します。 「apropos」シェル コマンドを使用するのと同じです。
$ man -k printf asprintf (3) - print to allocated string dprintf (3) - print to a file descriptor fprintf (3) - formatted output conversion fwprintf (3) - formatted wide-character output conversion printf (1) - format and print data printf (3) - formatted output conversion snprintf (3) - formatted output conversion sprintf (3) - formatted output conversion ... ...
上記のコマンドは、キーワード「printf」を正規表現として検索し、キーワードに一致するすべてのマニュアル ページを表示します。