GROFF_MDOC

名称

書式

解説

UNIX マニュアルページ全体を通して、マニュアルのエントリは単純に マニュアルページ (a man page) とみなされます。 これは実際のページ数と関係ありませんし、性差別をする意図もありません。  

さあ、始めよう

1. TROFF に特有な表現

   "マクロの使用方法"

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

   "行末の空白文字"

   "特殊文字のエスケープ"

   "その他の注意点"

2. マニュアルページのテンプレート
3. 使用法
4. タイトルマクロ
5. マニュアル領域および一般テキスト領域の紹介

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

   "一般的な構文"

6. マニュアル領域

   "アドレス"

   "作者名"

   "引数"

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

   "コマンド修飾子"

   "定義済みの変数"

   "errno (セクション 2 のみ)"

   "環境変数"

   "フラグ"

   "関数の宣言"

   "関数の型"

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

   "関数の引数"

   "戻り値"

   "終了ステータス"

   "対話的なコマンド"

   "ライブラリ名"

   "リテラル"

   "名称"

   "オプション"

   "パス名"

   "標準"

   "変数の型"

   "変数"

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

7. 一般テキスト領域

   "AT&T マクロ"

   "BSD マクロ"

   "NetBSD マクロ"

   "FreeBSD マクロ"

   "OpenBSD マクロ"

   "BSD/OS マクロ"

   "UNIX マクロ"

   "強調マクロ"

   "フォントモード"

   "囲い/クォート マクロ"

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

   "空白なしマクロ"

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

   "記号"

   "数式記号"

   "参考文献と引用"

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

   "拡張引数"

8. ページ構造領域

   "セクションヘッダ"

   "サブセクションヘッダ"

   "段落と行スペース"

   "キープ"

   "例示とディスプレイ"

   "リストとカラム"

9. その他のマクロ
10. 定義済みの文字列
11. 診断
12. GROFF, TROFF および NROFF を使用した整形
13. 関連ファイル
14. 関連項目
15. バグ

TROFF に特有な表現

マクロの使用方法

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

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

[-s bytes ]

は `.[-s ] ' Ar bytes で生成されます。

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

[-s bytes ]

は `.[\&-s ] ' \&Ar bytes で生成されます。

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

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

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

を使うことがあります (これは、 GNU troff(1) 拡張です)。 2 つ目の方法は、文字列をダブルクォートで括ることです。

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

Fn fetch char *str

は `.Fn fetch ' char\ *str で生成されます。

Fn fetch char *str

も `.Fn fetch ' "char *str" で生成することができます。

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

Fn fetch char *str

となります。  

行末の空白文字

特殊文字のエスケープ

その他の注意点

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

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

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

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

は、

The `.' character.

The `.' character.

test test

test. test

となります。

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

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

マニュアルページのテンプレート

.\" 以下の項目はすべてのマニュアルページで必要な項目です。
.Dd 月 日, 年
.Os [オペレーティングシステム] [バージョン/リリース]
.Dt ドキュメントタイトル [セクション番号] [アーキテクチャ/ボリューム]
.Sh NAME
.Nm 名称
.Nd 名称についての 1 行での説明
.\" 次の項目はセクション 2, 3 でのみ必要なものです。
.\" .Sh LIBRARY
.Sh SYNOPSIS
.Sh DESCRIPTION
.\" 以下の項目については、必要に応じてコメントをはずして使用してく
.\" ださい。
.\" .Sh IMPLEMENTATION NOTES
.\" この次の項目はセクション 2, 3, 9 でのみ必要な、関数の
.\" 戻り値です。
.\" .Sh RETURN VALUES
.\" 次の項目はセクション 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

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

テンプレート中の残りの項目はセクションのヘッダ ( . 

)

使用法

と一緒に) 中括弧 ({}) を用い、値の組を括ります。 メタ変数は山括弧 (<>) の中で指定されます。

例:

.Xx Aq foo Br q bar1 | bar2 [-test1 [-test2 | -test3] ] ...

とくに明示しない限り、すべてのマクロは 構文解析され、呼び出し可能なものです。

大部分のマクロはデフォルトの幅の値を持っており、これを `.

' および `. ' マクロ用にラベル

width ( -width あるいは offset ( -offset を指定するのに使用することができます。 -mdoc パッケージのローカルな変更に依存することのないように、 このとても曖昧な機能は使わないことを推奨します。

タイトルマクロ

.

[Aq ドキュメントタイトル ] [Aq セクション番号 ] [Aq ボリューム ] ドキュメントタイトルはマニュアルページの主題であり、 troff の制限により 大文字 でなければいけません。 省略された場合、 `UNTITLED ' が使われます。 セクション番号は 1,~ ... ,~9 の範囲の番号もしくは `unass' , `draft' , `paper' のいずれかを取ることができます。 セクション番号が指定されており、ボリューム名が与えられていない 場合には、デフォルトのボリューム名が使用されます。

では、次のセクションが定義されています:

1 Ta

2 Ta

3 Ta

4 Ta

5 Ta

6 Ta

7 Ta

8 Ta

9 Ta

ボリューム名は任意であるか、もしくは次のものを 取ることができます:

USD Ta

PS1 Ta

AMD Ta

SMM Ta

URM Ta

PRM Ta

KM Ta

IND Ta

LOCAL Ta

CON Ta

互換性を保つため、 `IND' の代わりに `MMI' を使用することができ、 `LOCAL' の代わりに `LOC' を使用できます。 先の表の値は、新しいボリューム名を指定します。 第 3 パラメータがコンピュータアーキテクチャを表すキーワードで ある場合、その値は第 2 パラメータで指定したようにボリューム名に 追加されます。デフォルトでは次のアーキテクチャに関するキーワードが 定義されています: # we use `No' to avoid hyphenation

alpha , amiga , arc , arm26 , arm32 , atari , bebox , cobalt , evbsh3 hp300 , hpcmips , i386 , luna68k , m68k , mac68k , macppc , mips mmeye , mvme68k , news68k , newsmips , next68k , ofppc , pc532 , pmax powerpc , prep , sgimips , sh3 , sparc , sparc64 , sun3 , tahoe , vax x68k

次の例では、マニュアルページのヘッダの左側 (これは右側と同じものです) と 中央に書かれる文字列を示しています。

.

`FOO(7)' `System' Reference Manual

.

`FOO(2)' `System' Programmer's Manual (mac68k Architecture)

.

`FOO' `bar'

ローカルな追加項目や OS に特化した追加項目が、ファイル mdoc.local にあるかもしれません。このファイル中で `volume-ds-XXX' (前者のタイプについて) および `volume-as-XXX' (後者のタイプについて) という名前の文字列を検索してください。ここで `XXX' は `. ' マクロで使用されるキーワードを表しています。

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

. [Aq オペレーティングシステム ] [Aq リリース番号 ]

第 1 パラメータが空の場合、 デフォルト値 ` ' が使用されます。 これは、ローカルの設定ファイル mdoc.local で上書きできます。一般的には、 オペレーティングシステムの名称には一般的な頭字語 (略称) を 使わなければなりません。 例えば BSD や ATT といったものです。 リリース番号は、各システムでの標準のリリースの命名法を使用します。 次の表では、いくつか事前に定義されているオペレーティングシステムに 対して取り得る第 2 引数をリストしています。 `. ' と同じように、ローカルな追加項目が mdoc.local に定義されているかもしれません。このファイル中で `operating-system-XXX-YYY' という名前の文字列を検索してください。ここで `XXX' はオペレーティングシステムの頭字語 (略称) そして `YYY' がリリース ID です。

ATT

7th, 7, III, 3, V, V.2, V.3, V.4

BSD

3, 4, 4.1, 4.2, 4.3, 4.3t, 4.3T, 4.3r, 4.3R, 4.4

NetBSD

0.8, 0.8a, 0.9, 0.9a, 1.0, 1.0a, 1.1, 1.2, 1.2a, 1.2b, 1.2c, 1.2d, 1.2e, 1.3, 1.3a, 1.4, 1.5

FreeBSD

1.0, 1.1, 1.1.5, 1.1.5.1, 2.0, 2.0.5, 2.1, 2.1.5, 2.1.6, 2.1.7, 2.2, 2.2.1, 2.2.2, 2.2.5, 2.2.6, 2.2.7, 2.2.8, 3.0, 3.1, 3.2, 3.3, 3.4, 3.5, 4.0, 4.1, 4.2, 5.0

ATT に関しては、判別できない第 2 パラメータがある時には それを文字列 UNIX に置き換えます。事前に定義されているその他の頭字語 (略称) に ついては、そのようなパラメータは無視され、警告メッセージが 出力されます。 認識できない引数は、ページフッタ中に記述された通りに 表示されます。例えば、典型的なフッタは次のようになるでしょう:

.BSD 4.3

は `4.3~Berkeley' Distribution となります。また、ローカルで作られたセットの例では、

.CS Department

は `CS~Department' となります。

`.マクロがない場合、ページの左下隅は見苦しくなってしまうでしょう。 '

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

.[Aq 月

Aq 日 , Aq 年 ] `に引数がない場合は、日付には ' `基準時点' (協定世界時 1970年1月1日 00:00:00) が使用されます。 ちょうど 3 つ引数がある場合には、それらは連結され、 分割できない空白で分けられたものになります。

.January 25, 2001

それ以外の場合は現在の日付が使用され、パラメータは無視されます。

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

マニュアル領域および一般テキスト領域の紹介

この名前には何が ...

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

.Xx argument1 argument2 ...

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

filter [-flag ] Ao Ar infile Ac Ao Ar outfile Ac

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

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

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

make

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

ここではコマンド make について記述しており、 makefile をフラグ -f の引数としています。 またオプションのファイルオペランドである target についても言及しています。 言葉での説明では、こういった詳細な記述が混乱を防いでくれますが、 -mdoc パッケージにはフラグ への 引数のためのマクロがありません。 その代わりに target のようなオペランドやファイル引数に使われる引数マクロ `file ... ' が 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

マクロ `. ' および `. ' は Sx キープ セクションにおいて解説されています。  

一般的な構文

.sptr, ptr),

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

sptr, ptr),

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

.sptr , ptr ) ,

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

sptr , ptr

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

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

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

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

マニュアル領域

アドレス

使い方: .Ao アドレス Ac ...

.addr1

addr1

.addr1 .

addr1

.addr1 , file2

addr1 , file2

.f1 , f2 , f3 :

f1 , f2 , f3

.addr ) ) ,

addr ) )

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

作者名

使い方: .An Ao 作者名 Ac ...

.An "Joe Author"

An Joe Author

.An "Joe Author" ,

An Joe Author ,

.An "Joe Author" Aq nobody@FreeBSD.org

An Joe Author Aq nobody@FreeBSD.org

.An "Joe Author" ) ) ,

An Joe Author ) ) ,

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

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

.An -nosplit

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

.An -split

と記述します。  

引数

使い方: .[Ao 引数 Ac ...]

.file ...

file ...

.file1

file1

.file1 .

file1

.file1 file2

file1 file2

.f1 f2 f3 :

f1 f2 f3

.file ) ) ,

file ) )

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

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

使い方: .Ao 引数 Ac ...

."device le0 at scode?"

device le0 at scode?

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

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

コマンド修飾子

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

定義済みの変数

使い方: .Ao 定義済みの変数 Ac ...

.MAXHOSTNAMELEN

MAXHOSTNAMELEN

.TIOCGPGRP )

TIOCGPGRP

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

errno

使い方: .Er Ao errno のタイプ Ac ...

.Er ENOENT

Er ENOENT

.Er ENOENT ) ;

Er ENOENT ) ;

.Bq Er ENOTDIR

Bq Er ENOTDIR

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

環境変数

使い方: .Ao 引数 Ac ...

.DISPLAY

DISPLAY

.PATH .

PATH

.PRINTER ) ) ,

PRINTER ) )

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

フラグ

使い方: .-Ao 引数 Ac ...

.-

-

.-cfv

-cfv

.-cfv .

-cfv

.cfv .

cfv

.-s v t

-s v t

.-- ,

--

.-xyz ) ,

-xyz )

.-|

-|

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

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

関数の宣言

使い方: .Fd Ao 引数 Ac ...

.Fd "#include <sys/types.h>"

Fd #include <sys/types.h>

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

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

使い方: .In Ao ヘッダファイル Ac

.In stdio.h

In stdio.h

関数の型

使い方: .Ft Ao 型 Ac ...

.Ft struct stat

Ft struct stat

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

使い方: .Fn Ao 関数 Ac [Ao パラメータ Ac ...]

.Fn getchar

Fn getchar

.Fn strlen ) ,

Fn strlen ) ,

.Fn align "char *ptr" ,

Fn align char *ptr ,

他のマクロを呼び出すと `.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

生成結果:

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

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

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

関数の引数

使い方: .Fa Ao 関数の引数 Ac ...

.Fa d_namlen ) ) ,

Fa d_namlen ) ) ,

.Fa iov_len

Fa iov_len

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

戻り値

使い方: .Rv [-std [Ao 関数 Ac ... ] ]

例えば、 `.Rv -std ' atexit は次のテキストを生成します。 # a small hack to suppress a warning message Rv -std atexit

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

終了ステータス

使い方: .Ex [-std [Ao ユーティリティ Ac ... ] ]

例えば `.Ex -std ' cat は次のテキストを生成します。 # a small hack to suppress a warning message Ex -std cat

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

対話的なコマンド

使い方: .Ao 引数 Ac ...

.:wq

:wq

."do while {...}"

do while {...}

.setenv , unsetenv

setenv , unsetenv

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

ライブラリ名

使い方: .Lb Ao 引数 Ac ...

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

libarm32

Lb libarm32

libc

Lb libc

libcompat

Lb libcompat

libcrypt

Lb libcrypt

libcurses

Lb libcurses

libedit

Lb libedit

libi386

Lb libi386

libipsec

Lb libipsec

libkvm

Lb libkvm

libm

Lb libm

libmenu

Lb libmenu

libossaudio

Lb libossaudio

libposix

Lb libposix

libresolv

Lb libresolv

libtermcap

Lb libtermcap

libutil

Lb libutil

libz

Lb libz

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

リテラル

使い方: .Ao 引数 Ac ...

.\en

\n

.M1 M2 M3 ;

M1 M2 M3

.cntrl-D ) ,

cntrl-D )

.1024 ...

1024 ...

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

名称

使い方: .[Ao 引数 Ac ...]

.groff_mdoc

groff_mdoc

.\-mdoc

-mdoc

.foo ) ) ,

foo ) )

.:

groff_mdoc:

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

オプション

使い方: .[[Ao オプション Ac ...] ]

.[[

.[-k ]

] ]

[-k ]

.[-k ) . ]

[-k ]

.[-k kookfile ]

[-k kookfile ]

.[-k kookfile , ]

[-k kookfile ]

.[objfil [corfil ] ]

[objfil [corfil ] ]

.[-c objfil [corfil , ] ]

[-c objfil [corfil ] ]

.[word1 word2]

[word1 word2]

..[[Ao option Ac ...] ]

.[[Ao options Ac ...] ]

これは、 `.[マクロと ' `.] ' マクロを使った典型的な例です:

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

出力結果:

[[-k kilobytes ] [-i interval ] [-c count ] ]

`.[マクロおよび] ' `.[マクロのデフォルト幅はそれぞれ ' 14n と 10n です。  

パス名

使い方: .[Ao パス名 Ac ...]

.

./usr/share

/usr/share

./tmp/fooXXXXX ) .

/tmp/fooXXXXX )

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

規格

使い方: .St Ao 短縮名称 Ac ...

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

ANSI/ISO C

-ansiC

St -ansiC

-ansiC-89

St -ansiC-89

-isoC

St -isoC

-isoC-99

St -isoC-99

POSIX パート 1: System API

-iso9945-1-90

St -iso9945-1-90

-iso9945-1-96

St -iso9945-1-96

-p1003.1

St -p1003.1

-p1003.1-88

St -p1003.1-88

-p1003.1-90

St -p1003.1-90

-p1003.1-96

St -p1003.1-96

-p1003.1b-93

St -p1003.1b-93

-p1003.1c-95

St -p1003.1c-95

-p1003.1g-2000

St -p1003.1g-2000

-p1003.1i-95

St -p1003.1i-95

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

-iso9945-2-93

St -iso9945-2-93

-p1003.2

St -p1003.2

-p1003.2-92

St -p1003.2-92

-p1003.2a-92

St -p1003.2a-92

X/Open

-susv2

St -susv2

-svid4

St -svid4

-xbd5

St -xbd5

-xcu5

St -xcu5

-xcurses4.2

St -xcurses4.2

-xns5

St -xns5

-xns5.2

St -xns5.2

-xpg3

St -xpg3

-xpg4

St -xpg4

-xpg4.2

St -xpg4.2

-xsh5

St -xsh5

その他

-ieee754

St -ieee754

-iso8802-3

St -iso8802-3

変数の型

使い方: .Vt Ao 型 Ac ...

.Vt extern char *optarg ;

Vt extern char *optarg ;

.Vt FILE *

Vt FILE *

変数

使い方: .Ao 変数 Ac ...

.count

count

.settimer ,

settimer

."int *prt" ) :

int *prt )

."char s" ] ) ) ,

char s ] ) )

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

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

使い方: .Aoマニュアルページの名称AcOoAoセクションAcOc...

.mdoc

mdoc

.mdoc,

mdoc,

.mdoc(7)

mdoc(7)

.xinit(1x);

xinit(1x);

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

一般テキスト領域

AT&T マクロ

使い方: .AT&T System [Ao バージョン Ac ...]

.AT&T System

AT&T System

.AT&T System v6 .

AT&T System v6 .

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

32v, v1, v2, v3, v4, v5, v6, v7, V, V.1, V.2, V.3, V.4

BSD マクロ

"使い方: .Bx" Bro -alpha | -beta | -devel Brc ...

" .Bx" [Ao バージョン Ac [Ao リリース Ac ...] ]

.BSD BSD

.BSD 4.3 .

BSD 4.3

.BSD -devel

BSD -devel

Ao バージョン Ac が文字列 `BSD の前につきます。 ' Ao リリース Ac には次の値をとることができます:

Reno, reno, Tahoe, tahoe, Lite, lite, Lite2, lite2

NetBSD マクロ

使い方: .Nx [Ao バージョン Ac ...]

.Nx Nx

.Nx 1.4 .

Nx 1.4 .

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

FreeBSD マクロ

使い方: .Fx [Ao バージョン Ac ...]

.Fx Fx

.Fx 2.2 .

Fx 2.2 .

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

OpenBSD マクロ

使い方: .Ox [Ao バージョン Ac ...]

.Ox 1.0

Ox 1.0

BSD/OS マクロ

使い方: .Bsx [Ao バージョン Ac ...]

.Bsx 1.0

Bs x 1.0

UNIX マクロ

使い方: .UNIX

.UNIX

UNIX

強調マクロ

使い方: .Ao 引数 Ac ...

.does not

does not

.exceed 1024 .

exceed 1024

.vide infra ) ) ,

vide infra ) )

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

フォントモード

`.Bf は次の文法をもっています: '

.Bf Ao フォントモード Ac

| -emphasis

`.マクロがテキストのブロック全体に対して使用された場合と ' 同じになります。

| -literal

`.マクロがテキストのブロック全体に対して使用された場合と ' 同じになります。

| -symbolic

`.マクロがテキストのブロック全体に対して使用された場合と ' 同じになります。

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

囲い/クォートマクロ

# XXX

クォート Ta 開始 Ta 終了 Ta 機能 Ta 結果 .Aq Ta .Ao Ta .Ac Ta 山括弧による囲い Ta Ao string Ac .Bq Ta .Bo Ta .Bc Ta 角括弧による囲い Ta Bo string Bc .Brq Ta .Bro Ta .Brc Ta 中括弧による囲い Ta Bro string Brc .``Ta .Do Ta .Dc Ta 2 重引用符 Ta Do string Dc .Eq Ta .Eo Ta .Ec Ta 囲い文字列 (XX による) Ta XXstringXX '' .(Ta .Po Ta .Pc Ta 括弧による囲い Ta Po string Pc .`Ta Ta Ta クォートされたリテラル ' )
 Ta So string Sc もしくは Li string .Qq Ta .Qo Ta .Qc Ta まっすぐな 2 重引用符 Ta Qo string Qc .`Ta .So Ta .Sc Ta 1 重引用符 Ta So string Sc

'

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

.Eo , .Ec これらのマクロはそれぞれ第 1 引数に囲い始めに使う文字列と

囲い終わりに使う文字列をとります。

.Es , .En オリジナルの troff プログラムでは、引数の数が 9 つまでという

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

.Eq このマクロの第 1、第 2 引数はそれぞれ囲い始めに使う文字列と

囲い終わりに使う文字列であり、この文字列の後に 囲われる引数が続きます。

.`クォートされたリテラルマクロは'

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

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

.プレフィックスマクロは第 1 引数と第 2 引数の間の

ホワイトスペースをなくします:

.( Fa name2

( Fa name2

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

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

.Ap `.Ap マクロはアポストロフィを追加し、特別なテキストモードから '

抜けます。そして `.モードで続けます。 '

クォートの例:

.Aq Aq

.Aq ctype.h ) ,

Aq Pa ctype.h ) ,

.Bq Bq

.Bq Greek , French .

Bq Em Greek , French .

.````

.``string abc .''

'' ''

``string abc''

.``'^[A-Z]'''

``'^[A-Z]'''

.`man'

mdoc `man' mdoc

.Qq Qq

.Qq string ) ,

Qq string ) ,

.Qq string ),

Qq string Ns ),

.``

.`string'

' '

`string'

.or Ap ing

or Ap ing

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

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

使い方: .Ao 引数 Ac ...

.test Ta with Ta tabs

test Ta with Ta tabs

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

空白なしマクロ

"使い方:" ... Ao 引数 Ac [Ao 引数 Ac ...]

" " .Ao 引数 Ac ...

.[-I directory ]

[-I directory ]

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

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

使い方: .Sx Ao セクションの参照 Ac ...

.Sx FILES

Sx FILES

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

記号

使い方: .Ao 記号 Ac ...

.Important Notice

Important Notice

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

数学記号

使い方: .Ao 数学記号 Ac ...

.sigma

sigma

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

参考文献と引用

.

参考文献の開始 (引数はとりません)。 Sx SEE ALSO セクションでは改行を挿入し、参考文献の終了マクロが 読み込まれるまで参考文献の情報を収集します。 Li .Re 参考文献の終了 (引数はとりません)。 参考文献が表示されます。 Li .%A 参考文献の作者名。1 回の呼び出しにつき、作者名をひとつ指定します。 Li .%B 書籍のタイトル。 Li .%C 市 / 場所 (まだ実装されていません)。 Li .%D 日付。 Li .%I 発行者/出版社名。 Li .%J 定期刊行物の名称。 Li .%N 発行番号。 Li .%O 追加情報。 Li .%P ページ番号。 Li .%Q 組織内部、あるいは外部の著者。 Li .%R 報告書の名称。 Li .%T 記事のタイトル。 Li .%V 巻数。

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

使用例:

.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

出力結果

"Matthew Bar" "John Foo" "Implementation Notes on foobar(1)" "Technical Report ABC-DE-12-345" "Drofnats College, Nowhere" "April 1991"

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

使い方: .Ao シンボル Ac ...

.DEC

DEC

.ASCII

ASCII

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

拡張引数

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

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

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

I operation \n count \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 ]

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

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

結果は以下の通りです。

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

]

ページ構造領域

セクションヘッダ

セクションヘッダマクロは、すべてのマニュアルページで必須のものです。

マクロは構文解析されますが、一般的には呼び出し不可能です。

を呼び出すときだけは、このマクロは引数として使用することができます。

用のデフォルトフォントを再度有効にします。

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

.

NAME

.Sh "ページ構造領域"