Provided by: manpages-ja_0.5.0.0.20210215+dfsg-1_all 
名称
roff - 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 は全データファイルを /usr/share/groff_font のサブディレクトリと
/usr/share/tmac へインストールされます (例外はシステム固有のマクロパッケージへのラッパファ
イルであり、これらは /usr/share/tmac にインストールされます)。 この場所は、システムによっ
ては異なるかもしれません。 以降、前者を <groff_font_dir> として、後者を <groff_macro_dir>
として表現します。
<groff_macro_dir>/troffrc
troff 用の初期化ファイル
<groff_macro_dir>/name.tmac
<groff_macro_dir>/tmac.name
マクロファイル
<groff_font_dir>/devname/DESC
name デバイス記述ファイル
<groff_font_dir>/devname/F
name デバイスの F フォント用のフォントファイル
最後に、ローカルのマクロディレクトリ /usr/share/tmac は、サイト固有のマクロとパッケージ用
に提供されます。 デフォルトでは、メインのマクロディレクトリの前にここが検索されます。
バグ
groff ドキュメントは現在も発展途上です。 ドキュメント間で一時的に小さな食い違いが生じる可
能性があります。
作者
このドキュメントは groff すなわち GNU roff 配布物の一部です。 Bernd Warken
<bwarken@mayn.de> が書きました。
このドキュメントは FDL (GNU Free Documentation License) バージョン 1.1 以降の条項のもとに
配布されています。FDL のコピーをシステム上に 持っているはずです。また、これはオンライン
<http://www.gnu.org/copyleft/fdl.html>
でも入手可能です。
関連項目
主な情報源は、 groff info(1) ファイルです。
定義済みの groff 言語要素についても groff(7) マニュアルページに記載があります。
フォーマッタおよびそのラッパについては groff(1), grog(1), nroff(1), troff(1) に記載があり
ます。
出力デバイス用のポストプロセッサについては grodvi(1), grohtml(1), grolbp(1), grolj4(1),
grops(1), grotty(1) に記載があります。
標準プリプロセッサについては eqn(1), grn(1), grap(1), pic(1), refer(1), soelim(1), tbl(1)
に記載があります。
マクロパッケージについてのマニュアルページには groff_tmac(5), groff_man(7),
groff_markup(7), groff_mdoc(7), groff_mdoc.samples(7), groff_me(7), groff_mm(7),
groff_mmroff(7), groff_ms(7) が含まれています。
次のようなユーティリティが利用できます: addftinfo(1), afmtodif(1), hpftodit(1),
indxbib(1), lookbib(1), pfbtops(1), tfmtodit(1), gxditview(1) です。
roff システムの GNU 実装についての詳細は groff_char(7), groff_font(7), groff_out(7) および
groff ソース配布物のメインディレクトリ内の README ファイルを参照してください。 groff 開発
グループとの連絡の取り方や参加の仕方についての 詳細も載っています。
古典的な ドキュメントは今でもオンラインで入手可能です。 特に有益なのが、かのフリーである
UNIX 7 用のベル研オリジナルの 会報です。これは http://cm.bell-labs.com/cm/cs/cstr.html に
あります。そして、故 Richard S. Stevens のコレクションが
http://www.kohala.com/start/troff/ にあります。