名前 | 形式 | 機能説明 | オプション | オペランド | 使用法 | マニュアルページのフォーマット | 環境 | 終了ステータス | ファイル | 属性 | 関連項目 | 注意事項 | 使用上の留意点
man コマンドはマニュアルページから得た情報を表示します。具体的には、name 引数が示すタイトルを持つマニュアルページの全内容を出力します。また -k オプションまたは -f オプションが指定された場合には、それぞれ keyword または filename が示すキーワードやファイル名により選択された 1 行からなる要約情報を 出力します。指定条件に一致するマニュアルページが見つからない場合には、man はエラーメッセージを出力します。
参照用マニュアルページには、nroff (nroff(1) を参照) または SGML (Standard Generalized Markup Language) (sgml(5) を参照) のどちらかのタグがマークアップされています。man コマンドはそのマークアップの種類を認識して、適宜にファイルを処理します。マークアップの種類によって分けられたディレクトリに、個々のソースファイルが置かれています。
オンラインの参照用マニュアルページのディレクトリは、通常 /usr/share/man ディレクトリにあります。nroff のソースは、/usr/share/man/man* ディレクトリにあります。また、SGML のソースは、/usr/share/man/sman* ディレクトリにあります。各ディレクトリはマニュアルのセクションごとに対応しています。これらのディレクトリは必須ではないため、ホスト上にインストール されているとは限りません。存在していなければ、他のホストから /usr/share/man をマウントしてください。
プレフォーマットされた最新バージョンが cat* または fmt* ディレクトリ中にあれば、man は単にそれを表示または印刷します。バージョンが古かったり存在しない場合には、man は再フォーマット処理を行なってから出力し、cat* または fmt* が書き込み可の場合にプレフォーマットされたバージョンを 格納します。windex データベースは変更されません (catman(1M) を参照)。プレフォーマットされたバージョン用のディレクトリが提供されていない場合、man は要求に応じてページを再フォーマットし、表示処理中、フォーマットされたテキストは一時ファイルに収納されます。
標準出力が端末ではない場合、または `-' フラグが指定された場合には、man は cat(1) を通じてテキストを出力します。その他の場合、man はページごとの出力や下線付けを画面上で行うために more(1) を通じて出力します。
以下にオプションを示します。
MANPATH 検索パス中で name に一致したすべてのマニュアルページを出力します。複数個あるときは、見つかった順序で出力します。
デバッグモード。セクションを示す引数に対応する値、検索に用いた方法、および man が検索を行なったパスを表示します。
指定された file のいずれかに関連するマニュアルページを探しだします。各 file から先頭のパス名部分を取り除き、そのベース名または 名前を含む 1 行の要約情報を出力します。本オプションも windex データべースを使用します。
windex 照合データべースを使う代わりに、MANPATH で指定した全ディレクトリまたは man.cf ファイルを使って検索を行うよう man に指示します。このオプションは、データべースの内容が最新状態にない場合に便利な指定で、man コマンドのデフォルトの動作に戻ります。そのため、通常はこのオプションを起動する必要はありません。参考のためにここに記述しています。
windex データべース (目次) を参照し、指定された keyword を含んでいるものを選び、その概要情報を出力します。windex データべースは catman(1M) コマンドを使って生成します。
検索パス内にある、name に一致するマニュアルページをすべて一覧表示します。
マニュアルページ用に別の検索パスを指定します。path には、マニュアルページのディレクトリ・サブツリーを含んだディレクトリの 名前をコロンで区切って記述します。たとえば path の値として /usr/share/man:/usr/local/man と指定すると、man は最初に標準のディレクトリである /usr/share/man を検索し、次に /usr/local/man を検索して name を探します。なお -M 本オプションを -k または -f と同時に指定する場合、-M の方を始めに記述しなければなりません。path 中の各ディレクトリ中には、各セクションにつき 1 つの man* または sman* という名のサブディレクトリが存在しているとみなされます。本オプションで指定した値は、MANPATH 環境変数の値より優先されます。
マニュアルページを再フォーマットするだけで、結果の表示は行いません。本指定は man -t name 指定と同等です。
検索を行うセクションを指定します。section 引数に対応するディレクトリだけを検索して name を探します。section の値は 1 桁の数字で、検索対象のマニュアルページのセクション名を伴う場合もあります (たとえば、“3libucb”)。または、1 つの語の場合もあります (たとえば local、new、old、public)。また、section は 1 文字の場合もあります。複数のセクションを指定するにはコンマで区切って記述します。本オプションで指定した値は、MANPATH 環境変数や man.cf ファイルの値より優先されます。man がマニュアルページを検索する方法に関しては、後述の「検索パス」の項を参照してください。
指定したマニュアルページが、適当なラスタ出力デバイス用に troff されるようにします ( troff(1) を参照)。- と -t の両オプションがともに指定された場合、man は指定された各 name の troff バージョンを (必要であれば) 更新しますが、結果の出力は行いません。
マニュアルページをフォーマットする際、デフォルトである /usr/share/lib/tmac/an に定義されている -man マクロの代わりに、macro-package が示すパッケージを使用します。デフォルトの検索パスの順序に関しては、後述の「使用法」の「検索パス」の項を参照してください。
マニュアルページはセクションという単位に分類されています。各セクションの名前は、主セクション名 (通常は 1 桁の数字) と、サブセクション名 (通常は 1 つ以上の文字) からなります (サブセクション名の指定は任意です)。主セクション名 (例: 9) を、そのセクションのサブセクション名 (例: 9e、9f、9s など) の省略名として使用することはできません。サブセクションを検索する場合は、man -s で個別に指定する必要があります。各セクションに属するマニュアルページ群は、共通のカテゴリに属しており、その中でさらに細かく分類するためにサブセクションがあります。本リリースにおける分類に関しては、intro のマニュアルページを参照してください。
指定されたある name を検索する前に、man はまず候補となりうるディレクトリとセクションのリストを構築します。man は環境変数 MANPATH が示すディレクトリ群の中で name を探します。この環境変数が設定されていなければ、デフォルトとして /usr/share/man を検索します。
マニュアルページのディレクトリ内において、man は以下に示すセクションだけを以下の順序で検索します。
コマンド行上で -s オプションにより指定されたセクション群
MANPATH 環境変数に埋め込まれているセクション群
MANPATH 環境変数が示す各ディレクトリの man.cf ファイル中に指定されているセクション群
上記の指定がいずれも存在しない場合には、man はマニュアルページ・パス中の各ディレクトリを検索し、最初に見つかったマニュアルページだけを表示します。
MANSECTS=section[,section] . . .
文字 `#' で始まる行および空行は、注釈とみなし無視します。MANPATH が示す各ディレクトリには、そのディレクトリの検索順序の デフォルト値を定義するマニュアルページ・コンフィギュレーション ファイルを含めることができます。
マニュアルページは nroff(1) または sgml(5) でマークアップされています。nroff のマニュアルページは、-man マクロパッケージにより用意されている nroff(1) または troff(1) によって処理されます。マクロ使用の詳細については man(5) を参照してください。SGML タグがついたマニュアルページは、SGML パーサーによって処理され、フォーマッタに引き渡されます。
nroff のマニュアルページをフォーマットする際、man は先頭行を参照して特殊な処理が必要かどうかを確かめます。先頭行が
' \" X
という形式 (X と " の間は 1 つの空白文字) で、X が以下に示す文字の組合せの場合、man は入力テキストを対応するプリプロセッサを介して troff(1) または nroff(1) に送ります。
eqn および neqn は、呼び出されると自動的に /usr/pub/eqnchar ファイル(eqnchar(5) を参照) を読み込みます。nroff(1) が呼び出されると col(1) が自動的に使用されます。
nroff のマニュアルページの先頭行が、次のパターンで他のマニュアルページを参照している場合、man はその参照されているマニュアルページの方を処理します。
.so man*/ sourcefile
この参照記述は、マニュアルページのディレクトリのサブツリーのルートに対して相対的なパス名で指定してください。
第 2 行目以降の行が .so で始まっていると man はそれを無視し、troff(1) および nroff(1) は通常の方法でリクエストを処理します。
マニュアルページはファイル中に <!DOCTYPE という文字列が存在することによって、SGML であると特定されます。ファイルに SHADOW_PAGE という文字列が含まれている場合、そのファイルは別のマニュアルページの内容を参照します。参照はテキストが含まれているマニュアルページに対する ファイル実体の参照です。これは nroff フォーマットのマニュアルページで使用される .so のメカニズムに類似しています。
man の実行に影響を与える環境変数 LC_CTYPE 、LC_MESSAGES 、NLSPATH についての詳細は、environ(5) を参照してください。
各々をコロンで区切ったディレクトリ名のリストを表します。各ディレクトリ名の後に、各々をコンマで区切ったセクションのリストを 付加することもできます。この環境変数が設定されていると、その値は /usr/share/man (ディレクトリ検索パスのデフォルト) および man.cf (セクション検索パスのデフォルト) よりも優先して用いられます。さらにこの環境変数の値よりも -M および -s オプションの値 (指定されていれば) が優先されます。
man の出力を対話モードで画面に送るプログラム名を表します。設定されていないと、プログラムとして `more -s' が使用されます。more(1) を参照してください。
troff で処理されたマニュアルページを表示するプログラム名を表します。
-t オプションが指定された場合に使用するフォーマッタ名を表します。設定されていないと、フォーマッタとして troff(1) が使用されます。
標準マニュアルページのディレクトリ・サブツリーのルート
フォーマットされていない nroff のマニュアルのエントリ
フォーマットされていない SGML のマニュアルのエントリ
nroff 処理後のマニュアルのエントリ
troff 処理後のマニュアルのエントリ
目次とキーワードのデータべース
標準 –man マクロパッケージ
SGML ドキュメント型定義ファイル
SGML のスタイルシートと実体ファイルの定義ディレクトリ
eqn と neqn の標準定義
セクションの検索順序のデフォルト
次の属性については attributes(5) のマニュアルページを参照してください。
属性タイプ | 属性値 |
使用条件 | SUNWdoc |
CSI | 対応済み |
apropos(1), cat(1), col(1), eqn(1), more(1), nroff(1), refer(1), tbl(1), troff(1), vgrind(1), whatis(1), catman(1M), attributes(5), environ(5), eqnchar(5), man(5), sgml(5)
-f と -k の両オプションは、catman(1M) が生成する windex データべースを使用します。man コマンドは CSI 対応が可能です。ただし、man コマンドによって呼び出されるいくつかのユーティリティ (troff 、eqn 、neqn 、refer 、tbl 、vgrind) は、CSI 対応が実証されていません。このため、-t オプションをつけた man コマンドは、EUC 以外のデータを扱えません。また、eqn 、neqn 、refer 、tbl 、vgrind を通した特殊処理が必要な マニュアルページを表示する man コマンド使用は、CSI 対応ができません。
マニュアルページは本来 ASCII 端末や写真植字機上で再出力可能な形式でなければなりません。しかし端末上では、フォントの変更など一部の情報が失われてしまいます。
一部のダム端末では、e 前処理フラグ (eqn(1) を参照) により生成される縦方向の動作を処理できません。このような端末で出力エラーを防ぐには、e フラグを指定するときに t も同時に指定して、暗黙的に col(1) を呼び出してください。ただしこの回避処置をとると、スーパースクリプト (上付き文字) とサブスクリプト (下付き文字) の出力が、たとえ端末がその出力機能を持っていても 不可能になってしまうという欠点があります。端末が eqn(1) の出力により正常に動作しなくなってしまったら、Control-q を使って端末をクリアしてください。
名前 | 形式 | 機能説明 | オプション | オペランド | 使用法 | マニュアルページのフォーマット | 環境 | 終了ステータス | ファイル | 属性 | 関連項目 | 注意事項 | 使用上の留意点