man troff (1): 文書をフォーマットする

書式

troff [ -abivzCERU ] [ -wname ] [ -Wname ] [ -dcs ] [ -ffam ] [ -mname ] [ -nnum ] [ -olist ] [ -rcn ] [ -Tname ] [ -Fdir ] [ -Mdir ] [ files... ]

コマンドラインオプションとパラメータの間に空白を含めることが可能です。

解説

本マニュアルでは、groff ドキュメントフォーマットシステムの一部である GNU バージョンの troff について記述します。本コマンドは UNIX troff と高い互換性を持ちます。通常 troff は groff コマンドから起動されます。 groff はまた、適切な前処理プログラムと後処理プログラムを適切なオプションで、適切な順序で起動します。

オプション

-a: ASCII 文字のみの近似的な出力を行います。
-b: 各警告とエラーメッセージに対するバックトレースを表示します。これは、警告やエラーの原因を調べるのに有用です。出力される行番号は必ずしも正しくはありません。 as や am リクエストにより、 troff が行番号を誤認する可能性があるからです。
-i: 指定されたファイルをすべて処理したあとに、標準入力も読み込み、処理します。
-v: バージョン番号を表示します。
-wname: name で指定した分類の警告を行います。指定できる name は、後述の警告のサブセクションを参照してください。 -w オプションは複数指定できます。
-Wname: name で指定した分類の警告を行いません。 -W オプションは複数指定することができます。
-E: エラーメッセージを一切出力しません。
-z: フォーマットした結果を出力しません。
-C: 互換モードにします。
-dcs
-dname=s マクロ c または name を文字列 s と定義します。 c は 1 文字のマクロ名です。
-ffam: fam をデフォルトのフォントファミリとして使用します。
-mname: マクロファイル name.tmac を読み込みます。見つからなければ、かわりに tmac.name を試みます。まず最初に -M コマンドラインオプションで指定されたディレクトリ、続いて GROFF_TMAC_PATH 環境変数で指定されたディレクトリ、そして現在のディレクトリ (安全でないモードの場合のみ)、ホームディレクトリ、/usr/share/tmac/、/usr/share/tmac/、 /usr/share/tmac の順に検索します。
-U: 安全でないモード。これによって以下のリクエストが有効になります: .open, .opena, .pso, .sy, .pi. そうでなければ、セキュリティのためにこれらの危険性のあるリクエストは禁止されています。また現在のディレクトリをマクロ検索パスに加えます。
-R: troffrc と troffrc-end を読みません。
-nnum: 最初のページ番号を num とします。
-olist: list で指定したページのみを出力します。 list は、コンマで区切られたページ範囲の列です。ページ範囲の指定方法は以下のとおりです: n は n ページの出力、 m-n は m ページから n ページまでの出力、 -n は n ページまでの出力、 n- は n ページ以降の出力を意味します。 troff はリストの最後のページを印刷し終えると終了します。
-rcn
-rname=n 数値レジスタ c または name の値を n とします。 c は 1 文字の名前です。 n は troff で扱える数式です。
-Tname: デバイス name 用の出力を生成します。デフォルトは ps です。
-Fdir: フォントファイルと DESC ファイルを検索するのに、ディレクトリ (またはディレクトリパス) dir 以下の devname (name は出力デバイス名) を探します。他のすべてのフォントディレクトリより前に dir を調べます。
-Mdir: 指定したディレクトリ (またはディレクトリパス) dir からマクロファイルを検索します。他のすべてのマクロディレクトリより前に調べます。

使用法

ここでは UNIX troff には無い機能のみを説明します。

長い名前

数値レジスタ、フォント、文字列/マクロ/転換、特殊文字のそれぞれの名前の長さは任意です。エスケープシーケンス中、すなわち

2 文字の名前 (xx を使用可能な場所で、任意の長さの名前 [xxx] を使用可能です。

\[xxx]: xxx で呼ばれる特殊文字を表示します。
\f[xxx]: フォント xxx を設定します。
\*[xxx]: 文字列 xxx を挿入する。
\n[xxx]: 数値レジスタ xxx を挿入する。

分数のポイントサイズ

スケールドポイントは 1/sizescale ポイントです。ここで sizescale は DESC ファイルで指定されます (デフォルト値は 1 です)。また、新しいスケールインジケータ z があります。これは sizescale 倍する効果があります。 troff におけるリクエストおよびエスケープシーケンスはポイントサイズを表す引数をスケールドポイント単位で表されているとして解釈しますが、このような引数の評価はデフォルトのスケールインジケータ z にて行います。このように取り扱われる引数には、 ps リクエストの引数、 cs リクエストの 3 番目の引数、 tkf リクエストの 2 番目および 4 番目の引数、 \H エスケープシーケンスの引数、 \s エスケープシーケンスの変形で数値式を引数として取るものとがあります。

例えば sizescale を 1000 とします; この場合スケールドポイントはミリポイントとなります; リクエスト .ps 10.25 は .ps 10.25z と同じですし、ポイントサイズは 10250 スケールドポイントに設定されます。これは 10.25 ポイントと等しい値です。

数値レジスタ \n[.s] はポイントサイズを 10 進数分数のポイント単位で返します。新しい数値レジスタ \n[.ps] もあり、これはスケールドポイント単位でのポイントサイズを返します。

デフォルトのスケールインジケータが u, z のどちらでもない数式中で z スケールインジケータを使用するのは無意味でしょう。 troff はこのようなことを禁止します。同様に、 z がデフォルトのスケールインジケータであった数式において z, u のどちらでもないスケールインジケータを使用するのは無意味でしょう。 troff はこのようなことを禁止します。

また、新しいスケールインジケータ s があります。これはもとの値をスケールドポイントの単位数で逓倍します。例えば、 \n[.ps]s は 1m と同じです。 s, z スケールインジケータを混同しないようにして下さい。

数値式

括弧内の数式中に空白を含めることが許されます。

M は em の 1/100 を意味します。

e1>?e2: e1 と e2 とで小さくない方。
e1<?e2: e1 と e2 とで大きくない方。
(c;e): c をデフォルトのスケールインジケータとして e を評価します。 c が指定されない場合は e の評価においてスケールインジケータは無視されます。

新しいエスケープシーケンス

\A'anything'

1 または 0 に展開されます。これは anything が文字列、マクロ、展開、数値レジスタ、環境、フォントのいずれかとして受理可能か否かに依存します。 anything が空の場合には 0 が返されます。連想表のようなものからユーザの入力を取り出すような場合に有効です。

\B'anything'

これは数値式 anything が正当か否かに応じて 1 または 0 に展開されます。 anything が空の場合は 0 を返します。

\C'xxx'

xxx という名前の文字をタイプセットします。通常、 \[xxx] を使用する方が便利です。しかし \C の優位点は、最近の UNIX と互換性があり互換モードにおいて使用可能であることです。

\E

エスケープ文字と等価ですが、コピーモードでは解釈されません。例えば、上付き文字の始まりと終りの文字列は次のように定義できます:

: .ds { \v'-.3m'\s'\En[.s]*6u/10u'
.ds } \s0\v'.3m'

\E を使用すると、例え \*{ がコピーモードにおいて解釈されるような場合でも、これらの定義がうまく作用することを保証できます (例えばマクロの引数で使用される場合)。

\N'n'

コード n の文字を現在のフォントでタイプセットします。 n は任意の整数値です。ほとんどのデバイスは文字コードが 0 から 255 までしかありません。現在のフォントが対応するコードの文字を持たない場合、スペシャルフォントは探されません。 \N エスケープシーケンスは char リクエストとの組み合わせにより便利に使えます:

: .char \[phone] \f(ZD\N'37'

各文字のコードは、フォント記述ファイルで、 charset コマンドの後の 4 番目のカラムに書かれています。文字の名前として --- を使うことで、名前の無い文字をフォント記述ファイルに組み込むことが可能です。これらの文字を使用するには、 \N エスケープシーケンスを使う方法しかありません。

\R'name ±n'

これは、次のものと同じ効果です。

: .nr name ±n

\s(nn

\s±(nn ポイントサイズを nn ポイントに設定します; nn は正確に 2 桁の 10 進数である必要があります。

\s[±n]

\s±[n]

\s'±n'

\s±'n' ポイントサイズを n スケールドポイントにします; n は数値式であり、デフォルトスケールインジケータは z です。

\Vx

\V(xx

\V[xxx] getenv(3) で返される環境変数 xxx の内容を挿入します。 \V はコピーモードで解釈されます。

\Yx

\Y(xx

\Y[xxx] これは \X'\*[xxx]' とほとんど同一です。しかし文字列/マクロ xxx は解釈されません; また xxx がマクロととして定義されることが許されており、改行文字を含んでも良いです ( \X の引数は改行文字を含んではなりません)。改行文字を含む場合には UNIX troff 出力フォーマットが拡張されている必要があります。また、この拡張を知らないドライバーを混乱させてしまいます。

\Z'anything'

anything を表示したあと水平位置及び垂直位置を元に戻します; anything はタブやリーダーを含んではなりません。

\$0

現在のマクロが呼び出された名前です。 als リクエストはマクロに複数の名前を持たせることができます。

\$*

マクロ中で、全ての引数を空白で区切って結合した文字列になります。

\$@

マクロ中で、各引数をダブルクォートで括り、その全てを空白で区切って結合した文字列になります。

\$(nn

\$[nnn] マクロ中で、 nn番目もしくは nnn番目の引数を与えます。マクロの取りうる引数の数には制限はありません。

\?anything\?

転換中で使用すると、 anything を転換中に透過的に埋め込みます。 anything はコピーモードで読まれます。転換の内容が後で読み込まれる時、 anything は解釈されます。 anything は改行文字を含んではなりません; 転換中に改行文字を埋め込みたい場合には \! を使用して下さい。エスケープシーケンス \? はコピーモードにおいて認識され、単一の内部コードに変換されます; anything の終了を表すのがこのコードです。それゆえ、

.nr x 1
.nf
.di d
\?\\?\\\\?\\\\\\\\nx\\\\?\\?\?
.di
.nr x 2
.di e
.d
.di
.nr x 3
.di f
.e
.di
.nr x 4
.f

は 4 を表示します。

\/

先行する文字の幅を増やします。その結果、継続する文字がローマン文字の場合、先行する文字と継続する文字との間隔が正しくなります。例えば、イタリックの f の直後にローマンの右括弧が続く場合、ほとんどのフォントにおいて f の右上の部分が右括弧の左上の部分とが重なり f) となります。これは醜いです。 \/ を挿入することにより f) となりこの問題を防ぎます。このエスケープシーケンスを、イタリック文字の直後に空白をはさまずにローマン文字が続く場合には常に使用することは良い考えです。

\,

後続する文字の空白を修正します。その結果、先行する文字がローマン文字の場合、その文字と先行する文字との間の空白が正しくなります。例えば \, を括弧と f の間に挿入することにより、 (f は (f となります。ローマン文字の直後に空白をはさまずにイタリック文字が続く場合には常に使用することは良い考えです。

\)

\& に似ていますが、 cflags リクエストにより宣言された文字として動作します。このは文の終了判定のために使用します。

\~

行分割されないが、行内部の空白調整において普通の単語間空白と同様に伸び縮みする空白を生成します。

\:

幅が 0 のブレークポイントを挿入します。 \% と等価ですがソフトハイフン文字を挿入しません。

\#

次の改行文字 (これを含みます) までの全てを無視します。コピーモードで解釈されています。これは \ に似ていますが、 \ は最後の改行文字を無視しないところが違います。

新しいリクエスト

.aln xx yy

数値レジスタオブジェクトで名前が yy のものへのエイリアス xx を作成します。新しい名前と古い名前は完全に等価になります。もし yy が未定義の場合、タイプ reg の警告が生成され、リクエストは無視されます。

.als xx yy

yy という名前のリクエスト/文字列/マクロ/転換の各オブジェクトに対するエイリアス xx を作成します。新しい名前と古い名前は完全に等価になります (ソフトリンクに対するハードリンクのようなものです)。 yy が未定義なら、タイプ mac の警告が生成され、リクエストは無視されます。マクロ/転換/文字列転換が現在未定義である場合、もしくはリクエストとして定義されている場合には、 de, am, di, da, ds, as リクエストは新しいオブジェクトを生成するだけです; これらは通常は既に存在するオブジェクトの値を変更します。

.am1 xx yy

.am と同様ですが、実行中に互換モードはオフになります。入る時に現在の互換モードが保存され、終了時に回復されます。

.asciify xx

このリクエストは、転換 xx を以下のように `アンフォーマット' します。すなわちフォーマットされ xx に転換格納された ASCII と空白文字 (そしていくつかのエスケープシーケンス) が、 xx が再度読み込まれる時に、普通に入力された文字として扱われます。 .writem リクエストと組み合わせた転換で有用です。また大々的なハックにも利用できます。例えば、

.tr @.
.di x
@nr n 1
.br
.di
.tr @@
.asciify x
.x

はレジスタ n を 1 に設定します。グリフ情報 (フォント、フォントサイズ等々) は保存されません。代わりに .unformat を使ってください。

.backtrace

入力スタックのバックトレースを標準エラー出力に出力します。

.blm xx

空行マクロを xx に設定します。空行マクロが存在する場合、空行に出会った時に、通常の troff の振舞とは異なり、このマクロを呼び出します。

.box xx

.boxa xx これらのリクエストは、途中まで行詰めされた行が転換の一部にならず (つまり転換は常に改行から始まります)、しかし転換の終了後に戻され、転換から生じたであろう途中まで行詰めされた行を破棄するという点を除いて、 di と da リクエストと同様です。

.break

while ループを抜けます。 while, continue リクエストも見て下さい。 br リクエストと混同しないようにして下さい。

.brp

\p と同様です。

.cflags n c1 c2...

文字 c1, c2,... は、 n で定義されるプロパティを持ちます。ここで n は以下のものを OR したものです。

1: この文字で文が終ります。 (初期状態では文字 .?! がこのプロパティを持ちます);
2: この文字の前でラインブレイク可能です (初期状態ではこのプロパティを持つ文字はありません); 両側の文字が非 0 のハイフネーションコードを持つ場合を除き、このプロパティを持つ文字の場所でラインブレイクはしません。
4: この文字の後でラインブレイク可能です (初期状態では文字 -\(hy\(em がこのプロパティを持ちます); 両側の文字が非 0 のハイフネーションコードを持つ場合を除き、このプロパティを持つ文字の場所でラインブレイクはしません。
8: この文字は水平にオーバラップします。 (初期状態では文字 \(ul\(rn\(ru がこのプロパティを持ちます);
16: この文字は垂直にオーバラップします。 (初期状態では文字 \(br がこのプロパティを持ちます);
32: このプロパティを持つ文字が任意数後続しその後に改行もしくは 2 つの空白が後続するような文の終りを表す文字は、文の終りとして扱われます; 言い替えると、この文字は文の終りの認識において透過です; TeX においてゼロ空白ファクタを持つのと同じです (初期状態では文字 s')]*\(dg\(rq がこのプロパティを持ちます)。

.char c string

文字 c を string と定義します。文字 c が表示される必要がある時はいつでも、一時的な環境で string が処理され、結果が単一のオブジェクトして生成されます。 string の処理中は、互換モードはオフにされエスケープ文字は \ に設定されます。太字化/定空白化/カーニングは、 string の各文字ではなくこのオブジェクトに対して適用されます。このリクエストによって定義された文字は、出力デバイスによって提供される通常の文字のように使用できます。特に、他の文字はこの文字に tr リクエストによって変換可能です; この文字は lc リクエストによってリーダ文字とすることが可能です; \l, \L エスケープシーケンスによって、この文字を繰り返しパタンで使用することが可能です; hcode リクエストによってこの文字がハイフネーションコードを持てば、この文字を含む語は正確にハイフネーション可能です。また特殊な非再帰機能があります: 文字の定義中にいて使用される文字は、通常の文字として扱われ、 char では定義されたものではありません。文字の定義は rchar リクエストにて除去可能です。

.chop xx

マクロ/文字列/転換 xx から最後の文字を切り落とします。文字列として挿入される転換から最後の改行文字を除去するのに有効です。

.close stream

stream という名前のストリームをクローズします; stream は write リクエストの引数とはなりえなくなります。 open リクエストを見て下さい。

.continue

while ループの現在の繰り返しを終了します。 while, break リクエストも見て下さい。

.cp n

n が非ゼロか存在しない場合、互換モードを有効にします。そうでない場合は互換モードを無効にします。互換モードでは、長い名前は理解されず、長い名前に起因する非互換性の問題は発生しません。

.dei xx yy

間接的にマクロを定義します。次の例は

.ds xx aa
.ds yy bb
.dei xx yy

以下と等価です。

: .de aa bb

.de1 xx yy

.de と同様ですが、実行中に互換モードはオフになります。入る時に現在の互換モードが保存され、終了時に回復されます。

.do xxx

.xxx を互換モードを無効にして解釈します。例えば

: .do fam T

は、互換モードが有効であっても機能することを除けば、

: .fam T

と同じ効果を持ちます。 xxx で使用するファイルを解釈する前に互換モードは元に戻されることに注意して下さい。

.ecs

現在のエスケープ文字を保存します。

.ecr

ecs で保存したエスケープ文字を復帰します。事前に ecs を呼び出していないと `\' が新しいエスケープ文字になります。

.evc xx

環境 xx の内容を、現在の環境へコピーします。環境のプッショおよびポップは行いません。

.fam xx

現在のフォントファミリを xx に設定します。現在のフォントファミリは現在の環境の一部です。 xx が無い場合は以前のフォントファミリに戻ります。フォントファミリに関するさらなる情報は、 sty リクエストの解説を見て下さい。

.fspecial f s1 s2...

現在のフォントが f の場合、フォント s1, s2,... がスペシャルとなります。すなわち、現在のフォントで存在しない文字がスペシャルフォントにおいて探されます。 special リクエストで指定されたフォントは fspecial リクエストで指定されたフォントの後に探されます。

.ftr f g

フォント f を g に変換します。 \f エスケープシーケンス中、 ft, ul, bd, cs, tkf, special, fspecial, fp, sty リクエスト中で、名前 f で参照されるフォントに関して、フォント g が使用されます。 g が指定されない場合および f と等しい場合は、フォント f は変換されません。

.hcode c1 code1 c2 code2...

ハイフネーションコードの設定を、文字 c1 に対し code1 、文字 c2 に対し code2 というふうに行います。ハイフネーションコードは、数字もしくは空白以外の単一入力文字 (非スペシャルな文字) である必要があります。初期状態では、各小文字はハイフネーションコードをそれ自体の文字として持ち、各大文字はハイフネーションコードを各小文字として持ちます。 hpf リクエストも見て下さい。

.hla lang

現在のハイフネーション言語を lang に設定します。 hw リクエストで指定されるハイフネーション例外および hpf リクエストで指定されるハイフネーションパタンは現在のハイフネーション言語に関連づけられます。 hla リクエストは通常 troffrc ファイルから起動されます。

.hlm n

ハイフネーションされた行が連続できる行数の最大値を n に設定します。 n が負の場合、最大値はありません。デフォルト値は -1 です。この値は現在の環境と関連づけられています。行数のカウントは、一つの環境の中でその環境での最大値まで行われます。 \% の結果のハイフンはカウントされます; 明示的なハイフンはカウントされません。

.hpf file

ハイフネーションパタンを file から読み込みます; ファイルの探索は、 -mname オプションが指定された時に name.tmac が探されるのと同じ方法で行われます。このパタンは TeX における \patterns プリミティブの引数と同じフォーマットである必要があります; このファイル中の文字はハイフネーションコードとして解釈されます。パタンファイル中の % 文字は行末までのコメントを表します。ハイフネーションパタンのセットは hla リクエストにより指定される言語に関連づけられます。 hpf リクエストは通常 troffrc ファイルにより起動されます。

.hym n

ハイフネーションマージン を n に設定します: 現在の修正モードが b ではない時、行が n より短い場合には行はハイフネーションされません。デフォルトのハイフネーションマージンは 0 です。このリクエストに対するデフォルトのスケーリングインジケータは m です。ハイフネーションマージンは現在の環境と関連づけられています。現在のハイフネーションマージンは \n[.hym] レジスタを介して利用可能です。

.hys n

ハイフネーション空白を n に設定します: 現在の修正モードが b の場合、各単語の間の間隔に追加する間隔の幅を n 以下で行調整が済ませられる場合、その行はハイフネーションされません。デフォルトのハイフネーション空白は 0 です。このリクエストに対するデフォルトのスケーリングインジケータは m です。ハイフネーション空白は現在の環境と関連づけられています。現在のハイフネーション空白は \n[.hys] レジスタを介して利用可能です。

.kern n

n が非 0 か指定されない場合、文字ペア間カーニングを有効にします。そうでない場合は文字ペア間のカーニングを無効にします。

.length xx string

string の長さを計算し、これを数値レジスタ xx (前もって定義する必要はありません) に入れて返します。

.linetabs n

n が 0 でないか省略されるとライン-タブモードが有効になり、そうでない場合は無効にします (デフォルトは無効です)。ライン-タブモードではタブの幅が (現在の) 出力行に応じて計算されます。そうでない場合は入力行に応じて計算されます。例えば次のソース

.ds x a\t\c
.ds y b\t\c
.ds z c
.ta 1i 3i
\*x
\*y
\*z

は以下を生成します。

: a b c

ライン-タブモードでは同じコードが以下のようになります。

: a b c

ライン-タブモードは現在の環境に関連づけられます。ライン-タブモードでは読み出し専用の数値レジスタ \en[.linetabs] が ~1 にセットされ、そうでなければ 0 にセットされます。

.mso file

-m コマンドラインオプションが指定された場合にマクロファイルを検索するのと同じディレクトリで file を検索する点を除いて so リクエストと同じです。インクルードするファイル名が name.tmac の形式で、見つからない場合は、代わりに mso は tmac.name をインクルードしようとします。逆もまた同様です。

.nop anything

anything を実行します。これは `.if 1' と同様です。

.nroff

n ビルトイン条件を真にし、 t ビルトイン条件を偽にします。 troff リクエストを使用することで、逆にできます。

.open stream filename

filename を書き込みのためにオープンし、 stream という名前のストリームと関連づけます。 close, write リクエストも見て下さい。

.opena stream filename

open と同様ですが、 filename が存在する場合、縮小することはせずに、アペンドします。

.pnr

現在定義されている数値レジスタの名前と内容を標準エラー出力に出力します。

.psbb filename

PostScript イメージ filename のバウンディングボックスを得ます。このファイルは、 Adobe の Document Structuring Conventions に従うことが必要です。このコマンドは、 %%BoundingBox コメントを探し、バウンディングボックス値を得ます。呼び出しに成功すると、左下と右上の角の座標が (PostScript 単位で)、レジスタ \n[llx], \n[lly], \n[urx], \n[ury] にそれぞれ設定されます。なんらかのエラーが発生すると、4 個のレジスタは 0 に設定されます。

.pso command

入力が command の標準出力であることを除けば、 so リクエストのように動作します。

.ptr

全てのトラップ (入力行のトラップと転換のトラップは除きます) の名前と位置を標準エラー出力に出力します。ページトラップリストの空のスロットも出力されます。なぜなら、後で設置されるトラップの優先度に影響を与え得るからです。

.rchar c1 c2...

文字 c1, c2,... の定義を取り除きます。 char リクエストの影響を取り除きます。

.return

マクロ中であれば即座に復帰します。それ以外では何もしません。

.rj

.rj n 後続する n 入力行を右揃えします。引数が無い場合、次の行を右揃えします。右揃えされる行の数は \n[.rj] レジスタを介して利用可能です。本リクエストにより暗黙的に .ce 0 となります。 ce リクエストは暗黙的に .rj 0 します。

.rnn xx yy

数値レジスタ xx を yy にリネームします。

.shc c

ソフトハイフン文字を c にします。 c が省略された場合、ソフトハイフン文字はデフォルトの \(hy になります。ソフトハイフン文字は、語がラインブレイクによってハイフネーションされる時に挿入される文字です。ブレイクすべき位置の直前の文字のフォントにソフトハイフン文字が存在しない場合、そのような位置ではブレイクしません。ソフトハイフン文字を見付ける時には、定義 ( char リクエストで指定) も変換 ( tr リクエストで指定) も解釈されません。

.shift n

マクロ中で引数を n ポジションだけシフトします: 引数 i は引数 i-n となります; 引数 1 から n は使用不能となります。 n が指定されない場合、引数は 1 シフトされます。負のシフトは現在未定義です。

.special s1 s2...

フォント s1, s2, はスペシャルであり、現在のフォントには無い文字が探されます。

.sty n f

スタイル f をフォント位置 n と関連づけます。フォント位置はフォントもしくはスタイルと関連づけ可能です。現在のフォントはフォント位置のインデックスであり、つまり、フォントもしくはスタイルです。現在のフォントがスタイルである場合、実際に使用されるフォントは、現在のファミリ名と現在のスタイル名とを結合した名前をもつものとなります。例えば現在のフォントが 1 であり、フォント位置 1 がスタイル R と関連づけられており、現在のフォントファミリが T である場合、フォント TR が使用されます。現在のフォントがスタイルではない場合、現在のファミリは無視されます。リクエスト cs, bd, tkf, uf, fspecial がスタイルに適用される場合、実際は当該スタイルに対応する現在のファミリのメンバに対して適用されます。デフォルトファミリは -f オプションで設定できます。 DESC ファイル中のスタイルコマンドが、 (もし存在すれば) どのフォント位置が初期状態においてフォントではなくスタイルに関連づけられているのかを制御します。

.substring xx n1 [n2]

レジスタ xx 中の文字列を、インデックス n1 と n2 で指定されるサブ文字列で置き換えます。文字列の最初の文字はインデックス 1 です。 n2 が省略されると、文字列の長さとみなされます。インデックス値 n1 または n2 が負または 0 である場合、文字列の末尾から後ろ向きに数えます。すなわち、最後の文字がインデックス 0 であり、最後の文字の前の文字が -1 などとなります。

.tkf f s1 n1 s2 n2

フォント f に対しトラックカーニングを有効にします。現在のフォントが f である場合、全ての文字の幅が n1 から n2 の範囲で増加します; 現在のポイントサイズが s1 以下の場合、幅は n1 増えます; 現在のポイントサイズが s2 以上の場合、幅は n2 増えます; ポイントサイズが s1 以上かつ s2 以下の場合は、増加する幅はポイントサイズの線形関数となります。

.tm1 string

tm リクエストと同様です。 string がコピーモードで読み込まれて標準エラーに書き出されます。ただし先頭に空白を置けるようにするために、 string の最初のダブルクォートは取り除かれます。

.tmc string

tm1 と同様ですが最後の改行を出力しません。

.trf filename

透過的にファイル filename の内容を出力します。各行の出力は各行の先頭に \! ついたものとして出力されます。しかし、行はコピーモードにおける解釈の対象とはなりません。ファイルが改行文字で終らない場合、改行文字が追加されます。例えば、ファイル f の内容を含むマクロ x を定義するには、

: .di x; .trf f; .di

とします。 cf リクエストとは異なり、ファイル中には NUL といった troff 入力文字として不正なものを含むことはできません。

.trnt abcd

\! により転換へ透過的に取り込まれるテキストに対して適用されないことを除いて、 tr リクエストと同じです。例えば、

.tr ab
.di x
\!.tm a
.di
.x

は b を表示します; trnt が tr のかわりに使われた場合、 a を表示します。

.troff

n ビルトイン状態を偽に、 t ビルトイン状態を真にします。 nroff リクエストの効果を打ち消します。

.unformat xx

このリクエストは、転換 xx を `アンフォーマット' します。転換の整形済み要素を可能な限り入力トークンに復元しようと試みる .asciify リクエストとは逆に、 .unformat は単語間のタブとスペース (通常、入力中のスペースか改行で生じる) のみ特別扱いします。前者はそれらが入力トークンであるかのように扱われます。そして後者は再び伸び縮み可能と扱われます。行の垂直方向のサイズが保存されないことに注意してください。グリフ情報 (フォント、フォントサイズ、スペース幅等々) は保たれます。 .box と .boxa リクエストと組み合わせると便利です。

.vpt n

n が非 0 の場合垂直位置トラップを有効にします。そうでない場合、垂直位置トラップを無効にします。垂直位置トラップは wh , dt リクエストにより設定されるトラップです。 it リクエストにより設定されるトラップは垂直位置トラップではありません。垂直位置トラップが発生するか否かを制御するこのパラメータは大域的です。初期状態では垂直位置トラップは有効です。

.warn n

警告を制御します。 n は有効とされるべき警告と関連づけられた数の和です; その他の警告は無効となります。警告と関連づけられる数のリストは`警告'の章に記載します。例えば .warn 0 は全ての警告を無効にします。また、 .warn 1 は存在しない文字に関する警告のみを有効にします。 n が与えられない場合、全ての警告が有効になります。

.while c anything

条件 c が真の間、 anything を入力として受け付けます; c は if リクエストとして受理可能な任意の条件です; 最初の行が \{ で開始され最後の行が \} で終了する場合、 anything は複数行となり得ます。 break, continue リクエストも見て下さい。

.write stream anything

anything を stream という名前のストリームに書き込みます。 stream はすでに open リクエストの対象であったはずです。 anything がコピーモードで読まれます; 先行する s は取り除かれます。

.writem stream xx

マクロまたは文字列 xx の内容を stream で指定されたストリームへ書き出します。 stream は事前に open リクエストでオープンされていなければなりません。 xx はコピーモードで読まれます。

拡張されたリクエスト

.cf filename

転換の中で使用された場合は、後でその転換が読み込まれるときに、 filename の内容が透過的に出力にコピーされるようなオブジェクトをその転換の中に埋め込みます。

UNIX troff では、現在、転換の中かどうかにかかわらず filename の内容はすぐに出力にコピーされます; この動作は変則的でありバグに違いありません。

.ev xx

xx が数でない場合、 xx で呼ばれる名前付き環境に切り替えます。引数なしの ev リクエストに対しては、番号付き環境の場合と同様に、対応する環境がポップされます。名前のある環境の数には制限はありません; 最初に参照される時に生成されます。

.fp n f1 f2

fp リクエストはオプションで 3 番目の引数を取ります。この引数はフォントの外部名を与えます。この名前でフォント記述ファイルを探します。 2 番目の引数はフォントの内部名であり、フォントをマウントした後に troff 中でフォントを参照するのに使用します。 3 番目の引数が無い場合は内部名を外部名として使用します。この機能により、互換モードにて長い名前のフォントを使用できます。

.ss m n

ss リクエストに対し 2 つの引数が与えられる場合、 2 番目の引数は 文の空白サイズ を与えます。 2 番目の引数が与えられない場合、文の空白サイズは語の空白サイズと同じになります。語の空白サイズと同様、文の空白サイズは現在のフォントの空白幅パラメータの 1/12 を単位とします。語の空白サイズと文の空白サイズの初期値はともに 12 です。 UNIX troff に反して GNU troff はこのリクエストも nroff モードで扱います。それから指定された値は ~12 の倍数で最も近い値に丸められます。文の空白サイズは 2 つの状況にて使用されます: 行詰めモードにて文の終りとなった場合、語間の空白と文の空白がともに追加されます; 行の途中にて、文の終りに引続き 2 つの空白が後続する場合、 2 番目の空白は文の空白となります。リクエストの 2 番目の引数を与えなければ、 GNU troff の動作は UNIX troff の動作と完全に同じになります。 GNU troff では UNIX troff と同様、改行及び 2 つの空白にて文を追跡します。

.ta n1 n2...nn T r1 r2...rn

タブ位置を n1, n2,..., nn とし、その後タブ位置を nn+r1, nn+r2,...., nn+rn とし、その後タブ位置を nn+rn+r1, nn+rn+r2,..., nn+rn+rn, とし…ということを繰り返します。例えば、

: .ta T .5i

は 1/2 インチ毎にタブ位置とします。

新しい数値レジスタ

以下の読み取り専用レジスタが利用可能です:

\n[.C]: 互換モード時に 1 に、そうでない場合は 0 になります。
\n[.cdp]: 現在の環境に付加されている最後の文字の深さ。文字がベースラインより下にいく場合に正になります。
\n[.ce]: 中央寄せされるべき残りの行数。この値は ce リクエストでセットされます。
\n[.cht]: 現在の環境に付加されている最後の文字の高さ。文字がベースラインの上にいく場合に正になります。
\n[.csk]: 現在の環境に付加されている最後の文字のスキュー値。文字の スキュー は、その文字の上に付くアクセントがその文字の中央からどれだけ右によって配置されるかを表します。
\n[.ev]: 現在の環境の名前もしくは番号。これは文字列で値を保持するレジスタです。
\n[.fam]: 現在のフォントファミリ。これは文字列で値を保持するレジスタです。
\n[.fp]: 次のフリーフォント位置の数を表します。
\n[.g]: 常に 1 です。マクロ中で GNU troff 下で動作しているかどうかを判定するには、この値を使用すること。
\n[.hla]: hla リクエストにより設定された現在のハイフネーション言語。
\n[.hlc]: 連続してハイフネーション処理した行数。
\n[.hlm]: 連続してハイフネーション処理して良い最大値。この値は、 hlm リクエストで設定されます。
\n[.hy]: 現在のハイフネーションフラグ ( hy リクエストにて設定されます)。
\n[.hym]: 現在のハイフネーションマージン ( hym リクエストにて設定されます)。
\n[.hys]: 現在のハイフネーション空白 ( hys リクエストにて設定されます)。
\n[.in]: 現在の出力行に適用されているインデント。
\n[.int]: 直前の出力行が割り込まれた場合に正の値に設定されます (つまり \c を含んでいる場合です)。
\n[.kern]: 文字ペア間カーニングが有効なら 1、そうでないなら 0 です。
\n[.lg]: 現在のリガチャモードを表します ( lg リクエストにて設定されます)。
\n[.linetabs]: 現在のライン-タブモード ( linetabs リクエストで設定された)。
\n[.ll]: 現在の出力行に適用する行の長さ。
\n[.lt]: lt リクエストにより設定されたタイトル長。
\n[.ne]: 最後にトラップを起こした ne リクエストに必要だった空白の量。 \n[.trunc] レジスタとともに使用します。
\n[.ns]: 空白モードが有効でない場合は 1 で、そうでない場合は 0 です。
\n[.pn]: 次のページ番号: pn リクエストにて設定されるか、現在のページ番号に 1 を加えたものです。
\n[.ps]: スケールドポイント単位で表した現在のポイントサイズです。
\n[.psr]: スケールドポイント単位で表した最後にリクエストされたポイントサイズです。
\n[.rj]: 右揃えすべき行数。 rj リクエストにより設定されます。
\n[.sr]: 最後にリクエストされた10進数分数ポイントで表すポイントサイズ。これは文字列で値を保持するレジスタです。
\n[.tabs]: 現在のタブ設定の文字列表記であり、 ta リクエストの引数としてそのまま利用可能です。
\n[.trunc]: 最後に発生した垂直位置トラップにより縮められた垂直空白の量。トラップが ne リクエストにて生じた場合、 ne リクエストにより垂直位置位置の移動分は差し引かれます。言い替えるなら、トラップが発生した場所で、トラップがなかったとした場合の垂直位置と、実際の垂直位置との差を表します。 \n[.ne] レジスタとともに使用すると効果があります。
\n[.ss]
\n[.sss] ss リクエストの最初の引数および 2 番目の引数により設定された値を与えます。
\n[.vpt]: 垂直位置トラップが有効の場合 1、そうでない場合は 0 です。
\n[.warn]: 現在有効となっている警告に関連づけられている数の和です。警告に関連づけられている数字のリストは`警告'節に記載されています。
\n[.x]: メジャーバージョン番号。例えばバージョン番号が 1.03 の場合、 \n[.x] は 1 です。
\n[.y]: マイナバージョン番号。例えばバージョン番号が 1.03 の場合、 \n[.y] は 03 です。
\n[.Y]: groff のバージョン番号。
\n[llx]
\n[lly]
\n[urx]
\n[ury] これらの 4 個のレジスタは、 .psbb リクエストによって設定され、指定された PostScript イメージに対する (PostScript 単位での) バウンディングボックス情報を保持します。

以下の読み書き可能レジスタは \w エスケープシーケンスで設定されます:

\n[rst]
\n[rsb] st, sb レジスタと同様ですが、文字の高さと深さも考慮に入れます。
\n[ssc]: 最後の文字から下付き文字までに加えられる水平空白の量。負も取り得ます。
\n[skw]: \w 引数における最後の文字の中央からどれほど右にずれて、ローマンフォントのアクセントの中央がその文字上に配置されるかを表します。

他に利用可能な読み書き可能の数値レジスタとして以下があります:

\n[c.]: 現在の入力行番号。 \n[.c] はこのレジスタの別名であり、読み出し専用です。
\n[hp]: 入力行での現在の水平位置です。
\n[systat]: sy リクエストにより最後に実行された system() の戻り値。
\n[slimit]: 0 より大きい場合、入力スタックの最大オブジェクト数を表します。 0 以下の場合、入力スタック上のオブジェクト数に制限はありません。制限が無い場合、仮想記憶を使い果たすまで再帰が続くことがあります。
\n[year]: 現在の年。伝統的な troff 数値レジスタ \n[yr] は、現在の年から 1900 を減じた値であることに注意してください。

その他

troff は、(読み書き用) 文字列ベースのレジスタ \*(.T を前もって定義しており、これには -T コマンドラインオプションに与えられた引数、すなわち現在の出力デバイスを保持しています (例えば latin1 や ascii )。これは、(読み込み専用の) 数値レジスタ \n[.T] が、 troff が -T コマンドラインオプション付で呼び出されたときに 1 に定義され、そうでないときに 0 に定義されるのとは同じではありません。この動作は、UNIX troff とは異なります。

DESC ファイルに記述されていないフォントは、参照された時点で自動的に次の利用可能なフォント位置にマウントされます。フォントを明示的に fp リクエストにて未使用のフォント位置にマウントする場合、最初の未使用のフォント位置にマウントしなければなりません。この位置は \n[.fp] レジスタにて参照できます; しかしながら、 troff はこれを厳密には強いません。現在使用されている位置よりも多大に大きくずれる位置にマウントされることは許されません。

文字列の挿入は既に存在するマクロ引数を隠しはしません。それゆえマクロ中で

: .xx \\$@

をより効率良く行うためには、

: \\*[xx]\\

とします。

フォント記述ファイルに文字ペア間カーニング情報が含まれる場合、このフォントから出力される文字はカーニングされます。 \& を 2 つの文字間に置くことで、その文字間のカーニングを禁止できます。

条件において文字列を比較する場合、最初のデリミタと異なる入力レベルにおいて出現する文字は 2 番目 3 番目のデリミタとして認識されません。これは tl リクエストにも当てはまります。 \w エスケープシーケンスにおいて、最初のデリミタ文字とは異なる入力レベルにある閉じる方のデリミタ文字は、認識されません。マクロ引数をデコードする時に、マクロ引数がダブルクォートで区切られる場合、最初のデリミタ文字とは異なる入力レベルにある文字は、閉じる方のデリミタ文字とは認識されません。 \$@ の実装では、引数を括るダブルクォートは同じレベルとなることが保証されています。このレベルは引数の入力レベルとは異なります。長いエスケープ名中では ] は開く方の ] の入力レベルと同じである場合を除き、閉じる方のデリミタとは認識されません。互換モードでは入力レベルに対する注意は払われません。

条件が増えました:

.if rxxx: 数値レジスタ xxx が存在する場合に真となります。
.if dxxx: 文字列/マクロ/転換/リクエストに xxx という名前のものがあった場合に真になります。
.if cch: 文字 ch が使用可能な場合に真になります; ch は ASCII 文字でもスペシャル文字 \(xx, \[xxx] でもかまいません; ch が char リクエストにて定義された場合にも真になります。

tr リクエストは文字を \~ にマップできるようになりました。

警告

troff が出力する警告は以下のカテゴリに分類されます。各警告に関連する名前は -w, -W オプションで使用可能です; また番号は、 warn リクエストおよび .warn レジスタが使用します。

char 1: 存在しない文字。デフォルトで有効です。
number 2: 不正な数式。デフォルトで有効です。
break 4: 行詰めモードにて、行を分割できなかったため、行の長さよりも短くなってしまいました。デフォルトで有効です。
delim 8: 閉じる方のデリミタが無いもしくはマッチしません。
el 16: 対応する ie リクエストの無い、 el リクエスト。
scale 32: 意味の無いスケーリングインジゲータ。
range 64: 引数が範囲を越えています。
syntax 128: 数式中の曖昧な文法。
di 256: 現在転換が無いにもかかわらず、引数無しで di, da を使用した。
mac 512: 未定義の文字列、マクロ、転換を使用した。未定義の文字列、マクロ、転換を使用した場合、文字列が自動的に空に定義されます。このため各名前に対する警告は大概最大 1 回だけです。
reg 1024: 未定義の数値レジスタを使用した。未定義の数値レジスタを使用した場合、レジスタが自動的に値 0 に定義されます。定義は自動的に値 0 にて行われます。このため各名前に対する警告は大概最大 1 回だけです。
tab 2048: タブ文字の使用が不適切でした。数字が期待される場所でタブを使用したか、クォートされいてないマクロの引数中でタブ文字を使用したかのどちらかでしょう。
right-brace 4096: 数字が期待される場所で \} が使用された。
missing 8192: 非オプション引数が足りないリクエスト。
input 16384: 不正な入力文字。
escape 32768: 認識できないエスケープシーケンス。認識できないエスケープシーケンスに会った場合は、そのエスケープ文字は無視されます。
space 65536: リクエストもしくはマクロとそれらの引数の間に空白がありません。この警告は、2 文字より長い未定義の文字に会った場合で最初の 2 文字が定義された名前のときに起こり得ます。このときリクエストもしくはマクロは起動されません。この警告が発せられる時、どのようなマクロも自動的には定義されません。デフォルトで有効です。この警告は互換モードでは起こり得ません。
font 131072: 存在しないフォント。デフォルトで有効です。
ig 262144: ig リクエストにより無視されたテキストの中にある不正なエスケープ。これらは無視されたテキストの中では発生しないエラーです。

警告のグループを指定する名前もあります:

all: すべて、ただし di, mac, reg を除きます。伝統的なマクロパッケージを使用する際に有用な警告の全てをカバーするように導入されました。
w: 全ての警告。

非互換性

長い名前を使用すると非互換性の問題が起こる場合があります。 UNIX troff は

: .dsabcd

を文字列 ab の定義であり、その内容が cd であると解釈します。通常、GNU troff はこれをマクロ dsabcd の呼び出しであると解釈します。また、UNIX troff は \*[ と \n[ を、文字列/数値レジスタ [ の参照であると解釈します。しかし、GNU troff では、これは通常長い名前の始まりであると解釈します。 互換モード では GNU troff はこれらを伝統的な方法で解釈します。また長い名前は認識されません。互換モードは -C コマンドラインオプションにて有効に出来、 cp リクエストにて有効無効の切替えが出来ます。互換モードが有効の場合には数値レジスタ \n[.C] が 1 となり、そうでない場合は 0 となります。

GNU troff は文字列/マクロ/展開/数値レジスタ/フォント/環境の名前において、エスケープシーケンス \e\|\^\&\}\{\(space)\'\`\-\_\!\%\c を使用することを許しません; 一方 UNIX troff では出来ます。名前中でのこれらのエスケープシーケンスの使用を避けるには、 \A エスケープシーケンスが役に立つかもしれません。

分数のポイントサイズは顕著な非互換性を引き起こします。 UNIX troff では ps リクエストはスケールインジケータを無視するため

: .ps 10u

はポイントサイズを 10 ポイントに設定しますが、 GNU troff ではポイントサイズを 10 スケールドポイントに設定します。

GNU torff では、フォーマットされていない入力文字とフォーマットされた出力文字との間に基本的な違いがあります。出力文字がどのように出力されるのかに影響することがらは全て、その文字に記録されています。一度出力文字が構成されたならば、その出力文字はその後に実行されるリクエストの影響を受けません。このリクエストには bd, cs, tkf, tr, fp リクエストが含まれます。通常、出力文字が入力文字から構成されるのは、出力文字が現在の出力行に追加される直前です。マクロ/転換/文字列は実際同じタイプのオブジェクトです; すなわち入力文字のリストと出力の文字の任意の組み合わせのリストを保持しています。マクロ処理においては出力文字は入力文字のようには振舞いません; 出力文字は、その元の入力文字が持っていた特殊なプロパティを一切継承しません。例えば、

.di x
\\\\
.br
.di
.x

は GNU groff では \\ を表示します; 各 \ のペアは単一の出力 \ になり、出力結果の複数の \ は、再読み込みの時にはエスケープ文字としては解釈されません。 UNIX troff では再読み込みの時にはエスケープ文字として解釈されるため、最終的な結果は単一の \ となります。表示可能な \ を得る正しい方法は、 \e エスケープシーケンスを使用することです: このエスケープシーケンスは、転換の中であるか否にかかわらず、常に現在のエスケープ文字実体を一つ表示します; これは GNU troff でも UNIX troff でも動作します。転換中に、転換が再読み込みされた時に解釈されるようなエスケープシーケンスを埋め込みたい場合、伝統的な \! 透過出力機構を使用するか、これが適当でないなら新しい \? エスケープシーケンスを使用して下さい。

環境変数

GROFF_TMAC_PATH: : で区切られた、マクロファイルを検索すべきディレクトリ名のリスト。 troff は、それらの前に -M オプションで指定されたディレクトリを調べ、そららの後で標準のディレクトリ (安全でないモードでは現在のディレクトリ、ホームディレクトリ、 /usr/share/tmac/, /usr/share/tmac/, /usr/share/tmac/) を調べます。
GROFF_TYPESETTER: デフォルトの出力デバイス
GROFF_FONT_PATH: : で区切られた、フォントを検索すべきディレクトリ名のリスト。 troff は、まず -F オプションで指定されたディレクトリを検索し、次に本環境変数で指定されたディレクトリ、最後に標準のディレクトリ ( /usr/share/groff_font ) を検索します。

書式

解説