doc/ja_JP.eucJP/man/man1/grn.1
2003-05-21 04:11:55 +00:00

652 lines
14 KiB
Groff

'\" t
.ig
Copyright (C) 2000, 2001, 2002 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$
.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"
..
.\" WORD: stipple font スティプルフォント
.\" WORD: dotted line 点線
.\" WORD: dashed line 破線
.\" WORD: dot-dashed line 1 点鎖線
.TH GRN 1 "11 October 2002" "Groff Version 1.19"
.SH 名称
grn \- gremlin ファイル用 groff プリプロセッサ
.SH 書式
.BR grn
[
.B \-Cv
]
[
.BI \-T dev
]
[
.BI \-M dir
]
[
.BI \-F dir
]
[
.IR file\.\.\.\&
]
.PP
コマンドラインオプションとパラメータの間に空白を含めることが可能です。
.SH 解説
.I grn
は、
.I groff
の入力中に
.I gremlin
図を入れるためのプリプロセッサです。
.I grn
は、
.B .GS
.BR .GE
の間にはさまれた入力行のみを処理し、標準出力に書き出します。
処理される行には
.I grn
コマンド (後述) が含まれていなくてはなりません。
これらのコマンドは、
.I gremlin
ファイルを要求し、そのファイル中の図を変換し
.I troff
の入力ストリームに置きます。
.B .GS
リクエストは、続けて C, L, R をとることができ、
.I gremlin
図全体を中央揃え、左揃え、あるいは右揃えにすることができます
(デフォルトは中央揃えです)。
.I file
が指定されていない場合は、標準入力が読み込まれます。
図の最後では、ページ内での位置は
.I gremlin
図の下になります。
.I grn
エントリが
.BR .GE
ではなく
.B .GF
で終わっている場合は、ページ内での位置は図の左上になります。
.PP
現在のところ、\-me マクロパッケージだけが
.BR .GS ,
.BR .GE ,
.BR .GF
をサポートしていることに注意してください。
.PP
次のコマンドラインオプションを理解します:
.TP
.BI \-T dev
プリンタ
.IR dev
用の出力を用意します。
デフォルトのデバイスは
.BR ps
です。受け付け可能なデバイスについては
.BR groff (1)
を参照してください。
.TP
.BI \-M dir
.I dir
を、
.I gremlin
ファイルのデフォルト検索パスの前に追加します。
デフォルトパスは (順番に)、現在のディレクトリ、ホームディレクトリ、
.BR /usr/share/tmac ,
.BR /usr/share/tmac ,
.BR /usr/share/tmac
(訳注: 重複していますが原文通りです) です。
.TP
.BI \-F dir
.I dir
中からサブディレクトリ
.BI dev name
.RI ( name
はデバイス名です) を探し、デフォルトフォントディレクトリ
.BR /usr/share/groff_font
の前に読み込まれる
.B DESC
ファイルを探します。
.TP
.B \-C
たとえ空白や改行以外の文字が後に続いていても
.B .GS
および
.B .GE
(およびこれに相応する
.BR .GF )
を認識します。
.\".TP
.\".B \-s
.\"This switch causes the picture to be traversed twice:
.\"The first time, only the interiors of filled polygons (as borderless
.\"polygons) are printed.
.\"The second time, the outline is printed as a series of line segments.
.\"This way, postprocessors that overwrite rather than merge picture elements
.\"(such as Postscript) can still have text and graphics on a shaded
.\"background.
.TP
.B \-v
バージョン番号を表示します。
.SH grn コマンド
.B .GS
.B .GE
にはさまれた入力行はそれぞれ 1 つずつ
.I grn
コマンドを持っています。
コマンドは、1 つの文字列か、空白で区切られた 2 つの文字列で
できています。最初の文字列はコマンドであり、2 番目の文字列は
オペランドです。
コマンドは大文字小文字どちらでも良く、1 文字までに縮めることもできます。
.PP
図の環境に影響を与えるコマンド (以降において
.BR default
の前にリストされているもの) は、現在の図に対して
のみ効果を持ちます。
次の図が始まると、環境はデフォルトで再初期化されます。
コマンドは次のとおりです:
.TP
.BI 1\ N
.TQ
.BI 2\ N
.TQ
.BI 3\ N
.TQ
.BI 4\ N
.IR gremlin
のテキストサイズ番号 1 (2, 3 または 4) を
.I N
ポイントに設定します。
デフォルトは 12 (16, 24, 36) です。
.TP
.BI roman\ f
.TQ
.BI italics\ f
.TQ
.BI bold\ f
.TQ
.BI special\ f
ローマン体 (イタリック体、ボールド体、あるいは特殊文字) の
フォントを
.IR troff
フォント
.I f
(フォント名あるいは番号) に設定します。
デフォルトは R (I, B, S) です。
.TP
.BI l\ f
.TQ
.BI stipple\ f
スティプル (stipple) フォントを
.IR troff
のスティプルフォント
.I f
(フォント名あるいは番号)
に設定します。
コマンド
.B stipple
は、`st' までになら省略できます
(
.BR special
との混乱を避けるためです)。
スティプルフォントにはデフォルトは
.I ありません
(default コマンドで設定されていない限りは)。
スティプルフォントを指定しないまま、ポリゴンを含んだ
.I gremlin
図を取り込むことは不正です。
.TP
.BI x\ N
.TQ
.BI scale\ N
(デフォルトの拡大処理に加えて) gremlin 図を
.IR N
倍に拡大します。ここで N は 0 より大きな浮動小数値です。
コマンド
.B scale
は、`sc' までになら省略できます。
.TP
.BI narrow\ N
.TQ
.BI medium\ N
.TQ
.BI thick\ N
細線 (中間の太さの線、および太線) の太さを
0.15 ポイント (この値は、コンパイル時に変更できます) の
.I N
倍に設定します。
デフォルトは 1.0 (3.0, 5.0) です。これは、0.15 ポイント
(0.45 ポイントおよび 0.75 ポイント) に対応しています。
太さを表す値が 0 のときは、使用できる中で最も小さな値を
選択します。
負の値は、現在のポイントサイズに比例した、線の太さの指定になります。
.TP
.BI pointscale\ <off/on>
テキストを図に合うようにスケーリングします。
gremlin テキストは、通常、図のスケールファクタによらず、
コマンド
.BR 1 ,\ 2 ,\ 3 ,\ あるいは\ 4
で指定されるポイントサイズで表示されます。
.B pointscale
を設定すると、ポイントサイズが図に合わせて変更されます
(もちろん、
.IR troff
の制限内で)。
.I off
以外のオペランドは何であっても
テキストのスケーリングを有効にします。
.TP
.B default
デフォルトの図の環境を、現在の図の環境で、再設定します。
このオプションは、
.I troff
入力ファイルの先頭でグローバルパラメータを設定するメカニズムとして
使われることを意図していますが、デフォルト設定を再設定したいときは
いつでも使うことができます。
.TP
.BI width\ N
図を強制的に幅
.I N
インチにします。
このオプションは、同じ図中に存在する他のスケールファクタに優先します。
.RB ` width
.IR 0 '
は、無視されます。
.TP
.BI height\ N
他のスケールファクタに優先して、図を強制的に高さ
.I N
インチにします。
`width' と `height' 両方が指定されているときには、
図をより小さくする制約が図のスケールを決定します。
.B height
および
.B width
コマンドは、
.B default
コマンドでは保存はされません。
しかしながら、
ポイントサイズスケーリングが使用されている場合には、
これに対する影響はあります。
.TP
.BI file\ name
カレントディレクトリ (あるいはライブラリディレクトリ。前述の
.B \-M
オプションを参照してください) に置かれた
.I gremlin
ファイル
.I name
から図を取得します。
.B file
コマンドが 2 つ与えられた場合、2 つめのコマンドが最初のコマンドに優先します。
.I name
が存在しない場合は、エラーメッセージが報告され、
.B .GE
行から処理が再開されます。
.SH groff に関しての注意
.I grn
はプリプロセッサですので、現在のインデントやポイントサイズ、
余白や番号レジスタなどについては分かりません。
そのため、
.B .GS
リクエストと
.B .GE
リクエストの間には
.I troff
への入力を置くことができません。
しかしながら、
.I gremlin
テキストは現在
.IR troff
で処理されます。そのため、
.I gremlin
テキスト行にある
.I troff
への入力行はどれも正しいものになります (ただし、
行頭に `.' ディレクティブを置くことは禁止されています)。
そのため、
.I gremlin
ファイル中に
定義済みのデリミタ (例えば
.IR $$ )
で括った
.I eqn
表記を埋め込むことによって、
.I gremlin
図の中に等式を書くことができます。
.PP
.I grn
を他のプリプロセッサと一緒に使う場合、
.IR tbl
が仕事をしすぎないようにするために、
.IR grn ,
.IR pic ,
.I ideal
よりも前に
.I tbl
を呼び出すのが最も良いやり方です。
.I eqn
は必ず最後に起動させるべきです。
.PP
図はひとつのエンティティとみなされますが、
ページの末尾を越えてしまった場合、
.I troff
は図を分割しようとしてしまいます。
\-me マクロ中で図を `keeps' 中に置くことで
適切な位置決めができるようになります。
.PP
.I grn
.IR troff
の番号レジスタ
.B g1
から
.B g9
までを使い、そして
.B .GS
リクエストを処理する前にレジスタ
.B g1
および
.B g2
.I gremlin
図の幅および高さ (デバイス単位) を設定します
(これらのマクロを書き直したいと思っている人たちのために
そうしています)。
.SH gremlin ファイル形式
.I gremlin
ファイル形式には 2 つの異なった形式があります。
.I AED
グラフィック端末用バージョン由来のオリジナルの形式と
.I SUN
および
.I X11
バージョンの形式です。
負の座標を用いた参照点を容認する
.IR SUN / X11
バージョンの拡張機能は、
.I AED
バージョンとは互換性が
.B ありません
.I gremlin
ファイルに負の座標が含まれていない限りは、どちらの形式のファイルも
.I gremlin
あるいは
.IR grn
で読み込むことができます。
他に
.IR SUN / X11
の形式が異なる点は、図のオブジェクトに対して番号を
使うのではなく、名前 (例えば、POLYGON, CURVE) を使うことです。
同じ図を表すファイルを、それぞれの形式について 表 1 に示します。
.sp
.TS
center, tab(@);
l lw(0.1i) l.
sungremlinfile@@gremlinfile
0 240.00 128.00@@0 240.00 128.00
CENTCENT@@2
240.00 128.00@@240.00 128.00
185.00 120.00@@185.00 120.00
240.00 120.00@@240.00 120.00
296.00 120.00@@296.00 120.00
*@@-1.00 -1.00
2 3@@2 3
10 A Triangle@@10 A Triangle
POLYGON@@6
224.00 416.00@@224.00 416.00
96.00 160.00@@96.00 160.00
384.00 160.00@@384.00 160.00
*@@-1.00 -1.00
5 1@@5 1
0@@0
-1@@-1
.T&
css.
.sp
表 1. ファイル例
.TE
.sp
.IP \(bu
それぞれの
.I gremlin
ファイルの 1 行目は、
文字列
.B gremlinfile
.RI ( AED
バージョン) あるいは
.B sungremlinfile
.RI ( SUN / X11 バージョン)
のどちらかです。
.IP \(bu
ファイルの 2 行目には点の位置を決めるための、方向、
.B x
および
.B y
の値が含まれており、各値は空白で区切られています。
方向は、
.B 0
あるいは
.BR 1
をとり、
.IR SUN / X11
バージョンでは無視されます。
.B 0
は、
.I gremlin
図が水平方向の形式で表示されることを意味しています
(描画領域の幅が実際の図の高さよりも広くとられ、
上部にメニューがつきます)。
.B 1
は、
.I gremlin
図が垂直方向の形式で表示されることを意味しています
(描画領域の高さが実際の図の幅よりも高くとられ、
左側にメニューがつきます)。
.B x
および
.B y
は浮動小数値であり、このファイルが他のファイルに読み込まれる
際に、位置決め点を与えるために使用されます。
この行の要素は、それほど重要なものではありません。
``1 0.00 0.00'' という値を推奨します。
.IP \(bu
このファイルの残りの部分は 0 個以上の要素を
記述したものになっています。
最後の要素を記述した後には、文字列 ``-1'' を持った行がきます。
.IP \(bu
127 文字を越える行はこの長さに切り詰められます。
.SH 要素の記述
.IP \(bu
各要素の最初の行には、要素タイプを与える 10 進数
.RI ( AED
バージョンの場合) あるいは要素の ASCII 文字での名称
.RI ( SUN / X11
バージョンの場合)
が 1 つ
含まれています。
表 2 を参照してください。
.sp
.TS
center, tab(@);
css
ccc
nll.
\fIgremlin\fP ファイルフォーマット \(mi オブジェクトタイプの仕様
.sp
\fIAED\fP 番号@\fISUN\fP/\fIX11\fP 名称@解説
0@BOTLEFT@左下揃えのテキスト
1@BOTRIGHT@右下揃えのテキスト
2@CENTCENT@中央揃えのテキスト
3@VECTOR@ベクトル
4@ARC@円弧
5@CURVE@曲線
6@POLYGON@ポリゴン
7@BSPLINE@B スプライン
8@BEZIER@ベジエ (B\['e]zier)
10@TOPLEFT@左上揃えのテキスト
11@TOPCENT@中央上揃えのテキスト
12@TOPRIGHT@右上揃えのテキスト
13@CENTLEFT@左中央揃えのテキスト
14@CENTRIGHT@右中央揃えのテキスト
15@BOTCENT@中央下揃えのテキスト
.T&
css.
.sp
表 2.
\fIgremlin\fP ファイルにおける要素タイプの仕様
.TE
.sp
.IP \(bu
オブジェクトタイプの後には、可変数の行がきます。
各行は、オブジェクトの要素を表示するのに使われる点を指定します。
各行には、x 座標および y 座標が浮動小数値で入っており、
それぞれは空白文字で区切られています。
点のリストは、文字列 ``-1.0 -1.0'' を含んだ行
.RI ( AED
バージョンの場合) あるいはアスタリスク ``*'' 1 個
.RI ( SUN / X11
バージョンの場合) で終わります。
.IP \(bu
点の後には、10 進数 2 個を含んだ行がきます。これは、
要素に対するブラシとサイズを与えます。
ブラシは、オブジェクトが描かれる際のスタイルを決定します。
ベクトル、円弧、および曲線については、ブラシの値として
6 個の正当な値があります:
.sp
.TS
center, tab(@);
ncw(0.1i)l.
1 \(mi@@細い点線
2 \(mi@@細い一点鎖線
3 \(mi@@太い直線
4 \(mi@@細い破線
5 \(mi@@細い直線
6 \(mi@@通常の直線
.TE
.sp
ポリゴンに対しては、さらに 0 も正当な値となります。
この値は、境界線の見えないポリゴンを指定するものです。
テキストに対しては、ブラシは次のようにフォントを選択します:
.sp
.TS
center, tab(@);
ncw(0.1i)l.
1 \(mi@@ローマン体 (groff での R フォント)
2 \(mi@@イタリック体 (groff での I フォント)
3 \(mi@@ボールド体 (groff での B フォント)
4 \(mi@@特殊文字 (groff での S フォント)
.TE
.sp
図を
.IR groff
に通すために
.I grn
を使っている場合は、
ここでのフォントはただ開始時のフォントになるだけです:
テキスト文字列には、
``\efI''
``\ed''
のような、フォントを変更し得る (他のこともする)
フォーマット用シーケンスを含んでも構いません。
テキストでは、サイズフィールドは 1 から 4 までの
10 進数です。
これは、テキストが描画されるフォントサイズを選択します。
ポリゴンに対しては、このサイズフィールドはポリゴン内部を
埋めるために使われるスティプル番号と解釈されます。
この番号は、表示する際にスティプルフォントに置き換える
インデックスとして使われます。
.IP \(bu
各要素の最終行には、10 進数と文字列が空白文字 1 つで
区切られて入っています。
10 進数は、文字列中の文字数をカウントしたものです。
この情報はテキスト要素に対してのみ使われ、
テキスト文字列が情報の中に含まれています。
テキスト内部には空白文字が入っていても良いです。
円弧、曲線、およびベクトルについては、それぞれの要素が対応する行には
文字列 ``0'' が入っています。
.SH 座標についての注意
.I gremlin
.IR AED
用に設計され、その座標系は
.I AED
の座標空間を反映したものになっています。
垂直方向の図に対しては、x 値は 116 から 511 までをとり、
y 値は 0 から 483 までをとります。
水平方向の図に対しては、 x 値は 0 から 511 までをとり、
y 値は 0 から 367 までをとります。
この範囲に必ずしもこだわることはありませんが、
少なくともこの近傍にとどめておけば最良の結果が
得られるでしょう。
さらに、点のリストは (-1, -1) で終わりますので、
負の座標を使うことはできません。
.I gremlin
図は、``%f1.2'' という形式を使って座標を出力します。
ですので、
.I grn
コードを変更したい場合には同じ形式を用いるのが
おそらくは良い考えでしょう。
.SH SUN/X11 バージョンの座標についての注意
.IR SUN / X11
バージョンの
.IR gremlin
図では、オブジェクト生成に用いられる座標の範囲に
制限はもうありません。
しかし、負の座標を持ったファイルでは、
.IR AED
上で表示させようとすると問題が
.B 発生するでしょう
.SH 関連ファイル
.Tp \w'/usr/share/groff_font/devname/DESC'u+3n
.BI /usr/share/groff_font/dev name /DESC
デバイス
.IR name
用のデバイス定義ファイル
.SH 関連項目
.BR gremlin (1),
.BR groff (1),
.BR pic (1),
.BR ideal (1)
.SH 歴史
.PP
David Slattengren と Barry Roitblat がオリジナルの Berkeley 版
.IR grn
を書きました。
.PP
Daniel Senderowicz と Werner Lemberg が
.IR groff
用に書き直しました。
.
.\" Local Variables:
.\" mode: nroff
.\" End: