Linux マニュアル参照コマンド man の構文とオプション解説

コマンドの概要

man は Unix 系オペレーティングシステムにおいて、システムマニュアルページを表示するための標準的なユーティリティです。このコマンドを利用することで、シェル命令、システムコール、設定ファイル、プログラミングインターフェースなどのドキュメントを整形された形式で閲覧できます。出力結果はページャ(通常は less)を通じて表示されるため、スクロールやテキスト検索などの操作が可能です。

基本構文

man [オプション] [ページ名]

ページ名には、確認したいコマンド名や関数名を指定します。セクション番号を事前に指定することで、特定の分類に属するマニュアルを直接呼び出すことも可能です。

主要オプション

man コマンドでは、検索動作や表示形式を制御するための多数のオプションが用意されています。主に利用されるものは以下の通りです。

検索と表示制御

  • -a: 名前が一致するすべてのマニュアルページを連続して表示します。デフォルトでは最初に見つかったページのみが表示されます。
  • -k: apropos コマンドと同様に、whatis デベースに対してキーワード検索を行い、関連するページの一覧を出力します。
  • -f: whatis コマンドと同様に、指定されたキーワードで始まるページ名の簡易説明を表示します。
  • -K: 全てのマニュアルページ内で指定された文字列を検索します。広範囲を捜索するため処理に時間がかかる場合があります。

パスとファイル情報

  • -w: マニュアルページの実際のファイルパスを出力し、内容の表示は行いません。複数該当する場合はすべてのパスリストを表示します。
  • -M パス: マニュアルページを検索するディレクトリパスを指定します。環境変数 MANPATH を上書きする効果があります。
  • -C 設定ファイル: 使用する設定ファイルのパスを指定します。デフォルトは man.config または man_db.conf です。

フォーマットとビューア

  • -P プログラム: マニュアルページを表示するために使用するページャプログラムを指定します。デフォルトは less です。
  • -t: マニュアルページを troff 形式で整形し、ポストスクリプト出力などを生成するために使用されます。
  • -H ブラウザ: HTML 形式のマニュアルを指定されたブラウザで表示します。

実行例

特定のコマンドに対応するマニュアルファイルの保存場所を確認するには、-w オプションを使用します。

$ man -w grep
/usr/share/man/man1/grep.1.gz

複数のバージョンやセクションにまたがるページが存在する場合、-a と -w を組み合わせることで全てのパスリストを取得できます。

$ man -aw printf
/usr/share/man/man1/printf.1.gz
/usr/share/man/man3/printf.3.gz

システム全体のマニュアル検索パスを確認するには、ページ名を指定せずに -w を実行します。

$ man -w
/usr/local/share/man:/usr/share/man

キーワードを含む関連コマンドを曖昧検索するには、-k オプションが有効です。例えば「network」に関連するコマンドを探す場合などは以下のように実行します。

$ man -k network

これらのオプションを適切に組み合わせることで、必要な技術文書を効率的に参照することが可能になります。

タグ: linux man-pages cli-tools system-administration unix-command

8月8日 01:57 投稿