man
はコマンドやシステムコール、設定ファイルなどのマニュアル(manページ)を表示するコマンドです。
オプションや書式を素早く確認したいときに最も基本的な参照手段です。
実務では「正しいオプションの確認」「設定ファイルの書式確認」「関連コマンドの探索(-k
)」に頻用します。
構文(Syntax)
man [OPTION...] [SECTION] NAME...
SECTION
は 1(ユーザーコマンド)、2(システムコール)、3(ライブラリ関数)…などの区分を指定します。- 複数の
NAME
をスペース区切りで指定できます。
主なオプション一覧
オプション | 説明 | 使用例 |
---|---|---|
-s SECTION | 探索するセクションを指定 | man -s 5 crontab |
-S LIST | 検索順セクションをコロン区切りで指定(実装依存、例: man-db) | man -S 2:3 open |
-a | 一致する全てのページを順に表示 | man -a printf |
-k KEYWORD | キーワード検索(apropos 相当) | man -k ssh key |
-K STRING | すべてのmanページ本文を全文検索(遅い) | man -K "EnvironmentFile" |
-f NAME | 要約表示(whatis 相当) | man -f tar |
-w | 実際に表示されるmanファイルのパスを表示 | man -w bash |
-l FILE... | ローカルのファイル(*.1 など)をmanとして表示 | man -l ./mytool.1 |
-M PATH | 参照するmanパスを上書き(MANPATH 相当) | man -M /opt/mans open |
-P PAGER | 使用するページャを指定 | man -P "less -R" grep |
-E ENC | 入力エンコーディング指定(実装依存) | man -E UTF-8 locale |
-L LOCALE | 言語・ロケールを指定(実装依存) | man -L ja_JP.UTF-8 ls |
-H BROWSER | HTML出力をブラウザで開く(man-db) | man -H firefox printf |
--path | 検索パス(MANPATH)を表示 | man --path |
--help , --version | ヘルプ、バージョン表示 | man --help |
代表的なセクション例: 1(ユーザーコマンド), 2(システムコール), 3(ライブラリ関数), 4(デバイス/特別ファイル), 5(ファイル形式/設定), 7(概念/規約), 8(管理コマンド)
実行例
基本:コマンドのマニュアルを開く
説明: ls
の使い方を確認します(終了は q
)。
コマンド:
man ls
出力例(先頭抜粋):
LS(1) User Commands LS(1)
NAME
ls - list directory contents
...
セクションを指定して同名エントリを選ぶ
説明: open
はセクション 2(システムコール)と 3(ライブラリ)に存在します。
コマンド:
man 2 open # もしくは man -s 2 open
出力例(先頭抜粋):
OPEN(2) System Calls Manual OPEN(2)
NAME
open, openat, openat2 - open and possibly create a file
...
キーワード検索で関連コマンドを探す(apropos 相当)
説明: cron
に関連するmanページの要約を一覧します。
コマンド:
man -k cron | head
出力例(例):
crond (8) - daemon to execute scheduled commands (Vixie Cron)
crontab (1) - maintain crontab files for individual users
crontab (5) - tables for driving cron
...
すべての一致ページを順に読む
説明: 同名ページが複数あるとき、-a
で順に表示できます。
コマンド:
man -a printf
(q
で抜けると次の候補が表示されます)
エラー例:存在しないエントリ
説明: 存在しない名前を指定するとエラーになります。
コマンド:
man nosuchcmd
出力例:
No manual entry for nosuchcmd
関連コマンド
apropos
: キーワードから関連manページを検索(man -k
相当)。whatis
: 名前の要約(1行説明)を表示(man -f
相当)。info
: GNU系の詳細ドキュメント閲覧。man
より詳しいことがある。less
:man
の既定ページャ。検索(/pattern
)や移動が可能。tldr
: 非公式の簡略チートシート集(別途インストール)。
備考
- 実装差分: Linux では主に man-db、BSD・macOS では mandoc 系が使われます。オプション(特に
-K
,-H
,-S
など)は実装により有無や挙動が異なります。 - セクション順序: 既定の探索順はディストリや環境により異なります。
-s/-S
やMANSECT
で制御可能な実装があります。 - ページャと表示:
man
はMANPAGER
→PAGER
→ 既定(多くはless -isR
)の順でページャを選びます。カラー出力を維持したい場合は-P "less -R"
を指定。 - 検索パス:
MANPATH
で探索パスを上書き可能。追加パッケージのmanを読む場合は-M /path
が手早いです。 - フォーマッタ: 出力整形に
groff
を利用します。-Tutf8
や-Tpdf
(実装依存)で別デバイス出力が可能な場合があります。 - 最小環境: コンテナや最小インストールでは
man
やman-pages
が入っていないことがあります。必要ならman-db
/man-pages
のパッケージを導入してください。 - 権限: 閲覧のみのため
sudo
は不要です。
参考
- manページ(オンライン, man7.org):
- GNU
less(1)
:https://man7.org/linux/man-pages/man1/less.1.html
コメント