manコマンドの使い方:コマンドのマニュアルを表示する
manは、コマンドのマニュアルを表示するコマンドです。オプションの意味や使い方を忘れたとき、インターネットで検索しなくても、その環境に入っているバージョンに合った正確な説明を確認できます。
manの仕組みと基本の考え方
manは「manual」の略です。Linuxのコマンドや設定ファイルの多くは、インストールと同時にマニュアルも配置されており、manはそれを探し出して、読みやすい形に整えて表示します。インターネットの記事と違い、手元の環境に入っているバージョンそのものの説明である点が、大きな利点です。
マニュアルは、内容の種類ごとにセクションに分かれています。1が一般のコマンド、5が設定ファイルの書式、8がシステム管理用のコマンドです。ls(1)やcrontab(5)のように、名前の後ろの括弧の数字が、セクション番号を表します。
マニュアルの構成は、ほぼ共通です。NAME(名前と1行の説明)、SYNOPSIS(書式)、DESCRIPTION(詳しい説明とオプション)、EXAMPLES(使用例)、SEE ALSO(関連する項目)の順に並びます。書式の[ ]は省略できる部分、...は繰り返し指定できる部分を表します。
manのよく使う形
実務や学習で登場しやすい使い方を、そのまま入力できる形でまとめました。
| コマンド例 | 内容 |
|---|---|
man ls | lsコマンドのマニュアルを表示する |
man -k copy | 説明文に「copy」を含むコマンドを検索する |
man 5 passwd | セクション5(ファイルの書式)のpasswdを表示する |
man -f ls | コマンドの1行の説明を表示する |
ls --help | コマンド自身が持つ、簡易的な説明を表示する |
help cd | シェルに組み込まれたコマンドの説明を表示する |
manの主なオプション
| オプション | 意味 |
|---|---|
-k | キーワード検索(apropos相当) |
数字 | セクション番号を指定して同名コマンドを区別 |
manの実行例と結果の読み方
man ls を実行した結果です。表示の意味は、画面の下の「出力の読み方」で項目ごとに説明しています。
$ man ls
LS(1) User Commands LS(1)
NAME
ls - list directory contents
SYNOPSIS
ls [OPTION]... [FILE]...
DESCRIPTION
List information about the FILEs (the current directory by default).
Sort entries alphabetically if none of -cftuvSUX nor --sort is speci‐
fied.
…
Manual page ls(1) line 1 (press h for help or q to quit)
出力の読み方
| 表示・項目 | 意味 |
|---|---|
LS(1) | コマンド名と、マニュアルのセクション番号。1 は一般コマンド、5 は設定ファイル、8 は管理者用コマンド |
NAME | コマンドの名前と、1行の説明 |
SYNOPSIS | 書式。[ ] は省略できる部分、... は繰り返せる部分 |
DESCRIPTION | 詳しい説明と、オプションの一覧 |
/文字列・q | less と同じ操作で、検索・終了できる |
練習用ターミナルでは、manをブラウザ上で安全に試せます。
manの実務での使いどころ
オプションの意味を、その場で確認する
man tar
/-zマニュアルを開いてから、/でオプション名を検索します。長いマニュアルでも、目的の説明にすぐたどり着けます。
設定ファイルの書き方を調べる
man 5 crontab
man 5 fstab設定ファイルの書式は、セクション5にまとめられています。crontabのように、コマンドとファイルの両方に同じ名前がある場合は、番号の指定が必要です。
manを組み合わせて使う実践例
やりたいことから、コマンドを探す
man -k compress
man -k 'disk usage'コマンド名が思い出せないときは、目的を表す英単語で検索します。結果には、名前・セクション番号・1行の説明が表示されます。
コマンドの正体を確かめてから、調べる
type cd
help cd
type ls
man lstypeで、組み込みコマンドか、外部のコマンドかを確認します。種類によって、調べ方をhelpとmanで使い分けます。
似たコマンドとの違い・使い分け
--helpは、コマンド自身が表示する簡易的な説明で、オプションの一覧をすばやく確認したいときに向いています。manは、より詳しい説明と背景まで書かれた正式な文書です。まず--helpで確認し、足りなければmanを開く、という順が効率的です。
実際の出力を並べると、違いがつかみやすくなります。
・whatis
コマンド名から一行の簡潔な説明を表示する。
$ whatis ls
ls (1) - list directory contents
・help
シェルに組み込まれたコマンドの使い方を表示する。
$ help cd | head -n 3
cd: cd [-L|[-P [-e]] [-@]] [dir]
Change the shell working directory.
manを使うときの注意点
マニュアルの表示には、lessが使われます。Spaceで次のページ、bで前のページ、/語で検索、qで終了です。
cdやaliasのような、シェルに組み込まれたコマンドには、個別のマニュアルがないことがあります。その場合は、help コマンド名で説明を確認します。
manでよくある失敗と対処
最初から最後まで読もうとして、時間がかかった
マニュアルは、辞書のように必要な箇所だけを引くものです。/での検索と、末尾のEXAMPLES(使用例)の確認から始めましょう。
シェルの組み込みコマンドをmanで調べて、見つからなかった
type コマンド名で種類を確認し、shell builtinと表示された場合はhelp コマンド名を使います。
manで困ったときの症状別チェック
実際の現場で出会いやすい症状を、原因の見当と確認方法とあわせて、逆引きできる形にまとめました。
| 症状 | 考えられる原因 | 確認・対処 |
|---|---|---|
No manual entry for ...と表示される | マニュアルが入っていない、または組み込みコマンド | コマンド名 --helpやhelp コマンド名を試します。 |
man: command not foundと表示される | 最小構成の環境やコンテナで、manが入っていない | --helpで確認するか、パッケージ(man-db)を導入します。 |
man -kで、何も見つからない | 検索用の索引が、作成されていない | sudo mandbを実行して、索引を作成します。 |
| 想定と違う内容が表示される | 同じ名前の項目が、別のセクションにある | man -f 名前でセクションを確認し、番号を指定して開きます。 |
manを手を動かして試す
マニュアルを開いて、検索・移動・終了の操作を試します。続いて、1行の説明の表示、キーワード検索、セクションの指定、--helpとの違いを確認しましょう。
man ls
(/sort で検索し、n で次へ移動する)
(G で末尾へ移動し、q で終了する)
man -f ls
man -k copy | head
man 5 passwd
ls --help | head -n 20
安全に練習したいときは、練習用ターミナルでも同じ操作を試せます。
manを使う練習課題
ブラウザで動く練習用ターミナルに、manを実際に打って進める課題があります。リンクを開くと、その課題がすぐに始まります。
- コマンドの使い方をmanで調べる(初級)
manに関するよくある質問
マニュアルの画面を終了するには?
qキーを押します。
マニュアルの中を検索するには?
/に続けて語を入力し、Enterを押します。nで次の一致、Nで前の一致へ移動できます。
コマンド名が分からないときは、どう探しますか?
man -k キーワードを使うと、説明文にキーワードを含むコマンドを一覧表示できます。apropos キーワードも同じ働きをします。
man 5 passwdの数字は何ですか?
マニュアルのセクション番号です。同じ名前でも、コマンドの説明(セクション1)と、設定ファイルの書式(セクション5)のように、別の内容がある場合に、番号で区別します。
マニュアルを日本語で表示できますか?
日本語のマニュアルのパッケージ(Debian系ではmanpages-jaなど)を導入すると、日本語で表示されるものがあります。ただし、内容が古い場合があるため、正確さが必要なときは英語版も確認しましょう。
manのまとめ
manは、手元の環境に合った正確な説明を確認できる手段です。/での検索と、qでの終了を覚えておきましょう。
関連ページ
あわせて覚えたいコマンド:less・which・grep・alias
manが登場する章:初級 第1章
コマンドをまとめて自動化したいときは、Linuxシェルスクリプト入門も参考にしてください。