【復習】3.1.8.マニュアルの参照

Linuxでは、オンラインマニュアルページ（manページ）が標準で用意されており、manコマンドで表示できる。
マニュアルを構成するファイルは、/usr/share/man
manページの検索ディレクトリは、環境変数MANPATHが参照される。
MANPATHに何も指定されていない場合は、/etc/man.config（もしくは/etc/man.conf）ファイルに指定されたデフォルトのリストが使われる。manコマンドは環境変数PAGERで指定されたページャプログラム（通常はless）で表示を行うが、変更可能。

書式） man [オプション] [セクション] コマンド名／キーワード

・manコマンドの主なオプション
-a：すべてのセクションのマニュアルを表示する。
-f：指定されたキーワード（完全一致）を含むドキュメントを表示する。
-k：指定されたキーワード（部分一致）を含むドキュメントを表示する。
-w：マニュアルの置かれているディレクトリを表示する。

・manページの見出し
NAME（名前）：コマンドやファイルの名前と簡単な説明。
SYNOPSIS（書式）：書式（オプションや引数）
DESCRIPTION（説明）：詳細な説明。
OPTIONS（オプション）：指定できるオプションの説明。
FILES（ファイル）：設定ファイルなど関連するファイル。
ENVIRONMENT（環境変数）：関連する環境変数。
NOTES（注意）：その他の注意事項
BUGS（バグ）：既知の不具合
SEE ALSO（関連項目）：関連項目
AUTHOR（著者）：プログラムやドキュメントの著者

manのデフォルトのページャでlessが設定されている。lessコマンドは「テキストを1画面ずつ表示する」こと、moreコマンドの高機能版である。
・lessの主なキー操作
スペースキー、fキー：下方向に1画面スクロール
bキー：上方向に1画面スクロール
qキー：終了
/検索文字列：下方向に検索
?検索文字列：上方向に検索

☆/etc/passwdファイルについて調べたい場合、ドキュメントの内容による分類であるセクションを指定する。
・セクション
１：ユーザーコマンド
２：システムコール
３：ライブラリ
４：デバイスファイル
５：ファイルフォーマット
６：ゲーム
７：その他
８：システム管理コマンド
９：Linux独自のカーネル用ドキュメント

→　man 5 passwd　　＞＞　/etc/passwdのファイルのフォーマットに関するマニュアルが表示される。

PASSWD(5) PASSWD(5)

名前
passwd - パスワードファイル

説明
passwd ファイルには各ユーザアカウントの様々な情報が記録されている。書か
れているのは次の通り。
（以下略）

☆ -fオプションで、指定した検索キーワードと完全にマッチした一覧が表示される。
whatisコマンドと同じ。
・man -f
・whatis

crontabをキーワードとして、すべてのマニュアルを検索する。

ubuntu@ubuntu-vm:~$ man -f crontab
crontab (1) - maintain crontab files for individual users (V3)
crontab (5) - tables for driving cron
ubuntu@ubuntu-vm:~$
ubuntu@ubuntu-vm:~$ whatis crontab
crontab (1) - maintain crontab files for individual users (V3)
crontab (5) - tables for driving cron
ubuntu@ubuntu-vm:~$

☆コマンド名などの正確な名前が不明な場合、-kオプションを使う。
aproposコマンドと同じ。
指定されたキーワードが、マニュアルタイトルもしくはNAME欄に含まれるマニュアルの項目一覧を表示する。

ubuntu@ubuntu-vm:~$ man -k crontab
/etc/anacrontab (5) [anacrontab] - configuration file for anacron
anacrontab (5) - configuration file for anacron
crontab (1) - maintain crontab files for individual users (V3)
crontab (5) - tables for driving cron
ubuntu@ubuntu-vm:~$
ubuntu@ubuntu-vm:~$ apropos crontab
/etc/anacrontab (5) [anacrontab] - configuration file for anacron
anacrontab (5) - configuration file for anacron
crontab (1) - maintain crontab files for individual users (V3)
crontab (5) - tables for driving cron
ubuntu@ubuntu-vm:~$

これらは、whtaisデータベースを用意しておく必要があり、makewhatisコマンドで作成する。whatisコマンド、aproposコマンド、-k及び-fオプション付きのmanコマンドは、whatisデータベースを参照する。

※シェルの内部コマンドの説明を表示するには、helpコマンドを使う。

■感想：manコマンドは、マニュアルが表示されて便利で助かるが、ちゃんと読んで理解するのが大変な時がある。頑張って理解したい。