ユーザーコマンド                                           man(1)

【名前】
     man - マニュアルページの表示

【形式】
     man [-] [-adFlrt] [-M path] [-T macro-package]  [-s section]
     name ...

     man [-M path] -k keyword ...

     man [-M path] -f file ...

【機能説明】
     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) を通じて出力します。


【オプション】
     以下にオプションを示します。

     -a              MANPATH 検索パス中で  name に一致したすべ て
                     のマニュアルページを出力します。複数個あると
                     きは、見つかった順序で出力します。



     -d              デバッグモード。セクションを示す引数に対応す
                     る 値、検索に用いた方法、および man が検索を
                     行なったパスを表示します。



     -f file...      指定された file のいずれかに関連するマニュア
                     ルページを探しだします。各 file から先頭のパ
                     ス名部分を取り除き、そのベース名または名前を
                     含 む 1 行の要約情報を出力します。本オプショ
                     ンも windex データべースを使用します。



     -F              windex 照合データべースを使う代わりに、 MAN-
                     PATH  で 指定した全ディレクトリまたは man.cf
                     ファイルを使って検索を行うよう man に指示 し
                     ます。このオプションは、データべースの内容が
                     最新状態にない場合に便利な指定で、man コマン
                     ドのデフォルトの動作に戻ります。そのため、通
                     常はこのオプションを起動する必要はあり ま せ
                     ん。参考のためにここに記述しています。



     -k keyword ...  windex データべース (目次) を参照し、指定 さ
                     れ た keyword を含んでいるものを選び、その概
                     要情報を出力します。windex データ べー ス は
                     catman(1M) コマンドを使って生成します。



     -l              検索パス内にある、name に一致するマニュア ル
                     ページをすべて一覧表示します。



     -M path         マニュアルページ用に別の検索パスを指定 し ま
                     す。 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 環境変数
                     の値より優先されます。



     -r              マニュアルページを再フォーマットするだけで、
                     結果の表示は行いません。本指定は man -t name
                     指定と同等です。



     -s section ...  検索を行うセクションを指定します。section 引
                     数 に対応するディレクトリだけを検索して name
                     を探します。section の値は 1 桁の数字で、 検
                     索対象のマニュアルページのセクション名を伴う
                     場合もあります (たとえば、"3libucb")。 ま た
                     は、 1  つ の 語 の 場合もあります (たとえば
                     local、new、old、public)。また、section は 1
                     文字の場合もあります。複数のセクションを指定
                     するにはコンマで区切って記述します。本 オ プ
                     ショ ン で 指 定した値は、MANPATH 環境変数や
                     man.cf ファイルの値より優先されます。man  が
                     マニュアルページを検索する方法に関しては、後
                     述の「検索パス」の項を参照してください。



     -t              指定したマニュアルページが、適当なラスタ出力
                     デ バ イ ス 用 に  troff  されるようにします
                     (troff(1) を参照)。- と -t の両オプション が
                     と も に 指 定された場合、man は指定された各
                     name の troff バージョンを (必要であれば) 更
                     新しますが、結果の出力は行いません。



     -T macro-packageマニュアルページをフォーマットする際、デフォ
                     ルトである /usr/share/lib/tmac/an に定義され
                     ている -man マクロの代わりに、 macro-package
                     が示すパッケージを使用します。デフォルトの検
                     索パスの順序に関しては、後述の「使用 法」 の
                     「検索パス」の項を参照してください。



【オペランド】
     以下のオペランドを指定できます。

     name            標準ユーティリティのキーワード、またはその名
                     前



【使用法】
  ［マニュアルページのセクション］
     マニュアルページはセクションという単位に分類されています。各
     セ クションの名前は、主セクション名 (通常は 1 桁の数字) と、
     サブセクション名 (通常は 1 つ以上の文字) からなります (サ ブ
     セクション名の指定は任意です)。主セクション名 (例: 9) を、そ
     のセクションのサブセクション名 (例: 9e、9f、9s など) の省 略
     名として使用することはできません。サブセクションを検索する場
     合は、man -s で個別に指定する必要があります。各セクション に
     属するマニュアルページ群は、共通のカテゴリに属しており、その
     中でさらに細かく分類するためにサブセクションがあります。本リ
     リースにおける分類に関しては、intro のマニュアルページを参照
     してください。

  ［検索パス］
     指定されたある name を検索する前に、man はまず候補となりうる
     ディレクトリとセクションのリストを構築します。man は環境変数
     MANPATH が示すディレクトリ群の中で name を探します。この環境
     変 数が設定されていなければ、デフォルトとして /usr/share/man
     を検索します。

     マニュアルページのディレクトリ内において、man は以下に示すセ
     クションだけを以下の順序で検索します。

       o  コマンド行上で -s オプションにより指定されたセクショ ン
          群

       o  MANPATH 環境変数に埋め込まれているセクション群

       o  MANPATH 環境変数が示す各ディレクトリの man.cf ファイ ル
          中に指定されているセクション群


     上記の指定がいずれも存在しない場合には、man はマニュアルペー
     ジ・パス中の各ディレクトリを検索し、最初に見つかったマニュア
     ルページだけを表示します。

     man.cf ファイルの形式は次のとおりです。

          MANSECTS=section[,section]...


     文字 `#' で始まる行および空行は、注釈とみなし無視 し ま す。
     MANPATH が示す各ディレクトリには、そのディレクトリの検索順序
     のデフォルト値を定義するマニュアルページ・コンフィ ギュ レー
     ションファイルを含めることができます。

【マニュアルページのフォーマット】
     マニュアルページは nroff(1) または sgml(5) でマークアップ さ
     れ ています。nroff のマニュアルページは、-man マクロパッケー
     ジにより用意されている nroff(1) または troff(1) によって処理
     されます。マクロ使用の詳細については man(5) を参照してくださ
     い。SGML タグがついたマニュアルページは、SGML パーサーによっ
     て処理され、フォーマッタに引き渡されます。

  ［nroff マニュアルページの前処理］
     nroff のマニュアルページをフォーマットする際、man は先頭行を
     参照して特殊な処理が必要かどうかを確かめます。先頭行が

                             '\" X



     という形式 (X と " の間は 1 つの空白文字) で、X が以下に示す
     文字の組合せの場合、man は入力テキストを対応するプリプロセッ
     サを介して troff(1) または nroff(1) に送ります。

     e        eqn(1) または、nroff の場合、neqn



     r        refer(1)



     t        tbl(1)



     v        vgrind(1)



     eqn および neqn は、呼び出されると自動的に  /usr/pub/eqnchar
     ファ イル(eqnchar(5) を参照) を読み込みます。nroff(1) が呼び
     出されると col(1) が自動的に使用されます。

  ［他の nroff マニュアルページへの参照］
     nroff のマニュアルページの先頭行が、次のパターンで他のマニュ
     アルページを参照している場合、man はその参照されているマニュ
     アルページの方を処理します。

          .so man*/ sourcefile

     この参照記述は、マニュアルページのディレクトリのサブツリーの
     ルートに対して相対的なパス名で指定してください。

     第 2 行目以降の行が .so で始まっていると man はそれ を 無 視
     し、 troff(1) および nroff(1) は通常の方法でリクエストを処理
     します。

  ［SGML マニュアルページの処理］
     マニュアルページはファイル中に <!DOCTYPE という文字列が存 在
     す る こ と に よって、SGML であると特定されます。ファイルに
     SHADOW_PAGE という文字列が含まれている場合、そのファイルは別
     のマニュアルページの内容を参照します。参照はテキストが含まれ
     ているマニュアルページに対するファイル実体の参照です。これは
     nroff  フォーマットのマニュアルページで使用される .so のメカ
     ニズムに類似しています。

【環境】
     man の実行に影響を与える環境変数 LC_CTYPE 、 LC_MESSAGES  、
     NLSPATH についての詳細は、environ(5) を参照してください。

     MANPATH         各々をコロンで区切ったディレクトリ名のリスト
                     を表します。各ディレクトリ名の後に、各々をコ
                     ンマで区切ったセクションのリストを付加するこ
                     と も できます。この環境変数が設定されている
                     と、その値は /usr/share/man (ディレクトリ 検
                     索 パスのデフォルト) および man.cf (セクショ
                     ン検索パスのデフォルト) よりも優先して用いら
                     れます。さらにこの環境変数の値よりも -M およ
                     び -s オプションの値 (指定されていれば) が優
                     先されます。



     PAGER           man の出力を対話モードで画面に送るプログラム
                     名を表します。設定されていないと、プログラム
                     として `more -s' が使用されます。more(1)  を
                     参照してください。



     TCAT            troff で処理されたマニュアルページを表示する
                     プログラム名を表します。



     TROFF           -t オプションが指定された場合 に 使 用 す る
                     フォー マッ タ名を表します。設定されていない
                     と、フォーマッタとして troff(1) が使用されま
                     す。


【使用例】
     例 1: PostScript バージョンのマニュアルページの作成

     以下の例では、pipe(2) のマニュアルページを PostScript で作成
     します。

     % setenv 'TROFF troff -Tpost'
     % setenv TCAT '/usr/lib/lp/postscript/dpost'
     % man -t -s 2 pipe > /tmp/output.ps

     これは、man -t でマニュアルページをデフォルトのプリンタに 出
     力 する代わりに、PostScript バージョンのマニュアルページを作
     成します。

     例 2: テキストバージョンのマニュアルページの作成

     以下の例では、pipe(2) のマニュアルページを ASCII テキスト で
     作成します。

     man pipe.2 | col -x -b  >  pipe.text

     これは、man -t でマニュアルページをデフォルトのプリンタに 出
     力する代わりに、テキストバージョンのマニュアルページを作成し
     ます。

【終了ステータス】
     以下の終了ステータスが返されます。

     0               入力ファイルはすべて、正常に出力された



     >0              エラーが発生した



【ファイル】
     /usr/share/man                          標準マニュアルページ
                                             のディレクトリ・サブ
                                             ツリーのルート



     /usr/share/man/man?/*                   フォーマットされてい
                                             な い   nroff   のマ
                                             ニュアルのエントリ



     /usr/share/man/sman?/*                  フォーマットされてい
                                             ない  SGML  のマニュ
                                             アルのエントリ



     /usr/share/man/cat?/*                   nroff 処理後のマニュ
                                             アルのエントリ



     /usr/share/man/fmt?/*                   troff 処理後のマニュ
                                             アルのエントリ



     /usr/share/man/windex                   目次とキーワー ド の
                                             データべース



     /usr/share/lib/tmac/an                  標準 -man マクロパッ
                                             ケージ



     /usr/share/lib/sgml/locale/C/dtd/*      SGML ドキュメント 型
                                             定義ファイル



     /usr/share/lib/sgml/locale/C/solbook/*  SGML のスタイル シー
                                             トと実体ファイルの定
                                             義ディレクトリ



     /usr/share/lib/pub/eqnchar              eqn と neqn の標準定
                                             義



     man.cf                                  セクションの検索順序
                                             のデフォルト



【属性】
     次の属性については 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> を使っ
     て端末をクリアしてください。