名称
groff - groff
ドキュメントフォーマットシステムのフロントエンド
書式
groff [ -abeghilpstvzCEGNRSUVXZ ]
[ -wname ]
[ -Wname ]
[ -mname ] [ -Fdir ]
[ -Idir ] [ -Tdev ]
[ -ffam ] [ -Mdir ]
[ -dcs ] [ -rcn ]
[ -nnum ] [ -olist ]
[ -Parg ] [ -Larg ]
[ files... ]
コマンドラインオプションとパラメータの間に空白を含めることが可能です。
解説
groff は、groff
ドキュメントフォーマットシステムのフロントエンドプログラムです。通常
groff は troff
を実行し、その出力を指定されたデバイスで扱うための
後処理プログラムを実行します。利用可能なデバイスは以下のとおりです:
- ps
- PostScript
プリンタやプレビュア。
- dvi
- TeX の dvi
フォーマット。
- X75
- 75dpi の X11 プレビュア。
- X100
- 100dpi の X11 プレビュア。
- ascii
- タイプライタに似た特性を持つデバイス。
- ascii8
- タイプライタに似た特性を持つデバイス。
ascii
とは異なり、このデバイスは
8
ビットクリーンです。このデバイスは
ASCII や ISO-8859-1
以外の文字集合での使用を想定しています。
- latin1
- ISO Latin-1 (ISO 8859-1)
文字集合を利用する
タイプライタに似た特性を持つデバイス。
- utf8
- UTF-8
エンコーディングの
Unicode (ISO 10646)
文字集合を利用する
タイプライタに似た特性を持つデバイス。
- cp1047
- EBCDIC コードページ IBM cp1047
を利用する
タイプライタに似た特性を持つデバイス
(例えば OS/390 Unix)。
- lj4
- HP LaserJet4 互換 (または他の
PCL5 互換) プリンタ。 lbp
Canon CAPSL プリンタ用 (LBP-4 と LBP-8
シリーズのレーザプリンタ)。
- html
- HTML 出力を行います。
指定されたデバイス用の後処理を行うプログラムは、デバイス記述ファイルの
postpro
コマンドにより指定されています。これは
-X
オプションにより変更できます。
デフォルトのデバイスは
ps です。 pic, eqn, grn,
grap, tbl, refer, soelim
の任意の前処理を行わせることもできます。
引数を伴わないオプションは
-
のあとにまとめて続けることができます。
ファイル名のかわりに用いられる
-
は標準入力を意味します。
grog
コマンドを用いてドキュメントを正しくフォーマットするための
groff
コマンドを調べることができます。
オプション
- -h
- ヘルプメッセージを表示します。
- -e
- eqn
を使って前処理を行います。
- -t
- tbl
を使って前処理を行います。
- -g
- grn
を使用して前処理を行います。
- -G
- grap
を使用して前処理を行います。
- -p
- pic
を使って前処理を行います。
- -s
- soelim
を使って前処理を行います。
- -Idir
- このオプションは
soelim(1)
に記述されています。
このオプションは -s
オプションを暗黙的に指定します。
- -R
- refer
を使って前処理を行います。
refer
に引数を渡す機構は用意されていません。
refer
のほとんどのオプションは、ファイル中に記述することができる等価なコマンドを
備えているからです。詳しくは
refer(1)
のマニュアルを参照してください。
- -v
- groff
から起動されるプログラムのバージョン番号を表示します。
- -V
- 実行しないで、 groff
で実行される処理内容を標準出力に表示します。
- -z
- troff
からの出力を捨てます。エラーメッセージのみが表示されます。
- -Z
- troff
からの出力を後処理しません。通常
groff
は、自動的に適当な後処理プログラムを起動します。
- -Parg
- 後処理プログラムに
arg
を引数として渡します。別々の引数は別々の
-P
オプションで指定する必要があります。
groff は、 arg の前に -
をつけてコマンドに渡したりしないことに注意してください。
- -l
- プリンタのスプーラへ出力します。印字出力に用いられるコマンドは、デバイス
記述ファイルの print
コマンドによって指定されます
(これが存在しない場合には、
-l は無効果です)。
- -Larg
- arg
をプリンタスプーラプログラムに渡します。別々の引数は、別々の
-L
オプションで指定する必要があります。
groff は、 arg の前に -
をつけてコマンドに渡したりしないことに注意してください。
デバイス記述ファイルに
print
コマンドが無い場合には、
-L
は無視されます。
- -Tdev
- デバイス dev
用に出力します。デフォルトのデバイスは
ps です。
- -X
- 通常の後処理プログラムのかわりに、
gxditview
を起動してプレビューします。
groff は gxditview に -printCommand
オプションを渡します。このオプションは
groff に -l
オプション指定時に実行される
Print
アクションを実行させます。
-Tps
以外が指定されている場合は、よい結果が得られません。
- -N
- eqn
の区切り文字間に改行が入ることを禁止します。
eqn の -N
オプションと同様です。
- -S
- より安全なモード。
-S オプションを pic
に渡し、次の troff
リクエストを無効化します:
.open, .opena, .pso, .sy, .pi 。
セキュリティ上の理由から安全なモードはデフォルトで有効です。
- -U
- 安全でないモード。古い安全でない動作に戻します。
- -a
- -b
- -i
- -C
- -E
- -wname
- -Wname
- -mname
- -olist
- -dcs
- -rcn
- -Fdir
- -Mdir
- -ffam
- -nnum
- これらのオプションの詳細は、
troff(1)
に記述してあります。
環境変数
- GROFF_COMMAND_PREFIX
- もしこの変数が X
に設定されていると、
groff は troff
のかわりに Xtroff
を起動します。これは、
tbl, pic, eqn, grn, refer,
soelim
にも同様に影響します。
grap, gropos, grodvi, grotty, grolj4,
grohtml, gxditview
には影響しません。
- GROFF_TMAC_PATH
- デフォルトディレクトリに加えて、
マクロファイルを検索すべきディレクトリのリスト
(リストの区切りはコロンです)。
更なる詳細は troff(1)
を参照してください。
- GROFF_TYPESETTER
- デフォルトのデバイス
- GROFF_FONT_PATH
- デフォルトディレクトリに加えて、
devname
という名前のディレクトリを検索すべき
ディレクトリのリスト
(リストの区切りはコロンです)。
更なる詳細は troff(1)
を参照してください。
- GROFF_BIN_PATH
- この検索パスは、
groff
が起動するコマンドのために、
PATH
の前に使用されます。
設定しないと、 PATH
の前に `/usr/bin'
が追加されます。
- GROFF_TMPDIR
- 一時的なファイルが作成されるディレクトリ。もし、
GROFF_TMPDIR が設定さ
れておらず、
TMPDIR
が設定されているなら、
TMPDIR
で示されるディレクトリ
に一時ファイルが生成されます。さもなければ、一時ファイルは
/tmp に作られます。
grops(1) と refer(1)
が一時ファイルを作成する可能性があります。
関連ファイル
- /usr/share/groff_font/devname/DESC
- デバイス name
のデバイス記述ファイル
- /usr/share/groff_font/devname/F
- デバイス name
のためのフォント F
を記述したフォントファイル
EBCDIC
ホストにおいては、出力デバイス
ascii, latin1, utf8
は使用不可です。
同様に、 cp1047 は ASCII
ベースのオペレーティングシステム上では使用不可です。
使用例
マニュアルページ
foo.1
を標準出力に対し、latin-1
出力デバイスを使用して印刷し、
less
をページャに使用するには、次のコマンドを使用します:
- groff -mandoc -Tlatin1 foo.1 | less
また、次のようにも使用できます:
- groff -m mandoc -Tlatin1 foo.1 | less
作者
James Clark <jjc@jclark.com>
バグ
バグレポートは、bug-groff@gnu.org
までお願いします。
レポートの際にはバグを再現できる完全な例題を添付し、あなたの利
用している groff
のバージョンを添えて下さい。
Copyright © 1989-2000 Free Software Foundation, Inc.
groff
はフリーソフトウェアです。Free
Software Foundation から
出版されている the GNU General
Public License の ver 2.0 かそ
れ以降に基づく限り再配布したり、変更することが可能です。
groff
は使い易いツールとして配布されることを望まれていますが、
どのような保証もありません。それが商業的であってもある特定の目
的に対するだけであっても保証はありません。詳しくは
GNU の General Public License
を参照して下さい。
あなた は groff
のコピーを GNU General Public License
と共に受
けとっているはずです。その
COPYING
を参照して下さい。そうでな
い場合には、 Foundation, 59 Temple Place
- Suite 330, Boston, MA 02111-1307, USA
まで御連絡下さい。
入手性
最新の groff
はたいてい ftp.gnu.org の gnu/groff
ディレクトリに置かれており、
anonymous ftp
で入手できます。
groff のみが、Ted Faber
<faber@lunabase.org>
が記述した自由に入手可能な
grap
実装をサポートします。
実物は、次のところにあります:
- http://www.lunabase.org/~faber/Vault/software/grap/
関連項目
grog(1), troff(1), tbl(1), pic(1),
eqn(1), grn(1), grap(1), soelim(1),
refer(1), grops(1), grodvi(1), grotty(1),
grolj4(1), grolbp(1), grohtml(1), gxditview(1),
groff_font(5), groff_out(5), groff_man(7),
groff_ms(7), groff_me(7), groff_char(7)