manコマンド
manualsの略です。ヘルプを表示します。
ヘルプはコマンドに限らず、設定ファイルやプログラムの関数(fopenなど)も表示可能です。
よく利用するコマンドの一つです。
使い方
man セクション番号 コマンド名などセクション番号は省略可能です。
その場合、一番最初に見つかったセクション番号が指定されたとみなされます。
例:
man ls
man 7 man
終了したい時は「q」キーを押します。
manのヘルプを表示する
「h」キーを押します。見出し
便宜上、以下の項目が標準で用意されていますが、標準にない見出しが表示されることもありますし、
標準の見出しのいくつかは表示されないこともあります。
NAME
ヘルプのタイトルが表示されます。SYNOPSIS
使い方やオプションの一覧が表示されます。CONFIGURATION
設定ファイルの説明が表示されます。DESCRIPTION
概要や説明が表示されます。OPTIONS
オプションの詳細説明が表示されます。EXIT STATUS
コマンドなどが終了した時の戻り値とその戻り値の意味です。RETURN VALUE
戻り値の情報が表示されます。主に関数のヘルプで表示されます。
ERRORS
エラー処理に関する情報が表示されます。主に関数のヘルプで表示されます。
ENVIRONMENT
コマンドなどが利用する環境変数の一覧と説明です。FILES
コマンドなどが利用するファイル(主に設定ファイル)の一覧と説明です。VERSIONS
バージョン情報が表示されます。CONFORMING TO
準拠情報です。主に関数のヘルプで表示されます。
NOTES
参考情報や注意事項が表示されます。BUGS
バグ情報が表示されます。EXAMPLE
コマンドの使用例が表示されます。AUTHORS
開発者や関係者、連絡先が表示されます。SEE ALSO
関連項目が表示されます。例えばnologin(5)と表示されていたら、
以下のmanコマンドで関連項目のヘルプが表示できます。
man 5 nologin
セクション番号
ヘルプの内容は、セクション番号により分けられています。カテゴリだと思えば良いです。
現在表示しているmanのセクション番号は、右上と左上に表示されています。
man lsの場合、LS(1)と書かれていますが、括弧内の数字がセクション番号です。
1.Executable programs or shell commands
実行可能なプログラムやコマンドのヘルプ
2.System calls (functions provided by the kernel)
カーネルが提供している関数のヘルプ
3.Library calls (functions within program libraries)
ライブラリが提供している関数のヘルプ
4.Special files (usually found in /dev)
デバイスファイルに関するのヘルプ
5.File formats and conventions eg /etc/passwd
設定ファイルのヘルプ
6.Games
ゲームアプリのヘルプ
7.Miscellaneous (including macro packages and conventions), e.g. man(7),groff(7)
その他
8.System administration commands (usually only for root)
システム管理者向けのコマンドのヘルプ(大抵はルートユーザー向けのコマンド)
9.Kernel routines [Non standard]
標準ではないカーネルの関数のヘルプ
上記の中でよく利用するのは、1,5,8です。
凡例
主にSYNOPSISで使われる凡例です。太字(bold text)
太字で表示される文字は、表示通りに入力します。アンダーバー付きの文字(italic text)
適切な任意の引数を指定します。[-abc]
[ ]内の文字(引数やオプション)は省略可能です。[-abc]は、-abcオプションを指定しても良いし省略してもよい、ということです。
-a|-b
何れかのオプションを指定できますが、併用できません。-a|-bは、-aオプションか-bオプションを指定できますが、
-a -bオプションを一緒に指定することはできません、
argument ...
引数やオプション(argument)を複数指定(...)できます。例えば、argument [, ...]と書かれていたら、
,(カンマ)で区切って複数の引数やオプションを指定できます。
また[ ]でくくられているので、1つ以上の引数やオプションを指定できます。
もし[argument , ...]だったら、0以上の引数やオプションを,(カンマ)で区切って指定できます。
[expression] ...
[ ]全体を複数指定(...)できます。また、上記で書いたように[ ]は省略可能ですから、省略することもできます。
凡例の例
「man ls」と入力してls manualのSYNOPSISを凡例に当てはめてみます。SYNOPSIS
ls [OPTION]... [FILE]...
ls
太字なので、そのとおりに入力します。
[OPTION]...
アンダーバーが引かれているので、引数やオプションを指定します。[ ]でくくられているので、オプションは省略可能です。
...がついているので、オプションを複数指定できます。
[FILE]...
アンダーバーが引かれているので、引数やオプションを指定します。
[ ]でくくられているので、オプションは省略可能です。
...がついているので、オプションを複数指定できます。
OPTIONやFILEに指定する内容や説明は、
DESCRIPTIONやOPTIONSに書かれています。