jpman project specific RCS keyword (jpman %Id) is obsolete, after manual entries are stored in freefall CVS repository. This old Id is useless and more worse it confuses users and bug reporters. So, this old Id is removed. Submitted by:jpman project <man-jp@jp.FreeBSD.org>
505 lines
9.5 KiB
Groff
505 lines
9.5 KiB
Groff
.\" $FreeBSD$
|
|
.ig \"-*- nroff -*-
|
|
Copyright (C) 1989-2000 Free Software Foundation, Inc.
|
|
|
|
Permission is granted to make and distribute verbatim copies of
|
|
this manual provided the copyright notice and this permission notice
|
|
are preserved on all copies.
|
|
|
|
Permission is granted to copy and distribute modified versions of this
|
|
manual under the conditions for verbatim copying, provided that the
|
|
entire resulting derived work is distributed under the terms of a
|
|
permission notice identical to this one.
|
|
|
|
Permission is granted to copy and distribute translations of this
|
|
manual into another language, under the above conditions for modified
|
|
versions, except that this permission notice may be included in
|
|
translations approved by the Free Software Foundation instead of in
|
|
the original English.
|
|
|
|
%FreeBSD: src/contrib/groff/src/roff/groff/groff.man,v 1.6.2.1 2001/04/26 17:35:15 ru Exp %
|
|
|
|
..
|
|
.de TQ
|
|
.br
|
|
.ns
|
|
.TP \\$1
|
|
..
|
|
.\" Like TP, but if specified indent is more than half
|
|
.\" the current line-length - indent, use the default indent.
|
|
.de Tp
|
|
.ie \\n(.$=0:((0\\$1)*2u>(\\n(.lu-\\n(.iu)) .TP
|
|
.el .TP "\\$1"
|
|
..
|
|
.TH GROFF 1 "26 April 2001" "Groff Version 1.17"
|
|
.SH 名称
|
|
groff \- groff ドキュメントフォーマットシステムのフロントエンド
|
|
.SH 書式
|
|
.nr a \n(.j
|
|
.ad l
|
|
.nr i \n(.i
|
|
.in +\w'\fBgroff 'u
|
|
.ti \niu
|
|
.B groff
|
|
.de OP
|
|
.ie \\n(.$-1 .RI "[\ \fB\\$1\fP" "\\$2" "\ ]"
|
|
.el .RB "[\ " "\\$1" "\ ]"
|
|
..
|
|
.OP \-abeghilpstvzCEGNRSUVXZ
|
|
.OP \-w name
|
|
.OP \-W name
|
|
.OP \-m name
|
|
.OP \-F dir
|
|
.OP \-I dir
|
|
.OP \-T dev
|
|
.OP \-f fam
|
|
.OP \-M dir
|
|
.OP \-d cs
|
|
.OP \-r cn
|
|
.OP \-n num
|
|
.OP \-o list
|
|
.OP \-P arg
|
|
.OP \-L arg
|
|
.RI "[\ " files\|.\|.\|. "\ ]"
|
|
.br
|
|
.ad \na
|
|
.PP
|
|
コマンドラインオプションとパラメータの間に空白を含めることが可能です。
|
|
.SH 解説
|
|
.B groff
|
|
は、groff ドキュメントフォーマットシステムのフロントエンドプログラムです。通常
|
|
.B groff
|
|
は
|
|
.B troff
|
|
を実行し、その出力を指定されたデバイスで扱うための
|
|
後処理プログラムを実行します。利用可能なデバイスは以下のとおりです:
|
|
.TP
|
|
.B ps
|
|
PostScript プリンタやプレビュア。
|
|
.TP
|
|
.B dvi
|
|
TeX の dvi フォーマット。
|
|
.TP
|
|
.B X75
|
|
75dpi の X11 プレビュア。
|
|
.TP
|
|
.B X100
|
|
100dpi の X11 プレビュア。
|
|
.TP
|
|
.B ascii
|
|
タイプライタに似た特性を持つデバイス。
|
|
.TP
|
|
.B latin1
|
|
ISO Latin-1 (ISO 8859-1) 文字集合を利用する
|
|
タイプライタに似た特性を持つデバイス。
|
|
.TP
|
|
.B koi8-r
|
|
ロシア語 KOI8-R 文字集合を利用するタイプライタに似た特性を持つデバイス。
|
|
.TP
|
|
.B utf8
|
|
UTF-8 エンコーディングの Unicode (ISO 10646) 文字集合を利用する
|
|
タイプライタに似た特性を持つデバイス。
|
|
.TP
|
|
.B cp1047
|
|
EBCDIC コードページ IBM cp1047 を利用する
|
|
タイプライタに似た特性を持つデバイス (例えば OS/390 Unix)。
|
|
.TP
|
|
.B lj4
|
|
HP LaserJet4 互換 (または他の PCL5 互換) プリンタ。
|
|
.B lbp
|
|
Canon CAPSL プリンタ用 (LBP-4 と LBP-8 シリーズのレーザプリンタ)。
|
|
.TP
|
|
.B html
|
|
HTML 出力を行います。
|
|
.LP
|
|
指定されたデバイス用の後処理を行うプログラムは、デバイス記述ファイルの
|
|
.B postpro
|
|
コマンドにより指定されています。これは
|
|
.B \-X
|
|
オプションにより変更できます。
|
|
.LP
|
|
デフォルトのデバイスは
|
|
.B ps
|
|
です。
|
|
.BR pic ,
|
|
.BR eqn ,
|
|
.BR grn ,
|
|
.BR grap ,
|
|
.BR tbl ,
|
|
.BR refer ,
|
|
.B soelim
|
|
の任意の前処理を行わせることもできます。
|
|
.LP
|
|
引数を伴わないオプションは
|
|
.B \-
|
|
のあとにまとめて続けることができます。
|
|
ファイル名のかわりに用いられる
|
|
.B \-
|
|
は標準入力を意味します。
|
|
.LP
|
|
.B grog
|
|
コマンドを用いてドキュメントを正しくフォーマットするための
|
|
.B groff
|
|
コマンドを調べることができます。
|
|
.SH オプション
|
|
.TP
|
|
.B \-h
|
|
ヘルプメッセージを表示します。
|
|
.TP
|
|
.B \-e
|
|
.B eqn
|
|
を使って前処理を行います。
|
|
.TP
|
|
.B \-t
|
|
.B tbl
|
|
を使って前処理を行います。
|
|
.TP
|
|
.B \-g
|
|
.B grn
|
|
を使用して前処理を行います。
|
|
.TP
|
|
.B \-G
|
|
.B grap
|
|
を使用して前処理を行います。
|
|
.TP
|
|
.B \-p
|
|
.B pic
|
|
を使って前処理を行います。
|
|
.TP
|
|
.B \-s
|
|
.B soelim
|
|
を使って前処理を行います。
|
|
.TP
|
|
.BI \-I dir
|
|
このオプションは
|
|
.BR soelim (1)
|
|
に記述されています。
|
|
このオプションは
|
|
.B \-s
|
|
オプションを暗黙的に指定します。
|
|
.TP
|
|
.B \-R
|
|
.B refer
|
|
を使って前処理を行います。
|
|
.B refer
|
|
に引数を渡す機構は用意されていません。
|
|
.B refer
|
|
のほとんどのオプションは、ファイル中に記述することができる等価なコマンドを
|
|
備えているからです。詳しくは
|
|
.BR refer (1)
|
|
のマニュアルを参照してください。
|
|
.TP
|
|
.B \-v
|
|
.B groff
|
|
から起動されるプログラムのバージョン番号を表示します。
|
|
.TP
|
|
.B \-V
|
|
実行しないで、
|
|
.B groff
|
|
で実行される処理内容を標準出力に表示します。
|
|
.TP
|
|
.B \-z
|
|
.B troff
|
|
からの出力を捨てます。エラーメッセージのみが表示されます。
|
|
.TP
|
|
.B \-Z
|
|
.B troff
|
|
からの出力を後処理しません。通常
|
|
.B groff
|
|
は、自動的に適当な後処理プログラムを起動します。
|
|
.TP
|
|
.BI \-P arg
|
|
後処理プログラムに
|
|
.I arg
|
|
を引数として渡します。別々の引数は別々の
|
|
.B \-P
|
|
オプションで指定する必要があります。
|
|
.B groff
|
|
は、
|
|
.I arg
|
|
の前に
|
|
.B \-
|
|
をつけてコマンドに渡したりしないことに注意してください。
|
|
.TP
|
|
.B \-l
|
|
プリンタのスプーラへ出力します。印字出力に用いられるコマンドは、デバイス
|
|
記述ファイルの
|
|
.B print
|
|
コマンドによって指定されます (これが存在しない場合には、
|
|
.B \-l
|
|
は無効果です)。
|
|
.TP
|
|
.BI \-L arg
|
|
.I arg
|
|
をプリンタスプーラプログラムに渡します。別々の引数は、別々の
|
|
.B \-L
|
|
オプションで指定する必要があります。
|
|
.B groff
|
|
は、
|
|
.I arg
|
|
の前に
|
|
.B \-
|
|
をつけてコマンドに渡したりしないことに注意してください。
|
|
デバイス記述ファイルに
|
|
.B print
|
|
コマンドが無い場合には、
|
|
.B \-L
|
|
は無視されます。
|
|
.TP
|
|
.BI \-T dev
|
|
デバイス
|
|
.I dev
|
|
用に出力します。デフォルトのデバイスは
|
|
.B ps
|
|
です。
|
|
.TP
|
|
.B \-X
|
|
通常の後処理プログラムのかわりに、
|
|
.B gxditview
|
|
を起動してプレビューします。
|
|
.B groff
|
|
は
|
|
.B gxditview
|
|
に
|
|
.B -printCommand
|
|
オプションを渡します。このオプションは
|
|
.B groff
|
|
に
|
|
.B -l
|
|
オプション指定時に実行される
|
|
.B Print
|
|
アクションを実行させます。
|
|
.B \-Tps
|
|
以外が指定されている場合は、よい結果が得られません。
|
|
.TP
|
|
.B \-N
|
|
.B eqn
|
|
の区切り文字間に改行が入ることを禁止します。
|
|
.B eqn
|
|
の
|
|
.B \-N
|
|
オプションと同様です。
|
|
.TP
|
|
.B \-S
|
|
より安全なモード。
|
|
.B \-S
|
|
オプションを
|
|
.B pic
|
|
に渡し、次の
|
|
.B troff
|
|
リクエストを無効化します:
|
|
.BR .open ,
|
|
.BR .opena ,
|
|
.BR .pso ,
|
|
.BR .sy ,
|
|
.BR .pi
|
|
。
|
|
セキュリティ上の理由から安全なモードはデフォルトで有効です。
|
|
.TP
|
|
.B \-U
|
|
安全でないモード。古い安全でない動作に戻します。
|
|
.TP
|
|
.B \-a
|
|
.TQ
|
|
.B \-b
|
|
.TQ
|
|
.B \-i
|
|
.TQ
|
|
.B \-C
|
|
.TQ
|
|
.B \-E
|
|
.TQ
|
|
.BI \-w name
|
|
.TQ
|
|
.BI \-W name
|
|
.TQ
|
|
.BI \-m name
|
|
.TQ
|
|
.BI \-o list
|
|
.TQ
|
|
.BI \-d cs
|
|
.TQ
|
|
.BI \-r cn
|
|
.TQ
|
|
.BI \-F dir
|
|
.TQ
|
|
.BI \-M dir
|
|
.TQ
|
|
.BI \-f fam
|
|
.TQ
|
|
.BI \-n num
|
|
これらのオプションの詳細は、
|
|
.BR troff (1)
|
|
に記述してあります。
|
|
.SH 環境変数
|
|
.TP
|
|
.SM
|
|
.B GROFF_COMMAND_PREFIX
|
|
もしこの変数が
|
|
.I X
|
|
に設定されていると、
|
|
.B groff
|
|
は
|
|
.B troff
|
|
のかわりに
|
|
.IB X troff
|
|
を起動します。これは、
|
|
.BR tbl ,
|
|
.BR pic ,
|
|
.BR eqn ,
|
|
.BR grn ,
|
|
.BR refer ,
|
|
.B soelim
|
|
にも同様に影響します。
|
|
.BR grap ,
|
|
.BR gropos ,
|
|
.BR grodvi ,
|
|
.BR grotty ,
|
|
.BR grolj4 ,
|
|
.BR grohtml ,
|
|
.B gxditview
|
|
には影響しません。
|
|
.TP
|
|
.SM
|
|
.B GROFF_TMAC_PATH
|
|
デフォルトディレクトリに加えて、
|
|
マクロファイルを検索すべきディレクトリのリスト (リストの区切りはコロンです)。
|
|
更なる詳細は
|
|
.BR troff (1)
|
|
を参照してください。
|
|
.TP
|
|
.SM
|
|
.B GROFF_TYPESETTER
|
|
デフォルトのデバイス
|
|
.TP
|
|
.SM
|
|
.B GROFF_FONT_PATH
|
|
デフォルトディレクトリに加えて、
|
|
.BI dev name
|
|
という名前のディレクトリを検索すべき
|
|
ディレクトリのリスト (リストの区切りはコロンです)。
|
|
更なる詳細は
|
|
.BR troff (1)
|
|
を参照してください。
|
|
.TP
|
|
.SM
|
|
.B GROFF_BIN_PATH
|
|
この検索パスは、
|
|
.BR groff
|
|
が起動するコマンドのために、
|
|
.BR PATH
|
|
の前に使用されます。
|
|
設定しないと、
|
|
.BR PATH
|
|
の前に `/usr/bin' が追加されます。
|
|
.TP
|
|
.SM
|
|
.B GROFF_TMPDIR
|
|
一時的なファイルが作成されるディレクトリ。もし、
|
|
.SM GRROFF_TMPDIR
|
|
が設定さ
|
|
れておらず、
|
|
.B
|
|
.SM TMPDIR
|
|
が設定されているなら、
|
|
.SM TMPDIR
|
|
で示されるディレクトリ
|
|
に一時ファイルが生成されます。さもなければ、一時ファイルは
|
|
.B /tmp
|
|
に作られます。
|
|
.BR grops (1)
|
|
と
|
|
.BR refer (1)
|
|
が一時ファイルを作成する可能性があります。
|
|
.SH 関連ファイル
|
|
.Tp \w'\fB/usr/share/groff_font/dev\fIname\fB/DESC'u+3n
|
|
.BI /usr/share/groff_font/dev name /DESC
|
|
デバイス
|
|
.IR name
|
|
のデバイス記述ファイル
|
|
.TP
|
|
.BI /usr/share/groff_font/dev name / F
|
|
デバイス
|
|
.I name
|
|
のためのフォント
|
|
.I F
|
|
を記述したフォントファイル
|
|
.LP
|
|
EBCDIC ホストにおいては、出力デバイス
|
|
.BR ascii ,
|
|
.BR latin1 ,
|
|
.B utf8
|
|
は使用不可です。
|
|
同様に、
|
|
.B cp1047
|
|
は ASCII ベースのオペレーティングシステム上では使用不可です。
|
|
.SH 使用例
|
|
マニュアルページ
|
|
.B foo.1
|
|
を標準出力に対し、latin-1 出力デバイスを使用して印刷し、
|
|
.B less
|
|
をページャに使用するには、次のコマンドを使用します:
|
|
.IP
|
|
.B groff -mandoc -Tlatin1 foo.1 | less
|
|
.PP
|
|
また、次のようにも使用できます:
|
|
.IP
|
|
.B groff -m mandoc -Tlatin1 foo.1 | less
|
|
.SH 作者
|
|
James Clark <jjc@jclark.com>
|
|
.SH バグ
|
|
バグレポートは、bug-groff@gnu.org までお願いします。
|
|
レポートの際にはバグを再現できる完全な例題を添付し、あなたの利
|
|
用している groff のバージョンを添えて下さい。
|
|
.SH COPYRIGHT
|
|
Copyright \(co 1989-2000 Free Software Foundation, Inc.
|
|
.LP
|
|
groff はフリーソフトウェアです。Free Software Foundation から
|
|
出版されている the GNU General Public License の ver 2.0 かそ
|
|
れ以降に基づく限り再配布したり、変更することが可能です。
|
|
.LP
|
|
groff は使い易いツールとして配布されることを望まれていますが、
|
|
どのような保証もありません。それが商業的であってもある特定の目
|
|
的に対するだけであっても保証はありません。詳しくは GNU の
|
|
General Public License を参照して下さい。
|
|
.LP
|
|
あなた
|
|
は groff のコピーを GNU General Public License と共に受
|
|
けとっているはずです。その COPYING を参照して下さい。そうでな
|
|
い場合には、
|
|
Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
|
|
まで御連絡下さい。
|
|
.SH 入手性
|
|
最新の groff はたいてい ftp.gnu.org の gnu/groff ディレクトリに置かれており、
|
|
anonymous ftp で入手できます。
|
|
.LP
|
|
.B groff
|
|
のみが、Ted Faber <faber@lunabase.org> が記述した自由に入手可能な
|
|
.B grap
|
|
実装をサポートします。
|
|
実物は、次のところにあります:
|
|
.IP
|
|
\%http://www.lunabase.org/~faber/Vault/software/grap/
|
|
.SH 関連項目
|
|
.BR grog (1),
|
|
.BR troff (1),
|
|
.BR tbl (1),
|
|
.BR pic (1),
|
|
.BR eqn (1),
|
|
.BR grn (1),
|
|
.BR grap (1),
|
|
.BR soelim (1),
|
|
.BR refer (1),
|
|
.BR grops (1),
|
|
.BR grodvi (1),
|
|
.BR grotty (1),
|
|
.BR grolj4 (1),
|
|
.BR grolbp (1),
|
|
.BR grohtml (1),
|
|
.BR gxditview (1),
|
|
.BR groff_font (5),
|
|
.BR groff_out (5),
|
|
.BR groff_man (7),
|
|
.BR groff_ms (7),
|
|
.BR groff_me (7),
|
|
.BR groff_char (7)
|