Provided by: manpages-ja_0.5.0.0.20110915-1_all bug

TROFF に特有な表現
     -mdoc パッケージは man ページを記述するプロセスを簡単にすることを 目的と
     しています。 -mdoc を使うために troff(1) のゴタゴタした詳細を学ぶ必要がな
     いのが理想ですが、 いくつか片付けるべき避けられない制限事項があります。
     また、このパッケージは高速で  ということも予め警告しておきます。

   マクロの使用方法
     troff(1) のように、マクロは ‘.’ (ドット文字) を行頭に置き、それに続けて 2
     文字からなるマクロの名称を指定することによって 呼び出されます。 引数はマ
     クロの後にスペースで区切って指定することができます。 行頭にドット文字を指
     定することによって troff(1) にそれに続く 2 文字をマクロ名として解釈するよ
     う指示しています。 マクロを起動せずに、ある文脈の行の先頭に ‘.’ (ドット文
     字) を置くためには、 ‘.’ (ドット) の前にエスケープシーケンス ‘\&’ を指定
     します。 ‘\&’ は文字通りスペース幅が 0 として解釈され、出力には現れませ
     ん。

     一般的に troff(1) マクロは引数を 9 つまで取ることができ、それ以上指定され
     た引数は無視されます。 -mdoc でのほとんどのマクロは 9 つの引数を取ること
     ができ、 限られた場合にのみ引数は次の行に続けて指定することができます (
      セクションを参照)。 いくつかのマクロは引用符に囲まれた引数を扱う
     ことができます (下の  セクションを参照)。

     -mdoc での一般テキスト領域とマニュアル領域のほとんどのマクロは特別であ
     り、 その引数のリストは呼び出し可能なマクロ名として  されます。 これ
     は一般テキスト領域またはマニュアル領域のマクロ名に一致し、 呼び出し可能で
     あると判断された引数リストの中の引数は、 実行されるか、それが処理される時
     に呼び出されることを意味しています。 この場合、引数はマクロ名にも関わら
     ず、 ‘.’ (ドット) で前置されません。 このようにしてたくさんのマクロを入れ
     子にすることができます。 例えばオプションマクロ ‘.Op’ はフラグマクロ ‘Fl’
     と引数マクロ ‘Ar’ を  、オプションのフラグを引数とともに指定す
     ることができます。

           [-s bytes]         は .Op Fl s Ar bytes によって生成される

     2 文字からなる文字列をマクロ名として解釈されないようにするには、 その文字
     列の前にエスケープシーケンス ‘\&’ を指定します。

           [Fl s Ar bytes]    は .Op \&Fl s \&Ar bytes によって生成される

     ここで文字列 ‘Fl’ と ‘Ar’ はマクロとして解釈されていません。 本ドキュメン
     トと関連のクイックリファレンスマニュアル mdoc(7) を通して、 引数リストが
     呼び出し可能な引数として解析されるマクロは「解析される」、 引数リストから
     呼び出されることができるマクロは「呼び出し可能」 と表現します。 -mdoc の
     ほとんどすべてのマクロは解析されるのですから、これは技術的には 
     ことですが、常にマクロを「呼び出し可能である」とか「他のマクロを 呼び出す
     ことができる」と表現するのは面倒なことであるため、 「解析される」という用
     語が使われています。

   引数に空白文字を指定する
     ひとつ以上の空白文字を含む文字列をひとつの引数として指定したい場合が よく
     あります。 これは 9 個を越える引数を指定できないという制限に対処したり、
     引数のリストにある特有な配置をおこなうことが必要なマクロに引数を指定する
     ような 場合に必要となることがあります。 たとえば、関数マクロ ‘.Fn’ では最
     初の引数は関数名であり、残りの引数が関数のパラメータであることが 必要で
     す。 ANSI C の括弧で囲まれたパラメータリストにおける関数のパラメータの宣
     言の規定に より、各パラメータは最低でも 2 語の文字列となります。 たとえば
     int foo のようになります。

     空白を含む引数を指定するには 2 通りの方法があります。 : 解
     析の前に個々の引数を再割り当てすることによって、 引用符の間に空白を含めて
     渡すのが最も便利な方法なのですが、 AT&T の troff のすべてのマクロを実装す
     るには処理速度およびメモリ使用量の点で かなり高価な方法となります。 groff
     では高価な処理にはなりませんが、移植性のため、この方法は 空白を含めること
     が最も必要である以下のマクロだけに限っています。

           Cd    コンフィギュレーション宣言 (セクション 4 の SYNOPSIS)
           Bl    リスト開始 (幅指定用)
           Em    テキスト強調
           Fn    関数 (セクション 2 と 4)
           It    リストの項目
           Li    リテラルテキスト
           Sy    シンボリックテキスト
           %B    書籍のタイトル
           %J    定期刊行物のタイトル
           %O    参照の追加的な注釈
           %R    報告書のタイトル (参照の中で)
           %T    書籍もしくは定期刊行物の中の記事のタイトル

     空白を含む文字列を渡すのに、固定空白、すなわち詰め込まれない空白文字 ‘\を
     使う方法があります。すなわち、空白の前にエスケープ文字’ ‘\’ を指定する方
     法です。 この方法はどのマクロでも使うことができますが、1 行を越える長さの
     テキストの 調整の邪魔になるという副作用があります。 troff では固定空白は
     他の印刷可能文字と同様に扱われ、通常期待されるように、 そこで文字列を空白
     や改行で分けることを行なわなくなります。 この方法は文字列が行の境界をまた
     がないであろう場合に有用です。 例えば、

           fetch(char *str)  は ‘.Fn fetch char\ *str’ によって生成される

           fetch(char *str)  は ‘.Fn fetch "char *str"’ でも生成される

     もし ‘\’ や引用符が省かれると、 ‘.Fn’ は引数を 3 つ取り、その結果は

           fetch(char, *str)

     となります。

     パラメータのリストが改行の境界をまたぐ場合に何がおこるかについては、 
     のセクションを参照してください。

   行末の空白文字
     troff は行末に空白文字があると混乱してしまうことがあります。 <空白><行
     末>の文字シーケンスからすべての空白文字を取り除くのは良い予防策です。 ど
     うしても行末に空白文字をおく必要性が出てきた場合は、 詰め込まれない空白と
     エスケープ文字 ‘\&’ を使用することによって対応できます。 例えば、
     ‘string\ \&’ のようにします。

   特殊文字のエスケープ
     改行 ‘\n’ のような特殊文字は ‘\’ を ‘\e’ で置き換える (すなわち ‘\en’ と
     する) ことによって、バックスラッシュを残して扱うことができます。

MAN ページの分析
     man ページの本文はファイル /usr/share/misc/mdoc.template の基本テンプレー
     トを使って容易に作り上げることができます。 /usr/share/examples/mdoc には
     いくつかのサンプルの man ページが収められています。

   マニュアルページのテンプレート
           .\" 以下の項目はすべての man ページで必要な項目です。
           .Dd 月 日, 年
           .Os オペレーティングシステム [バージョン/リリース]
           .Dt ドキュメントタイトル [セクション番号] [ボリューム]
           .Sh NAME
           .Nm 名称
           .Nd 名称の 1 行での説明
           .Sh SYNOPSIS
           .Sh DESCRIPTION
           .\" 以下の項目については、必要に応じてコメントをはずして使用してく
           .\" ださい。
           .\" .Sh IMPLEMENTATION NOTES
           .\" この次の項目はセクション 2, 3, 9 でのみ必要な、関数の
           .\" 戻り値です。
           .\" .Sh RETURN VALUE
           .\" 次の項目はセクション 1, 6, 7, 8, 9 でのみ必要なものです。
           .\" .Sh ENVIRONMENT
           .\" .Sh FILES
           .\" .Sh EXAMPLES
           .\" 次の項目はセクション 1, 6, 7, 8, 9 でのみ必要なものです。
           .\"     ((シェルへの)コマンドの戻り値と fprintf/stderr の型の診断
           .\"      です。)
           .\" .Sh DIAGNOSTICS
           .\" .Sh COMPATIBILITY
           .\" 次の項目はセクション 2, 3, 9 でのみ必要な、エラーハンドリングと
           .\" シグナルハンドリングです。
           .\" .Sh ERRORS
           .\" .Sh SEE ALSO
           .\" .Sh STANDARDS
           .\" .Sh HISTORY
           .\" .Sh AUTHORS
           .\" .Sh BUGS

     このテンプレートにおける最初の項目はマクロ (.Dd, .Os, .Dt) であり、それぞ
     れドキュメントの日付、 man ページもしくは題材となっているソースの開発や変
     更のベースとなった オペレーティングシステム、 () man ページタイト
     ルをそのページが属するマニュアルのセクション番号とともに 指定したもの、と
     なっています。 これらのマクロはそのページを識別するものであり、後述の 
      で議論されています。

     テンプレート中の残りの項目はセクションのヘッダ (.Sh) であり、それらのうち
     NAMESYNOPSISDESCRIPTION は必須項目です。 これらのヘッダについては
      を説明した後、  で議論されます。 いくつかの
     コンテントマクロはページレイアウトマクロの説明に 使われていますので、ペー
     ジレイアウトマクロの前にコンテントマクロについて 読むことを推奨します。

タイトルマクロ
     タイトルマクロはページ構造領域の最初の部分ですが、man ページを 前日に書き
     始めたいという人のために、最初に分けて記述されます。 3 つのヘッダマクロで
     ドキュメントか man ページのタイトル、 オペレーティングシステム、および原
     著の日付を指定します。 これらのマクロはドキュメントの最初に一度だけ呼び出
     されるもので、 ヘッダとフッタを構成するためだけに使用されます。

     .Dt ドキュメントタイトル セクション番号 [ボリューム]
             ドキュメントタイトルは man ページの主題であり、troff の制限により
             大文字 でなければいけません。 セクション番号は 1, ..., 9 とな
             り、これが指定されると ボリュームタイトルを省略してもかまいませ
             ん。

             FreeBSD では、次のセクション番号と解説について後述します:

                   1      FreeBSD General Commands Manual
                   2      FreeBSD System Calls Manaul
                   3      FreeBSD Library Calls Manual
                   4      FreeBSD Kernel Interfaces Manual
                   5      FreeBSD File Formats Manual
                   6      FreeBSD Games Manual
                   7      FreeBSD Miscellaneous Information Manual
                   8      FreeBSD System Manager's Manual
                   9      FreeBSD Kernel Developers Guide

             ボリュームタイトルは任意のものか、以下のうちいずれかになります。

                   AMD    UNIX Ancestral Manual Documents
                   SMM    UNIX System Manager's Manual
                   URM    UNIX Reference Manual
                   PRM    UNIX Programmer's Manual

             デフォルトのボリュームは セクション 1, 6, 7 では URM 、セクション
             8 では SMM 、セクション 2, 3, 4, 5 では PRM となっています。

     .Os オペレーティングシステム リリース番号
             オペレーティングシステムの名称には一般的な頭字語 (略称) を使わな
             ければなりません。 例えば、 BSD や FreeBSD や ATT といったもので
             す。 リリース番号は、例えば4.3, 4.3+Tahoe, V.3, V.4 というような
             各システム での標準のリリースの命名法を使用します。 認識されない
             引数はページのフッタ中に記述された通りに表示されます。 以下にフッ
             タの典型的な例を示します。

                   .Os 4.3BSD

             や
                   .Os FreeBSD 2.2

             ローカルで作られたセットの例。

                   .Os CS Department

             Berkeley でのデフォルトである、引数なしの ‘.Os’ はサイト固有の
             ファイル /usr/share/tmac/mdoc/doc-common において BSD として定義
             されています。 これは実際には LOCAL として定義すべきです。 ‘.Os’
             マクロがない場合は、ページの左下角はみにくくなるであろうことに 注
             意してください。

     .Dd 月 日, 年
             日付は次のようにフォーマルな形式で記述しなければなりません。

                   January 25, 1989

マニュアル領域および一般テキスト領域の紹介
   この名前には何が...?
     マニュアル領域のマクロ名はコマンドやサブルーチン、それに関連ファイルを 説
     明するために使われている日常のインフォーマルな言葉から取られています。 こ
     の言葉と少し違うバリエーションのものが man ページを書く上での 3 つの異
     なった面を記述するのに使われます。 最初のものは、 -mdoc マクロ使用方法の
     説明です。 2 番目のものは -mdoc マクロを用いた UNIX コマンドの記述です。
     3 番目はコマンドを通常の言葉の感覚でユーザに示したものです。 これはすなわ
     ち、man ページのテキスト中でのコマンドの議論となります。

     最初のケースでは、 troff(1) マクロはそれ自身、一種のコマンドとなっていま
     す。 troff コマンドは一般的に以下のような形式をとります。

           .Va argument1 argument2 ... argument9

     ‘.Va’ はマクロコマンドもしくは要求を示しており、それに続くものは すべて引
     数として処理されます。 2 番目のケースでは、コンテントマクロを使用する
     UNIX コマンドの記述がもう少し含まれます。 典型的な SYNOPSIS コマンド行は
     このように表示されます。

           filter [-flag] infile outfile

     ここで filter はコマンド名であり、角括弧で囲まれた文字列 -flag
     引数で、これは角括弧で囲むことによってオプションであることを示していま
     す。 -mdoc の用語では infileoutfile と称されています。 上の例
     のフォーマットを行なったマクロは以下のものです。

           .Nm filter
           .Op Fl flag
           .Ar infile outfile

     3 番目のケースでは、コマンドの説明や構文に上記の例の両方が使われ、 さらに
     細かい記述が追加されるでしょう。 上の例での引数 infileoutfile
      もしくは  として参照されます。 コマンド行の引数のリス
     トはかなり長くなる場合もあります。

           make  [-eiknqrstv] [-D variable] [-d flags] [-f makefile]
                 [-I directory] [-j max_jobs] [variable=value] [target ...]

     ここではコマンド make について記述しており、 makefile をフラグ -f の引数
     としています。 またオプションのファイルオペランド target についても議論し
     ています。 言葉での説明では、こういった詳細な記述が混乱を防いでくれます
     が、 -mdoc パッケージにはフラグ  引数のためのマクロがありません。 そ
     の代わりに target のようなオペランドやファイル引数に使われる引数マクロ
     ‘Ar’ が variable のようなフラグへの引数にも使われます。 この make コマン
     ド行は以下の指定により生成されています。

           .Nm make
           .Op Fl eiknqrstv
           .Op Fl D Ar variable
           .Op Fl d Ar flags
           .Op Fl f Ar makefile
           .Op Fl I Ar directory
           .Op Fl j Ar max_jobs
           .Op Ar variable=value
           .Bk -words
           .Op Ar target ...
           .Ek

     マクロ ‘.Bk’ と ‘.Ek’ は  セクションにおいて解説されています。

   一般的な構文
     マニュアル領域と一般テキスト領域のマクロはいくつかの小さな違い があるもの
     の、同様な構文を使用しています。 ‘.Ar’, ‘.Fl’, ‘.Nm’, ‘.Pa’ は引数なしで
     呼び出された時のみ異なります。 ‘.Fn’ と ‘.Xr’ は引数のリストの順番が異な
     ります。 マクロ ‘.Op’ と ‘.Fn’ には入れ子の制限があります。 すべてのコン
     テントマクロが句読点を認識し、正しく扱うには、 各々の句読点文字が先行する
     空白で分離されている必要があります。 以下のように指定されている場合、

           .Li sptr, ptr),

     その結果は以下のようになります。

           sptr, ptr),

     ここでは句読点は認識されずすべての出力はリテラルなフォントで行なわれて い
     ます。句読点が空白文字で区切られている場合、

           .Li sptr , ptr ) ,

     結果は以下のようになります。

           sptr, ptr),

     今度は句読点が認識され、出力はデフォルトのフォントで行なわれ リテラルフォ
     ントの文字列と区別されています。

     ‘\&’ でエスケープすることによって句読点文字の特別な意味を取り除くことがで
     きます。 troff はマクロ言語としての限界から、数学、論理学、もしくは以下の
     引用符の 集合のメンバを含んだ文字列を表現するのは困難です。

                 {+,-,/,*,%,<,>,<=,>=,=,==,&,`,',"}

     troff が文字によって示唆されている操作もしくは評価を実際に行なっているこ
     とが、 その問題の原因となっています。 ‘\&’ でこれらをエスケープすることに
     よって、これらの文字が予期せずに 評価されることを防止することができます。
     最初のコンテントマクロは、以下の ‘.Ad’ において、その典型的な構文が示され
     ています。

マニュアル領域
   アドレスマクロ
     アドレスマクロは addr1[,addr2[,addr3]] の形式からなるアドレスを識別しま
     す。

           使い方: .Ad address ...
                   .Ad addr1    addr1
                   .Ad addr1 .  addr1.
                   .Ad addr1 , file2
                                addr1, file2
                   .Ad f1 , f2 , f3 :
                                f1, f2, f3:
                   .Ad addr ) ) ,
                                addr)),

     ‘.Ad’ を引数なしで呼び出すのはエラーです。 ‘.Ad’ は他のマクロから呼び出し
     可能で解析されます。

   作者名
     ‘.An’ マクロは文書化されている項目の作者の名前、もしくは実際の マニュアル
     ページの作者の名前を指定するために使われます。 名前の情報の後のすべての引
     数は句読点として扱われます。

           使い方: .An author_name
                   .An Joe Author
                                  Joe Author
                   .An Joe Author ,
                                  Joe Author,
                   .An Joe Author Aq nobody@FreeBSD.ORG
                                  Joe Author ⟨nobody@FreeBSD.ORG⟩
                   .An Joe Author ) ) ,
                                  Joe Author)),

     ‘.An’ マクロは解析され、呼び出し可能です。 ‘.An’ を引数なしで呼び出すのは
     エラーです。

     AUTHORS セクションでは、 ‘.An’ 要求は改行を引き起こし、各新規の名前がそれ
     ぞれの行に表示されます。 この動作が望ましくない場合、

           .An -nosplit

     呼び出しで無効化可能です。 それぞれの行に表示させる動作に戻したい場合は、

           .An -split
     呼び出しを使用します。

   引数マクロ
     引数マクロ ‘.Ar’ はコマンド行の引数を参照する際に使用することができます。

           使い方: .Ar argument ...
                    .Ar          file ...
                    .Ar file1    file1
                    .Ar file1 .  file1.
                    .Ar file1 file2
                                 file1 file2
                    .Ar f1 f2 f3 :
                                 f1 f2 f3:
                    .Ar file ) ) ,
                                 file)),

     ‘.Ar’ が引数なしで呼び出されると、 ‘file ...’ として扱われます。 ‘.Ar’ マ
     クロは解析され、呼び出し可能です。

   コンフィギュレーション宣言 (セクション 4 のみ)
     ‘.Cd’ マクロはセクション 4 のマニュアルにおいて、デバイスインタフェースの
     config(8) による宣言の説明に使われます。 このマクロは引用符 (2 重引用符の
     み) で囲まれた引数を取ることができます。

           device le0 at scode?  は ‘.Cd device le0 at scode?’ によって生成さ
                                 れます。

   コマンド修飾子
     コマンド修飾子は ‘.Cm’ マクロがすべての引数の前にダッシュ文字を付けないこ
     とを除いて、 ‘.Fl’ (フラグ) コマンドと同じです。 伝統的にフラグはダッシュ
     文字に引き続いて指定されますが、 いくつかのコマンドやコマンドのサブセット
     はこの方法を使っていません。 コマンド修飾子はエディタコマンドのような対話
     的なコマンドでも 指定されることがあります。  のセクションを参照して
     ください。

   定義済みの変数
     インクルードファイルにおいて定義されている変数は ‘.Dv’ マクロによって指定
     します。

           使い方: .Dv defined_variable ...
                   .Dv MAXHOSTNAMELEN
                                   MAXHOSTNAMELEN
                   .Dv TIOCGPGRP )
                                   TIOCGPGRP)

     ‘.Dv’ を引数なしで呼び出すのはエラーです。 ‘.Dv’ は解析され、呼び出し可能
     です。

   errno (セクション 2 のみ)
     エラーマクロ ‘.Er’ はセクション 2 のライブラリルーチンにおけるエラーの戻
     り値を指定します。 下記の 2 番目の例では ‘.Er’ は一般テキスト領域マクロで
     ある ‘.Bq’ (これはセクション 2 のマニュアルページで使われています) と共に
     使われています。

           使い方: .Er ERRNOTYPE ...
                   .Er ENOENT
                              ENOENT
                   .Er ENOENT ) ;
                              ENOENT);
                   .Bq Er ENOTDIR
                              [ENOTDIR]

     ‘.Er’ を引数なしで呼び出すのはエラーです。 ‘.Er’ は解析され、呼び出し可能
     です。

   環境変数
     ‘.Ev’ マクロは環境変数を指定します。

           使い方: .Ev argument ...
                   .Ev DISPLAY
                               DISPLAY
                   .Ev PATH .  PATH.
                   .Ev PRINTER ) ) ,
                               PRINTER)),

     ‘.Ev’ を引数なしで呼び出すのはエラーです。 ‘.Ev’ は解析され、呼び出し可能
     です。

   関数の引数
     ‘.Fa’ マクロは関数の引数 (パラメータ) を マニュアルの SYNOPSIS のセクショ
     ン外、もしくは SYNOPSIS のセクション内で参照する場合に使われます。 パラ
     メータのリストが ‘.Fn’ マクロでは長すぎる場合は、 囲って使うマクロ ‘.Fo’
     と ‘.Fc’ を使わなければなりません。 ‘.Fa’ は構造体のメンバを参照する場合
     にも使われます。

           使い方: .Fa function_argument ...
                   .Fa d_namlen ) ) ,
                                   d_namlen)),
                   .Fa iov_len     iov_len

     ‘.Fa’ を引数なしで呼び出すのはエラーです。 ‘.Fa’ は解析され、呼び出し可能
     です。

   関数の宣言
     ‘.Fd’ マクロは SYNOPSIS セクションにおいて、セクション 2 または 3 の関数
     の説明で使われます。 ‘.Fd’ マクロから他のマクロを呼び出すことはなく、他の
     マクロから呼び出すことも できません。

           使い方: .Fd include_file (or defined variable)

     SYNOPSIS セクションにおいて、関数がすでに示されていて改行が入っていない場
     合、 ‘.Fd’ によって改行が挿入されます。 これによって前の関数呼び出しと次
     の関数の宣言の間に最適な行間が設定されます。

   フラグ
     ‘.Fl’ マクロはコマンド行のフラグを扱います。 フラグの前にはダッシュ ‘-’
     が挿入されます。 対話的なコマンドのフラグでは、ダッシュがフラグの前には挿
     入されませんが、 ‘.Cm’ (コマンド修飾子) マクロは、ダッシュを付けないこと
     を除き、同じ働きをします。

           使い方: .Fl argument ...
                   .Fl          -
                   .Fl cfv      -cfv
                   .Fl cfv .    -cfv.
                   .Fl s v t    -s -v -t
                   .Fl - ,      --,
                   .Fl xyz ) ,  -xyz),

     引数なしで ‘.Fl’ マクロを指定すると、標準入力/標準出力を意味するダッシュ
     となります。 ひとつのダッシュに ‘.Fl’ マクロを使用すると、2 つダッシュと
     なることに注意して下さい。 ‘.Fl’ マクロは解析され、呼び出し可能です。

   関数 (ライブラリルーチン)
     ‘.Fn’ マクロは ANSI C の記法を規範としています。

     使い方: .Fn [type] function [[type] parameters ... ]
     .Fn getchar                              getchar()
     .Fn strlen ) ,                           strlen()),
     .Fn "int align" "const * char *sptrs",   int align(const * char *sptrs),

     ‘.Fn’ を引数を指定せずに呼び出すのはエラーです。 ‘.Fn’ マクロは解析さ
     れ、呼び出し可能です。他のマクロの呼び出しは ‘.Fn’ の呼び出しの終了を意味
     することに注意して下さい (閉じ括弧がその点で挿入されます)。

     9 個以上のパラメータをとる関数 (これは滅多にないことですが) では、 ‘.Fo’
     マクロ (関数オープン) と ‘.Fc’ マクロ (関数クローズ) を ‘.Fa’ (関数引数)
     と共に使って、この制限を回避することができます。 以下にその例を示します。

           .Ft int
           .Fo res_mkquery
           .Fa "int op"
           .Fa "char *dname"
           .Fa "int class"
           .Fa "int type"
           .Fa "char *data"
           .Fa "int datalen"
           .Fa "struct rrec *newrr"
           .Fa "char *buf"
           .Fa "int buflen"
           .Fc

     これは以下のような結果になります。

           int    res_mkquery(int op,    char *dname,   int class,   int type,
           char *data, int datalen, struct rrec *newrr, char *buf, int buflen)

     ‘.Fo’ と ‘.Fc’ マクロは解析され、呼び出し可能です。 SYNOPSIS セクションで
     は、関数は常に行の先頭から開始されます。 SYNOPSIS セクションにおいて、複
     数の関数が示されており、関数の型が示されない場合、 改行が挿入され、現在の
     関数名とその前の関数名の間に最適な改行量が設定されます。 現在、 ‘.Fn’ は
     troff の行の長さに対して、語の境界をチェックしておらず、予期しない 場所で
     改行が挿入されてしまうことがあります。 これは近い将来修正されるでしょう。

   関数の型
     このマクロは SYNOPSIS セクションで使うものです。 man ページ中の他の場所で
     も問題なく使うことができますが、 セクション 2 と 3 の SYNOPSIS セクション
     でカーネルの通常の形式で関数の型を示すことがこのマクロの目的です (このマ
     クロは関数名が次の行に置かれるように改行を挿入します)。

           使い方: .Ft type ...
                   .Ft struct stat  struct stat

     ‘.Ft’ は他のマクロからは呼び出せません。

   対話的なコマンド
     ‘.Ic’ マクロは対話的なコマンド、もしくは内部コマンドを指定します。

           使い方: .Ic argument ...
                   .Ic :wq             :wq
                   .Ic do while {...}  do while {...}
                   .Ic setenv , unsetenv
                                       setenv, unsetenv

     ‘.Ic’ を引数なしで呼び出すのはエラーです。 ‘.Ic’ マクロは解析され、呼び出
     し可能です。

   ライブラリ名
     ‘.Lb’ マクロは、関数がどのライブラリに組み込まれるかを指定します。

           使い方: .Lb argument ...

     ‘.Lb’ マクロに対して使用可能な引数と結果は次の通りです:

           libc         Standard C Library (libc, -lc)
           libc_r       library “libc_r”
           libcalendar  library “libcalendar”
           libcam       library “libcam”
           libcompat    Compatibility Library (libcompat, -lcompat)
           libcrypt     Crypt Library (libcrypt, -lcrypt)
           libdevstat   library “libdevstat”
           libdisk      library “libdisk”
           libedit      Command Line Editor Library (libedit, -ledit)
           libfetch     library “libfetch”
           libipsec     IPsec Policy Control Library (libipsec, -lipsec)
           libipx       library “libipx”
           libkvm       Kernel Data Access Library (libkvm, -lkvm)
           libm         Math Library (libm, -lm)
           libmd        library “libmd”
           libnetgraph  library “libnetgraph”
           libposix1e   library “libposix1e”
           libskey      library “libskey”
           libusb       library “libusb”
           libutil      System Utilities Library (libutil, -lutil)
           libvgl       library “libvgl”

   名称マクロ
     ‘.Nm’ マクロは文書のタイトルやサブジェクト名を指定するために使われます。
     このマクロは最初に呼び出された時の引数を覚えておくという特性を持ってお
     り、 それは常にそのページのサブジェクト名であるべきです。 引数なしで呼び
     出されると ‘.Nm’ は作者の作業を少なくするためだけの目的で、最初の名称を出
     力します。 注: セクション 2 または 3 のドキュメントの関数名は NAME セク
     ションにおいて ‘.Nm’ で指定され、 SYNOPSIS セクションや残りのセクションで
     は ‘.Fn’ で指定されます。 csh(1) での ‘while’ コマンドのキーワードのよう
     な対話的なコマンドでは ‘.Ic’ マクロを使うべきです。 ‘.Ic’ はほとんど
     ‘.Nm’ と同一ですが、 それが最初に使われたときの引数を記憶することはできま
     せん。

           使い方: .Nm argument ...
                   .Nm mdoc.sample
                                mdoc.sample
                   .Nm \-mdoc   -mdoc.
                   .Nm foo ) ) ,
                                foo)),
                   .Nm          mdoc.samples

     ‘.Nm’ マクロは解析され、呼び出し可能です。

   オプション
     ‘.Op’ マクロはコマンド行の残りのすべての引数を オプションであることを示す
     角括弧で囲み、 末尾の句読点は角括弧の外に置きます。 ‘.Oc’ マクロと ‘.Oo’
     マクロは複数行に渡って使うことができます。

           使い方: .Op options ...
           .Op                    []
           .Op Fl k               [-k]
           .Op Fl k ) .           [-k]).
           .Op Fl k Ar kookfile   [-k kookfile]
           .Op Fl k Ar kookfile ,
                                  [-k kookfile],
           .Op Ar objfil Op Ar corfil
                                  [objfil [corfil]]
           .Op Fl c Ar objfil Op Ar corfil ,
                                  [-c objfil [corfil]],
           .Op word1 word2        [word1 word2]

     ‘.Oc’ マクロと ‘.Oo’ マクロ:

           .Oo
           .Op Fl k Ar kilobytes
           .Op Fl i Ar interval
           .Op Fl c Ar count
           .Oc

     出力結果: [[-k kilobytes] [-i interval] [-c count]]

     ‘.Op’ と ‘.Oc’ と ‘.Oo’ マクロは解析され、呼び出し可能です。

   パス名
     ‘.Pa’ マクロはパス名もしくはファイル名をフォーマットします。

           使い方: .Pa pathname
                   .Pa /usr/share   /usr/share
                   .Pa /tmp/fooXXXXX ) .
                                    /tmp/fooXXXXX).

     ‘.Pa’ マクロは解析され、呼び出し可能です。

   規格
     ‘.St’ マクロは、規格の短縮名称を正式名称に置換します。

           使い方: .St abbreviature

     使用可能な “短縮名称/正式名称” の組は次の通りです:
           -ansiC          ANSI X3.159-1989 (“ANSI C89”)
           -ansiC-89       ANSI X3.159-1989 (“ANSI C89”)
           -ieee754        IEEE Std 754-1985
           -iso8802-3      ISO/IEC 8802-3:1989
           -isoC           ISO/IEC 9899:1990 (“ISO C90”)
           -isoC-99        ISO/IEC 9899:1999 (“ISO C99”)
           -p1003.1        IEEE Std 1003.1 (“POSIX.1”)
           -p1003.1-88     IEEE Std 1003.1-1988 (“POSIX.1”)
           -p1003.1-90     ISO/IEC 9945-1:1990 (“POSIX.1”)
           -p1003.1-96     ISO/IEC 9945-1:1996 (“POSIX.1”)
           -p1003.1b-93    IEEE Std 1003.1b-1993 (“POSIX.1”)
           -p1003.1g-2000  IEEE Std 1003.1g-2000 (“POSIX.1”)
           -p1003.2        IEEE Std 1003.2 (“POSIX.2”)
           -p1003.2-92     IEEE Std 1003.2-1992 (“POSIX.2”)
           -susv2          Version 2 of the Single UNIX Specification
                           (“SUSv2”)
           -xpg3           X/Open Portability Guide Issue 3 (“XPG3”)
           -xpg4           X/Open Portability Guide Issue 4 (“XPG4”)
           -xpg4.2         X/Open Portability Guide Issue 4, Version 2
                           (“XPG4.2”)

   変数
     一般的な変数への参照です。

           使い方: .Va variable ...
                   .Va count   count
                   .Va settimer,
                               settimer,
                   .Va int *prt ) :
                               int *prt):
                   .Va char s ] ) ) ,
                               char s])),

     ‘.Va’ を引数なしで呼び出すのはエラーです。 ‘.Va’ マクロは解析され、呼び出
     し可能です。

   マニュアルページのクロスリファレンス
     ‘.Xr’ マクロは最初の引数にマニュアルページの名称を取り、もしあれば次の引
     数に セクションのページ数か句読点を取ります。 すべての残りの引数は句読点
     と見なされます。

           使い方: .Xr man_page [1,...,9]
                   .Xr mdoc    mdoc
                   .Xr mdoc ,  mdoc,
                   .Xr mdoc 7  mdoc(7)
                   .Xr mdoc 7 ) ) ,
                               mdoc(7))),

     ‘.Xr’ マクロは解析され、呼び出し可能です。 ‘.Xr’ を引数なしで呼び出すのは
     エラーです。

一般テキスト領域
   AT&T マクロ
           使い方: .At [v6 | v7 | 32v | V.1 | V.4] ...
                   .At                    AT&T UNIX
                   .At v6 .               Version 6 AT&T UNIX.

     ‘.At’ マクロは解析  、呼び出し  です。 最大 2 つまでの引数を
     取ることができます。

   BSD マクロ
           使い方: .Bx [Version/release] ...
                   .Bx       BSD
                   .Bx 4.3 .
                             4.3BSD.

     ‘.Bx’ マクロは解析され、呼び出し可能です。

   FreeBSD/NetBSD/OpenBSD マクロ
           使い方: .Fx [ Version.release ] ...
                   .Fx 2.2 .      FreeBSD 2.2.

           使い方: .Nx [ Version.release ] ...
                   .Nx 1.4 .     NetBSD 1.4.

           使い方: .Ox [ Version.release ] ...
                   .Ox 2.5 .      OpenBSD 2.5.

     ‘.Fx’, ‘.Nx’, ‘.Ox’ マクロは解析され、呼び出し可能です。 最大 2 つまでの
     引数を取ることができます。

   UNIX マクロ
           使い方: .Ux ...
                   .Ux         UNIX

     ‘.Ux’ マクロは解析され、呼び出し可能です。

   囲い/クォートマクロ
     囲いの概念はクォートと似たものです。 1 つ以上の文字列が引用符や括弧のよう
     な文字のペアで囲まれている オブジェクトを指します。 クォートと囲いという
     用語はこの文書を通して同じ意味で使われます。 ほとんどの 1 行の囲いマクロ
     はクォート (quote) のヒントとするために、小文字の ‘q’ で終了しますが、い
     くつかの例外があります。 各々の囲いマクロに対し、開始マクロと終了マクロの
     ペアもあり、それぞれ小文字の ‘o’ と ‘c’ で終了します。 これらは 1 行以上
     のテキストに渡って使うことができますが、 入れ子にする場合に制限がありま
     す。 その中では 1 行形式のクォートマクロのみ使用することができます。

                                             
           .Aq         .Ac     .Ao     カギ括弧による囲い        <文字列>
           .Bq         .Bc     .Bo     角括弧による囲い          [文字列]
           .Dq         .Dc     .Do     2 重引用符                ``文字列''
                       .Ec     .Eo     囲い文字列 (XXによる)     XX文字列XX
           .Pq         .Pc     .Po     括弧による囲い            (文字列)
           .Ql                         クォートされたリテラル    `st' または文字列
           .Qq         .Qc     .Qo     まっすぐな 2 重引用符     "文字列"
           .Sq         .Sc     .So     1 重引用符                `文字列'

     下記の不正なマクロを除き、すべてのクォートマクロは解析され、呼び出し可能
     です。 句読点がひとつずつ置かれていて、スペースで区切られていれば、 すべ
     てのクォートマクロは句読点を適切に扱います。 クォートマクロは開く句読
     点、閉じる句読点 (訳注: 句読点には括弧なども含みます) を調べ、 それが囲む
     文字列より前か後かを決めます。 これによって、ある程度の入れ子が可能になっ
     ています。

     .Ec, .Eo  これらのマクロは各々開始および終了の文字列を最初の引数に取りま
               す。

     .Ql       リテラルをクォートするマクロは troff では nroff と異なった処理
               を行ないます。 nroff でフォーマットされた場合、クォート指定され
               たリテラルは常にクォートされます。 troff でフォーマットされた場
               合は、アイテムの幅が固定幅文字 3 つ分より 狭い場合にのみクォー
               トされます。 これはリテラル (固定幅) のフォントの変更があまり気
               づかれないものであるため、 短い文字列を良く見えるようにするため
               です。

     .Pf       プレフィックスマクロは呼び出し可能ではありませんが、解析されま
               す。

                     .Pf ( Fa name2
                              は (name2 となります。

               ‘.Ns’ (空白なし) マクロはサフィックス機能と同様の作用がありま
               す。

     クォートの例:
           .Aq                   ⟨⟩
           .Aq Ar ctype.h ) ,    ⟨ctype.h⟩),
           .Bq                   []
           .Bq Em Greek , French .
                                 [Greek, French].
           .Dq                   “”
           .Dq string abc .      “string abc”.
           .Dq ´^[A-Z]´          “´^[A-Z]´”
           .Ql man mdoc          ‘man mdoc’
           .Qq                   ""
           .Qq string ) ,        "string"),
           .Qq string Ns ),      "string),"
           .Sq                   ‘’
           .Sq string            ‘string’

     囲いマクロの入れ子についての良い例については、 オプションマクロ ‘.Op’ を
     参照してください。 このマクロは上でリストされているような囲いマクロと同じ
     ベースの上に 作られています。 拡張引数リストマクロ ‘.Xo’ と ‘.Xc’ もまた
     同じルーチンをベースに作られており、 -mdoc マクロの使い方の非常に良い例と
     なっています。

   no-op もしくは通常テキストマクロ
     ‘.No’ マクロはマクロコマンド行において、コンテントマクロの構文形式に従う
     が、 フォーマットされては  単語をハックするものです。

   空白なしマクロ
     ‘.Ns’ マクロはマクロ間での不要な空白を除去します。 これはフラグと引数の間
     に空白を含まない古いスタイルの引数リストを使う場合に 便利です。

           .Op Fl I Ns Ar directory
                            これは以下の結果になります。 [-Idirectory]

     注: ‘.Ns’ マクロは他のマクロ名が続かなければ、スペースを除去したあとに
     ‘.No’ マクロを常に起動します。 ‘.Ns’ マクロは解析され、呼び出し可能です。

   セクションのクロスリファレンス
     ‘.Sx’ マクロは同一文書内でのセクションのヘッダへの参照を指定します。 これ
     は解析され、呼び出し可能です。

                   .Sx FILES     FILES

   参考文献と引用
     以下のマクロは多少なりとも参考文献を扱えるようにと意図したものです。 これ
     らのマクロは、せいぜい参照スタイルの参考文献のサブセットを手動で 作成しや
     すくする程度です。

           .Rs     参考文献の開始。 改行を挿入してから、参考文献の終了マクロが
                   読み込まれるまで 参考文献の情報を収集する。
           .Re     参考文献の終了。 参考文献が表示される。
           .%A     参考文献の作者名。1 回の呼び出しにつき、作者名をひとつ指定
                   する。
           .%B     書籍のタイトル。
           .%C     市 / 場所。
           .%D     日付。
           .%J     定期刊行物の名称。
           .%N     発行番号。
           .%O     追加情報。
           .%P     ページ番号。
           .%R     報告書の名称。
           .%T     記事のタイトル。
           .%V     巻数。

     ‘%’ で始まるマクロは呼び出し不可能ですが、 呼び出し側に戻る商標名マクロだ
     けは解析されます。 (現時点では予期できないことです。) 商標名のみ解析され
     るのは troff/ditroff の出力をきれいにするためです。

   戻り値
     ‘.Rv’ マクロは RETURN VALUE のセクションで使うテキストを生成します。

           使い方: .Rv [-std function]

     ‘.Rv -std atexit’ これは以下のテキストを生成します。

     The atexit() function returns the value 0 if successful; otherwise the
     value -1 is returned and the global variable errno is set to indicate the
     error.

     -std オプションはセクション 2 と 3 のマニュアルページでのみ有効です。

   商標名 (頭字語とタイプ名)
     商標名マクロは一般的に長さが 2 文字を越えるすべてが大文字の単語用 に使わ
     れる小さな大文字のマクロです。

           使い方: .Tn symbol ...
                   .Tn DEC
                          DEC
                   .Tn ASCII
                          ASCII

     ‘.Tn’ マクロは解析され、他のマクロから呼び出し可能です。

   拡張引数
     ‘.Xo’ と ‘.Xc’ マクロでマクロの境界における引数リストを拡張することができ
     ます。 引数リストは ‘.Op’ のようなすべての引数が 1 行中に指定されているこ
     とを前提としている マクロの中では行に渡って拡張することができません。

     以下に空白モードマクロをスペーシングをオフにするために使った ‘.Xo’ での例
     を示します。

           .Sm off
           .It Xo Sy I Ar operation
           .No \en Ar count No \en
           .Xc
           .Sm on

     これは以下のような結果になります。

           Ioperation\ncount\n

     例をもうひとつ:

           .Sm off
           .It Cm S No / Ar old_pattern Xo
           .No / Ar new_pattern
           .No / Op Cm g
           .Xc
           .Sm on

     これは以下のような結果になります。

           S/old_pattern/new_pattern/[g]

     囲いマクロを使った ‘.Xo’ の他の例: 変数の値をテストして下さい。

           .It Xo
           .Ic .ifndef
           .Oo \&! Oc Ns Ar variable
           .Op Ar operator variable ...
           .Xc

     結果は以下の通りです。

           .ifndef [!]variable [operator variable ...]

     上のすべての例では ‘.It’ (リスト項目) マクロの引数リストに ‘.Xo’ マクロを
     使用しています。 拡張マクロが使われることはあまりありません。 使われると
     すれば、リスト項目の引数リストを拡張する場合です。 残念なことに、これが拡
     張マクロが最も懲り性であるところでもあります。 最初の 2 つの例では、ス
     ペーシングはオフになっています。 3 番目では、ある箇所にはスペーシングを入
     れることが望ましいのですが、 出力全体に入れたいわけではありません。 その
     ような状況でこれらのマクロが適切に動作するためには、 ‘.Xo’ と ‘.Xc’ マク
     ロが 3 番目の例にあるように指定されていることを確認してください。 ‘.Xo’
     マクロが置かれた ‘.It’ の引数リストに他のものが置かれると、スペーシングが
     どうなるかは予測不可能です。 この場合、 ‘.Ns’ (空白なしマクロ) は行中の最
     初もしくは最後のマクロに指定してはいけません。 現在 BSD でリリースされて
     いる 900 のマニュアルページ (実際のページでは約 1500 ページ) のうち 15 の
     マニュアルページでのみしか ‘.Xo’ が使われていません。

ページ構造領域
   セクションヘッダ
     以下にリストされている、最初の 3 つのセクションヘッダマクロ ‘.Sh’ はすべ
     ての man ページで必須のものです。 残りのセクションヘッダはマニュアルペー
     ジの作者の裁量において、 推奨されているものです。 ‘.Sh’ マクロは 9 つまで
     の引数を取ることができます。 これは解析されますが、呼び出し不可能です。

     .Sh NAME  ‘.Sh NAME (訳注: 名称)’ マクロは必須のものです。 これが指定され
               ていないと、ヘッダとフッタ、それにデフォルトの ページレイアウト
               が設定されず、結果はかなり好ましくないものになるでしょう。 NAME
               セクションは最低 3 つの項目からなります。 最初のものは名称マク
               ロ ‘.Nm’ であり、man ページのサブジェクトとなります。 2 番目の
               ものは名称説明マクロ ‘.Nd’ であり、サブジェクト名を 3 つめの項
               目、 すなわちその名称の説明と分離します。 説明に割り当てられる
               スペースは小さいものですので、 できるだけ簡潔で分かりやすいもの
               でなければなりません。

     .Sh SYNOPSIS
               SYNOPSIS (: ) セクションはその man ページのサブジェクト
               となっている項目の 典型的な使用法を説明します。 必須のマクロは
               ‘.Nm’, ‘.Cd’, ‘.Fn’ のいずれかです。 (他には ‘.Fo’, ‘.Fc’,
               ‘.Fd’, ‘.Ft’ のマクロも必要な場合があります。) 関数名マクロ
               ‘.Fn’ はセクション 2 と 3 のマニュアルページにおいて必須のもの
               で、 コマンドと一般名称マクロ ‘.Nm’ はセクション 1, 5, 6, 7, 8
               で必須の項目です。 セクション 4 のマニュアルでは ‘.Nm’ か ‘.Fd’
               、もしくはコンフィギュレーションデバイス使用法マクロ ‘.Cd’ が必
               要です。 その他のいくつかのマクロが下に示すような書式行を生成す
               るために必要なこと があります。

                     cat [-benstuv] [-] file ...

               以下のマクロが使われています。

                     .Nm cat
                     .Op Fl benstuv
                     .Op Fl
                     .Ar

               注: マクロ ‘.Op’, ‘.Fl’, ‘.Ar’ はパイプの文字 ‘|’ を認識し、下
               記のようなコマンド行

                     .Op Fl a | Fl b

               はうまくいきません。 troff は通常 | を特別のオペレータとして解
               釈します。 この他で | が使える場合については 
               セクションを参照して下さい。

     .Sh DESCRIPTION
               DESCRIPTION (: ) セクションでの最初のテキストは、ほとん
               どの場合ではそのコマンド、 関数もしくはファイルについての短い段
               落で、オプションの構文リストと それぞれの説明がそれに続きます。
               そのようなリストを作成するには リスト開始マクロ ‘.Bl’ 、リスト
               項目マクロ ‘.It’ 、リスト終了マクロ ‘.El’ を使います (後述の 
                セクションを参照)。

     以下の ‘.Sh’ のセクションヘッダはマニュアルページの好ましいレイアウトの一
     部であり、 一貫性を保つために適切に使われなければなりません。 これらは使
     われる順番にリストされています。

     .Sh ENVIRONMENT (訳注: 環境変数)
           ENVIRONMENT セクションは関連する環境変数を明らかにし、 それらの振舞
           や使用方法を示します。

     .Sh EXAMPLES (訳注: 使用例、実行例)
           使用例、実行例を作成するには様々な方法があります。 詳細について
           は、下の  のセクションを参照してください。

     .Sh FILES (訳注: 関連ファイル)
           man ページのサブジェクトによって使用されるか生成されるファイルで、
           FILES のセクション中でマクロ ‘.Pa’ によってリストされます。

     .Sh SEE ALSO (訳注: 関連項目)
           SEE ALSO セクションには、その man ページの題材に関する資料への参照
           と 他の関連する man ページへのクロスリファレンスが記載されます。 ク
           ロスリファレンスは ‘.Xr’ マクロによって指定されます。 SEE ALSO セク
           ションでのクロスリファレンスはセクション番号順に並べ、 セクション中
           ではカンマで区切ってアルファベット順に並べなければなりません。 以下
           に例を示します。

           ls(1), ps(1), group(5), passwd(5)

           ここで参考スタイルである refer(1) は適応されていません。

     .Sh STANDARDS (訳注: 規格)
           コマンドやライブラリ関数やファイルが、 IEEE Std 1003.2 (“POSIX.2”)
           や ANSI X3.159-1989 (“ANSI C89”) のような特定の実装によるものであれ
           ば、ここで記述します。 もしコマンドがどの規格にも基づいていなけれ
           ば、その歴史は HISTORY のセクションで説明されなければなりません。

     .Sh HISTORY (訳注: 歴史)
           特定の規格に基づいていないコマンドは、 このセクションでその歴史の概
           要が説明されるべきです。

     .Sh AUTHORS (訳注: 作者)
           クレジットが必要であれば、ここで入れます。 人物名を指定するには
           ‘.An’ マクロを使用すべきです。

     .Sh DIAGNOSTICS (訳注: 診断)
           コマンドからの診断はこのセクションに入れます。

     .Sh ERRORS (訳注: エラー)
           特定のエラーハンドリング、特にライブラリ関数 (man ページのセクショ
           ン 2, 3, 9) でのエラーハンドリングは、ここで説明します。 ‘.Er’ マク
           ロが errno を記述するために使われます。

     .Sh BUGS (訳注: バグ)
           あきらかな問題はここで記述します。

     ユーザ指定の ‘.Sh’ セクションを追加することができます。 たとえば、このセ
     クションは以下のように設定されています。

                   .Sh ページ構造領域

   段落と行スペース
     .Pp     ‘.Pp’ 段落コマンド は必要な場合に行スペースを指定するために使われ
             ます。 このマクロは ‘.Sh’ マクロや ‘.Ss’ マクロのあと、それに
             ‘.Bl’ マクロの前では必要ありません。 ( ‘.Bl’ マクロは -compact フ
             ラグが指定されていなければ、縦方向の距離を宣言します )。

   キープ
     現在実装されているキープは単語に対するものだけです。 それらは ‘.Bk’ (キー
     プ開始) マクロと ‘.Ek’ (キープ終了) マクロです。 ‘.Bk’ に指定できるオプ
     ションは -words のみであり、これはオプションの途中で改行が入らないように
     するのに便利です。 コマンド行の引数を生成する例 ( ...? セ
     クションを参照) において、キープは nroff がフラグと引数を別の行に分けない
     ように使われています。 (実際には、オプションマクロがこの目的で使われてい
     ましたが、 オプションが行中にわたって散らばってしまうと 一般的に見栄えが
     悪くなるという理由により troff で右揃えのマージンを強制的に行なう (宗教的
     な) 決定がなされてから、 オプションマクロをこの目的で使わないようになりま
     した。 キープマクロについてはもっと機能を向上する作業が必要であり、 -line
     オプションを追加していく必要があります。)

   例示とディスプレイ
     ディスプレイには 5 つのタイプがあります。 即席 1 行インデントディスプレイ
     ‘.D1’ 、即席 1 行リテラルディスプレイ ‘.Dl’ 、それに ディスプレイ開始マク
     ロ ‘.Bd’ とディスプレイ終了マクロ ‘.Ed’ を使用するリテラルブロック、フィ
     ルブロックおよび凸凹ブロックです。

     .D1    (D-いち) インデントされたテキストを 1 行表示します。 このマクロは
            解析されますが、呼び出し不可能です。

                  -ldghfstru

            これは次の指定で生成されたものです。 .D1 Fl ldghfstru

     .Dl    (D-エル) インデントされた  テキストを 1 行表示します。
            ‘.Dl’ マクロの例は本ファイルの中に渡って使われています。 これに
            よって 1 行のテキストのインデント (表示) が可能になります。 このマ
            クロは解析され、他のマクロを認識することができますが、 デフォルト
            のフォントは固定幅 (リテラル) にセットされています。 しかしなが
            ら、呼び出しは不可能です。

                  % ls -ldg /usr/local/bin

            これは .Dl % ls -ldg /usr/local/bin から生成されています。

     .Bd    ディスプレイ開始です。 ‘.Bd’ によるディスプレイは ‘.Ed’ マクロに
            よって終了しなければなりません。 ディスプレイはディスプレイ内およ
            びリスト内で入れ子にすることができます。 ‘.Bd’ は以下の書式をとり
            ます。

                  .Bd ディスプレイタイプ [-offset オフセット値] [-compact]

            ディスプレイタイプは以下の 4 つのタイプの内の 1 つでなければなら
            ず、 インデント ‘.Bd’ のオフセット値を指定することができます。

            -ragged            テキストのブロックをタイプされた通りに表示しま
                               す。 右マージン (と左マージン) のエッジは左に不
                               揃いに寄せられます。
            -filled            フィル (フォーマット) されたブロックを表示しま
                               す。 テキストのブロックがフォーマットされます
                               (エッジは左非揃えではなく、フィルされます)。
            -literal           リテラルなブロックを表示します。 ソースコード
                               や、単純にタブもしくはスペースで整えられたテキ
                               ストで便利です。
            -file    -file フラグに続く名称のファイルが読み込ま
                               れ、表示されます。 表示はリテラルなモードで行わ
                               れ、タブは定幅文字 8 つ分に固定されますが、
                               ファイル中のすべての troff/-mdoc コマンドは解釈
                               されます。
            -offset      -offset が以下の文字列のいずれかとともに指定さ
                               れていると、 その文字列は次のテキストのブロック
                               のインデントのレベルを示すものとして 解釈されま
                               す。

                               left        ブロックを現在の左マージンに揃えま
                                           す。 これは ‘.Bd’ のデフォルトの
                                           モードです。
                               center      ブロックを中央揃えにします。 残念な
                                           がら現時点では、 単にブロックの左側
                                           を仮想的な中央マージンに揃えるだけ
                                           です。
                               indent      デフォルトのインデント値もしくはタ
                                           ブの分だけインデントします。 デフォ
                                           ルトのインデント値はディスプレイ
                                           ‘.D1’ でも使われ、これら 2 つのタイ
                                           プのディスプレイを使った場合、 行が
                                           揃うことが保証されています。 このイ
                                           ンデントは通常 6n か約 2/3 インチ
                                           (定幅文字 6 つ分) です。
                               indent-two  デフォルトのインデント値の 2 倍分イ
                                           ンデントします。
                               right       これはブロックをページの右端から約
                                           2 インチ離して  揃えします。 この
                                           マクロはちゃんと動作する必要がある
                                           のですが、 troff ではまったくちゃん
                                           と動作してくれていません。

     .Ed    ディスプレイ終了。

   フォントモード
     マニュアルページのテキストの見栄えを変更するマクロは 5 つあります。

     .Em    テキストは ‘.Em’ マクロで強調することができます。 強調の場合、通常
            イタリック体のフォントが使われます。

                  使い方: .Em argument ...
                          .Em does not   does not
                          .Em exceed 1024 .
                                         exceed 1024.
                          .Em vide infra ) ) ,
                                         vide infra)),

            ‘.Em’ マクロは解析され、呼び出し可能です。 ‘.Em’ を引数なしで呼び
            出すのはエラーです。

     .Li    リテラルマクロ ‘.Li’ は特殊文字や変数定数、その他タイプされた通り
            に表示する必要があるものに 使用することができます。

                  使い方: .Li argument ...
                          .Li \en    \n
                          .Li M1 M2 M3 ;
                                     M1 M2 M3;
                          .Li cntrl-D ) ,
                                     cntrl-D),
                          .Li 1024 ...
                                     1024 ...

            ‘.Li’ マクロは解析され、呼び出し可能です。

     .Sy    シンボリック体強調マクロはシンボリックの意味でも 伝統的な英語の使
            いかたにおいても、 通常はボールドマクロとなっています。

                  使い方: .Sy symbol ...
                          .Sy Important Notice
                                             Important Notice

            ‘.Sy’ マクロは解析され、呼び出し可能です。 ‘.Sy’ の引数は引用符で
            囲むことができます。

     .Bf    フォントモード開始。 フォントモード ‘.Bf’ は ‘.Ef’ マクロで終了し
            なければなりません。 フォントモードは他のフォントモードと入れ子に
            することができます。 ‘.Bf’ は次の構文を取ります。

                  .Bf フォントモード

            フォントモードは以下の 3 つのタイプのうちのいずれかでなければなり
            ません。

            Em | -emphasis    強調モード。 ‘.Em’ マクロがテキストブロック全体
                              に使われているのと同様です。
            Li | -literal     リテラルモード。 ‘.Li’ マクロがテキストブロック
                              全体に使われているのと同様です。
            Sy | -symbolic    シンボリックモード。 ‘.Sy’ マクロがテキストブ
                              ロック全体に使われているのと同様です。

     .Ef    フォントモードの終了。

   タグつきリストと列
     リスト開始マクロ ‘.Bl’ で開始されるリストにはいくつかのタイプがあります。
     リスト中の項目は項目マクロ ‘.It’ で指定され、各リストは ‘.El’ マクロで終
     了しなければなりません。 リストはリスト自身やディスプレイの中で入れ子にす
     ることができます。 列はリストの中で使うことができますが、 リストが列の中
     で使えるかどうかは検証されていません。

     さらに、タグの幅、リストのオフセット、コンパクトさ (項目間の空白行が許さ
     れているかどうか) のような、 いくつかのリストの属性を指定することができま
     す。 本ドキュメントのほとんどはタグ (-tag) スタイルリストでフォーマットさ
     れています。 各種リストタイプは、調子を変えるためにオーバーハング
     (-ohang) でリストしました。 このリストのタイプは TeX のユーザに非常に人気
     のあるものですが、tag リストで構成されたページを 何ページも読んだ後には幾
     分変に見えるでしょう。 以下のリストタイプを ‘.Bl’ で使うことができます。

     -bullet
     -item
     -enum
     これら 3 つは最も単純なリストのタイプです。 一旦 ‘.Bl’ マクロが与えられる
     と、リスト中の項目は単に ‘.It’ マクロによってのみ構成される行で指定されま
     す。 例として、簡単な列挙リストのソーステキストは、このようになります。

                 .Bl -enum -compact
                 .It
                 ひとつめはここ。
                 .It
                 そしてふたつめ。
                 .It
                 最後にみっつめはここ。
                 .El

     これらの結果は以下のようになります。

               1.   ひとつめはここ。
               2.   そしてふたつめ。
               3.   最後にみっつめはここ。

     簡単な bullet リスト構成の例を示します。

                 .Bl -bullet -compact
                 .It
                 ひとつめの bullet。
                 .It
                 これはふたつめの bullet。
                 .El

     その結果はこうなります。
               ·   ひとつめの bullet。
               ·   これはふたつめの bullet。

     -tag
     -diag
     -hang
     -ohang
     -inset
     これらのリストタイプは ‘.It’ マクロによって指定されている引数からラベルを
     生成します。 そして、 inset では、次のテキストへそのラベルを挿入します。
     hang では、次のテキストをラベルの位置へインデントします。 ohang (オーバー
     ハング) では、次のテキストをラベルの位置にぶら下げ、インデントしません。
     tag では、タグつきテキストの形式にします。 ちなみに上のリストは ‘-ohang’
     リストタイプで構成されています。 ‘.It’ マクロは inset, hang, tag のリスト
     タイプでのみ解析され、 呼び出し不可能です。 以下に inset ラベルの例を示し
     ます。

           tag tag リスト (tag 段落とも呼ばれる) は、 Berkely マニュアルで使わ
           れているリストのうち最も一般的なタイプです。

           diag () 診断リストはセクション 4 の診断リストを生成するもので、
           呼び出し可能なマクロが無視されることを除き、inset リストと似ていま
           す。

           hang hang ラベルは好みの問題です。

           ohang ohang ラベルはスペースに制限がある時に便利です。

           inset inset ラベルは段落のブロックを制御するのに便利で、 -mdoc マ
           ニュアルを他の形式に変換する時に役立ちます。

     上の例を生成したソーステキストはこうなっています。

           .Bl -inset -offset indent
           .It Em tag
           tag リスト (tag 段落とも呼ばれる) は、
           Berkely マニュアルで使われているリストのうち最も一般的なタイプです。
           .It Em diag (診断)
           診断リストはセクション 4 の診断リストを生成するもので、
           呼び出し可能なマクロが無視されることを除き、inset リストと似ています。
           .It Em hang
           hang ラベルは好みの問題です。
           .It Em ohang
           ohang ラベルはスペースに制限がある時に便利です。
           .It Em inset
           inset ラベルは段落のブロックを制御するのに便利で、
           .Nm -mdoc
           マニュアルを他の形式に変換する時に役立ちます。
           .El

     以下は 2 つの項目を持つ hang リストです。

           hang    ラベルがラベルの幅より小さいときには、 ラベルは tag リスト
                   と同じようになります。

            hang  は、tag 段落のラベルとは異なり、 段落の中に
                   埋め込まれます。

     これを生成している元のテキストは以下の通りです。

           .Bl -hang -offset indent
           .It Em hang
           ラベルがラベルの幅より小さいときには、
           ラベルは tag リストと同じようになります。
           .It Em 長い hang リストラベル
           は、tag 段落のラベルとは異なり、
           段落の中に埋め込まれます。
           .El

     タグ幅を制御するためのオプションの幅指定を使ったタグつきリストは 以下の通
     りです。

           SL      プロセスが sleep している時間 (ブロックされた秒数)
           PAGEIN  そのプロセスによるコアにロードされていないページへの参照に
                   よるディスク I/O の回数
           UID     プロセスの所有者の数字表記によるユーザID
           PPID    親プロセスの数字表記によるID、プロセスの優先度 (割り込み不
                   可のウエイトであるときには非正値)

     元のテキストは以下の通りです。

           .Bl -tag -width "PAGEIN" -compact -offset indent
           .It SL
           プロセスが sleep している時間 (ブロックされた秒数)
           .It PAGEIN
           そのプロセスによるコアにロードされていないページへの参照によるディスク
           .Tn I/O
           の回数
           .It UID
           プロセスの所有者の数字表記によるユーザID
           .It PPID
           親プロセスの数字表記によるID、プロセスの優先度
           (割り込み不可のウエイトであるときには非正値)
           .El

     幅指定として以下のものを使うことができます。

           -width Fl     そのフラグでのデフォルトの幅を指定します。 すべての呼
                         び出し可能なマクロは各々デフォルトの幅の値を持ってい
                         ます。 現在、 ‘.Fl’ の値は定幅文字 10 個分、もしくは
                         約 5/6 インチとなっています。

           -width 24n    定幅文字 24 個分の幅、もしくは約 2 インチの幅をセット
                         します。 これが正しく動作するには ‘n’ が必ず必要とな
                         ります。

           -width ENAMETOOLONG
                         指定された文字列の固定長に幅をセットします。

           -width "int mkfifo"
                         これも、指定された文字列の固定長に幅をセットします。

     タグつきリストタイプで幅が指定されていないと、 ‘.It’ が最初に起動された時
     に適した幅を決定することが試みられます。 ‘.It’ の最初の引数が呼び出し可能
     なマクロであれば、そのマクロのデフォルトの幅が そのマクロ名が幅として指定
     されたように使用されます。 しかしながら、そのリスト中に他の項目が別の呼び
     出し可能なマクロ名で 与えられていると、新しく入れ子となったリストとして処
     理されます。

定義済みの文字列
     以下の文字列はあらかじめ定義されているものであり、 troff の文字列解釈シー
     ケンス ‘\*(xx’ もしくは ‘\*x’ を前に伴って使われます。 ここで、 xx もしく
     は x は定義されている文字列の名称です。 解釈シーケンスはテキストのどこで
     も使うことができます。

           文字列     Nroff     Troff
           <=         <=        ≤
           >=         >=        ≥
           Rq         ''        ”
           Lq         ``        “
           ua         ^         ↑
           aa         '         ´
           ga         `         `
           q          "         "
           Pi         pi        π
           Ne         !=        ≠
           Le         <=        ≤
           Ge         >=        ≥
           Lt         <         >
           Gt         >         <
           Pm         +-        ±
           If         infinity  ∞
           Na         NaN       NaN
           Ba         |         |

     注: ‘q’ の名称がつけられている文字列は、1 文字であるため ‘\*q’ と書かなけ
     ればなりません。

診断
     -mdoc は限られたデバッグ機能しか持っていませんが、 引数名と内部レジスタや
     マクロ名との衝突のような 潜在的なエラーを検出するのに役立ちます。 (A って
     何?)  レジスタは troff での演算用記憶クラスであり、1 文字か 2 文字の名称
     がついています。 troff と ditroff での -mdoc のすべての内部レジスタは
     ‘Ar’ のように2 文字からなる <大文字><小文字> の形式か、 ‘aR’ のように <小
     文字><大文字> の形式か、 ‘C1’ のように <大文字もしくは小文字><数字> の形
     式を取ります。 さらに混乱することに、 troff はそれ自身の内部レジスタを持
     ち、 それらすべては小文字 2 文字か、ドットに文字もしくはメタ文字が続く形
     式を取ります。 紹介例の 1 つに、 エスケープシーケンス ‘\&’ でマクロ名を解
     釈させない方法がありました。 これは内部レジスタ名にも有効です。

     エスケープされていないレジスタ名が引数リストに指定されると、 予期できない
     振舞いとなります。 一般的には、テキストのかなり大きな部分が出力されるべき
     ところに 出力されないとか、リストのタグのような小さな文字列が消えてしまう
     とか、 引数リストの中の引数のタイプが間違って解釈されるとかいうことが、起
     こり得ます。 きっとあなたのお母さんは、あなたにこんな面倒なことを覚えるよ
     うにとは 考えていないでしょう。 そこで、与えられた引数が有効か無効かを判
     断する方法があります。 そんなときには、 ‘.Db’ (デバッグ) マクロによってほ
     とんどのマクロの引数リストがどう解釈されるか を表示することができます。
     ‘.Pp’ (段落) マクロのようなマクロはデバッグ情報を含んでいません。 呼び出
     し可能なマクロはすべてデバッグ情報を含んでおり、 疑いがある場合はいつでも
     ‘.Db’ マクロをオンにすることを強くお勧めします。

           使い方: .Db [on | off]

     以下の例では、 問題が故意に発生するようにされた部分の上と下で デバッグマ
     クロが指定されています (フラグ引数 ‘aC’ は正しく動作するためには ‘\&aC’
     でなければなりません)。

           .Db on
           .Op Fl aC Ar file )
           .Db off

     この結果の出力は以下の通りです。

           DEBUGGING ON
           DEBUG(argv) MACRO: `.Op'  Line #: 2
                   Argc: 1  Argv: `Fl'  Length: 2
                   Space: `'  Class: Executable
                   Argc: 2  Argv: `aC'  Length: 2
                   Space: `'  Class: Executable
                   Argc: 3  Argv: `Ar'  Length: 2
                   Space: `'  Class: Executable
                   Argc: 4  Argv: `file'  Length: 4
                   Space: ` '  Class: String
                   Argc: 5  Argv: `)'  Length: 1
                   Space: ` '  Class: Closing Punctuation or suffix
                   MACRO REQUEST: .Op Fl aC Ar file )
           DEBUGGING OFF

     この情報の最初の行では呼び出されているマクロの名称が出力されています。 こ
     こでは ‘.Op’ とそれが現れた行番号が表示されています。 複数のファイルが処
     理されている場合 (特にテキストが他のファイルからインクルードされている場
     合)、 行番号は正しくないでしょう。 ファイルが 1 つだけの場合には正しい行
     番号が出力されます。 2 番目の行では引数の個数と引数 (‘Fl’) とその長さが出
     力されています。 引数の長さが 2 文字であれば、 その引数が実行可能 (ゼロで
     ない値を含むすべてのレジスタは実行可能なように見えます) かどうかテストさ
     れます。 3 番目の行ではそのクラスで指定されているスペースとクラスタイプが
     出力されています。 ここでの問題は引数 aC が実行不可能でなければならないこ
     とです。 クラスの 4 つのタイプは文字列、実行可能、閉じる句読点、開く句読
     点です。 最後の行では引数リスト全体が読み込まれた通りに表示されています。
     次の例では問題の原因となっている ‘aC’ がエスケープされています。

           .Db on
           .Em An escaped \&aC
           .Db off

           DEBUGGING ON
           DEBUG(fargv) MACRO: `.Em'  Line #: 2
                   Argc: 1  Argv: `An'  Length: 2
                   Space: ` '  Class: String
                   Argc: 2  Argv: `escaped'  Length: 7
                   Space: ` '  Class: String
                   Argc: 3  Argv: `aC'  Length: 2
                   Space: ` '  Class: String
                   MACRO REQUEST: .Em An escaped &aC
           DEBUGGING OFF

     ‘\&’ シーケンスは長さが 0 となるために 引数 ‘\&aC’ は先の例と同様に長さ 2
     と表示されています。 しかし、 ‘\&aC’ という名称のレジスタが見つからず、タ
     イプは文字列と判断されています。

     この他の診断は使用方法を報告するものであり、 それ自身が説明を含んでいま
     す。

GROFF, TROFF, NROFF

     -mdoc パッケージは groff との互換モードは必要ではありません。

     このパッケージでは改ページと、 nroff で改ページ時に通常挿入されるヘッダと
     フッタは禁止されており、 マニュアルをオンラインで効率良く見ることができる
     ようになっています。 現在の所、 -Tascii が指定された groff はページ内容の
     無いファイル末の残りの部分まで出力します。 改ページを禁止することによって
     nroff による出力はハードコピーには適さないものとなっています。 サイト依存
     のスタイルファイル /usr/src/share/tmac/doc-nroff において 0 にセットする
     ことができる ‘cR’ の名称を持つレジスタが古いスタイルの振る舞いを実現する
     ために用意されています。

関連ファイル
     /usr/share/tmac/doc.tmac      マニュアルマクロパッケージ
     /usr/share/misc/mdoc.template
                                   man ページを書くためのテンプレート
     /usr/share/examples/mdoc/*    man ページのいくつかの例

バグ
     あらかじめ定義されている文字列は文書において宣言されていません。

     セクション 3f はヘッダルーチンには追加されていません。

     ‘.Nm’ フォントは NAME セクションにおいて変更されるべきです。

     ‘.Fn’ は分割されるのを防止するために、 行の長さが短すぎないかどうかを
     チェックする必要があります。 ときどき、最後の括弧が分割されることがあり、
     行がフィルモードであるときには全くおかしな結果になることがあります。

     リストマクロとディスプレイマクロはキープを行いませんが、 これはキープを行
     うべきです。

関連項目
     man(1), troff(1), groff_mdoc(7), mdoc(7)