troff − groff テキストフォーマットシステムの troff プロセッサ

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

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

本マニュアルでは、GNU バージョンの troff について記述しています。 こ れ は、groff ドキュメントフォーマットシステムの一部です。本コマンドは UNIX troff と高い互換性を持っている一方で、多くの拡張がなされています。こ の 拡 張 に つ い て は、 groff_diff(7) を参照してください。通常 troff は groff(1) コマンドから起動されます。また groff は、適切な前処理プログ ラ ム と 後 処理プログラムを適切なオプションを用いて、適切な順序で起動しま す。

−a

ASCII 文字のみの近似的な出力を行います。

−b

各警告とエラーメッセージに対するバックトレースを表示しま す。これは、警告やエラーの原因を調べるのに有用です。出力され る行番号は必ずしも正しくはありません。 as や am リクエストに よって、 troff が行番号を誤認する可能性があるからです。

−c

カラー出力を無効にします (互換モードでは常に無効です)。

−C

互換モードを有効にします。

−dcs

−dname=s

マクロ c または name を文字列 s と定義します。 c は 1 文字のマクロ名です。

−E

troff のエラーメッセージを一切出力しません。これは、 tm や tm1 リクエストを用いたマクロパッケージによって標準エラー 出力へ表示されるメッセージには影響しないことに注意してくださ い。

−ffam

fam をデフォルトのフォントファミリとして使用します。

−Fdir

ディレクトリ (またはディレクトリパス) dir 以下のサブ ディレクトリ devname (name は出力デバイス名) を検索し、そ の 中 からフォントファイルと DESC ファイルを探します。 dir は、 他のすべてのフォントディレクトリより前に調べられます。

−i

指定されたファイルをすべて処理したあとに、標準入力を読み 取ります。

−mname

マクロファイル name.tmac を読み取ります。見つからな ければ、かわりに tmac.name を試みます。まず最初に −M コマ ン ド ラ イ ン オ プ ショ ン で 指 定されたディレクトリ、続いて GROFF_TMAC_PATH 環境変数で指定されたディレクトリ、そして現在 の ディレクトリ (安全でないモードの場合のみ)、ホームディレク ト リ、/usr/share/tmac/、/usr/share/tmac/、 /usr/share/tmac の順に検索します。

−Mdir

指定したディレクトリ (またはディレクトリパス) dir か らマクロファイルを検索します。これは他のすべてのマクロディレ クトリより前に調べられます。

−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 で扱える数式です。

−R

troffrc と troffrc-end を読み取りません。

−Tname

デバイス name 用の出力を生成します。デフォルトは ps です。更なる解説は groff(1) を参照してください。

−U

安全でないモード。これによって以下のリクエストが有効にな ります: open, opena, pso, sy, pi 。このオプションが指定さ れ ない場合、セキュリティのためにこれらの危険性のあるリクエスト は禁止されます。またこのオプションによって、現在のディレクト リがマクロ検索パスに追加されます。

−v

バージョン番号を表示します。

−wname

name で指定した分類の警告を行います。指定できる警告 は、後述の 警告のサブセクションを参照してください。例え ば、 すべての警告を有効にする場合、 −w all とします。 −w オプショ ンは複数指定できます。

−Wname

name で指定した分類の警告を行いません。 −W オプ ショ ンは複数指定することができます。

−z

フォーマットした結果を出力しません。

troff が出力する警告は以下のカテゴリに分類されます。各警告に関連する名 前は −w と −W オプションで使用可能です。また番号は、 warn リクエスト お よび .warn レジスタが使用します。番号は、ビット合成しやすいように常に 2 の冪乗となっています。

break 4

行詰めモードにおいて、行を分 割 できなかったため、行の長さよりも短くなりました。こ れはデフォルトで有効です。

char 1

存在しない文字です。こ れ は デ フォルトで有効です。

color 524288

色に関する警告です。

delim 8

閉じる方のデリミタがないか、も しくはマッチしませんでした。

di 256

現在転換がないにもかかわら ず、 引数なしで di や da を使用しました。

el 16

対応する ie リクエストのない、 el リクエストです。

escape 32768

認識できないエスケープシーケ ン スです。認識できないエスケープシーケンスがあった場 合は、そのエスケープ文字は無視されます。

font 131072

存在しないフォントです。これ は デフォルトで有効です。

ig 262144

ig リクエストによって無視された テキストの中にある、不正なエスケープです。こ れ ら は、無視されたテキストの中でなければエラーとなって いるものです。

input 16384

不正な入力文字です。

mac 512

未定義の文字列、マクロ、転換 を 使用しました。未定義の文字列、マクロ、転換を使用し た場合、その文字列は自動的に空に定義されます。この た め 多くの場合、各名前に対する警告は、たかだか 1 回だけです。

missing 8192

必要な引数が足りないリクエス ト です。

number 2

不正な数式です。これはデフォル トで有効です。

range 64

引数が範囲を越えています。

reg 1024

未定義の数値レジスタを使用し ま した。未定義の数値レジスタを使用した場合、そのレジ スタは自動的に値 0 に定義されます。このため多く の 場 合、特定の名前に対する警告は、たかだか 1 回だけ です。

right-brace 4096

数字が期待される場所で \} が 使 用されました。

scale 32

意味のないスケールインジゲータ です。

space 65536

リクエストもしくはマクロとそ れ らの引数との間に空白がありません。この警告は、最初 の 2 文字が定義された名前であるような、 2 文字より 長い未定義の名前があった場合に起こります。この時、 リクエストもしくはマクロは起動されません。この警告 が発せられる時、どのようなマクロも自動的には定義さ れません。これはデフォルトで有効です。この警告は互 換モードでは起こりません。

syntax 128

数式中に疑わしい文法がありま す。

tab 2048

タブ文字の使い方が不適切で す。 数 字 が 期 待される場所でタブを使用したか、または クォートされていないマクロの引数中でタブ文字を使用 しました。

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

all

di, mac, reg を除くすべての警告を指定します。これは、伝統 的なマクロパッケージを使用する際に有用な警告のすべてをカバー す るよう意図されています。

w

すべての警告を指定します。

GROFF_TMAC_PATH

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

GROFF_TYPESETTER

デフォルトの出力デバイス。

GROFF_FONT_PATH

devname ディレクトリを検索すべきディレクトリ名の、コロン区切 り のリストです。 troff は、まず −F オプションで指定されたディレク トリを検索し、次に本環境変数で指定されたディレクトリ、最後に 標 準 の ディ レ ク ト リ ( (/usr/share/groff_font, /usr/share/groff_font, /usr/share/groff_font) を検索します。

/usr/share/tmac/troffrc

初期化ファイル (他のマクロパッケージの前に呼び出されます)

/usr/share/tmac/troffrc-end

初期化ファイル (他のマクロパッケージの後に呼び出されます)

/usr/share/tmac/name.tmac

/usr/share/tmac/tmac.name

マクロファイル

/usr/share/groff_font/devname/DESC

デバイス name 用のデバイス記述ファイル

/usr/share/groff_font/devname/F

デバイス name のフォント F 用のフォント記述ファイル

troffrc と troffrc-end は、セキュリティのためデフォルトでは ( −U オ プ ショ ンが指定されていても) 現在のディレクトリとホームディレクトリのどち らからも検索されない事に注意してください。必要な場合は、 −M コマンド ラ インオプションもしくは GROFF_TMAC_PATH 環境変数を使用することで、これら のディレクトリを検索パスに加えられます。

Copyright (C) 1989, 2001, 2002 Free Software Foundation, Inc.

この文書は、FDL (GNU Free Documentation License) バージョン 1.1 かそ れ 以 降 のものに基づいて配布されています。あなたは、システム上に FDL のコ ピーを受け取っているはずですが、これは GNU copyleft siteからもオンラインで入手 可 能 で す。 こ の文書は James Clark によって書かれ、 Werner Lembergと Bernd Warkenによって修正されまし た。

この文書は GNU の roff ディストリビューションである groff の一部です。

groff(1)

groff システムの主要プログラムです。これは troff を包むラッパと なっています。

groff(7)

groff 言語の説明です。これには、素の groff の持つすべての定義済 みのリクエスト、レジスタ、エスケープについての簡潔ですが完全 な リ ファレンスが含まれています。コマンドラインからは、以下のよう に呼び出します。

man 7 groff

groff_diff(7)

groff 言語と 古典的な troff 言語の違いです。現在のところ、こ れ が groff システムで実際の文書そのものです。

roff(7)

groff や他の roff システムの概要です。これにはさらなる関連文書 へのポインタも含まれています。

groff info ファイル ( info(1) を参照) は、1 文書で groff のすべての説明 をしています。