man roff (1): roff 清書システムの調査

解説

roff とは清書プログラム群の一般名称です。 troff, nroff, groff などの名前で知られています。

roff 清書システムは、整形用言語、マクロパッケージ、プリプロセッサ、出力デバイス用ポストプロセッサ、ユーザ用フロントエンドプログラム、そして変換ツールから構成されています。

今日、最も一般的な roff システムはフリーソフトウェアでの実装である groff (`GNU roff') です。groff より前の実装は「古典」 (1973 年まで遡ります) と呼ぶことにします。

groff は、古典である祖先のシステムと下位互換性がありますが、数多くの拡張がされており、今もなお進化し続けています。ほとんどすべての計算機システムで利用できるため、今日では事実上の roff 標準となっています。

その古さにもかかわらず、roff は今日でも広く使用されています。例えば、UNIX システムのマニュアルページ (manページ) は roff で書かれています。テキストデバイスに対する roff 出力は、いまだに並ぶもののないほど優れています。グラフィカルな出力も他のフリーの清書プログラムと同等の品質を持っていますし、ものによっては商用システムのものよりも優れているときもあります。

このドキュメントでは概要のみを示し、詳細なドキュメントについてはポインタを示します。

このドキュメントは維持されておらず、時代遅れになっている可能性があります。正確なドキュメントが必要なら groff info ファイルを参照してください。これには詳細で現実に即した正確なリファレンス情報が含まれています。

整形用言語

roff システム用の言語を指す 3 つの用語があります。 troff 言語 は、 roff の古典的な部分に重点を置くときに使われます。 groff 言語 は GNU 拡張を含んでおり、それに対して roff 言語 は一般的な用語です。

groff 言語 のすべての部分について記述されたドキュメントの一次情報源は groff info ファイルです。 groff(7) マニュアルページでは、定義済みの言語要素すべてについて簡潔な説明をしています。

roff を使用したドキュメントは、普通のテキストファイルを整形用要素で修飾したものです。マクロパッケージの 1 つを使って高品質のドキュメントを書くのはとても簡単なことです。マクロパッケージは高水準プログラミング言語のようなものであり、それに対して素の roff 言語は C やアセンブラのような低水準言語にたとえられます。

roff 言語は低水準のリクエスト、マクロ定義、エスケープシーケンス、文字列変数、数値レジスタまたはサイズレジスタ、そして C のような制御構造を提供する完全なプログラミング言語です。

この言語の要素についていくらか説明が必要でしょう。リクエストは、C, C++ のようなプログラミング言語によって定義された基本的な整形用コマンドです。それに対して、マクロは roff 言語で記述された整形用コマンドです。ドキュメントの著者は、リクエストとマクロを使う際の違いに気づくことはないでしょう。どちらもドット . 始まりの単独行で記述されます。ただし、望むならば、ユーザは独自のマクロを定義できます。

エスケープシーケンスはインライン要素で、バックスラッシュ \ で始まります。これらはさまざまな機能を実装するのに使われます。それには、 ( を用いた非 ASCII 文字の挿入、 * を用いた文字列の内容の挿入、 n を用いたレジスタ変数の挿入、 f を用いたフォントの変更、 " を用いた文中のコメント、 \ のような特殊な制御文字のエスケープ、その他多くの機能が含まれます。

フォーマッタ

フォーマッタは groff ドキュメントを解析し、それを特殊なデバイスに合った形式に変換するためのフロントエンドプログラムです。古典的な roff にはフォーマッタが 2 つあります。 nroff がテキストデバイス用で、 troff がグラフィカルデバイス用です。

これらのプログラムは groff 実装でもまだ存在しますが、通常は groff と呼ばれるプログラムを通してアクセスされます。これによって、古くからの機能を 1 つのプログラムに結合し、拡張できるのです。 groff には多くのコマンドラインオプションがあります。その大部分が troff からもらい受けたものです。このオプションの密林から逃れるべく、ユーザフレンドリなユーティリティ grog (`groff guess' からとられた名前です) が作成されました。これは、どの引数を使うべきかを、ドキュメントから推測して、適切なコマンドラインを表示します。完璧なものではありませんが、取り掛かりには良いでしょう。

プリプロセッサ

groff でもまだ利用可能な古典的プリプロセッサです。

eqn: 数式を埋め込むためのものです。
grap: グラフィカル要素を構成するためのものです (このプリプロセッサは groff と一緒にはついてきません。追加パッケージです)。
grn: gremlin 図を埋め込むためのものです。
pic: 図を作成するためのものです。
refer: 参考文献の参照用です。
soelim: 他の roff ファイルを埋め込むためのものです。
tbl: 長方形のテーブル用です。

これらのプリプロセッサはそれぞれ独自の言語を定義しており、プリプロセッサに通されると、roff コードに変換されます。ですので、これらの言語で書かれた部分は roff ドキュメントに埋め込んであっても良いのです。こうした拡張ドキュメントは、実際のフォーマッタにかけられる前に、対応する 1 つ以上のプリプロセッサに通されます。

プリプロセッサプログラムは、プリプロセッサ用に限定されているドキュメントの部分を抽出し、変換します。プリプロセッサは、それらのプログラム名を使った UNIX パイプラインで呼び出すことも、もしくは groff オプションで自動的に呼び出すこともできます。

プリプロセッサ	groff オプション

eqn	-e
grap	-G
grn	-g
pic	-p
refer	-R
tbl	-r
soelim	-s

マクロパッケージ

マクロパッケージは、ある特殊な種類のドキュメントを簡便な方法でフォーマットするのに適したマクロの集合です。マクロパッケージによって、roff の使い勝手が格段に良くなります。パッケージのマクロ定義は、 name.tmac (または tmac.name) と呼ばれるファイルに保管されています。ここで、 name はこのパッケージに対する roff 内部での名称です。すべての tmac ファイルは、 1 つあるいは少数のディレクトリ中の標準の場所に保管されています。

ドキュメントが使用するマクロパッケージは、フォーマッタのコマンドラインオプション -m で指定し、例えば troff -m name や groff -m name とします。マクロパッケージの命名およびその置き場所についての一般的な詳細は groff_tmac(5) にあります。

古くからある有名なマクロパッケージは man, mandoc, mdoc がマニュアルページ用、そして me, ms, mm が書籍、記事、そして手紙用です。これらのコレクションのほかにも、groff はさまざまな用途の新しいマクロパッケージを提供しており、その数は増加しています。例えば、他のファイル形式を統合したり変換したりするものです。

ファイル名の拡張子

マニュアルページ (man ページ) はファイル名の拡張子としてセクション番号をとります。例えば、このドキュメントのファイル名は roff.7 です。つまり、このドキュメントはマニュアルページの section 7 に保存されているということです。

古典的なマクロパッケージは、パッケージ名を拡張子にとります。例えば、 me マクロパッケージを使ったドキュメントは file.me となり、 mm マクロパッケージに対しては file.mm 、 ms マクロパッケージに対しては file.ms 、 pic ファイルに対しては file.pic といった具合です。

編集方法

ほとんどのテキストエディタは roff を使ったドキュメントの編集をサポートしています。特に使い勝手が良いのが、Emacs エディタとその仲間での nroff-mode です。

環境変数

GROFF_TMAC_PATH: コロン区切りの検索ディレクトリリストです。 groff_tmac(5) を参照してください。
GROFF_TYPESETTER: デフォルトのデバイスです。
GROFF_FONT_PATH: devname コロン区切りの検索ディレクトリリストです。 troff は、 -F コマンドオプションで与えられたディレクトリを先に検索します。次に、 GROFF_FONT_PATH を探します。最後に、標準ディレクトリ (/usr/share/groff_font) を探します。

バグ

groff ドキュメントは現在も発展途上です。ドキュメント間で一時的に小さな食い違いが生じる可能性があります。

作者

このドキュメントは groff すなわち GNU roff 配布物の一部です。 Bernd Warken <[email protected]> が書きました。

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

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

でも入手可能です。

解説