マクロの使用方法¶

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

一般的に GNU troff(1) マクロは取り得る引数の数に制限はありません (9 つ以上の 引数を扱うことのできない他のバージョンの troff とは違います)。 限られた場合ではありますが、引数を次の行に続けたり、拡張したり することができます (後述の 拡張引数 のセクションを参照)。 ほとんどすべてのマクロで引用符に囲まれた引数を扱うことができます (後述の 引数に空白文字を指定する のセクションを参照)。

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

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

ここで文字列 ‘Fl’ と ‘Ar’ はマクロとして解釈されていません。 このドキュメントを通じて、 呼び出し可能な引数を調べるために引数リストが構文解析されるマクロは 構文解析される マクロとして参照し、 引数リストから呼び出されることができるマクロは 呼び出し可能 なマクロとして参照します。 -mdoc のマクロはほとんどすべてが構文解析されるのですから、これは技術的には 適当でない 表現ですが、常にマクロを「呼び出し可能である」とか「他のマクロを 呼び出すことができる」と表現するのは面倒なことであるため、 「構文解析される」という用語を使います。

引数に空白文字を指定する¶

1 つ以上の空白文字を含む文字列を引数として指定したい 場合があります。 引数リスト中の要素が特定の並びをしていることを 期待しているマクロに引数を指定する時に必要になることがあります。 さらに、こうすると -mdoc が速く実行されるようになるのです。 例えば、関数マクロ ‘.Fn’ では第 1 引数は関数名であり、残りの引数が関数のパラメータであると 想定されています。 ANSI C では、関数のパラメータ宣言を括弧で囲まれたパラメータリスト中に 明示することを規定しているので、 各パラメータは最低でも 2 語の文字列となります。 例えば、 int foo のようになります。

空白を含む引数を指定するには 2 通りの方法があります。 1 つは、空白を含む文字列を渡すのに、固定の空白、 つまりパディングされない空白文字 ‘\ ’ を使う方法です。すなわち、空白の前にエスケープ文字 ‘\’ を指定します。 この方法はどのマクロでも使うことができますが、1 行が長くなり過ぎた テキストを調整するときの邪魔になるという副作用があります。 troff では、固定の空白は他の印刷可能な文字と同様に扱われ、通常期待されるように その箇所で文字列を空白や改行で分けることは行われなくなります。 この方法は文字列が行の境界にまたがることが好ましくない場合に有用です。 代替案としては、 パディング可能 (すなわち伸長可能) で分割不可能な空白 ‘\~’ を使うことがあります (これは、 GNU troff(1) 拡張です)。 2 つ目の方法は、文字列をダブルクォートで括ることです。

例えば、次のようにします:

もし、空白およびダブルクォートの前の ‘\’ が省略されていた場合には ‘.Fn’ は引数が 3 つであるとみなし、その結果は

となります。

行末の空白文字¶

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

特殊文字のエスケープ¶

改行 ‘\n’ のような特殊文字は、バックスラッシュを保存するために ‘\’ を ‘\e’ で置き換え (たとえば ‘\en’ とする) て扱います。

その他の注意点¶

表示領域外で空の入力行が見つかった場合には警告が発生します (後述)。 代わりに ‘.sp’ を使用してください ( -mdoc マクロを使用して、低レベルコマンドを使用しないようにすると ずっと良いです)。

先頭に空白を置くと行分割が生じ、そのまま出力されてしまいます。 可能ならばこうなることを避けてください。 同様に、通常のテキスト行において単語間に 2 つ以上の空白文字を 使用しないでください。これは、他のテキストフォーマッタとは 対照的です。空白文字を 2 つ以上置いても 1 つの空白文字に 置き換わりません 。

引数として ‘"’ を直接渡すことはできません。 代わりに ‘\*[q]’ (あるいは ‘\*q’) を使用してください。

デフォルトでは、 troff(1) は文を終了させる句読点の後に空白文字を 2 つ挿入します。 つまり、 ‘)’ あるいは ‘'’ などの文字はそのまま扱われ、文の終了には影響を与えません。 この動作を変更するには、 ドットの前あるいは後に ‘\&’ を挿入してください。

The
.Ql .
character.
.Pp
The
.Ql \&.
character.
.Pp
.No test .
test
.Pp
.No test.
test

は、

となります。

1 行目および 3 行目にみられるように、 -mdoc はマクロ引数の中では句読点を特別に扱います。 これについては、後述の 一般的な構文 の節で述べます。 同様の方法で、幅 0 の空白を続けることで、 省略形の後に続いたピリオドを保護しなくてはなりません。 例えば ‘e.g.\&’ のようにします。

マニュアルページのソースファイル中のコメントは、 独立した行では ‘.\"’ 、何らかの入力があった後では ‘\"’ を、あるいはどのような場所でも使いたい場合は ‘\#’ を使うことができます (後者は GNU troff(1) 拡張です)。このような行の残りの部分は無視されます。

この名前には何が...¶

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

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

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

ここで filter はコマンド名であり、角括弧で囲まれた文字列 -flag は フラグ 引数で、これは角括弧で囲むことによってオプションであることを 示しています。 -mdoc の用語では、 ⟨infile⟩ および ⟨outfile⟩ は メタ引数 と称されています。 この例では、ユーザは山括弧 (<>) の中で与えられたメタ引数を 実際のファイル名に置き換えなくてはなりません。 このドキュメントでは、メタ引数は -mdoc コマンドを記述するのに使用していることに注意してください。 多くのマニュアルページでは、メタ変数はわざわざ山括弧を使って 書かれていません。 上の例を整形したマクロは以下のものです。

.Nm filter
.Op Fl flag
.Ao Ar infile Ac Ao Ar outfile Ac

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

ここではコマンド 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 Ns = Ns Ar value
.Bk
.Op Ar target ...
.Ek

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

一般的な構文¶

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

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

ここでは句読点は認識されず、すべての出力は ‘.Ar’ で使用されるフォントで行われています。 句読点が空白文字で区切られている場合、

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

今度は句読点が認識され、出力はデフォルトのフォントで行われ 引数文字列とは区別されています。 句読点文字の特別な意味を取り除くには、 ‘\&’ でエスケープしてください。

troff はマクロ言語としての限界から、以下のような、数学、論理学、引用符の 集合のメンバを含んだ文字列を表現するのは困難です。

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

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

アドレス¶

アドレスマクロはアドレスの構成を識別します。

デフォルトの文字幅は 12n です。

作者名¶

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

デフォルトの文字幅は 12n です。

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

.An -nosplit

を呼び出すことで無効にできます。 それぞれの行に表示させる動作に戻したい場合は、

.An -split

と記述します。

引数¶

引数マクロ .Ar はコマンド行の引数を参照する際にはいつでも使用することができます。 引数なしで呼ばれた場合、 ‘file ...’ が出力になります。

デフォルト幅は 12n です。

コンフィギュレーション宣言 (セクション 4 のみ)¶

‘.Cd’ マクロはセクション 4 のマニュアルにおいて、デバイスインタフェースの config(8) による宣言の説明に使われます。

SYNOPSIS セクションでは ‘.Cd’ リクエストはその引数が表示される前後で改行を入れます。

デフォルト幅は 12n です。

コマンド修飾子¶

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

デフォルト幅は 10n です。

定義済みの変数¶

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

デフォルト幅は 12n です。

errno¶

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

デフォルト幅は 17n です。

環境変数¶

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

デフォルト幅は 15n です。

フラグ¶

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

引数なしで ‘.Fl’ マクロを指定すると、標準入力/標準出力を意味するダッシュとなります。 ‘.Fl’ マクロにダッシュを 1 つ与えると、2 つのダッシュとなることに 注意して下さい。

デフォルト幅は 12n です。

関数の宣言¶

‘.Fd’ マクロは SYNOPSIS セクションにおいて、セクション 2 または 3 の関数の説明で使われます。 このマクロは呼び出し不可能であり、構文解析もされせん。

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

‘.In’ (#include 文) マクロは、以上の例を短く記述したものです。 このマクロは C プログラム中でインクルードされる C ヘッダファイルを指定します。 このマクロも改行を挿入し、 呼び出し不可能であり、構文解析されることもありません。

関数の型¶

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

関数 (ライブラリルーチン)¶

‘.Fn’ マクロは ANSI C の記法を規範としています。

他のマクロを呼び出すと ‘.Fn’ 呼び出しの終了を意味することに注意してください (閉じ括弧がその箇所に挿入されます)。

多くのパラメータをとる関数 (これは滅多にないことですが) では、 ‘.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

生成結果:

SYNOPSIS セクションでは、関数は常に行の先頭から開始されます。 SYNOPSIS セクションにおいて複数の関数が示されており、関数の型が 示されない場合、改行が挿入され、現在の関数名とその前の 関数名の間に最適な改行量が設定されます。

‘.Fn’ および ‘.Fo’ のデフォルト幅の値はそれぞれ 12n と 16n です。

関数の引数¶

‘.Fa’ マクロは関数の引数 (パラメータ) を マニュアルの SYNOPSIS のセクション外で参照する場合、あるいは ‘.Fn’ の代わりに ‘.Fo’ および ‘.Fc’ 囲いマクロを使用した場合には SYNOPSIS のセクション内で参照する場合にも使われます。 ‘.Fa’ は構造体のメンバを参照する場合にも使われます。

デフォルト幅は 12n です。

戻り値¶

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

例えば、 ‘.Rv -std atexit’ は次のテキストを生成します。

-std オプションはセクション 2 と 3 のマニュアルページでのみ有効です。 現在のところ、このマクロは -std フラグなしで使用しても何も起こりません。

終了ステータス¶

‘.Ex’ マクロは DIAGNOSTICS のセクションで使うテキストを生成します。

例えば ‘.Ex -std cat’ は次のテキストを生成します。

-std オプションはセクション 1 と 6 と 8 のマニュアルページでのみ有効です。 現在のところ、このマクロは -std フラグなしで使用しても何も起こりません。

対話的なコマンド¶

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

デフォルト幅は 12n です。

ライブラリ名¶

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

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

ローカルな追加項目や OS 特有の追加項目が、ファイル mdoc.local にあるかもしれません。 ‘str-Lb-XXX’ という名前の文字列を検索してください。ここで ‘XXX’ は ‘.Lb’ マクロとともに使用されるキーワードを示しています。

リテラル¶

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

デフォルト幅は 16n です。

名称¶

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

デフォルト幅は 10n です。

オプション¶

‘.Op’ マクロはコマンド行の残りのすべての引数を オプションであることを示す角括弧で囲み、 末尾の句読点は角括弧の外に置きます。 ‘.Oo’ マクロと ‘.Oc’ マクロ (それぞれ開き角括弧と閉じ角括弧を生成します) は 複数行に渡って使うことができ、また閉じ括弧の正確な位置を 指定するのに使うことができます。

これは、 ‘.Oo’ マクロと ‘.Oc’ マクロを使った典型的な例です:

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

出力結果:

‘.Op’ マクロおよび ‘.Oo’ マクロのデフォルト幅はそれぞれ 14n と 10n です。

パス名¶

‘.Pa’ マクロはパス名もしくはファイル名を整形します。 引数なしで呼ばれた場合、 ‘~’ 文字列が出力となり、これは現在のユーザのホームディレクトリを 表しています。

デフォルト幅は 32n です。

規格¶

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

使用可能な “短縮名称/正式名称” の組は次の通りです:

ANSI/ISO C

POSIX パート 1: System API

POSIX パート 2: シェルとユーティリティ

X/Open

その他

変数の型¶

‘.Vt’ マクロは型を参照するときにはいつでも使用することができます。 SYNOPSIS セクションでは改行が挿入されます (古いスタイルの変数宣言では便利です)。

変数¶

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

デフォルト幅は 12n です。

マニュアルページのクロスリファレンス¶

‘.Xr’ マクロは最初の引数にマニュアルページの名称をとります。 オプションである第 2 引数は、文字列 (マニュアルセクションを定義します) であれば 括弧で囲われます。

デフォルト幅は 10n です。

AT&T マクロ¶

⟨バージョン⟩ には次の値をとることができます:

BSD マクロ¶

⟨バージョン⟩ が文字列 ‘BSD’ の前につきます。 ⟨リリース⟩ には次の値をとることができます:

NetBSD マクロ¶

⟨バージョン⟩ にとり得る値については前述の タイトルマクロ セクションの ‘.Os’ リクエストの説明を参照してください。

FreeBSD マクロ¶

⟨バージョン⟩ にとり得る値については前述の タイトルマクロ セクションの ‘.Os’ リクエストの説明を参照してください。

OpenBSD マクロ¶

BSD/OS マクロ¶

UNIX マクロ¶

強調マクロ¶

テキストは ‘.Em’ マクロを用いて強調することができます。 通常強調に用いられるフォントはイタリック体です。

デフォルト幅は 10n です。

フォントモード¶

‘.Bf’ フォントモードは ‘.Ef’ マクロで終了しなくてはなりません (後者のマクロは引数をとりません)。 フォントモードは別のフォントモード内に入れ子にできます。

‘.Bf’ は次の文法をもっています:

⟨フォントモード⟩ は次の 3 種類のうちのいずれかでなくてはなりません。

いずれのマクロも呼び出し不可能であり、構文解析もされません。

囲い/クォートマクロ¶

囲いの概念はクォートと似たものです。 1 つ以上の文字列が引用符や括弧のような文字のペアで囲まれている オブジェクトを指します。 クォートと囲いという用語はこの文書を通して同じ意味で使われます。 ほとんどの 1 行の囲いマクロはクォートであることをほのめかすために、 小文字の ‘q’ で終了しますが、例外もいくつかあります。 各々の囲いマクロに対し、開始マクロと終了マクロのペアもあり、 それぞれ小文字の ‘o’ と ‘c’ で終了します。

‘q’ および ‘o’ で終わるマクロはすべてデフォルト幅が 12n です。

.Eo, .Ec

これらのマクロはそれぞれ第 1 引数に囲い始めに使う文字列と 囲い終わりに使う文字列をとります。

.Es, .En

オリジナルの troff プログラムでは、引数の数が 9 つまでという 制限がありましたので、(Eo, Ec とは) 別の 2 つのマクロが 実装されています。現在は非推奨になっています。 ‘.Es’ は第 1 引数と第 2 引数に左囲い文字列および右囲い文字列を とります。この文字列は、 ‘.En’ の引数を囲うのに使用されます。 デフォルト幅は、どちらのマクロも 12n です。

.Eq

このマクロの第 1、第 2 引数はそれぞれ囲い始めに使う文字列と 囲い終わりに使う文字列であり、この文字列の後に 囲われる引数が続きます。

.Ql

クォートされたリテラルマクロは troff モードと nroff モードで 違った挙動をします。 nroff で整形された場合、 クォートされたリテラルは常にクォートされます。 troff で整形された場合、その要素の幅が固定幅文字 3 文字分の幅よりも 小さいときのみクォートされます。 これにより、リテラル (固定幅) フォントへフォントを変更すると 目立たなくなってしまうような短い文字列がより見やすくなります。

デフォルト幅は 16n です。

.Pf

プレフィックスマクロは第 1 引数と第 2 引数の間の ホワイトスペースをなくします:

.Pf ( Fa name2

(name2

デフォルト幅は 12n です。

‘.Ns’ マクロ (後述参照) は同じようにサフィックスに働きます。

.Ap

‘.Ap’ マクロはアポストロフィを追加し、特別なテキストモードから 抜けます。そして ‘.No’ モードで続けます。

クォートの例:

囲いマクロの入れ子についての良い例については、 オプションマクロ ‘.Op’ を参照してください。 このマクロは上でリストされているような囲いマクロと同じベースの上に 作られています。 ‘.Xo’ と ‘.Xc’ 拡張引数リストマクロについては後で述べます。

無操作もしくは通常テキストマクロ¶

‘.No’ マクロは、マクロコマンド行において整形されては ならない パラメータ用に使用できます。 この英単語 (マクロでなく) をパラメータとして 本当に使いたい場合は、この単語 ‘No’ に ‘\&’ を足すように注意してください。

デフォルト幅は 12n です。

空白なしマクロ¶

‘.Ns’ マクロは、現在の位置とマクロの第 1 パラメータとの間に 空白を挿入するのを抑止します。 例えば、フラグと引数の間に空白を含まない古いスタイルの 引数リストを使う場合に便利です:

注: ‘.Ns’ マクロは他のマクロ名が続かなければ、スペースを除去したあとに ‘.No’ マクロを常に起動します。 リクエストとして使用される場合 (つまり、 ‘使い方’ の行での 2 番目の形式です)、 ‘.Ns’ マクロは ‘.No’ と同一です。

セクションのクロスリファレンス¶

‘.Sx’ マクロは同一文書内でのセクションのヘッダへの参照を指定します。

デフォルト幅は 16n です。

記号¶

記号体強調マクロは、記号の意味でも伝統的な英語の 使い方においても通常はボールド体マクロとなっています。

デフォルト幅は 6n です。

数学記号¶

数学記号やそれに似たものについては、このマクロを使用して ください。

デフォルト幅は 6n です。

参考文献と引用¶

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

‘%’ で始まるマクロは呼び出し不可能ですが、 通常の方法で複数の引数をとることができます。 パラメータとしては ‘.Tn’ マクロのみ扱います。その他のマクロを使うと 奇妙な出力が得られてしまいます。 ‘.%B’ および ‘.%T’ を ‘.Rs/.Re’ 環境の外側では使用することができます。

使用例:

.Rs
.%A "Matthew Bar"
.%A "John Foo"
.%T "Implementation Notes on foobar(1)"
.%R "Technical Report ABC-DE-12-345"
.%Q "Drofnats College, Nowhere"
.%D "April 1991"
.Re

出力結果

商標名 (頭字語とタイプ名)¶

商標名マクロは、引数をより小さなフォントで出力します。 意図される使い方は、大文字の頭字語用に小さな大文字フォントを 似せて作ることです。

デフォルト幅は 10n です。

拡張引数¶

.Xo と .Xc マクロによって、 ‘.It’ マクロ (後述) についてマクロ境界での引数リストを 拡張することができます。 .Xo と .Xc マクロは囲いを開いたり閉じたりする他のすべてのマクロに 対して同じように実装されている (もちろん文字は挿入しません) ということに注意してください。 つまり、次の例もこれらのマクロには当てはまります。

次は、スペーシングをオフにするために 空白モードマクロを使った ‘.Xo’ の使用例です。

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

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

例をもうひとつ:

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

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

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

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

結果は以下の通りです。

セクションヘッダ¶

次の ‘.Sh’ セクションヘッダマクロは、すべてのマニュアルページで必須のものです。 残りのセクションヘッダはマニュアルページの作者の裁量において、 推奨されているものです。 ‘.Sh’ マクロは構文解析されますが、一般的には呼び出し不可能です。 ‘.Sh’ を呼び出すときだけは、このマクロは引数として使用することができます。 この場合、 ‘.Sh’ 用のデフォルトフォントを再度有効にします。

デフォルト幅は 8n です。

.Sh NAME

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

‘.Nd’ は全ての引数の頭に ‘-’, を印字します。

.Sh LIBRARY

このセクションは、セクション 2 および 3 の関数呼び出しの ためにあります。 このセクションには、 ‘.Lb’ マクロ呼び出し 1 つのみが含まれている必要があります。 ライブラリ名 を参照してください。

.Sh SYNOPSIS

SYNOPSIS セクションはそのマニュアルページのサブジェクトとなっている項目の 典型的な使用法を説明します。 ‘.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

.Sh DESCRIPTION

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

.Sh IMPLEMENTATION NOTES

特定の実装に関する情報はここに置く必要があります。

.Sh RETURN VALUES

セクション 2, 3, 9 の関数の戻り値はここに来る必要があります。 ‘.Rv’ を使用して、セクション 2 および 3 のライブラリ関数の RETURN VALUES セクションを生成することができます。 戻り値 の項を参照してください。

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

.Sh ENVIRONMENT

ENVIRONMENT セクションでは関連する環境変数および それらの振るまいや使用方法に関する手がかりを明らかにする 必要があります。

.Sh FILES

マニュアルページのサブジェクトによって使用されるか生成されるファイルで、 FILES セクション中でマクロ ‘.Pa’ によってリストする必要があります。

.Sh EXAMPLES

使用例を生成するにはいくつか方法があります。 詳細は後述の 使用例 セクションを参照してください。

.Sh DIAGNOSTICS

コマンドからの診断メッセージはこのセクションに置く必要があります。

.Sh COMPATIBILITY

知られている互換性の問題 (例えば、非推奨になったオプションや パラメータ) をここにリストする必要があります。

.Sh ERRORS

特定のエラーハンドリング、特にライブラリ関数 (マニュアルページのセクション 2, 3, 9) でのエラーハンドリングは ここで説明する必要があります。 ‘.Er’ マクロはエラー (errno) を指定するのに使用されます。

.Sh SEE ALSO

SEE ALSO セクションには、そのマニュアルページの題材に関する資料への参照と 他の関連するマニュアルページへのクロスリファレンスが記載されます。 クロスリファレンスは ‘.Xr’ マクロによって指定されます。 現在、 refer(1) スタイルのリファレンスには適合していません。

クロスリファレンスはセクション番号順、同一セクションにあるものは アルファベット順に並べ、カンマで区切ることを推奨します。 以下に例を示します:

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

.Sh STANDARDS

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

.Sh HISTORY

特定の規格に基づいていないコマンドは、 このセクションでその歴史の概要を説明する必要があります。

.Sh AUTHORS

クレジットはここに置く必要があります。 人物名を指定するには ‘.An’ マクロを使用する必要があります。

.Sh BUGS

あきらかな問題はここで記述します。

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

.Sh "ページ構造領域"

サブセクションヘッダ¶

サブセクションヘッダはセクションヘッダとまったく同じ文法を しています。 ‘.Ss’ は構文解析されますが、一般的に呼び出し不可能です。 このマクロは、 ‘.Ss’ の呼び出し時にのみ引数として使用できます。このとき、 ‘.Ss’ のデフォルトフォントが再度有効になります。

デフォルト幅は 8n です。

段落と行スペース¶

.Pp

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

このマクロは呼び出し不可能であり、構文解析もされません。そして 引数をとりません。別名は ‘.Lp’ です。

キープ¶

現在実装されているキープは単語に対するものだけです。 マクロは ‘.Bk’ (キープ開始) と ‘.Ek’ (キープ終了) です。 現在 ‘.Bk’ が受け付けるオプションは -words のみで (オプションを何も与えていなければこれがデフォルトでもあります) オプションの途中で改行が入らないようにするのに便利です。 make コマンド行の引数を生成する例 ( この名前には何が の項を参照) において、キープは nroff がフラグと引数を別の行に分けないように使われています。

いずれのマクロも呼び出し不可能であり、構文解析もされません。

キープマクロについてはもっと作業をする必要があります。 特に -line オプションは追加する必要があるでしょう。

例示とディスプレイ¶

ディスプレイには 7 つのタイプがあります。

.D1

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

-ldghfstru

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

.Dl

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

% ls -ldg /usr/local/bin

これは、次の指定で生成されたものです: .Dl % ls -ldg /usr/local/bin

.Bd

ディスプレイ開始。 ‘.Bd’ ディスプレイは ‘.Ed’ マクロで終了しなければなりません。 これは、次の書式をとります:

.Bd {-literal | -filled | -unfilled | -ragged | -centered} [-offset ⟨文字列⟩] [-file ⟨ファイル名⟩] [-compact]

 

-ragged

行詰めされますが、右マージンは調整しません (左マージンのみです)。

-centered

現在の左マージンと右マージン間の中央線です。 線それぞれが中央揃えになるということに注意してください。

-unfilled

行詰めしません。テキストのブロックを入力されたままの状態で 表示します。改行もユーザが指定した通りに使われます。 このため、何の警告メッセージも出さずに長過ぎる行を 生成する可能性があります。

-filled

行詰めされたブロックを表示します。 テキストブロックが整形されます (つまり、 テキストは左右どちら側にも揃えられます)。

-literal

リテラルフォント (通常固定幅) でブロックを表示します。 ソースコードや、単純にタブもしくは空白で整えられた テキストには便利です。

-file ⟨ファイル名⟩

-file フラグに続いた名前を持ったファイルが読み込まれ、 指定されたディスプレイタイプで ‘.Bd’ と ‘.Ed’ マクロで囲まれたデータよりも前に表示されます。 ファイル中の troff/-mdoc コマンドはどんなものでも処理されます。

-offset ⟨文字列⟩

-offset が以下の文字列のいずれかとともに指定されていると、 その文字列は次のテキストのブロックのインデントのレベルを示すものとして 解釈されます。

left

ブロックを現在の左マージンに揃えます。 これは ‘.Bd’ のデフォルトのモードです。

center

ブロックを中央揃えにします。 残念ながら現時点では、 単にブロックの左側を仮想的な中央マージンに揃えるだけです。

indent

デフォルトのインデント値もしくはタブの分だけインデントします。 デフォルトのインデント値は ‘.D1’ および ‘.Dl’ マクロでも使われていますので、この 2 つのディスプレイと 行が揃うことが保証されています。 インデント値は通常 6n つまり約 2/3 インチ (固定幅文字 6 つ分) です。

indent-two

デフォルトのインデント値の 2 倍分インデントします。

right

これはブロックをページの右端から約 2 インチ離して 左 揃えします。 このマクロはちゃんと動作する必要があるのですが、 troff ではまったくちゃんと動作してくれていません。

⟨文字列⟩ がそれ以外で正しい数値表現をしている場合 (‘u’ 以外のスケール指示子を伴う)、 インデント用にその値を使用します。 スケール指示子のなかで最も役に立つものは ‘m’ および ‘n’ です。これらはいわゆる Em と En square を指定します。 これは、現在のフォントでの文字 ‘m’ および文字 ‘n’ の幅とほぼ同じです ( nroff の出力については、 どちらのスケール指示子でも同じ値が得られます )。 ⟨文字列⟩ が数値表現をしていない場合、文字列は -mdoc マクロ名であるかどうか検査され、このマクロに関連する デフォルトのオフセット値が使われます。 最終的にすべてのテストが失敗した場合 the width of ⟨文字列⟩ の幅 (固定幅フォントでのタイプセット) がオフセットと見なされます。

-compact

ディスプレイを開始するときに垂直方向の空白を挿入しないようにします。

.Ed

ディスプレイの終了 (引数はとりません)。

リストとカラム¶

リスト開始マクロ ‘.Bl’ で開始できるリストには何種類かあります。 リスト中の項目は項目マクロ ‘.It’ で指定され、各リストは ‘.El’ マクロで終了しなければなりません。 リストはリスト自身やディスプレイの中で入れ子にすることができます。 リスト中でカラムを使ったり、カラムの中でリストを使ったりすることに ついては検証されていません。

さらに、タグ幅、リストのオフセット、コンパクトの度合 (項目間の空白行が許されているかどうか) のような リストの属性をいくつか指定することができます。 本ドキュメントのほとんどはタグ (-tag) スタイルリストで整形されています。

このマクロは次の文法規則を持っています:

次に、このリストタイプの詳細な解説を行います。

-bullet

ビュレットリストです。

.Bl -bullet -offset indent -compact
.It
1 つ目のビュレットはここにきます。
.It
2 つ目のビュレットはここにきます。
.El

生成結果は次の通りです:

• 1 つ目のビュレットはここにきます。
• 2 つ目のビュレットはここにきます。

-dash (または -hyphen)

ダッシュ文字によるリストです。

.Bl -dash -offset indent -compact
.It
1 つ目のダッシュはここにきます。
.It
2 つ目のダッシュはここにきます。
.El

生成結果は次の通りです:

• 1 つ目のダッシュはここにきます。
• 2 つ目のダッシュはここにきます。

-enum

箇条書きリストです。

.Bl -enum -offset indent -compact
.It
1 つ目の項目はここにきます。
.It
2 つ目の項目はここにきます。
.El

生成結果は次の通りです:

1. 1 つ目の項目はここにきます。
2. 2 つ目の項目はここにきます。

箇条書きリストを入れ子にしたい場合、 -nested フラグを使用してください (第 2 レベルのリストが開始されます):

.Bl -enum -offset indent -compact
.It
1 つ目の項目はここにきます。
.Bl -enum -nested -compact
.It
2 つ目の項目はここにきます。
.It
3 つ目の項目はここにきます。
.It
.El
.It
4 つ目の項目はここにきます。
.El

生成結果は次の通りです:

1. 1 つ目の項目はここにきます。
   1. 2 つ目の項目はここにきます。
   2. 3 つ目の項目はここにきます。
2. 4 つ目の項目はここにきます。

-item

リストの印をつけない -item タイプのリストです。

.Bl -item -offset indent
.It
1 つ目の項目はここにきます。
1 つ目の項目はここにきます。
1 つ目の項目はここにきます。
.It
2 つ目の項目はここにきます。
2 つ目の項目はここにきます。
2 つ目の項目はここにきます。
.El

生成結果は次の通りです:

• 1 つ目の項目はここにきます。 1 つ目の項目はここにきます。 1 つ目の項目はここにきます。
• 2 つ目の項目はここにきます。 2 つ目の項目はここにきます。 2 つ目の項目はここにきます。

-tag

タグつきリストです。 タグ幅を指定するには -width を使用してください。

SL

プロセスが sleep している時間 (ブロックされた秒数)

PAGEIN

そのプロセスによって、まだメモリにロードされていないページへの参照が 起こることにより生じたディスク I/O の回数

UID

数値表記によるプロセス所有者のユーザ ID

PPID

数値表記による親プロセスの ID、プロセスの優先度 (割り込み不可の待機状態のときには、正でない値になる)

元のテキストは次の通りです:

.Bl -tag -width "PPID" -compact -offset indent
.It SL
プロセスが sleep している時間 (ブロックされた秒数)
.It PAGEIN
そのプロセスによって、まだメモリにロードされていないページへの参照が
起こることにより生じたディスク
.Tn I/O
の回数
.It UID
数値表記によるプロセス所有者のユーザ ID
.It PPID
数値表記による親プロセスの ID、プロセスの優先度
(割り込み不可の待機状態のときには、正でない値になる)
.El

-diag

診断リストはセクション 4 の診断リストを生成するもので、 呼び出し可能なマクロが無視されることを除き、inset リストと似ています。 フラグ -width は、この文脈では意味がありません。

使用例:

.Bl -diag
.It ここで Sy を使うことはできません。
このメッセージはすべて出力されます。
.El

生成結果

ここで Sy を使うことはできません。

このメッセージはすべて出力されます。

-hang

ぶら下がりタグつきリストです。

Hanged

ラベル幅よりもラベルが小さい場合には ぶら下げられたラベルはタグつきリストと同じように見えます。

Longer hanged list labels

ラベル幅より長いぶら下がりリストのラベルは、 タグつき段落ラベルとは違い、段落に溶け込みます。

以上の文章を生成した、整形前のテキストは 次の通りです:

.Bl -hang -offset indent
.It Em Hanged
ラベル幅よりもラベルが小さい場合には
ぶら下げられたラベルはタグつきリストと同じようにみえます。
.It Em Longer Hanged list labels
ラベル幅より長いぶら下がりリストのラベルは、
タグつき段落ラベルとは違い、段落に溶け込みます。
.El

-ohang

オーバハングタグ (overhanging tags) を用いたリストは 項目に対してインデントを使いません。 タグは別の行に出力されます。

SL

プロセスが sleep している時間 (ブロックされた秒数)

PAGEIN

そのプロセスによって、まだメモリにロードされていないページへの参照が 起こることで生じたディスク I/O の回数

UID

数値表記によるプロセス所有者のユーザ ID

PPID

数値表記による親プロセスの ID、プロセスの優先度 (割り込み不可の待機状態のときには、正でない値になる)

元のテキストは次の通りです:

.Bl -ohang -offset indent
.It Sy SL
プロセスが sleep している時間 (ブロックされた秒数)
.It Sy PAGEIN
そのプロセスによって、まだメモリにロードされていないページへの参照が
起こることで生じたディスク
.Tn I/O
の回数
.It Sy UID
数値表記によるプロセス所有者のユーザ ID
.It Sy PPID
数値表記による親プロセスの ID、プロセスの優先度
(割り込み不可の待機状態のときには、正でない値になる)
.El

-inset

次は、inset ラベルの例です:

tag

タグリスト (タグ段落とも呼びます) は バークレーのマニュアルで使われている最も一般的な 種類のリストです。 後で述べるように、 -width 属性を使用してください。

diag

診断リストはセクション 4 の診断リストを生成し、 呼び出し可能なマクロを無視するという点を除けば inset リストと似ています。

hang

ぶら下がりラベルは気分の問題です。

ohang

オーバハングラベルは空白に制限がある場合には良いです。

inset

inset ラベルは段落ブロックを制御するのに便利で、 -mdoc マニュアルを別のフォーマットに変換するのに有用です。

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

.Bl -inset -offset indent
.It Em tag
タグリスト (タグ段落とも呼びます) は
バークレーのマニュアルで使われている最も一般的な
種類のリストです。
後で述べるように、
.Fl width
属性を使用してください。
.It Em diag
診断リストはセクション 4 の診断リストを生成し、
呼び出し可能なマクロを無視するという点を除けば
inset リストと似ています。
.It Em hang
ぶら下がりラベルは気分の問題です。
.It Em ohang
オーバハングラベルは空白に制限がある場合には良いです。
.It Em inset
inset ラベルは段落ブロックを制御するのに便利で、
.Nm -mdoc
マニュアルを別のフォーマットに変換するのに有用です。
.El

-column

この種類のリストは複数カラムを生成します。 カラムの数および各カラムの幅は -column リストへの引数、 ⟨string1⟩, ⟨string2⟩ 等によって決定されます。 ⟨stringN⟩ が ‘.’ (ドット) で開始し直後に有効な -mdoc マクロ名が続く場合、 ⟨stringN⟩ を解釈して結果の幅を使用します。 そうでない場合、 ⟨stringN⟩ (固定幅フォントでのタイプセット) は N 番目の桁の幅になります。

‘.It’ 引数はそれぞれ構文解析され行を生成します。 行中の各列はタブや ‘.Ta’ マクロで分けられた引数です。

次の表、

文字列	nroff	troff
<=	<=	≤
>=	>=	≥

は次のようにして生成されています:

.Bl -column -offset indent ".Sy 文字列" ".Sy nroff" ".Sy troff"
.It Sy 文字列 Ta Sy nroff Ta Sy troff
.It Li <= Ta <= Ta \*(<=
.It Li >= Ta >= Ta \*(>=
.El

その他のキーワード:

-width ⟨文字列⟩

⟨文字列⟩ が ‘.’ (ドット) で開始し直後に有効な -mdoc マクロ名が続く場合、 ⟨文字列⟩ を解釈し、その結果の幅を使います。 本ドキュメントのほとんどすべてのリストは このオプションを使用しています。

使用例:

.Bl -tag -width ".Fl test Ao Ar 文字列 Ac"
.It Fl test Ao Ar 文字列 Ac
これは、
.Fl width
フラグをタグリストと一緒に使うとどのように
働くかを見るためのもっと長い文です。
.El

生成結果:

-test ⟨文字列⟩

これは、 -width フラグをタグリストと一緒に使うとどのように 働くかを見るためのもっと長い文です。

⟨文字列⟩ が解釈される前に現在の -mdoc の状態が保存されることに注意してください。 文字列が解釈された後ですべての変数が再度復元されます。 しかし、ボックス (囲いに使用される) は GNU troff(1) では保存されません。結果としては、醜いエラーを防ぐためには 引数は常に 平衡がとれて いなくてはなりません。 例えば、本当に開き山括弧だけが必要である場合には ‘.Ao Ar 文字列’ と書いてはだめで、代わりに ‘.Ao Ar 文字列 Xc’ と書かなくてはなりません。

そうでない場合、 ⟨文字列⟩ が正当な数値表現である場合 (‘u’ 以外のスケール指示子を伴う)、 インデント用にその値を使用します。 最も有用なスケール指示子は ‘m’ と ‘n’ です。これらはいわゆる Em および En square を指定します。 これは、現在のフォントでの文字 ‘m’ および文字 ‘n’ の幅とほぼ同じです (nroff の出力については、 どちらのスケール指示子でも同じ値が得られます)。 ⟨文字列⟩ が数値表現をしていない場合、文字列は -mdoc マクロ名であるかどうか検査され、このマクロに関連する デフォルトのオフセット値が使われます。 最終的にすべてのテストが失敗した場合 ⟨文字列⟩ の幅 (固定幅フォントでのタイプセット) がオフセットと見なされます。

タグリストタイプ用に幅が指定されていない場合、 ‘.It’ が起動される度に適切な幅を決定しようと試みます。 ‘.It’ の第 1 引数が呼び出し可能なマクロである場合、 そのマクロのデフォルト幅が使われます。 そうでなければ、 ‘.No’ のデフォルト幅が使われます。

-offset ⟨文字列⟩

⟨文字列⟩ が indent である場合、デフォルトのインデント値 (通常 6n に設定されており、 ‘.Dl’ または ‘.Bd’ で使われる値と似ています) が使われます。 ⟨文字列⟩ が正当な数値表現である場合 (‘u’ 以外のスケール指示子を伴う )、 その値をインデントに使用します。 最も有用なスケール指示子は ‘m’ と ‘n’ であり、これらはいわゆる Em および En square です。 これは、それぞれ現在のフォントでの ‘m’ と ‘n’ の幅とほぼ同じです (nroff の出力については、 どちらのスケール指示子も同じ値をとります)。 ⟨文字列⟩ が数値表現でない場合、その文字列が -mdoc のマクロ名であるかどうか検査され、このマクロに関連する デフォルトのオフセット値が使われます。 最終的にすべてのテストが失敗した場合、 ⟨文字列⟩ の幅 (固定幅フォントでのタイプセット) がオフセットとして とられます。

-compact

リストの前およびリスト項目間に垂直方向の空白を挿入しないように します。