マクロの使用方法

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

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

[ -s bytes]

は、‘ .Op Fl s Ar bytes’で生成されます。

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

[ Fl s Ar bytes]

は、‘ .Op \&Fl s \&Ar bytes’で生成されます。

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

以降、この区別が必要な場合、行頭 (でドットで開始する) -mdoc マクロを コマンド と呼びます。

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

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

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

fetch( char *str)

は、‘ .Fn fetch char\ *str’で生成されます。

fetch( char *str)

は、また‘ .Fn fetch "char *str"’でも生成することができます。

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

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

は、

となります。

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

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

この名前には何が...

最初のケースでは、 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 sptr, ptr),

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

sptr, ptr),

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

.Ar sptr , ptr ) ,

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

sptr, ptr),

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

-mdoc は、次の句読点文字を認識します。

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

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

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

アドレス

使い方: .Ad <アドレス> ...

.Ad addr1

addr1

.Ad addr1 .

addr1.

.Ad addr1 , file2

addr1, file2

.Ad f1 , f2 , f3 :

f1, f2, f3:

.Ad addr ) ) ,

addr)),

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

作者名

使い方: .An <作者名> ...

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

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

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

.An -nosplit

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

.An -split

と記述します。

引数

使い方: .Ar [ <引数>] ...

.Ar

file ...

.Ar file1

file1

.Ar file1 .

file1.

.Ar file1 file2

file1 file2

.Ar f1 f2 f3 :

f1 f2 f3:

.Ar file ) ) ,

file)),

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

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

使い方: .Cd <引数> ...

.Cd "device le0 at scode?"

device le0 at scode?

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

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

コマンド修飾子

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

定義済みの変数

使い方: .Dv <定義済みの変数> ...

.Dv MAXHOSTNAMELEN

MAXHOSTNAMELEN

.Dv TIOCGPGRP )

TIOCGPGRP)

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

errno

使い方: .Er <errno のタイプ> ...

.Er ENOENT

ENOENT

.Er ENOENT ) ;

ENOENT);

.Bq Er ENOTDIR

[ ENOTDIR]

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

環境変数

使い方: .Ev <引数> ...

.Ev DISPLAY

DISPLAY

.Ev PATH .

PATH.

.Ev PRINTER ) ) ,

PRINTER)),

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

フラグ

使い方: .Fl <引数> ...

.Fl

-

.Fl cfv

-cfv

.Fl cfv .

-cfv.

.Cm cfv .

cfv.

.Fl s v t

-s -v -t

.Fl - ,

--,

.Fl xyz ) ,

-xyz),

.Fl |

| -

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

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

関数の宣言

使い方: .Fd <引数> ...

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

#include <sys/types.h>

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

‘ .In’マクロは、 SYNOPSIS (書式) セクションで使用すると、 #include 文を表現するものであり、以上の例を短く記述したものです。このマクロは、C プログラム中でインクルードされる C ヘッダファイルを指定します。このマクロも改行を挿入します。

SYNOPSIS (書式) セクション以外で使用すると、山括弧で括られたヘッダファイルを表現します。

使い方: .In <ヘッダファイル>

.In stdio.h

< stdio.h>

.In stdio.h

< stdio.h>

関数の型

使い方: .Ft <型> ...

.Ft struct stat

struct stat

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

使い方: .Fn <関数>[ <パラメータ>] ...

.Fn getchar

getchar()

.Fn strlen ) ,

strlen()),

.Fn align "char *ptr" ,

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

生成結果:

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

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

関数の引数

使い方: .Fa <関数の引数> ...

.Fa d_namlen ) ) ,

d_namlen)),

.Fa iov_len

iov_len

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

戻り値

使い方: .Rv [ -std][ <関数> ...]

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

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

終了ステータス

使い方: .Ex [ -std][ <ユーティリティ> ...]

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

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

対話的なコマンド

使い方: .Ic <引数> ...

.Ic :wq

:wq

.Ic "do while {...}"

do while {...}

.Ic setenv , unsetenv

setenv, unsetenv

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

ライブラリ名

使い方: .Lb <引数> ...

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

libarchive

Streaming Archive Library (libarchive, -larchive)

libarm

ARM Architecture Library (libarm, -larm)

libarm32

ARM32 Architecture Library (libarm32, -larm32)

libbluetooth

Bluetooth Library (libbluetooth, -lbluetooth)

libbsm

Basic Security Module User Library (libbsm, -lbsm)

libc

Standard C Library (libc, -lc)

libc_r

Reentrant C Library (libc_r, -lc_r)

libcalendar

Calendar Arithmetic Library (libcalendar, -lcalendar)

libcam

Common Access Method User Library (libcam, -lcam)

libcdk

Curses Development Kit Library (libcdk, -lcdk)

libcipher

FreeSec Crypt Library (libcipher, -lcipher)

libcompat

Compatibility Library (libcompat, -lcompat)

libcrypt

Crypt Library (libcrypt, -lcrypt)

libcurses

Curses Library (libcurses, -lcurses)

libdevinfo

Device and Resource Information Utility Library (libdevinfo, -ldevinfo)

libdevstat

Device Statistics Library (libdevstat, -ldevstat)

libdisk

Interface to Slice and Partition Labels Library (libdisk, -ldisk)

libdwarf

DWARF Access Library (libdwarf, -ldwarf)

libedit

Command Line Editor Library (libedit, -ledit)

libelf

ELF Access Library (libelf, -lelf)

libevent

Event Notification Library (libevent, -levent)

libfetch

File Transfer Library (libfetch, -lfetch)

libform

Curses Form Library (libform, -lform)

libgeom

Userland API Library for Kernel GEOM subsystem (libgeom, -lgeom)

libgpib

General-Purpose Instrument Bus (GPIB) library (libgpib, -lgpib)

libi386

i386 Architecture Library (libi386, -li386)

libintl

Internationalized Message Handling Library (libintl, -lintl)

libipsec

IPsec Policy Control Library (libipsec, -lipsec)

libipx

IPX Address Conversion Support Library (libipx, -lipx)

libiscsi

iSCSI protocol library (libiscsi, -liscsi)

libjail

Jail Library (libjail, -ljail)

libkiconv

Kernel-side iconv Library (libkiconv, -lkiconv)

libkse

N:M Threading Library (libkse, -lkse)

libkvm

Kernel Data Access Library (libkvm, -lkvm)

libm

Math Library (libm, -lm)

libm68k

m68k Architecture Library (libm68k, -lm68k)

libmagic

Magic Number Recognition Library (libmagic, -lmagic)

libmd

Message Digest (MD4, MD5, etc.) Support Library (libmd, -lmd)

libmemstat

Kernel Memory Allocator Statistics Library (libmemstat, -lmemstat)

libmenu

Curses Menu Library (libmenu, -lmenu)

libnetgraph

Netgraph User Library (libnetgraph, -lnetgraph)

libnetpgp

Netpgp Signing, Verification, Encryption and Decryption (libnetpgp, -lnetpgp)

libossaudio

OSS Audio Emulation Library (libossaudio, -lossaudio)

libpam

Pluggable Authentication Module Library (libpam, -lpam)

libpcap

Capture Library (libpcap, -lpcap)

libpci

PCI Bus Access Library (libpci, -lpci)

libpmc

Performance Counters Library (libpmc, -lpmc)

libposix

POSIX Compatibility Library (libposix, -lposix)

libprop

Property Container Object Library (libprop, -lprop)

libpthread

POSIX Threads Library (libpthread, -lpthread)

libpuffs

puffs Convenience Library (libpuffs, -lpuffs)

librefuse

File System in Userspace Convenience Library (librefuse, -lrefuse)

libresolv

DNS Resolver Library (libresolv, -lresolv)

librpcsec_gss

RPC GSS-API Authentication Library (librpcsec_gss, -lrpcsec_gss)

librpcsvc

RPC Service Library (librpcsvc, -lrpcsvc)

librt

POSIX Real-time Library (librt, -lrt)

libsdp

Bluetooth Service Discovery Protocol User Library (libsdp, -lsdp)

libssp

Buffer Overflow Protection Library (libssp, -lssp)

libSystem

System Library (libSystem, -lSystem)

libtermcap

Termcap Access Library (libtermcap, -ltermcap)

libterminfo

Terminal Information Library (libterminfo, -lterminfo)

libthr

1:1 Threading Library (libthr, -lthr)

libufs

UFS File System Access Library (libufs, -lufs)

libugidfw

File System Firewall Interface Library (libugidfw, -lugidfw)

libulog

User Login Record Library (libulog, -lulog)

libusbhid

USB Human Interface Devices Library (libusbhid, -lusbhid)

libutil

System Utilities Library (libutil, -lutil)

libvgl

Video Graphics Library (libvgl, -lvgl)

libx86_64

x86_64 Architecture Library (libx86_64, -lx86_64)

libz

Compression Library (libz, -lz)

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

ライブラリ のセクションでは、‘ .Lb’コマンドは、引数の表示の前後でラインブレークを引き起こします。

リテラル

使い方: .Li <引数> ...

.Li \en

\n

.Li M1 M2 M3 ;

M1 M2 M3;

.Li cntrl-D ) ,

cntrl-D),

.Li 1024 ...

1024 ...

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

名称

注: セクション 2 または 3 のドキュメントの関数名は、 NAME セクションにおいて‘ .Nm’で指定され、 SYNOPSIS セクションや残りのセクションでは、‘ .Fn’で指定されます。 csh(1) での‘ while’コマンドのキーワードのような対話的なコマンドでは、‘ .Ic’マクロを使う必要があります。‘ .Ic’は、ほとんど‘ .Nm’と同一ですが、それが使われたときの第 1 引数を記憶することはできません。

使い方: .Nm [ <引数>] ...

.Nm groff_mdoc

groff_mdoc

.Nm \-mdoc

-mdoc

.Nm foo ) ) ,

foo)),

.Nm :

groff_mdoc:

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

オプション

使い方: .Op [ <オプション>] ...

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

.Li .Op Oo Ao option Ac Oc ...

.Op [ <option>] ...

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

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

出力結果:

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

パス名

使い方: .Pa [ <パス名>] ...

.Pa

~

.Pa /usr/share

/usr/share

.Pa /tmp/fooXXXXX ) .

/tmp/fooXXXXX).

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

規格

使い方: .St <短縮名称> ...

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

ANSI/ISO C

-ansiC

ANSI X3.159-1989 (“ANSI C89”)

-ansiC-89

ANSI X3.159-1989 (“ANSI C89”)

-isoC

ISO/IEC 9899:1990 (“ISO C90”)

-isoC-90

ISO/IEC 9899:1990 (“ISO C90”)

-isoC-99

ISO/IEC 9899:1999 (“ISO C99”)

-isoC-2011

ISO/IEC 9899:2011 (“ISO C11”)

POSIX パート 1: System API

-iso9945-1-90

ISO/IEC 9945-1:1990 (“POSIX.1”)

-iso9945-1-96

ISO/IEC 9945-1:1996 (“POSIX.1”)

-p1003.1

IEEE Std 1003.1 (“POSIX.1”)

-p1003.1-88

IEEE Std 1003.1-1988 (“POSIX.1”)

-p1003.1-90

IEEE Std 1003.1-1990 (“POSIX.1”)

-p1003.1-96

ISO/IEC 9945-1:1996 (“POSIX.1”)

-p1003.1b-93

IEEE Std 1003.1b-1993 (“POSIX.1b”)

-p1003.1c-95

IEEE Std 1003.1c-1995 (“POSIX.1c”)

-p1003.1g-2000

IEEE Std 1003.1g-2000 (“POSIX.1g”)

-p1003.1i-95

IEEE Std 1003.1i-1995 (“POSIX.1i”)

-p1003.1-2001

IEEE Std 1003.1-2001 (“POSIX.1”)

-p1003.1-2004

IEEE Std 1003.1-2004 (“POSIX.1”)

-p1003.1-2008

IEEE Std 1003.1-2008 (“POSIX.1”)

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

-iso9945-2-93

ISO/IEC 9945-2:1993 (“POSIX.2”)

-p1003.2

IEEE Std 1003.2 (“POSIX.2”)

-p1003.2-92

IEEE Std 1003.2-1992 (“POSIX.2”)

-p1003.2a-92

IEEE Std 1003.2a-1992 (“POSIX.2”)

X/Open

-susv2

Version 2 of the Single UNIX Specification (“SUSv2”)

-susv3

Version 3 of the Single UNIX Specification (“SUSv3”)

-svid4

System V Interface Definition, Fourth Edition (“SVID4”)

-xbd5

X/Open Base Definitions Issue 5 (“XBD5”)

-xcu5

X/Open Commands and Utilities Issue 5 (“XCU5”)

-xcurses4.2

X/Open Curses Issue 4, Version 2 (“XCURSES4.2”)

-xns5

X/Open Networking Services Issue 5 (“XNS5”)

-xns5.2

X/Open Networking Services Issue 5.2 (“XNS5.2”)

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

-xsh5

X/Open System Interfaces and Headers Issue 5 (“XSH5”)

その他

-ieee754

IEEE Std 754-1985

-iso8802-3

ISO 8802-3: 1989

変数の型

使い方: .Vt <型> ...

.Vt extern char *optarg ;

extern char *optarg;

.Vt FILE *

FILE *

変数

使い方: .Va <変数> ...

.Va count

count

.Va settimer ,

settimer,

.Va "int *prt" ) :

int *prt):

.Va "char s" ] ) ) ,

char s])),

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

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

使い方: .Xr <マニュアルページの名称>[ <セクション>] ...

.Xr mdoc

mdoc

.Xr mdoc ,

mdoc,

.Xr mdoc 7

mdoc(7)

.Xr xinit 1x ;

xinit(1x);

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

AT&T マクロ

使い方: .At [ <バージョン>] ...

.At

AT&T UNIX

.At v6 .

Version 6 AT&T UNIX.

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

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

BSD マクロ

使い方: .Bx {-alpha | -beta | -devel} ...

.Bx [ <バージョン>[ <リリース>]] ...

.Bx

BSD

.Bx 4.3 .

4.3BSD.

.Bx -devel

-develBSD

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

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

NetBSD マクロ

使い方: .Nx [ <バージョン>] ...

.Nx

NetBSD

.Nx 1.4 .

NetBSD 1.4.

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

FreeBSD マクロ

使い方: .Fx [ <バージョン>] ...

.Fx

FreeBSD

.Fx 2.2 .

FreeBSD 2.2.

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

DragonFly マクロ

使い方: .Dx [ <バージョン>] ...

.Dx

DragonFly

.Dx 1.4 .

DragonFly 1.4.

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

OpenBSD マクロ

使い方: .Ox [ <バージョン>] ...

.Ox 1.0

OpenBSD 1.0

BSD/OS マクロ

使い方: .Bsx [ <バージョン>] ...

.Bsx 1.0

BSD/OS 1.0

UNIX マクロ

使い方: .Ux ...

.Ux

UNIX

強調マクロ

使い方: .Em <引数> ...

.Em does not

does not

.Em exceed 1024 .

exceed 1024.

.Em vide infra ) ) ,

vide infra)),

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

フォントモード

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

.Bf <フォントモード>

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

Em | -emphasis

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

Li | -literal

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

Sy | -symbolic

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

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

囲い/クォートマクロ

‘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’モードで続けます。

クォートの例:

.Aq

<>

.Aq Pa 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’

.Em or Ap ing

or'ing

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

無操作または通常テキストマクロ

使い方: .No <引数> ...

.No test Ta with Ta tabs

test with Ta tabs

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

空白なしマクロ

使い方: ... <引数> Ns [ <引数>] ...

.Ns <引数> ...

.Op Fl I Ns Ar directory

[ -Idirectory]

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

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

使い方: .Sx <セクションの参照> ...

.Sx FILES

FILES

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

記号

使い方: .Sy <記号> ...

.Sy Important Notice

Important Notice

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

数学記号

使い方: .Ms <数学記号> ...

.Ms sigma

sigma

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

参考文献と引用

.Rs

参考文献の開始 (引数はとりません)。 SEE ALSO セクションでは、改行を挿入し、参考文献の終了マクロが読み込まれるまで参考文献の情報を収集します。

.Re

参考文献の終了 (引数はとりません)。参考文献が表示されます。

.%A

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

.%B

書籍のタイトル。

.%C

市 / 場所 (まだ実装されていません)。

.%D

日付。

.%I

発行者/出版社名。

.%J

定期刊行物の名称。

.%N

発行番号。

.%O

追加情報。

.%P

ページ番号。

.%Q

組織内部、あるいは外部の著者。

.%R

報告書の名称。

.%T

記事のタイトル。

.%U

オプションのハイパーテキスト参照。

.%V

巻数。

‘ %’で始まるマクロは、呼び出し不可能ですが、通常の方法で複数の引数をとることができます。パラメータとしては、‘ .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

出力結果

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

使い方: .Tn <シンボル> ...

.Tn DEC

DEC

.Tn ASCII

ASCII

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

拡張引数

次は、スペーシングをオフにするために空白モードマクロを使った‘ .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

結果は、以下の通りです。

セクションヘッダ

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

コマンドからの診断メッセージは、このセクションに置く必要があります。‘ .Ex’マクロは、ほとんどのセクション 1、6、と 8 コマンドのために 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’マクロとオプションの連絡先としての電子メールアドレスのためには、‘ .Aq’マクロを使用します。最初のマニュアルページまたはソフトウェアを執筆した人物かどうか、またはクレジットされるべき人物なら誰でも明白に示します。

.Sh BUGS

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

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

.Sh "ページ構造領域"

サブセクションヘッダ

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

段落と行スペース

.Pp

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

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

キープ

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

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

例示とディスプレイ

.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

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

リストとカラム

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

このリストタイプを不正使用しないでください! より複雑な場合に、テーブルプリプロセッサ tbl(1) を使用することは、はるかに良くて、より簡単であるかもしれません。

その他のキーワード:

-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

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