GROFF(7)

名称
groff - GNU roff 言語の簡易リファレンス

解説
groff とは、 GNU roff を表しており、roff 清書システムをフリーで実装したものです。 groff システムの概観ならびに背景については roff(7) を参照してください。

このドキュメントでは、groff 内で使用される、あらかじめ定義された roff 言語要素を簡潔に説明しているだけです。 古くからある機能と groff 拡張機能についての両方とも扱っています。

歴史的に、 roff 言語 は troff と呼ばれています。 groff は、古くからあるシステムと互換性を持ちつつ、独自の拡張機能も 提供しています。 そのため GNU 版では、 roff, troff, groff 言語 という術語は同義として使うこともできるでしょう。 しかし、 troff は、どちらかと言えば古くからの機能に対して適用されるという 傾向があり、それに対して、 groff は GNU 拡張に重きを置いています。 そして、 roff は、この言語の一般的な術語になっています。

このファイルは、 groff info(1) ファイルにある完全なドキュメントの簡易版に過ぎません。 info ファイルの方がより詳細で実情に近く、正確な情報を含んでいます。

groff ドキュメントを書くために使う一般的な文法は比較的 やさしいのですが、 roff 言語の拡張機能を書くのは少々骨が折れるかもしれません。

roff 言語は、行指向の言語です。 行には、制御行とテキスト行の 2 種類しかありません。 制御行は制御文字で始まります。 制御文字は、デフォルトではピリオド あるいはシングルクォート です。 そのほかの文字で始まる行はすべてテキスト行です。

制御行 は、コマンドを表し、オプションで引数を取ることもあります。 制御行は、次のような文法になります。 先頭の制御文字の後には、コマンド名を続けることができます。 引数は、もしあれば、コマンド名や他の引数と空白で分けられます。 例えば、次のようにします。

    .command_name arg1 arg2

インデント用に、先頭の制御文字とコマンド名との間にはスペースや タブ文字をいくつ入れても良いですが、制御文字は行の先頭になくては なりません。

テキスト行 は、表示される部分のことです。 テキスト行はエスケープシーケンスで変更することができます。 エスケープシーケンスは先頭にバックスラッシュ を置くことで認識されます。 これらは、行や単語の一部に含まれ、整形要素となったり 関数となったりします。 エスケープシーケンスには、シングルクォート で区切られた引数を取るものもありますし、 開き括弧 に続いて符合化され長さの一定なものや、角括弧 と で括られているものもあります。

roff 言語は、マクロなど、言語拡張機能を書くための柔軟な手段を 提供しています。 マクロ定義を解釈する際に、roff システムは コピーモード と呼ばれる特別なモードに入ります。

コピーモードの振る舞いはとても扱いにくいものでもありますが、 確実に安全に使えるようにするルールがいくつかあります。

1.  表示可能なバックスラッシュは と記述しなくてはなりません。 もっと正確に言えば、 は現在のエスケープ文字を表します。 バックスラッシュのグリフを得るには を使用してください。

2.  バックスラッシュはすべて 2 重にしてください。

3.  テキスト行はすべて、スペースをとらない特殊文字 で始めてください。

このやり方は、一番効率の良いコードが生成できる というわけではありませんが、最初の一歩としては使えるはずです。 さらに良いやり方については groff info ファイルおよび groff_tmac(5) を参照してください。

roff ソースファイルを読むのはこれよりは簡単です。 すべてのマクロ定義部分で 2 重になっているバックスラッシュを 1 つに置き換えればよいだけです。

groff 要素
roff 言語の要素は、テキストファイルに整形用情報を 付加するものです。 基本的な要素は、あらかじめ定義されたコマンド および変数であり、 この要素のおかげで roff は本格的なプログラミング言語に なっているのです。

roff コマンドには 2 種類あります。 コマンドは引数を取ることもあります。 リクエスト は、ドット あるいは で始まる行に書かれるものです。 これに対して エスケープシーケンス は、 バックスラッシュ で始まる、行埋め込み式の関数や単語中の整形要素です。

ユーザは独自の整形コマンドを リクエストを使って定義することができます。 これらのコマンドは マクロ と呼ばれていますが、実際にはリクエストとまったく同様に使われます。 マクロパッケージは groff 言語で書かれた定義済みのマクロセットです。 ユーザが独自にエスケープシーケンスを作成できる場合というのは 非常に限られており、特殊文字のみマップすることができます。

groff 言語は、異なるインタフェースを持ついくつかの種類の変数を 提供しています。 定義済みの変数もありますが、ユーザも同様に自分で変数を定義できます。

文字列 変数は文字列を格納します。 この変数は リクエストで設定され、値は エスケープシーケンスを使って取り出します。

レジスタ 変数は数値、スケールファクタつき数字、 場合によっては文字列に似たオブジェクトを格納できます。 リクエストで設定され、値は エスケープシーケンスを使って取り出します。

環境 を使うことによって、行の長さやフォントサイズなどのような グローバルな整形パラメータを、後の再利用のために ユーザが一時的に格納することができます。 これは リクエストによって行われます。

フォント は、名前もしくは内部番号のどちらかで判別されます。 現在のフォントは リクエストもしくは エスケープシーケンスで選択されます。 デバイスごとに特別フォントがありますが、次のフォントはすべての デバイスで利用可能です。 R は標準フォント、ローマン体です。 B はその ボールド体 です。 イタリック体 フォントは I と呼ばれておりどこででも利用可能ですが、テキストデバイスでは ローマン体フォントに下線がついたものとして表示されます。 グラフィカルの出力デバイスに対しては、次のフォントの固定幅の 修飾文字が存在します。 CR, CI, および CB です。 テキストデバイスでは、いずれにしても文字はすべて固定幅です。

さらに、roff の拡張要素がいくつかあります。 ディバージョン は、後で利用できるように情報をマクロに格納します。 トラップ は、ページの先頭から何行目とか、ディバージョンや入力において 何行目というような位置条件です。 アクションの中には、条件が揃ったときに自動的に起動するように 指示できるものがあります。

これより詳細な情報については、groff info ファイルに示されています。

制御文字
ある条件下で特別な制御タスクをもつ文字が いくつかあります。

ドットは、行の先頭あるいは
    および リクエスト中の条件の後にある場合のみ特別です。 その位置では、リクエスト (あるいはマクロ) を導入する制御文字になります。 エスケープを使うと、この特別な動作を遅らせることができます。 リクエストを使うことで、この制御文字を別の文字に設定して、 ドット を特殊文字でなくすることができます。

    他の位置にドットがあるときは、ただのドット文字以上の意味はありません。 テキスト段落の中では、文はそれぞれ新しい行で始めるほうが有利です。

シングルクォートには 2 つの制御機能があります。
    行の先頭および条件リクエスト内では、 シングルクォートは非ブレーク制御文字になります。 これは、ドットのようにリクエストを導入しますが、 リクエストが行を折り返さないような追加のプロパティをつけるものです。 リクエストを用いると、非ブレーク制御文字を別の文字に設定する ことができます。

    2 つめのタスクとして、シングルクォートは、 いくつかの関数エスケープシーケンスの中で 引数の区切り文字としてよく使用されます (引数に含まれない文字のペアならどれでも良いのですが)。 その他の場所にあれば、シングルクォート文字 あるいはアポストロフィ文字になります。 groff は、表示用の表記として エスケープシーケンス を提供しています。

ダブルクォートはリクエストおよびマクロ中の引数を括るときに使用されます。
    および リクエスト内では、引数の先頭にくるダブルクォートは取り除かれ、 その後に続くダブルクォート以外の文字を定義文字列とします (先頭に空白が来るのを有効にします)。 エスケープされたダブルクォート はコメントの開始になります。 それ以外は、ダブルクォートには特別な機能はありません。 groff は、表示用の表記として エスケープシーケンス を提供しています。

バックスラッシュは、通常エスケープシーケンスの開始を意味しています
    (この文字は、 リクエストによって変更できます)。 表示用のエスケープ文字は、エスケープシーケンス で、バックスラッシュのグリフは で得られます。

開き括弧は、エスケープシーケンス内で、ちょうど 2 文字でできた
    エスケープ名あるいは引数を導入したときのみ特別な意味を持ちます。 groff では、この動作は [] の組で置き換えることができます。

開き角括弧は、groff のエスケープシーケンス内でのみ特別な意味を持ちます。
    これは、長いエスケープシーケンス名やエスケープシーケンスの引数を 導入するときに使用します。 それ以外の場合は、例えばマクロ呼び出しなどでも特別な意味はありません。

閉じ角括弧は、groff のエスケープシーケンス内でのみ特別な意味を持ちます。
    これは、長いエスケープシーケンス名やエスケープシーケンスの引数を 終わらせます。 それ以外の場合は、特別な意味はありません。

space
    空白文字は、機能的な働きしか持たない文字です。 これは、 リクエストやマクロの引数の区切り文字、 およびテキスト行における単語の区切り文字です。 また、空白文字は groff の単語間の水平方向の空白計算に作用します。 定義された空白幅を得たい場合は、 (エスケープ文字とそれに続いた空白文字)、 あるいは のようなエスケープシーケンスを使う必要があります。

newline
    テキストの段落においては、改行は空白文字とほぼ同じような作用をします。 連結された行は、エスケープした改行で指定できます。 つまり、行の最後の文字に を指定するのです。

tab テキスト中にタブ文字があれば、インタプリタは次の定義済みのタブ位置へ 水平方向にインデントを作ります。 タブ位置の調整には洗練されたインタフェースが存在します。

数式
数値 は、符号つき整数、符号なし整数、浮動小数点実数のいずれか、 およびそれに単位指定子を付加したものです。 単位指定子 は、計測単位を表す 1 文字の略語です。 単位指定子が後についた数字は、サイズに関する値を意味しています。 デフォルトでは、数値は単位指定を持ちません。 つまり、単なる数字にすぎません。

roff 言語では、次の単位指定子を定義しています。

c | センチメートル
i | インチ
P | パイカ 1/6 インチ
p | ポイント 1/72 インチ
m | em ポイント値でのフォントサイズ (文字 `m' の幅)
M | em の 100 倍
n | en em/2
u | 実際の出力デバイスでの基本単位
v | 基本単位での行送り幅
z | スケールされたポイント数 1 ポイントの 1/sizescale 倍 (フォントの DESC ファイルで定義)

数式 は、先で定義された数値と算術演算子 (剰余), 比較演算子 ( と同じ), 論理演算子 (論理積), (論理和), (否定), および括弧 と との組み合わせです。

さらに、 groff は、数式に対して次の演算子を追加しました。

e1>?e2 | e1 と e2 の最大値
e1<?e2 | e1 と e2 の最小値
(c;e) | c をデフォルトの単位指定子として e を評価

詳細は groff info ファイルを参照してください。

条件式
条件式 は、リクエスト および での判定文で出てきます。 次の表にいろいろな種類の条件式を示します。

N | 数式 N は値が 0 より大きければ真を返します。
!N | N の値が 0 以下であれば真です。
's1's2' | 文字列 s1 が文字列 s2 と同一であれば真です。
!'s1's2' | 文字列 s1 が文字列 s2 と同一でなければ真です。
cch | 文字 ch が利用可能であれば真です。
dname | name という文字列、マクロ、ディバージョン、 リクエストが存在すれば真です。
e | 現在のページ番号が偶数なら真です。
o | 現在のページ番号が奇数なら真です。
n | フォーマッタが nroff なら真です。
rreg | reg というレジスタがあれば真です。
t | フォーマッタが troff なら真です。

リクエスト
このセクションでは、定義済みのリクエストについて短いリファレンスを 与えます。 groff では、リクエストとマクロの名前を任意の長さにすることができます。 長い名前に対して括弧で括ったりマークをつける必要はありません。

たいていのリクエストは 1 つ、ないしは複数の引数をとります。 引数は空白文字で区切られます (タブではありません!)。 引数の長さや数について、固有の制限はありません。 引数はダブルクォートで括ることができます。 引数に空白文字が含まれる場合にとても便利です。 例えば、 は 1 つの引数を表しています。

リクエストの中には、引数を与えると、引数なしの場合と異なった動きを するものがあります。 その詳細すべてについては、ここでは説明しません。 詳細は、groff info ファイルを参照してください。

後に述べるリクエストの説明では、引数の名前の多くは その意味を表すように選ばれています。 次にあげる表記についてだけは、意味を明らかにする必要があるでしょう。

c | 1 文字を表します。
font | フォント名あるいはフォント番号で指定されたフォント
anything | 行末までのすべての文字、あるいは \{ と \} に囲われた文字
n | 評価されると整数値を返す数式
N | 符号つきまたは符号なしの任意の数式
±N | 符号によって 3 つの意味があります。 次に説明をします。

で定義された式が 符号で始まる場合、この式の結果の値は、関連するリクエストが すでに持っている固有値に加算されます。 例えば、数値レジスタに加算されます。 式が で始まる場合、この式の結果の値は、リクエストの値から減算されます。

符号がない場合は、既存の値を で直接置き換えます。 負の値を指定する場合は、 を前に置くかあるいは負の値を括弧で括ってください。

  リクエストの簡易リファレンス
空行 (無視されます)。ドキュメントの整形に便利です。 行全体がコメントとなります。 を標準エラー出力に出力し、プログラムを終了します。 現在の位置揃えモードで出力行の位置揃えを開始します。 位置揃えモード で行の位置揃えを開始します (cl,r,b,n)。 フォーマット をレジスタ に割り当てます (cl,i,I,a,A)。 レジスタ の別名 を作成します。 リクエスト、文字列、マクロ、ディバージョン の別名 を作成します。 が呼ばれるまでのものをマクロ に追加します。 が呼ばれるまでのものをマクロ に追加します。 リクエスト と同じですが、マクロ展開の時に互換モードが無効になります。 リクエスト と同じですが、マクロ展開の時に互換モードが無効になります。 文字列 を文字列変数 に追加します。 ディバージョン に含まれる ASCII 文字、スペース、およびエスケープシーケンスの いくつかをアンフォーマットします。 入力のバックトレースを標準エラー出力に出力します。 フォント を 単位分強調します。 現在のフォントが のときに特別フォント で強調します。 空行マクロを解除します。 空白行マクロをマクロ に設定します。 現在のディバージョンを終了します。 へ転換します。その際、部分的に行詰めされた行は取り除きます。 現在のディバージョンを終了します。 へ転換し、追加します。 その際、部分的に行詰めされた行は 取り除きます。 現在のページを終了して新しいページを開始します。 現在のページを終了します。 次のページ番号を にします。 改行です。 改行し、出力行を引き延ばします。 と同じです。 while ループを終了します。 非改行制御文字を に戻します。 非改行制御文字を に設定します。 制御文字を に戻します。 制御文字を に設定します。 次の入力行をセンタリングします。 次に来る 行の入力行をセンタリングします。 ファイル の内容をそのまま標準出力またはディバージョンへコピーします。 番号に従って、文字 を扱います。 の場所を に変更します。 文字 を 文字列 と定義します。 マクロ、文字列、ディバージョン の最後の 1 文字をとり除きます。 ストリーム をクローズします。 while ループにおける現在の繰り返し処理を終了します。 互換モードを有効にします。 N が 0 なら互換モードを無効にします。 それ以外なら有効にします。 フォント の固定文字幅モードを em に設定します (em は値 nroff の場合の連続アンダーライン。 troff のリクエスト に相当します。 現在のディバージョンを終了します。 マクロ に転換・追加します。 リクエスト が呼ばれるまでマクロ を定義 (再定義) します。 リクエスト が呼ばれるまでマクロ を定義 (再定義) します。 リクエスト と同じですが、マクロ展開の時に互換モードが無効になります。 リクエスト と同じですが、マクロ展開の時に互換モードが無効になります。 文字列レジスタ に名前が含まれるマクロを、 が呼ばれるまで定義 (再定義) します。 間接的にマクロを定義 (再定義) します。 および は文字列レジスタであり、この内容がそれぞれマクロ名と終了マクロに 挿入されます。 現在のディバージョンを終了します。 マクロ に転換します。 リクエスト を、互換モードを無効にして解釈します。 文字列変数 に文字列 を設定します。 ディバージョンのトラップ位置を に設定します (デフォルトの単位指定子は エスケープ文字を に戻します。 エスケープ文字を に設定します。 を用いて保存されているエスケープ文字を復元します。 現在のエスケープ文字を保存します。 if-else リクエスト (の else ブロックです。 入力が終わった後にマクロ を実行します。 エスケープ文字の処理を抑制します。 直前の環境に変更します。 環境 (番号または名前で指定) をプッシュして切り替えます。 環境 の内容を現在の環境にコピーします。 環境のプッシュまたはポップは行いません。 roff の処理を終了します。 以前のフォントファミリを返します。 現在のフォントファミリを に設定します。 フィールド機構を無効にします。 フィールド区切りを に設定し、パディング文字を空白にします。 フィールド区切りを に、パディング文字を に設定します。 出力行を埋めます。 出力バッファをフラッシュします。 位置 にフォント をマウントします。 長い名前 のフォントを短い名前 のフォントとし、位置 にマウントします。 現在のフォントが の場合に、 を特別フォントにします。 直前のフォントに戻します。 リクエスト と同じです。 フォント名または番号 に変更します。 エスケープシーケンス と同じです。 フォント をフォント に変換します。 追加ハイフネーション指定文字を削除します。 追加ハイフネーション指定文字として を設定します。 文字 のハイフネーションコードを に、文字 のコードを のように設定します。 現在のハイフネーション言語を に設定します。 ハイフンされた行の最大連続数を に設定します。 ハイフネーションのパターンをファイル から読み込みます。 例外的なハイフネーションをする単語のリストを で指定します。 ハイフネーションモードを に変更します。 ハイフネーションの余白を に設定します (デフォルトの単位指定子は です)。 ハイフネーションの空白を に設定します。 条件式 が真ならば を処理します。 偽の場合はリクエスト へ移動します。 条件式 が真ならば を処理します。偽の場合は何もしません。 リクエスト が呼ばれるまでテキストを無視します。 リクエスト が呼ばれるまでテキストを無視します。 インデント量を直前の値に戻します。 引数 に従ってインデント量を変更します (デフォルトの単位指定子は 入力行のカウントトラップを位置 に設定します。 ペアワイズカーニングを有効にします。 が 0 ならばペアワイズカーニングを無効にします。 0 でなければ有効にします。 リーダ繰り返し文字の定義を削除します。 リーダ繰り返し文字を に設定します。 文字列 の文字列長をレジスタ に書き込みます。 行タブモードを有効にします (つまり、出力行に比例したタブ位置を計算します)。 が 0 の場合、行タブモードを無効にします。 それ以外の場合は、行タブモードを有効にします。 入力する行数を に、ファイル名を に設定します。 引数 が 0 より大きければリガチャ (合字) モードにします。 行幅を直前の値に戻します。 行幅を引数 に従って設定します (デフォルトの設定は で、単位指定子は です)。 追加の行間スキップ量を直前の値に戻します。 追加の行間スキップ量を に設定します。 つまり、テキストの出力行それぞれの後に 行の空白行を挿入します。 タイトルの長さです (デフォルトの単位指定子は です)。 余白文字を無効にします。 それぞれのテキスト行の後、 右側余白から現在設定されている距離に文字 を出力します。 余白文字を に、右側余白からの距離を に設定します (デフォルトの単位指定子は です)。 現在の垂直位置を にマークします。 リクエスト .so と同じですが、tmac ディレクトリにある file が検索される点が違います。 出力行の位置揃えを行いません。 1 行分の行送りが必要であることを指定します。 行分の行送りが必要であることを指定します (デフォルトの単位指定子は です)。 出力行に行詰めや位置揃えを行いません。 ハイフネーションをしません。 行番号モードを無効にします。 行番号モードの、行番号、行番号出力間隔、空白、インデントを設定します。 次の行に行番号をつけません。 次の 行に行番号をつけません。 を常に実行します。 レジスタの値を、インクリメント値 で に設定・変更します。 組み込み条件式 n を真に、 t を偽にします。 空白なしモードにします。 次のファイルへ処理を移します。 ファイル を書き込みモードでオープンし、名前 を持つストリームに関連づけます。 リクエスト と同じですが、追加モードでファイルをオープンします。 リクエスト で指定された行送り量を出力します。 ページ番号文字を に戻します。 ページ番号文字を設定します。 プログラム に出力をパイプします (nroff のみ)。 ページ長をデフォルトの に設定します。 現在のページ長はレジスタ に格納されています。 ページ長を に変更します (デフォルトの単位指定子は です)。 マクロ名とサイズを出力します (サイズは 1 ブロック 128 バイトのブロック数です)。 マクロ全体のサイズのみを出力します (サイズは 1 ブロック 128 バイトのブロック数です)。 次のページ番号を に設定します。 現在定義されている数値レジスタの名前と内容を標準エラー出力に 出力します。 ページオフセットを直前の値に戻します。 現在のページオフセットはレジスタ に格納されています。 ページオフセットを に設定します。 ポイントサイズを直前の値に戻します。 ポイントサイズを指定します。 エスケープシーケンス と同じです。 PostScript 画像 のための矩形領域を確保します。 リクエスト と同様ですが、 の標準出力から入力します。 すべてのトラップの名前と位置を標準エラー出力に出力します (入力行のトラップとディバージョンのトラップは含まれません)。 文字定義 を削除します。 標準入力からの入力を読み込みます。 マクロから戻ります。 次の 行の入力行を右寄せします。 で指定されたリクエスト、マクロ、文字列を削除します。 で指定されたリクエスト、マクロ、文字列の名前を に変更します。 レジスタ名 を に変更します。 レジスタ を削除します。 空白を復活させます。つまり空白なしモードを無効にします。 (上方向のみ、) マークしておいた垂直位置まで戻します (デフォルトの単位指定子は です)。 ソフトハイフン文字を に戻します。 ソフトハイフン文字を に設定します。 マクロにおいて、引数を位置 にシフトします。 ソースファイルをインクルードします。 1 行スキップします。 の行送りを挿入します。 の符号によって上下方向が決まります (デフォルトの単位指定子は です)。 フォント などを特別フォントとします。 現在のフォントにない文字をこれらから検索します。 空白文字のサイズを に設定します。 単位は現在のフォントの空白幅です。 空白文字のサイズを に、文の空白サイズを に設定します。 単位は現在のフォントの空白幅 (1/3 em) です。 位置 のフォントをスタイル に関連づけます。 レジスタ の文字列の中の部分文字列 を に置き換えます。 行送り量を に設定します。 リクエスト で出力される空白行の送り量を に設定します。 プログラム を実行します。 タブ位置を の倍数に設定します (デフォルトの単位指定子は です)。 位置 ... , のタブ位置をそれぞれ ... に、さらにそれ以降を ... のように設定します。 タブ繰り返し文字を削除します。 タブ繰り返し文字を に設定します。 次の行を一時的にインデントします (デフォルトの単位指定子は です)。 フォント のトラックカーニングを有効にします。 3 つの部位をもつタイトルです。 を端末 (UNIX の標準的なメッセージ出力先) に出力します。 を端末 (UNIX の標準的なメッセージ出力先) に出力します。 その際、 が で始まっている場合は、先頭を空白で始めることができます ( 自体は取り除かれます)。 と似ていますが、末尾の改行を出力しません。 出力で を に、 を のように変換します。 ファイル の内容をそのまま出力します。 リクエスト と同じですが、 によってディバージョンへと出力されるテキストは変換されません。 組み込み条件式 t を真に、 n を偽に設定します。 アンダーラインフォントセットを に設定します (リクエスト で切り替わります)。 入力行を 行、アンダーライン付きにします (troff では イタリック体になります)。 内のフォント情報を保存しつつ、空白文字およびタブ文字を アンフォーマットします。 が 0 でなければ垂直位置のトラップを有効にします。 0 ならば無効にします。 行送りの基準線間隔を直前の値に戻します。 行送りの基準線間隔を に設定します。 デフォルト値は です。 警告コードを に設定します。 位置によるトラップを設定します。 負の値の場合はページ末尾からになります。 条件式 が真ならば を入力として受理します。 ストリーム へ を書き込みます。

これらの基本的な groff リクエストの他にも、 マクロの呼び出しがあります。 これらはマクロパッケージ (概要は roff(7) を参照) やプリプロセッサに由来するものです。

プリプロセッサマクロを認識するのは容易です。 これらは独特のマクロの対で括られています。

プリプロセッサ | 開始マクロ | 終了マクロ
eqn | .PS | .PE
grap | .G1 | .G2
grn | .GS | .GE
pic | .PS | .PE
refer | .R1 | .R2
soelim | なし | なし
tbl | .TS | .TE

エスケープシーケンス
エスケープシーケンスは、行中の要素であり、通常は バックスラッシュ で開始され、エスケープ名がそれに続きます。 場合によっては、必要な引数をつけることもあります。 入力処理は、エスケープ文字あるいはその引数の直後から再開されます。 引数には区切り文字がはさまっているわけではありません。 そのため、エスケープ名や引数の終わりを決定する方法が必要です。

これは、名前 (エスケープ名、および変数名からなる引数) を 角括弧 で囲い、定数引数 (数式および文字) を アポストロフィ (ASCII 0x27) で ’constant’ のように囲うことによって実現します。

エスケープ名には短い名前の省略形があります。 2 文字のエスケープ名は開き括弧で のように指定され、閉じ括弧は必要ありません。 そして、特殊文字である と 以外の 1 文字の名前はすべて のようにマーカなしで指定することができます。

長さ の定数の引数もアポストロフィのマーカを省略できますが、 2 文字の名前のときには省略できません。

1 文字のエスケープシーケンスは主に行中での 関数とシステムに関連したタスク用に使われるのに対して、 が続いた 2 文字の名前は roff システムで定義済みの特殊文字用に 使われます。 2 文字より多い文字を持った名前 は、ほとんどユーザ定義の文字を表しています ( リクエスト を参照してください)。

  1 文字のエスケープシーケンス
コメントの開始です。 行末までのものすべてが無視されます。 次の改行文字までのものすべてが無視されます。 これは、コピーモードで解釈されます。 と似ていますが、終端となる改行を無視する点が異なります。 1 文字の名前 を持った文字列変数に格納されている文字列です。 2 文字の名前 を持った文字列変数に格納されている文字列です。 任意の長さの名前 を持った文字列変数に格納されている文字列です。 現在のマクロが呼び出されている名前。 リクエスト は、1 つのマクロに複数の名前をつけることができます。 番目のマクロの引数。 ここで、 は、1 から 9 までの数値です。 2 桁の番号 番目のマクロの引数。 番目のマクロの引数。 ここで、 は 1 以上の整数に評価される数値表現です。 マクロにおいて、引数すべてを空白文字区切りで連結したもの。 マクロにおいて、引数すべてをそれぞれダブルクォートで囲い、 空白文字で区切って連結したもの。 バックスラッシュ 1 個に縮退します。 コピーモードでエスケープ文字として解釈されるのを 遅らせるときに便利です。 表示可能なバックスラッシュには、 を使用してください。 揚音アクセント符号 ´。 と同じです。 エスケープなし: アポストロフィ、右クォーテーション記号、シングルクォート (ASCII 0x27)。 抑音アクセント符号 `。 と同じです。 エスケープなし: 左クォート、バッククォート (ASCII 0x60)。 現在のフォントでの - 符号。 解釈されないドット (ピリオド)。 行頭にあってもそうなります。 デフォルトでのオプションのハイフン文字。 透過行指定子。 ディバージョンにおいて、そのまま を組み込みます。 コピーモードで は読み込まれます。 エスケープシーケンス および も参照してください。 パディングされない、空白の大きさを持った空白文字 (改行もされません)。 数字の幅の空白。 1/6 em の狭い空白文字。nroff では幅 0 です。 1/12 em のさらに狭い空白文字。nroff では幅 0 です。 表示されない、幅 0 の文字。 と同様ですが、文の終わりを認識する目的で、 cflags リクエストを 用いて透過になるように宣言された文字のように振る舞うという 点で異なります。 次の文字がローマン体であるときには、それの前の文字の幅を増やして 次の文字との間の空白が修正されるようにします。 前の文字がローマン体であるときには、次の文字の空白を変更して 前の文字との間の空白が修正されるようにします。 改行されない空白。 行を調整するとき、通常の単語間の空白のように 引き延ばされます。 幅 0 のブレークポイント ( と似ていますが、ソフトハイフン文字は使いません)。 無視される改行。 行を連続させるときのためです。 条件入力の開始。 条件入力の終了。 2 文字の名前を持った特殊文字。 セクション 特殊文字 を参照してください。 任意の長さの名前 を持った文字 解釈されないリーダ文字。 が文字列、マクロ、ディバージョン、レジスタ、環境、あるいは フォント名として受け付けられるものの場合、 に展開します。 そうでない場合 になります。 角括弧を作る関数。 が正しい数値表現として受け付けられるものの場合、 に展開します。 そうでない場合、 になります。 テキスト処理を中断します。 と呼ばれる文字。 と同じですが、他の roff バージョンと互換性があります。 垂直単位で 1/2 em だけ前方 (下) に移動します (nroff では 1/2 行です)。 中の文字で定義されたグラフィカルな要素を描きます。 詳細は groff info ファイルを参照してください。 現在のエスケープ文字を表示する時の表記。 エスケープ文字と等価ですが、コピーモードでは評価されません。 1 文字の名前もしくは 1 個の数字 を持つフォントに変更します。 2 文字の名前もしくは 2 個の数字 を持つフォントに変更します。 任意の長さの名前もしくは数式 で表されるフォントに変更します。 リクエスト に適した、名前 を持ったレジスタのフォーマットを返します。 別の形式として および があります。 局所的な水平移動。 右側へ だけ移動します (負の値のときは左側へ移動します)。 現在のフォントの高さを に設定します。 任意の長さの名前 を持つレジスタ中の水平入力位置をマークします。 別の形式では と です。 水平線描画関数 (文字 を用いることも可能です)。 垂直線描画関数 (文字 を用いることも可能です)。 1 文字の名前 を持つレジスタ変数に格納されている数値。 2 文字の名前 を持つレジスタ変数に格納されている数値。 任意の長さの名前 を持つレジスタ変数に格納されている数値。 現在のフォントで、コード で指定された文字を出力します。 特別フォントは検索されません。 リクエスト を用いて文字にフォントを追加するときに便利です。 文字 などを 2 度打ちします。 改行し、その出力行を引き延ばします。 垂直方向に 1 em 逆戻りします (nroff では 1 行逆戻りします)。 リクエスト と同じです。 ポイントサイズを N スケールポイントに設定します。 別の書式として \s±[N] , \s'±N' , \s±'N' , \s±(xy , が使えることに注意してください。 これは、リクエスト と同じです。 出力を 度傾けます。 解釈されない水平タブ。 垂直方向に 1/2 em 逆戻りします (nroff では 1/2 行逆戻りします)。 局所的な垂直移動。 だけ下がります (負の値のときは上がります)。 環境変数 の内容。 別の書式では、 と が使えます。 文字列 の幅。 さらに行送りする関数 (負の値なら前へ、正の値なら後ろへ行送りします)。 をデバイス制御関数として出力します。 文字列変数あるいはマクロ をデバイス制御関数として解釈しないように出力します。 別の書式では、 と になります。 幅 0 (空白なし) で を出力します。 を出力し、水平・垂直位置を元に戻します。 にはタブや先頭文字は含まれません。

エスケープシーケンス および はコピーモードで解釈されます。

あるいは で始まるエスケープシーケンスは 1 文字のエスケープシーケンスを 表すものではなく、2 つ以上の文字を持ったエスケープ名の 開始を示します。

バックスラッシュの後に定義済みのエスケープシーケンスを 形成しない文字が続く場合は、バックスラッシュは黙って無視され、 文字そのものがマップされます。

  特殊文字
よく使われる特殊文字は、文字 と を用いた の形式のエスケープシーケンスであらかじめ定義されています。 特殊文字の中には通常のフォントに含まれているものも一部ありますが、 ほとんどは特別フォントでしか利用できません。 最も重要なグリフを抜き出したものを次に示します。 完全なリストは、 groff_char(7) にあります。

レジスタ
レジスタは値を格納する変数です。 groff では、ほとんどのレジスタは数値を格納しますが (前述セクション 数式 を参照してください)、なかには文字列値を保持できるものもあります。

各レジスタには名前が与えられています。 任意のレジスタを定義でき、リクエスト で定義・設定できます。

レジスタに格納された値は、エスケープシーケンス を用いて取り出すことができます。

最も有用なのは、定義済みのレジスタです。 次からは、レジスタのことを話しているのだということを明確にするため、 という表記を用いて レジスタのことを示します。 修飾はレジスタ名の一部ではないことを気にとめておいてください。

  読み込み専用レジスタ
次のレジスタは、ユーザが書き換えられない定義済みの値を持った レジスタです (通常、ドットで始まるレジスタは読み込み専用です)。 ほとんどは、現在の設定についての情報を提供したり、リクエスト呼び出し からの結果を保存したりするものです。

最後に を用いて指定した行送り幅。 オプション -A が使用されているときに troff 内で が設定されます。 nroff 内では常に です。 現在の環境に追加された最後の文字の深さ。 最後の文字が基準線から下に突き出ている場合に正になります。 リクエスト で設定された、センタリングされる行の残数。 現在の環境に追加された最後の文字の高さ。 基準線よりも上に文字が突き出ている場合に正になります。 現在の環境に追加された最後の文字の傾き。 文字の傾きとは、文字の上についたアクセント記号が文字の中央からどれだけ 右に離れて置かれるかということです。 現在のディバージョンでの垂直方向の位置です。 レジスタ と同じです。 GNU troff では常に 1 です。 マクロ中で groff で動作しているかどうかをテストする場合、 このレジスタを使用すべきでしょう。 最高点です。 リクエスト .hla で設定された現在のハイフネーション言語。 直前で連続したハイフネーション行数。 連続したハイフネーション行数の許される最大値。 これは、 リクエスト で設定されます。 現在のハイフネーションフラグ ( リクエスト で設定されます)。 現在のハイフネーションの余白 ( リクエスト で設定されます)。 現在のハイフネーションの空白 ( リクエスト で設定されます)。 最後に出力した行に が含まれていれば正です。 ペアワイズカーニングが有効になっている場合 で、無効になっていれば です。 現在の合字モード ( リクエスト で設定されます)。 現在の行タブモード ( リクエストによって設定されます)。 タイトルの長さ ( リクエスト で設定されます)。 トラップを生起させる原因となった最後のリクエスト が必要とした空白の量。 このレジスタは、 と一緒に使用すると便利です。 空白なしモードであれば で、そうでなければ が設定されます。 次ページの番号。 これは、リクエスト で定義された値もしくは現在ページに 1 を足した番号の いずれかです。 リクエスト によって設定された右寄せされる行の数。 10 進小数での最後に要求されたポイントサイズ (文字列値)。 オプション -T が使われている場合 に設定されます。 現在のタブ設定の文字列表現。 リクエスト に対する引数として使用するのに適しています。 最近の垂直位置トラップによって切り詰められた垂直スペースの量。 リクエスト によるトラップが引き起こされた場合は、そのリクエストによって生じた 垂直移動量をさらにマイナスした値になります。 別の言い方をすれば、トラップが発生した時点での、 トラップが起きなかった場合の垂直位置と現在の垂直位置との差を 表しています。 リクエスト と一緒に使用すると便利です。 リクエスト の第 1 引数によって設定されたパラメータの値。 リクエスト の第 2 引数によって設定されたパラメータの値。 垂直位置トラップが有効なら で、無効なら です。 現在有効になっている警告の番号コードの和。

  書き込み可能なレジスタ
次のレジスタは、ユーザによって読み書き可能です。 定義済みのデフォルト値を持っていますが、ドキュメントを カスタマイズするために変更できます。

で指定されます)。 与えられた PostScript 画像 ( で設定されます) の左下 x 座標 (PostScript 単位)。 与えられた PostScript 画像 ( で設定されます) の左下 y 座標 (PostScript 単位)。 と同様ですが、文字の高さおよび深さを勘定に含めています。 と同様ですが、文字の高さおよび深さを勘定に含めています。 文字列の、基準線の下側の深さ (幅関数 で生成されます)。 引数の最後の文字の中央からの右スキップ幅。 0 よりも大きければ、入力スタック上のオブジェクトの最大数。 0 以下であれば、制限はありません。 つまり、仮想メモリを使い果たすまで再帰呼び出しし続けることができます。 添字の直前にある文字に追加すべき水平方向の空白量 (幅関数 で生成されます) (負の値になる可能性もあります)。 文字列の、基準線の上の高さ (幅関数 で生成されます)。 最後の リクエストによって実行された system() 関数の戻り値。 与えられた PostScript 画像 ( で設定されます) の右上 x 座標 (PostScript 単位)。 与えられた PostScript 画像 ( で設定されます) の右上 y 座標 (PostScript 単位)。 現在の年から 1900 を引いたものです。 2000 年問題対応にするにはレジスタ を代わりに使用してください。

警告
groff が生成する警告は各々名前およびコード番号で識別されます。 コードは 2 の累乗になっていて、1 つの整数の上にビットエンコード できるようになっています。 また警告のグループを参照するのに使用することのできる名前もあります。

警告と関連のある名前は、 および オプションで使用されます。 コード番号は リクエスト および レジスタで使用されます。

および を除いたすべての警告です。 伝統的なマクロパッケージでの警告をすべて網羅しています。 行連結モード時に、1 行の長さよりも短くなるように 行を分割できませんでした。デフォルトでは有効です。 存在しない文字です。 デフォルトでは有効です。 閉じ区切り記号がないか、もしくは対応が取れません。 現在ディバージョンが存在しないのに、引数なしで あるいは を使っています。 対応するリクエスト が存在しないのに、 リクエストを使っています。 認識されないエスケープシーケンスです。 そのためエスケープ文字は無視されます。 存在しないフォントです。 デフォルトでは有効です。 リクエスト を使って無視されているテキスト中で不正なエスケープがあります。 無視されるテキストの外側でこの警告が発生する場合、 エラーとなる状態です。 定義されていない文字列、マクロ、およびディバージョンが使われました。 自動的に空文字として扱われます。 通常は、名前ごとに 1 つしか警告は出ません。 オプションではない引数が指定されていないリクエストです。 不正な入力文字です。 不正な数式です。 デフォルトでは有効です。 引数が範囲外です。 定義されていない番号レジスタを使っています。 自動的に値 0 をもつレジスタとして扱われます。 通常は、名前ごとに 1 つしか警告は出ません。 数字を指定すべき場所で が使われました。 意味のない単位指定子です。 リクエストあるいはマクロとその引数との間に空白がありません。 そのため、自動的にマクロは定義されません。 デフォルトでは有効です。 この警告は互換モードでは絶対に発生しません。 数式中の構文が曖昧です。 タブ文字の使い方が適切ではありません (クォートされていない マクロ引数中や数字を指定すべきところにタブ文字がある)。 すべての警告です。

Bit | Code | 警告 | Bit | Code | 警告 | Bit | Code | 警告
0 | 1 | char | 8 | 256 | di | 16 | 65536 | space
1 | 2 | number | 9 | 512 | mac | 17 | 131072 | font
2 | 4 | break | 10 | 1024 | reg | 18 | 262144 | ig
3 | 8 | delim | 11 | 2048 | tab
4 | 16 | el | 12 | 4096 | right-brace
5 | 32 | scale | 13 | 8192 | missing
6 | 64 | range | 14 | 16384 | input
7 | 128 | syntax | 15 | 32768 | escape

互換性
groff は、古典的な troff 用に書かれた roff コードや他の roff 実装用の roff コードを同じ方法で 処理できるようにする 互換モード を提供します。

互換モードはコマンドラインオプション を用いて有効にでき、リクエスト で有効にしたり無効にしたりできます。 番号レジスタ は、互換モードが有効であるとき で、無効であるとき です。

長い名前に対する GNU の考え方によってある種の非互換性が 生まれてしまうのでこれが必要になりました。 古典的な troff は、

    .dsabcd

を cd という中身を持った文字列 ab を定義しているものとして解釈します。 groff は、通常これを という名前のマクロ呼び出しとして解釈します。

さらに、 古典的な troff では または を と呼ばれる文字列レジスタあるいは番号レジスタへのリファレンスとして 解釈します。 しかし、 GNU 独自の モード では通常これを長い名前の始まりとして解釈してしまいます。

互換性 モードでは、 groff はこれらを古典的な方法で解釈するようになりますが、長い名前は 認識されなくなります。

これに対して、 GNU 独自モード での groff は、文字列やマクロ、変換、番号レジスタ、フォントあるいは 環境名にエスケープシーケンス を使うことはできません。 これに対して 古典的な troff ではこれらのエスケープシーケンスを使えます。 エスケープシーケンス は、名前の中でこれらのエスケープシーケンスを使わないようにするとき 役に立ちます。

小数のポイントサイズは、顕著な非互換性を生み出します。 古典的な troff では、 リクエストは単位指定子を無視しますので、

    .ps 10u

とするとポイントサイズを 10 ポイントに設定します。 これに対して groff 独自のモードでは、ポイントサイズは スケールポイントで 10 ポイントに設定します。

groff モードでは、整形されていない入力と整形された出力文字との間に 基本的な違いがあります。 出力文字がどのように出力されるかに影響を与えるものは、 すべてその文字と一緒に格納されます。 一度出力文字が作られれば、 その後でどのようなリクエストが実行されても出力文字は影響を受けません。 のいずれのリクエストでも同様です。

通常、出力文字は、入力文字を現在の出力行に追加する直前に作られます。 マクロ、ディバージョン、文字列は、実はすべて 同じオブジェクトタイプです。 これらは、どのような組み合わせでも入力文字のリスト ならびに出力文字のリストを持っています。

マクロを処理する目的では、出力文字は入力文字と同じような 振る舞いはしません。 出力文字は、自分の構築元となった入力文字ならば持っていたであろう 特別な属性を一切引き継ぎません。 次の例は、これらのことをもっと明解に示しています。

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

GNU モード では、これは として表示されます。 つまり、入力されたバックスラッシュの対 はそれぞれ 1 つのバックスラッシュ に変換されます。 そして、結果として出力されるバックスラッシュは、 再度読み込まれるときにはエスケープ文字としては解釈されません。

古典的な troff では、こうしたバックスラッシュは再度読み込まれるときには エスケープ文字として解釈されるので、最終的には 1 つのバックスラッシュ として出力されるでしょう。

出力可能な を得る正しい方法は エスケープシーケンス を使うことでしょう。 これは、ディバージョン内で使用されているかどうかに関わらず、 現在のエスケープ文字を常に 1 つだけ出力します。 さらにこれは GNU モードでも互換モードでも動作します。

ディバージョン内に、再度読み込まれたときに解釈したい エスケープシーケンスを格納するには、伝統的な 透過出力ファシリティ あるいは新しいエスケープシーケンス のどちらかが使用できます。

バグ
現在、groff システムのドキュメントは変更・刷新途上にあります。 それぞれのマニュアルには小さな不一致がある可能性があります。

警告 セクションは troff(1) に属しています。

作者
このドキュメントは groff、すなわち GNU roff 配布物の一部です。 Bernd Warken <bwarken@mayn.de> が書きました。

このドキュメントは、FDL (GNU Free Documentation License) バージョン 1.1 以降の条項のもとに配布されています。 システムに FDL のコピーがあるはずですし、オンライン

    http://www.gnu.org/copyleft/fdl.html

でも入手できます。

もともと、groff 言語拡張については troff(1) マニュアルページで管理されていました。 このドキュメントは groff 言語拡張の不可欠な部分を含んではいますが、 詳しい説明については、groff info ファイルの中にあります。

関連項目
groff 言語の主な情報源は groff info(1) ファイルです。

roff および groff システムを調べたり、さらなるドキュメントへの ポインタを得るには、 roff(7) を参照してください。

フォーマッタプログラムについては groff(1) および troff(1) で説明されており、 前もって定義されているグリフ名のすべては groff_char(7) で説明されています。

古くからある troff のドキュメントはオンライン

    http://cm.bell-labs.com/cm/cs/cstr.html
および
    http://www.kohala.com/start/troff/
にあります。