MDOC.SAMPLES

名称

書式

解説

マニュアルのエントリは、実際の長さに関わらず、 また男女の区別をするような意図なしで、 UNIX のマニュアルページを通して、単純に man ページとして参照されています。  

さあ、始めよう

1. TROFF に特有な表現

   "マクロの使用方法"

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

   "行末の空白文字 (警告)"

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

2. MAN ページの分析

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

3. タイトルマクロ
4. マニュアル領域および一般テキスト領域の紹介

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

   "一般的な構文"

5. マニュアル領域

   "アドレス"

   "作者名"

   "引数"

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

   "コマンド修飾子"

   "定義済みの変数"

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

   "環境変数"

   "関数の引数"

   "関数の宣言"

   "フラグ"

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

   "関数の型"

   "ライブラリ名"

   "対話的なコマンド"

   "名称"

   "オプション"

   "パス名"

   "標準"

   "変数"

   "クロスリファレンス"

6. 一般テキスト領域

   "AT&T マクロ"

   "BSD マクロ"

   "FreeBSD/NetBSD/OpenBSD マクロ"

   "UNIX マクロ"

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

   "カギ括弧 <> によるクォート/囲い"

   "角括弧 [] によるクォート/囲い"

   "二重引用符マクロ/囲い"

   "括弧 () によるクォート/囲い"

   "一重引用符によるクォート/囲い"

   "プレフィックスマクロ"

   "no-op もしくは通常テキストマクロ"

   "空白なしマクロ"

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

   "参考文献と引用"

   "戻り値 (セクション 2 および 3 のみ)"

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

   "拡張引数"

7. ページ構造領域

   "セクションヘッダ"

   "段落と行スペース"

   "キープ"

   "例示とディスプレイ"

   "フォントモード (強調、リテラル、およびシンボリック)"

   "リストと列"

8. 定義済みの文字列
9. 診断
10. GROFF、TROFF、および NROFF を使用したフォーマッティング
11. バグ

TROFF に特有な表現

マクロの使用方法

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

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

[-s bytes ]

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

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

[-s bytes ]

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

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

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

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

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

Sx SYNOPSIS )

リスト開始 (幅指定用)

テキスト強調

Fn 関数 (セクション 2 と 4)

リストの項目

リテラルテキスト

シンボリックテキスト

%B

書籍のタイトル

%J

定期刊行物のタイトル

%O

参照の追加的な注釈

%R

報告書のタイトル (参照の中で)

%T

書籍もしくは定期刊行物の中の記事のタイトル

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

Fn fetch char *str

は `.Fn fetch ' char\ *str によって生成される

Fn fetch char *str

は `.Fn fetch ' \*qchar *str\*q でも生成される

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

Fn fetch char *str

となります。

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

行末の空白文字

特殊文字のエスケープ

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

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

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

であり、それらのうち

タイトルマクロ

.

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

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

1      FreeBSD General Commands Manual

2    FreeBSD System Calls Manaul

3        FreeBSD Library Calls Manual

4FreeBSD Kernel Interfaces Manual

5FreeBSD File Formats Manual

6FreeBSD Games Manual

7FreeBSD Miscellaneous Information Manual

8FreeBSD System Manager's Manual

9FreeBSD Kernel Developers Guide

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

AMD    UNIX Ancestral Manual Documents

SMM  UNIX System Manager's Manual

URM     UNIX Reference Manual

PRMUNIX Programmer's Manual

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

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

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

.4.3BSD

や

.FreeBSD 2.2

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

.CS Department

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

.月 日, 年

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

January 25, 1989

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

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

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

.Va argument1 argument2 ... argument9

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

filter [-flag ] infile outfile

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

.Nm filter
.Op Fl flag
.Ar infile outfile

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

make

[-eiknqrstv ] [-D variable ] [-d flags ] [-f makefile ] -words [-I directory ] [-j max_jobs ] [variable=value ] -words [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=value
.Bk -words
.Op Ar target ...
.Ek

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

一般的な構文

.sptr, ptr),

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

sptr, ptr),

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

.sptr , ptr ) ,

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

sptr , ptr

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

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

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

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

マニュアル領域

アドレスマクロ

使い方: .address ...

.addr1

addr1

.addr1

addr1

.addr1 , file2

addr1 , file2

.f1 , f2 , f3:

f1 , f2 , f3

.addr ) ),

addr ) )

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

作者名

使い方: .An author_name

.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 ) ) ,

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

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

.An -nosplit

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

.An -split

引数マクロ

使い方: .argument ...

.file ...

file ...

.file1

file1

.file1

file1

.file1 file2

file1 file2

.f1 f2 f3:

f1 f2 f3

.file ) ),

file ) )

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

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

device le0 at scode?

は `.device ' le0 at scode? によって生成されます。

コマンド修飾子

定義済みの変数

使い方: .defined_variable ...

.MAXHOSTNAMELEN

MAXHOSTNAMELEN

.TIOCGPGRP )

TIOCGPGRP

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

errno (セクション 2 のみ)

使い方: .Er ERRNOTYPE ...

.Er ENOENT

Er ENOENT

.Er ENOENT );

Er ENOENT ) ;

.Bq Er ENOTDIR

Bq Er ENOTDIR

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

環境変数

使い方: .argument ...

.DISPLAY

DISPLAY

.PATH

PATH

.PRINTER ) ),

PRINTER ) )

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

関数の引数

使い方: .Fa function_argument ...

.Fa d_namlen ) ),

Fa d_namlen ) ) ,

.Fa iov_len

Fa iov_len

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

関数の宣言

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

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

フラグ

使い方: .-argument ...

.-

-

.-cfv

-cfv

.-cfv

-cfv

.-s v t

-s v t

.--,

--

.-xyz ),

-xyz )

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

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

使い方: .Fn [type] function [[type] parameters ... ]

.Fn getchar

Fn getchar

.Fn strlen ) ,

Fn strlen ) ,

.Fn \*qint align\*q \*qconst * char *sptrs\*q

Fn 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

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

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

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

関数の型

使い方: .Ft type ...

.Ft struct stat

Ft struct stat

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

対話的なコマンド

使い方: .argument ...

.:wq

:wq

.do while {...}

do while {...}

.setenv , unsetenv

setenv , unsetenv

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

ライブラリ名

使い方: .Lb argument ...

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

libc

Lb libc

libc_r

Lb libc_r

libcalendar

Lb libcalendar

libcam

Lb libcam

libcompat

Lb libcompat

libcrypt

Lb libcrypt

libdevstat

Lb libdevstat

libdisk

Lb libdisk

libedit

Lb libedit

libfetch

Lb libfetch

libipsec

Lb libipsec

libipx

Lb libipx

libkvm

Lb libkvm

libm

Lb libm

libmd

Lb libmd

libnetgraph

Lb libnetgraph

libposix1e

Lb libposix1e

libskey

Lb libskey

libusb

Lb libusb

libutil

Lb libutil

libvgl

Lb libvgl

名称マクロ

使い方: .argument ...

.mdoc.sample

mdoc.sample

.\-mdoc

-mdoc

.foo ) ),

foo ) )

.

`. ' マクロは解析され、呼び出し可能です。  

オプション

使い方: .[options ... ]

.[[

.[-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]

`.] ' マクロと `.[マクロ: '

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

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

`.[と] ' `.] ' と `.[マクロは解析され、呼び出し可能です。 '  

パス名

使い方: .pathname

./usr/share

/usr/share

./tmp/fooXXXXX )

/tmp/fooXXXXX )

`.マクロは解析され、呼び出し可能です。 '  

規格

使い方: .St abbreviature

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

-ansiC

St -ansiC

-ansiC-89

St -ansiC-89

-ieee754

St -ieee754

-iso8802-3

St -iso8802-3

-isoC

St -isoC

-isoC-99

St -isoC-99

-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.1g-2000

St -p1003.1g-2000

-p1003.2

St -p1003.2

-p1003.2-92

St -p1003.2-92

-susv2

St -susv2

-xpg3

St -xpg3

-xpg4

St -xpg4

-xpg4.2

St -xpg4.2

変数

使い方: .variable ...

.count

count

.settimer

settimer

.int *prt ):

int *prt )

.char s ] ) ),

char s ] ) )

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

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

使い方: .man_page[1,...,9]

.mdoc

mdoc

.mdoc

mdoc,

.mdoc(7)

mdoc(7)

.mdoc(7)))

mdoc(7))),

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

一般テキスト領域

AT&T マクロ

使い方: .At [v6 | v7 | 32v | V.1 | V.4] ... 

.At

AT&T System

.AT&T System v6 .

AT&T System v6 .

`.AT&T System ' マクロは解析 されず 、呼び出し 不可能 です。 最大 2 つまでの引数を取ることができます。  

BSD マクロ

使い方: .BSD [Version/release] ...

.Bx

BSD

.BSD 4.3 .

BSD 4.3

`.BSD マクロは解析され、呼び出し可能です。 '  

FreeBSD/NetBSD/OpenBSD マクロ

使い方: .Fx [ Version.release ] ... 

.Fx 2.2 .

Fx 2.2 .

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

.Nx 1.4 .

Nx 1.4 .

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

.Ox 2.5 .

Ox 2.5 .

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

UNIX マクロ

使い方: .UNIX

.Ux

UNIX

`.UNIX ' マクロは解析され、呼び出し可能です。  

囲い/クォートマクロ

クォート     終了    開始    機能    結果 .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 これらのマクロは各々開始および終了の文字列を最初の引数に取ります。

.`リテラルをクォートするマクロは'

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

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

.( Fa name2

は ( Fa name2 となります。

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

クォートの例:

.Aq Aq

.Aq ctype.h ),

Aq Ar 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'

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

no-op もしくは通常テキストマクロ

空白なしマクロ

.[-I directory ]

これは以下の結果になります。 [-I directory ]

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

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

.Sx FILES

Sx FILES

参考文献と引用

.Rs

参考文献の開始。 改行を挿入してから、参考文献の終了マクロが読み込まれるまで 参考文献の情報を収集する。

.Re

参考文献の終了。 参考文献が表示される。

.%A

参考文献の作者名。1 回の呼び出しにつき、作者名をひとつ指定する。

.%B

書籍のタイトル。

.%C

市 / 場所。

.%D

日付。

.%J

定期刊行物の名称。

.%N

発行番号。

.%O

追加情報。

.%P

ページ番号。

.%R

報告書の名称。

.%T

記事のタイトル。

.%V

巻数。

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

戻り値

使い方: .Rv [-std function]

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

Rv -std atexit

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

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

使い方: .symbol ...

.DEC

DEC

.ASCII

ASCII

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

拡張引数

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

.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
.Op Ar operator variable ...
.Xc

結果は以下の通りです。

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

上のすべての例では `. ' (リスト項目) マクロの引数リストに `. ' マクロを使用しています。 拡張マクロが使われることはあまりありません。 使われるとすれば、リスト項目の引数リストを拡張する場合です。 残念なことに、これが拡張マクロが最も懲り性であるところでもあります。 最初の 2 つの例では、スペーシングはオフになっています。

.Sh ページ構造領域