「コマンドのマニュアルを見る」ときに使うmanコマンドについて、manコマンドマニュアル(man man)を調べてまとめました。書式などは、マニュアルページの表記に準ずるように記載しています。
manコマンドの基本書式
manコマンドは、マニュアルを表示するコマンドです。書式は下のとおりです。
man [options] [[section] page …] …
※manページによる表記
※man [options] 'page ([section])'や man [options] [section] pageでも同じ意味となり、同じようにマニュアルを表示します。※筆者がmanマニュアルの[例]から引き出して表現を書式と合わせた表記です(下に実行例があるので参照ください)
意味は、『マニュアルページ(page)のマニュアルを、セクション番号[section]で検索し、[option]にしたがって表示する』となります。各項目は、
- man(太字):マニュアルを表示するコマンドです
- options(斜め文字・下線付き文字):オプションを指定します(省略可能)
- section:(斜め文字・下線付き文字)マニュアルのセクションを指定します(値:1〜9。省略可能)
- page:(引数)。(斜め文字・下線付き文字)マニュアルを表示させたいものの名称を指定(プログラムやユーティリティ、関数など)
となります。マニュアルページを閉じるときは[q]キーを押してください。ページ送りなどその他の操作方法は「画面の動かし方」の項で説明しています。
太字や下線、その他の表記の意味とルール
書式では、太字や下線などの表記が用いられていて、すべて統一された意味があるそうです。
- 太字:表示されているとおりに記述する文字(コマンドやオプションなど)
- イタリック(italic)体(斜め文字):適切な引数に置き換えて記述(引数など)
- [-xxx]:「[ ] 大括弧内」の引数はオプション
- -y | -z:「| 縦線」で区切られたオプションは同時指定不可
- argument:「argument(引数)」は繰り返し指定可能
- [expression]:「[]大括弧内」の「expression(表現)」全体は、繰り返し指定可能
Ubuntu24.04では、manを実行するとイタリック体(斜め文字)では表示されず下線で表記されます。当ページでは、イタリック体(斜め文字)に下線をつける形で表現しました。
section(セクション)
セクションとは分割された節のことで、マニュアルページmanでは9つのセクションに分けられています。
セクション番号とマニュアルページの種類
下は、man manを実行時に表示されたmanコマンドのマニュアルの冒頭の部分です。
MAN(1) マニュアルページユーティリティー MAN(1)
名前
man - an interface to the system reference manuals
書式
man [man options] [[section] page …] …
~~以下省略~~
man manで表示されたmanコマンドのマニュアルページの一部
MAN(1)と表示されている(1)の数字がセクション番号です。このように、マニュアルはセクションにより区分されています。
セクション番号は1〜9まであり、
- 「1」は、実行プログラムまたはシェルコマンドで
man、ps、systemctlなどが該当します。 - 「2」は、システムコール(カーネルが提供する関数)で
read、add_keyなどが該当します - 「3」は、ライブラリー呼び出し(プログラムライブラリーに含まれる関数)で
getnameinfo、rcmdなどが該当します。 - 「4」は、特別なファイルで
ptmx、smartpqiなどが該当します。(manマニュアル参照) - 「5」は、ファイル形式と規則で
clamd.conf、freshclam.conf、ipptoolfileなどが該当します。 - 「6」は、ゲームで
例として挙げられマニュアルを探し出せませんでした(調査中) - 「7」は、その他(マクロパッケージと規約を含む)で
UPower、systemd.index、man-pagesなどが該当します。 - 「8」は、システム管理コマンドで
apt-mark、gufw、poweroffなどが該当します。(manマニュアル参照) - 「9」は、カーネルルーチン[非標準]で
調査中です。
と、このようになっています。
セクションの処理のされ方
上記の書式でmanコマンドを実行したとき、sectionが指定されていればそのセクション番号のマニュアルが直接表示されます。
sectionを指定しなかった場合は、利用可能なすべてのセクションが検索され、見つかったセクションのうち最初のセクションのマニュアルだけが表示されるという仕組みになっています。(-aオプションを使うと同名の全てのマニュアルを表示することができます)
セクションの検索順序はあらかじめ決められています。検索順序のデフォルト値を変更することも可能ですがこのページでは説明していません。(manマニュアル内の「デフォルトの値と動作」の項目を参照してください)
opsion(オプション)
オプションをいくつか抽出して挙げました。その他のオプションや詳細を知りたい場合はman manやman -hなどを参照してください。
-k、--apropos:【実行例】
マニュアルページの名前と要約文を検索し、一致するものを表示します(aproposコマンドとほぼ同じ。man apropos参照)
-K、--global-apropos:
すべてのマニュアルページのテキストを検索します(長時間を要するため、注意事項が書かれています。man manで詳細を確認してください)
-f、--whatis:【実行例】
マニュアルページから短い説明を表示(whatisコマンドとほぼ同じ。man whatis参照)
-I、 --match-case:
マニュアルページ検索時、大文字と小文字を区別して検索する(このオプションを指定せずに検索すると、大文字と小文字は区別されません)
-a、 --all:【実行例】
検索条件に一致したすべてのマニュアルページを順に表示
-?、--help:
ヘルプメッセージが表示されて終了([q]キーを押さなくても終了します)
--usage:
短い使用方法のメッセージが表示されて終了([q]キーを押さなくても終了します)
-V、--version:
バージョン情報が表示されて終了([q]キーを押さなくても終了します)
コマンド実行例:
manコマンドの実行例を記載します。マニュアルページの操作方法は次項に記載しています。
lsコマンドのマニュアルページを表示する
man ls
セクション7のマクロパッケージman-pagesのマニュアルページを表示する
man 7 man-pages
man man-pages.7
man 'man-pages(7)'
man "man-pages(7)"
※section「7」を指定した例。上記4つはすべて同じ結果になります。「()括弧」は、シェルから保護するために引用符で囲む必要があります。
同名のすべてのマニュアルを表示する(セクションが異なる同名のマニュアルがあれば)例:chmod
man -a chmod
※実行すると、最初のマニュアルページが表示されます(section1のchmodマニュアル)
CHMOD(1) User Commands CHMOD(1)
NAME
chmod - change file mode bits
~~以下省略~~
[q]キーでマニュアルページを終了すると、下のように表示されます。
--Man-- 次は: apt(8) [ 閲覧 (return) | スキップ (Ctrl-D) | 終了 (Ctrl-C) ]
[Enter]キーを押せばsection2のchmodマニュアルが表示され、[Crtl]+[C]を押せば終了します。
chmod(2) System Calls Manual chmod(2)
NAME
chmod, fchmod, fchmodat - change permissions of a file
~~以下省略~~
すべてのセクションを表示を終えると、終了します。
キーワード「apt-」をマニュアルページ名と要約分の中から正規表現として検索する
man -k apt-
キーワード検索は、マニュアルページを表示しません。以下のように検索結果のみが出力されます。
ユーザーネーム@PCネーム:~$ man -k apt-
apt-cache (8) - APT キャッシュへの問い合わせ
apt-cdrom (8) - APT CD-ROM 管理ユーティリティ
apt-config (8) - APT 設定取得プログラム
apt-extracttemplates (1) - Debian パッケージから debconf の設定と...
~~以下省略~~
キーワード検索は、「ひらがな検索」もできました
ユーザーネーム@PCネーム:~$ man -k あ
manconv (1) - マニュアルページをあるエンコーディン...
run-parts (8) - ディレクトリにあるスクリプト・プログ...
~~以下省略~~
manのマニュアルページから短い説明(要約)を表示する
man -f man
実行すると、以下のように要約が出力されます。
ユーザーネーム@PCネーム:~$ man -f man
man (1) - an interface to the system reference manuals
該当するマニュアルが複数ある場合は、すべて出力されます。
ユーザーネーム@PCネーム:~$ man -f chmod
chmod (1) - change file mode bits
chmod (2) - change permissions of a file
画面の動かし方
manコマンドでマニュアルページを開いたとき、「いつも使い慣れているショートカットキーが使えない」ことがよくあります。
マニュアルページの最下行の部分に簡単な説明があり、「[h]キーを押すとhelp、[q]キーを押すと終了する」と書かれているので、[h]キーを押して操作方法を調べ、便利で使えそうな操作方法を抽出してまとめました。
~~略~~
Manual page man(1) line 684/717 (END) (press h for help or q to quit)
[h]キーを押すと「LESSコマンドの概要」のページが表示される
MOVING(移動)
矢印キーは使用できます。(上下左右)
1行進む::[e]キー([ctrl]+[e]キー・[ctrl]+[n]キー・[j]でも同じく1行進みます)
n行進む::半角数字で数値を指定してから[e]キー(例:5行進める場合は[5]を入力してから[e]キーです)
1行戻る::[y]キー([ctrl]+[y]キー・[k]キー・[ctrl]+[k]キー・[ctrl]+[p]でも同じく1行戻ります)
n行戻る::半角数字で数値を指定してから[y]キー(例:5行戻る場合は[5]を入力してから[y]キーです)
1画面進む::[f]キー([ctrl]+[f]キー・[ctrl]+[v]キー・[space]キーでも同じく1画面進みます)
1画面戻る::[b]キー([ctrl]+[b]キー[esc]キーを押してから[v]でも同じく1画面戻ります)
SEARCHING(検索)
検索::[/]キーを入力後、検索したい語句を入力して[enter]
検索のハイライトをクリアする::[esc]キーを押してから[U](大文字)を押す(通常は[shift]+[u]で大文字になります)
JUMPING(ジャンプ)
ページの始め(1行目)に移動:[g]キー([shift]+[<]キーでも同じように移動します)
ページの最後の行に移動:[G](大文字)を押す通常は[shift]+[g]で大文字になります)([shift]+[>]キーでも同じように移動します)
まとめ・参考資料
以上で、manコマンドの使用方法、マニュアルページの見方と操作方法の説明を終わります。詳細を知りたい場合は、以下のコマンドを実行してみてください
manマニュアル:man man
aporposマニュアル:man 1 apropos

