マニュアル領域

アドレス

使い方: .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 [email protected]

An Joe Author Aq [email protected]

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

.:

:

デフォルト幅は 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

NAME

セクションヘッダはマニュアルページの好ましいレイアウトの一部であり、

.

セクションを追加することができます。

.Sh "ページ構造領域"

サブセクションヘッダ

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

の呼び出し時にのみ引数として使用できます。このとき、

のデフォルトフォントが再度有効になります。

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

段落と行スペース

.

`.

' 段落コマンドは必要な場合に行スペースを指定するために使われます。 このマクロは `.

マクロや

マクロの後、ならびに

' マクロや `. ' マクロの前では必要ありません (いずれのマクロも -compact フラグが指定されていなければ垂直方向の距離を宣言します)。

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

キープ

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

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

例示とディスプレイ

.D1

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

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

.

(D-エルです)

インデントされた リテラル テキストを 1 行表示します。 `.

マクロの例は本ファイル中にわたって使われています。

' これによって 1 行のテキストのインデント (表示) が可能になります。 デフォルトフォントは固定幅 (リテラル) に設定されます。 `.

は構文解析されますが、呼び出し不可能です。

'

% ls -ldg /usr/local/bin

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

% ls -ldg /usr/local/bin

.

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

.

Br o -literal | -filled | -unfilled | -ragged | -centered Brc [-offset Ao 文字列 Ac [-file Ao ファイル名 Ac [-compact ] ] ]

-ragged

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

-centered

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

-unfilled

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

-filled

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

-literal

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

-file Ao ファイル名 Ac -file

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

-offset Ao 文字列 Ac -offset

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

left

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

center

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

indent

デフォルトのインデント値もしくはタブの分だけインデントします。 デフォルトのインデント値は `.D1' および `.

マクロでも使われていますので、この

' 2 つのディスプレイと 行が揃うことが保証されています。 インデント値は通常 6n つまり約 2/3 インチ (固定幅文字 6 つ分) です。

indent-two

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

right

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

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

-compact

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

.

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

リストとカラム

' で開始できるリストには何種類かあります。 リスト中の項目は項目マクロ `.

で指定され、各リストは

' `.

' マクロで終了しなければなりません。 リストはリスト自身やディスプレイの中で入れ子にすることができます。 リスト中でカラムを使ったり、カラムの中でリストを使ったりすることに ついては検証されていません。

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

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

.

Br o -hang | -ohang | -tag | -diag | -inset Brc [-width Ao 文字列 Ac ] [-offset Ao 文字列 Ac [-compact ] ]

.

-column [-offset Ao 文字列 Ac ] Ao 文字列1 Ac Ao 文字列2 Ac ... Xc

.

Br o -item | -enum Oo -nested Oc | -bullet | -hyphen | -dash Brc [-offset Ao 文字列 Ac [-compact ] ]

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

-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

生成結果

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

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

-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 リストへの引数、 Aq Ar string1 , Aq Ar string2 等によって決定されます。 Aq Ar stringN が `.' (ドット) で開始し直後に有効な -mdoc マクロ名が続く場合、 Aq Ar stringN を解釈して結果の幅を使用します。 そうでない場合、 Aq Ar stringN (固定幅フォントでのタイプセット) は N 番目の桁の幅になります。

`.

引数はそれぞれ構文解析され行を生成します。

' 行中の各列はタブや `.Ta マクロで分けられた引数です。 '

次の表、

文字列 Ta nroff Ta troff

<= Ta <= Ta <=

>= Ta >= Ta &gt=;

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

.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 Ao 文字列 Ac Aq 文字列

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

使用例:

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

生成結果:

-test Ao 文字列 Ac これは、

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

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

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

タグリストタイプ用に幅が指定されていない場合、 `.

が起動される度に適切な幅を決定しようと試みます。

' `.

の第

' 1 引数が呼び出し可能なマクロである場合、 そのマクロのデフォルト幅が使われます。 そうでなければ、 `.のデフォルト幅が使われます。 '

-offset Ao 文字列 Ac Aq 文字列

が indent である場合、デフォルトのインデント値 (通常 6n に設定されており、 `.

または

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

-compact

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

その他のマクロ

. is currently in beta test.

は

is currently in beta test.

を表示します。

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

.

使い方: .Ao 関数の戻り値 Ac ...

このマクロは使わないでください。 このマクロは戻り値 (通常は数字 1 個) の直前での 改行を許してしまいます。 印刷時の振る舞いとしては悪いことです。 直前の単語と戻り値とを結合させるには `\~' を使用してください。

.Hf (ヘッダ) ファイルをそのまま含めるにはこのマクロを

使ってください。 このマクロは、最初に `File:' とファイル名を表示し、その後で Ao ファイル Ac の内容を表示します。

使い方: .Hf Ao ファイル Ac

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

.Lk 将来書かれる予定です。

.Me 正確な使用方法は分かりません。

-mdoc ソースファイル中の記述では ``メニューエントリ '' となっています。

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

.Mt 将来書かれる予定です。

.Ot 正確な使用方法は分かりません。

-mdoc ソースファイル中の記述では ``古い関数タイプ (fortran) '' となっています。

.

空白モードを有効に (トグル) します。

使い方: .

空白モードが off の場合、マクロ引数の間に空白は 挿入されません。引数なしで呼ばれた場合 (あるいは 次の引数が `on' でも `off' でもない場合) `. ' マクロは空白モードに入ります。

.Ud マクロは

Ud

を表示します。

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

定義済み文字列

文字列 Ta nroff Ta troff Ta 意味

<= Ta <= Ta <= Ta 以下

>= Ta >= Ta &gt=; Ta 以上

Rq Ta '' Ta ” Ta 右側のダブルクォート

Lq Ta `` Ta “ Ta 左側のダブルクォート

ua Ta ^ Ta ^ Ta 上向き矢印

aa Ta ' Ta ' Ta アキュートアクセント

ga Ta ` Ta ` Ta グレーブアクセント

q Ta Ta " Ta まっすぐなダブルクォート

Pi Ta pi Ta Pi Ta ギリシャ語のパイ

Ne Ta != Ta != Ta 不等号

Le Ta <= Ta <= Ta 以下

Ge Ta >= Ta &gt=; Ta 以上

Lt Ta < Ta < Ta 小なり

Gt Ta > Ta > Ta 大なり

Pm Ta +- Ta ± Ta プラスマイナス

If Ta infinity Ta ∞ Ta 無限

Na Ta NaN Ta NaN Ta 非数値

Ba Ta | Ta | Ta 垂直線

カラムの名前 nroff と troff は少々誤解を招くものです。 nroff は ASCII 文字を表示しますが、 troff では利用可能なもののうち一番良いグリフ形式を 表示します。 例えば、Unicode を使用可能にした TTY デバイスはすべての文字列に対して適切なグリフ表現を 持っていますが、それに対して Latin1 に対して機能を強化した TTY デバイスはプラスマイナス記号しか持っていません。

文字を 2 つ含んだ文字列名は `\*(xx'

として表記できます。 文字を 1 文字だけ含んだ文字列名は `\*x'

と表記できます。 どのような長さの文字列名に対しても、一般的な文法は `\*[xxx]' となります ( これは GNU troff(1) 拡張です)。 # #===================================================================== #

診断

唯一残ったデバッグ用マクロは `.Rd であり、これはすべてのグローバルレジスタならびに文字列の ' レジスタダンプを出力するものです。 通常のユーザが使う必要は決してないでしょう。

GROFF, TROFF, および NROFF を使用した整形

groff -Tlatin1 -rcR=0 -mdoc foo.man > foo.txt

両面印刷用には、レジスタ `D' を 1 に設定してください:

groff -Tps -rD1 -mdoc foo.man > foo.ps

ドキュメントのフォントサイズを 11pt や 12pt に変更したい 場合は、レジスタ `S' をそれに合わせて設定してください:

groff -Tdvi -rS11 -mdoc foo.man > foo.dvi

レジスタ `S' は TTY デバイスに対しては無視されます。

関連ファイル

doc.tmac

主なマニュアル用マクロパッケージです。

mdoc.tmac

doc.tmac を呼ぶラッパファイルです。

mdoc/doc-common

共通する文字列、定義、および印刷出力に関連する項目です。

mdoc/doc-nroff

TTY 出力デバイス用に使用される定義です。

mdoc/doc-ditroff

その他すべてのデバイス用に使用される定義です。

mdoc.local

ローカルマシンでの追加項目およびカスタマイズ項目です。

andoc.tmac

このファイルは -mdoc パッケージと -man パッケージのどちらを使用すべきかをチェックします。