Makefile change and file add/del for 4.3-20010428-STABLE
This commit is contained in:
Kazuo Horikawa
parent
0938b2b04d
commit
6ad4efac88
Notes:
svn2git
2020-12-08 03:00:23 +00:00
svn path=/head/; revision=9339
8 changed files with 47 additions and 3999 deletions
|
|
@ -106,7 +106,6 @@ MAN1 = a2p.1\
|
|||
grodvi.1\
|
||||
groff.1\
|
||||
grog.1\
|
||||
grohtml.1\
|
||||
grolbp.1\
|
||||
grolj4.1\
|
||||
grops.1\
|
||||
|
|
|
|||
|
|
@ -1,181 +0,0 @@
|
|||
.ig \"-*- nroff -*-
|
||||
.\" jpman %Id: grohtml.1,v 1.3 2000/04/25 16:54:27 yt-kage Stab %
|
||||
.\" WORD: hyphenation ハイフネーション (ハイフンで文字を連結する)
|
||||
Copyright (C) 1999-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.
|
||||
..
|
||||
.\" 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 GROHTML 1 "7 December 2000" "Groff Version 1.16.1"
|
||||
.SH 名称
|
||||
grohtml \- groff の HTML ドライバ
|
||||
.SH 書式
|
||||
.nr a \n(.j
|
||||
.ad l
|
||||
.nr i \n(.i
|
||||
.in +\w'\fBgrohtml 'u
|
||||
.ti \niu
|
||||
.B grohtml
|
||||
.de OP
|
||||
.ie \\n(.$-1 .RI "[\ \fB\\$1\fP" "\\$2" "\ ]"
|
||||
.el .RB "[\ " "\\$1" "\ ]"
|
||||
..
|
||||
.OP \-atTvdgm?
|
||||
.OP \-F dir
|
||||
.OP \-I imagetype
|
||||
.OP \-r resolution
|
||||
.RI "[\ " files\|.\|.\|. "\ ]"
|
||||
.br
|
||||
.ad \na
|
||||
.PP
|
||||
コマンドラインオプションとパラメータの間に空白を含めることが可能です。
|
||||
.SH 解説
|
||||
.B grohtml
|
||||
は GNU
|
||||
.B troff
|
||||
の出力を HTML に翻訳します。
|
||||
通常は
|
||||
.B grohtml
|
||||
は
|
||||
.B \-Thtml
|
||||
オプションを付けて groff コマンドを使用することで起動されます。
|
||||
ファイルが与えられない場合、
|
||||
.B grohtml
|
||||
は標準入力を読みます。
|
||||
ファイル名が
|
||||
.B \-
|
||||
のときでも、
|
||||
.B grohtml
|
||||
は標準入力を読みます。
|
||||
HTML 出力は標準出力へ書き出されます。
|
||||
.B groff
|
||||
から
|
||||
.B grohtml
|
||||
を実行する時は、
|
||||
.B groff
|
||||
.B \-P
|
||||
を使用して
|
||||
.B grohtml
|
||||
にオプションを渡すことが出来ます。
|
||||
.SH オプション
|
||||
.TP
|
||||
.B \-a
|
||||
.B grohtml
|
||||
に troff が指定したのと同じ位置で HTML の改行を出力するよう強制します。
|
||||
このオプションなしでは
|
||||
.B grohtml
|
||||
は HTML ブラウザにより整形される段落中にテキストを出力します。
|
||||
.TP
|
||||
.B \-d
|
||||
内部デバッギングを有効にします。
|
||||
.TP
|
||||
.B \-g
|
||||
.B grohtml
|
||||
に表題や見出しを推測しないよう伝えます。
|
||||
-m や -a フラグと一緒にこのフラグを使用することにより
|
||||
.B grohtml
|
||||
は HTML ブラウザを整形機ではなくプリンタとして扱います。
|
||||
.TP
|
||||
.B \-m
|
||||
余白をそのままにします。
|
||||
.B grohtml
|
||||
は左の余白を取り除きません。
|
||||
.TP
|
||||
.B \-t
|
||||
.B grohtml
|
||||
が字下げや表の文を実現する時に HTML の表を生成することを禁止します。
|
||||
.B grohtml
|
||||
は表あるいは HTML の字下げにより .IP を実現出来ます。
|
||||
しかしながら .2C が使用される場合には、
|
||||
テーブル構造を使用したときだけ、それと判るように HTML に変換出来ます。
|
||||
HTML のテーブルのコードに 2,3 の既知のバグがまだ存在するため、
|
||||
このオプションは、開発中のコードの実行を抑止するために存在します。
|
||||
.B grohtml
|
||||
でのデフォルトは、適切な時には HTML テーブルが生成されます。
|
||||
.TP
|
||||
.B \-T
|
||||
tbl からの出力を処理するときに、
|
||||
.B grohtml
|
||||
がイメージを生成することを禁止します。
|
||||
簡単なテキストの表が生成されるときに有用です。
|
||||
.TP
|
||||
.BI \-F dir
|
||||
フォントとデバイス記述ファイルのために
|
||||
.IB dir /dev name
|
||||
を検索します ;
|
||||
.I name
|
||||
がデバイスの名前であり、通常は
|
||||
.BR html
|
||||
です。
|
||||
.TP
|
||||
.BI \-I imagetype
|
||||
grohtmlが式や表、図に遭遇した時に生成する画像の形式を選択します。
|
||||
このデフォルトは png256 です。
|
||||
受け付けられる画像形式は gif および ghostscript gs(1) によりサポート
|
||||
される任意の png です。
|
||||
.TP
|
||||
.BI \-r resolution
|
||||
全ての画像の解像度を選択します。
|
||||
デフォルトではインチ当り 80 ピクセルです。
|
||||
例: -r100 はインチ当り 100 ピクセルを示します。
|
||||
.TP
|
||||
.B \-v
|
||||
バージョン番号を印字します。
|
||||
.TP
|
||||
.B \-?
|
||||
使用法を表示します。
|
||||
.SH 使用法
|
||||
.BR R ,
|
||||
.BR I ,
|
||||
.BR B ,
|
||||
.B BI
|
||||
という形式があり、フォントポジション 1 から 4 にマウントされます。
|
||||
groff を -mhtml マクロセット付きで起動する事をお勧めします。
|
||||
このマクロセットを指定すると、へッダ、フッタ、ハイフネーションを
|
||||
無効にして、更にテキストを右揃えします。
|
||||
.SH 依存関係
|
||||
.B grohtml
|
||||
は grops と gs に依存します。
|
||||
.B grohtml
|
||||
が gif ファイルを生成するよう構成されている場合には、更に ppmtogif と
|
||||
ppmquant にも依存します。
|
||||
しかしながら png ファイルを生成するよう構成されている場合 (デフォルト)
|
||||
には png 出力デバイスを持つ gs に依存します。
|
||||
画像は表、図、式や線に遭遇した時に生成されます。
|
||||
.SH バグ
|
||||
これはまだまだアルファバージョンです。
|
||||
少なくとも三つの大きなバグが残っています。
|
||||
第一に、
|
||||
.B grohtml
|
||||
は HTML テーブルの終わりの判断を間違えて、同じテキストが 2 回出力されて
|
||||
しまうことがあります。
|
||||
第二に式番号が正しく処理されません。
|
||||
第三に式マクロと図のマクロが
|
||||
.BR grohtml
|
||||
を混乱させることがあります。
|
||||
.SH 関連項目
|
||||
.BR afmtodit (1),
|
||||
.BR groff (1),
|
||||
.BR troff (1),
|
||||
.BR psbb (1),
|
||||
.BR groff_out (5),
|
||||
.BR groff_font (5),
|
||||
.BR groff_char (7)
|
||||
|
|
@ -4,19 +4,15 @@ MAN7 = ascii.7\
|
|||
groff.7\
|
||||
groff_char.7\
|
||||
groff_man.7\
|
||||
groff_markup.7\
|
||||
groff_me.7\
|
||||
groff_mm.7\
|
||||
groff_mmse.7\
|
||||
groff_ms.7\
|
||||
groff_msafer.7\
|
||||
groff_mwww.7\
|
||||
hier.7\
|
||||
hostname.7\
|
||||
intro.7\
|
||||
mailaddr.7\
|
||||
man.7\
|
||||
mdoc.7\
|
||||
mdoc.samples.7\
|
||||
mmroff.7\
|
||||
operator.7\
|
||||
ports.7\
|
||||
|
|
@ -27,12 +23,14 @@ MAN7 = ascii.7\
|
|||
symlink.7\
|
||||
term.7
|
||||
|
||||
MLINKS=groff_man.7 man.7
|
||||
#MLINKS+=groff_mdoc.7 mdoc.7
|
||||
#MLINKS+=groff_mdoc.7 mdoc.samples.7
|
||||
MLINKS= groff_me.7 me.7
|
||||
MLINKS+=groff_mm.7 mm.7
|
||||
MLINKS+=groff_mmse.7 mmse.7
|
||||
MLINKS+=groff_ms.7 ms.7
|
||||
MLINKS+=groff_msafer.7 msafer.7
|
||||
MLINKS+=groff_markup.7 markup.7
|
||||
MLINKS+=groff_mwww.7 mwww.7
|
||||
MLINKS+=intro.7 miscellaneous.7
|
||||
|
||||
.include "bsd.prog.mk"
|
||||
|
|
|
|||
|
|
@ -1,61 +0,0 @@
|
|||
.ig \"-*- nroff -*-
|
||||
Copyright (C) 1989-1999 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.
|
||||
..
|
||||
.\" Original Revision: 1.1.1.1
|
||||
.\" jpman %Id: groff_msafer.7,v 1.3 1999/08/27 02:06:47 yt-kage Stab %
|
||||
.TH GROFF_MSAFER 7 "12 January 2000" "Groff Version 1.15"
|
||||
.SH 名称
|
||||
msafer \- groff -msafer マクロ
|
||||
.SH 書式
|
||||
.B groff
|
||||
.B \-msafer
|
||||
[
|
||||
.IR options .\|.\|.
|
||||
]
|
||||
[
|
||||
.IR files .\|.\|.
|
||||
]
|
||||
.SH 解説
|
||||
マクロ -msafer は、リクエスト
|
||||
.BR open ,
|
||||
.BR opena ,
|
||||
.BR pso ,
|
||||
.BR sy ,
|
||||
.B pi
|
||||
を除去します。
|
||||
信頼できない入手元からのソースを処理するときには、
|
||||
本マクロを使用すべきです。
|
||||
安全性を最大限に高めるには、
|
||||
本マクロは、コマンドオプションにおける最初の -m オプションであるべきです。
|
||||
通常、本マクロは groff の
|
||||
.B \-S
|
||||
オプションを使用して起動されます。
|
||||
本オプションは、
|
||||
.B pic
|
||||
に対しても
|
||||
.B \-S
|
||||
フラグを渡します。
|
||||
これは現在ではデフォルトであり、古い動作をさせるには
|
||||
.B \-U
|
||||
フラグを使用します。
|
||||
.SH 関連ファイル
|
||||
.B /usr/share/tmac/tmac.safer
|
||||
.SH 関連項目
|
||||
.BR groff (1),
|
||||
.BR troff (1),
|
||||
.BR pic (1)
|
||||
|
|
@ -1,37 +1,40 @@
|
|||
.TH GROFF_MARKUP 7 "7 December 2000" "Groff Version 1.16.1"
|
||||
.TH GROFF_MWWW 7 "26 April 2001" "Groff Version 1.17"
|
||||
.\" jpman %Id: groff_markup.7,v 1.3 2001/03/09 04:57:05 horikawa Stab %
|
||||
.\" Copyright (C) 2000 Free Software Foundation, Inc.
|
||||
.\" Written by Gaius Mulley (gaius@glam.ac.uk)
|
||||
.\"
|
||||
.\" This file is part of groff.
|
||||
.\"
|
||||
.\"
|
||||
.\" groff is free software; you can redistribute it and/or modify it under
|
||||
.\" the terms of the GNU General Public License as published by the Free
|
||||
.\" Software Foundation; either version 2, or (at your option) any later
|
||||
.\" version.
|
||||
.\"
|
||||
.\"
|
||||
.\" groff is distributed in the hope that it will be useful, but WITHOUT ANY
|
||||
.\" WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
||||
.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
||||
.\" for more details.
|
||||
.\"
|
||||
.\"
|
||||
.\" You should have received a copy of the GNU General Public License along
|
||||
.\" with groff; see the file COPYING. If not, write to the Free Software
|
||||
.\" Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
|
||||
.\"
|
||||
.\" user level guide to using the -markup macroset
|
||||
.\" user level guide to using the -mwww macroset
|
||||
.\"
|
||||
.do mso tmac.arkup
|
||||
.LINE
|
||||
.do mso www.tmac
|
||||
.\" we need the .LINKS here as we use it in the middle as an example
|
||||
.\" once the user requests .LINKS then the automatic generation of links
|
||||
.\" at the top of the document is suppresed.
|
||||
.LINKS
|
||||
.SH 名称
|
||||
groff_markup \- ウェブページのオーサリング用 groff マクロ
|
||||
groff_mwww \- ウェブページのオーサリング用 groff マクロ
|
||||
.LINE
|
||||
.SH 書式
|
||||
.B "groff \-markup"
|
||||
.B "groff \-mwww"
|
||||
[ options ]
|
||||
file ...
|
||||
file ...
|
||||
.SH 解説
|
||||
このマニュアルページは、GNU \-markup マクロについて解説しています。
|
||||
このマニュアルページは、GNU \-mwww マクロについて解説しています。
|
||||
これは、groff ドキュメント整形システムの一部です。
|
||||
このマニュアルページは、ごく基本的なガイドに過ぎませんし、
|
||||
html デバイスドライバ
|
||||
|
|
@ -109,6 +112,8 @@ html
|
|||
.sp
|
||||
という見出しも、3 レベル目の見出しがあるということにより、
|
||||
リンクに含まれないようになります。
|
||||
自動的な見出しを切り替える別の方法は、
|
||||
コマンドラインスイッチ \fC-P-l\fP です。
|
||||
.TP
|
||||
.B BODYCOLOR
|
||||
5 つパラメータを取ります: 文字色、背景色、アクティブな
|
||||
|
|
@ -159,20 +164,17 @@ HTML
|
|||
これは、次のマクロで実現します:
|
||||
.sp
|
||||
.nf
|
||||
\s-2\fC\&.MAILTO wl@gnu.org "Werner Lemberg"\fP
|
||||
.sp
|
||||
\fC\&.MAILTO Ted.Harding@nessie.mcc.ac.uk \\
|
||||
.br
|
||||
"Ted Harding" \s+2\fP
|
||||
\s-2\fC\&.MAILTO wl@gnu.org "Werner Lemberg"
|
||||
\&.MAILTO Ted.Harding@nessie.mcc.ac.uk "Ted Harding" .\s+2\fP
|
||||
.fi
|
||||
.sp
|
||||
実際には、groff では URL はテキストとしての空白を
|
||||
一切使わないものとして扱われることに注意してください。
|
||||
このことは、いくつかの問題の原因となりますのでバグだと
|
||||
考えられるでしょう。
|
||||
これを回避するために、\fCtmac.arkup\fP は他に影響を
|
||||
これを回避するために、\fCwww.tmac\fP は他に影響を
|
||||
与えない空白に展開される幅 0 の文字を挿入します
|
||||
(HTML モードであるときに限ります)。
|
||||
(-Thtml 付で実行された場合のみ)。
|
||||
.TP
|
||||
.B FTP
|
||||
データが FTP 経由で取得できることを示します。
|
||||
|
|
@ -187,9 +189,10 @@ ftp://ftp.ffii.org/pub/groff/devel/groff-current.tar.gz
|
|||
の場所です。
|
||||
このマクロの例は、次のように指定します:
|
||||
.sp
|
||||
.nf
|
||||
\s-2\fC\&.FTP "現在の groff 開発者用配布物" \\
|
||||
.br
|
||||
ftp://ftp.ffii.org/pub/groff/devel/groff-current.tar.gz \fP\s+2
|
||||
.fi
|
||||
.sp
|
||||
.TP
|
||||
.B IMAGE
|
||||
|
|
@ -227,99 +230,51 @@ ftp://ftp.ffii.org/pub/groff/devel/groff-current.tar.gz \fP\s+2
|
|||
このリンクは、先の URL マクロの記述の中で TAG を置くことで
|
||||
実現したのです。ソースは次のようになります:
|
||||
.sp
|
||||
.nf
|
||||
\s-2\fC\&.TP
|
||||
.br
|
||||
\&.B URL
|
||||
.br
|
||||
は、
|
||||
.br
|
||||
\&.TAG URL
|
||||
を生成します。
|
||||
.br
|
||||
URL は 2 個あるいは 3 個の
|
||||
.br
|
||||
引数を使います。
|
||||
.br
|
||||
$1 がリンクの名前、そして $2 が実際の URL です。
|
||||
.br
|
||||
\fP\s+2 (後略)
|
||||
$1 がリンクの名前、そして $2 が実際の URL です。\fP\s+2
|
||||
.fi
|
||||
.sp
|
||||
.\".TP
|
||||
.\".B CDFTP
|
||||
.\"takes four arguments.
|
||||
.\"Basically it is the FTP macro with optional local reference.
|
||||
.\"It was designed to allow the same groff source to be built on two different
|
||||
.\"machines and access the ftp data differently.
|
||||
.\"For example, on a web server you might wish for the web page to reference
|
||||
.\"a web site.
|
||||
.\"However, if you were producing a CDROM of your information you might wish
|
||||
.\"for the ftp data to be also stored on your CDROM and referenced as a file.
|
||||
.\"An example to get the current groff development distribution
|
||||
.\".CDFTP merlin "click here." \
|
||||
.\"ftp://ftp.ffii.org/pub/groff/devel/groff-current.tar.gz \
|
||||
.\"../../groff.tar.gz
|
||||
.\"The source for this CDFTP invocation is
|
||||
.\".sp
|
||||
.\"\fC\s-2\&.CDFTP merlin "click here." \
|
||||
.\"ftp://ftp.ffii.org/pub/groff/devel/groff-current.tar.gz \
|
||||
.\"../../groff.tar.gz\fP\s+2
|
||||
.\".sp
|
||||
.\"which means if the html is generated on machine \fCmerlin\fP
|
||||
.\"then generate a URL to \fC../../groff.tar.gz\fP.
|
||||
.\"Otherwise construct an FTP URL to
|
||||
.\"\fCftp://ftp.ffii.org/pub/groff/devel/groff-current.tar.gz\fP.
|
||||
.TP
|
||||
.B LINE
|
||||
水平方向に幅いっぱいの罫線を生成します。
|
||||
次が例です:
|
||||
.sp
|
||||
.nf
|
||||
\fC\s-2\&.LINE\fP\s+2
|
||||
.fi
|
||||
.sp
|
||||
.TP
|
||||
.B LINKS
|
||||
.TAG LINK
|
||||
は、grohtml が自動的に生成されるリンクをこの位置へ置くよう要求します。
|
||||
例:
|
||||
.LINKS
|
||||
.SH
|
||||
セクション見出しへのリンク
|
||||
.LP
|
||||
デフォルトでは、
|
||||
.B grohtml
|
||||
はセクションの見出しすべてへのリンクを生成し、リンクを
|
||||
はセクションの見出しすべてへのリンクを生成し、
|
||||
リンクを
|
||||
HTML ドキュメントの先頭に配置します。
|
||||
.B grohtml
|
||||
は、セクションの見出しがどう見えるかを推測しなくてはなりません
|
||||
\(em
|
||||
.B grohtml
|
||||
が実際に見ているものは、どこにテキストを置き、どこに
|
||||
線を引き、どこでフォントサイズやフェースを変えるべきかなどを示した、
|
||||
デバイス非依存の言語だけなのだということを覚えておいてください。
|
||||
.B grohtml
|
||||
は、最も左端から始まったボールド体のテキスト行が
|
||||
見出しなのだと信じています。
|
||||
そのため、見出しを間違って解釈することもあります。
|
||||
ユーザは、\fCgroff -P-g\fP を使って groff を起動させることで、
|
||||
見出しおよびタイトルの推測機能をすべて抑制することができます。
|
||||
オフにしたり位置を変えるための詳細は
|
||||
.URL LINKS #LINK
|
||||
を参照してください。
|
||||
.SH
|
||||
grohtml の制限
|
||||
.LP
|
||||
基本的なテキストはそのままの形で変換できますが、
|
||||
.B grohtml
|
||||
がテキストの関係を作ろうとしたり推測したりしなくては
|
||||
ならないような領域がいくつかあります。
|
||||
とりわけ、
|
||||
テキストの表やインデントされた段落、あるいは 2 段組モードに
|
||||
つき当たると、
|
||||
.B grohtml
|
||||
は常に列をそろえるために HTML の table の作成を実行しようと
|
||||
します。
|
||||
.B grohtml
|
||||
は、ブラウザが自動的に整形する必要があるのはどの行なのかも
|
||||
突き止めようとします。
|
||||
結局のところ、理にかなった推測をしようとすれば、大抵の場合
|
||||
間違いが生じます。
|
||||
バグレポートやパッチを頂いていくうちにこうした間違いはどんどん
|
||||
起こらなくなっていくのではないかと期待します。:-)
|
||||
.PP
|
||||
tbl, pic, eqn の結果も画像を使って生成されており、
|
||||
このことも制限とみなされるかもしれません。
|
||||
tbl 情報は、現状 png イメージで描かれます。
|
||||
.SH 関連ファイル
|
||||
/usr/share/tmac/tmac.arkup
|
||||
/usr/share/tmac/mwww.tmac (www.tmac へのラッパ)
|
||||
.br
|
||||
/usr/share/tmac/www.tmac
|
||||
.SH "関連項目"
|
||||
.BR groff (1),
|
||||
.BR troff (1),
|
||||
|
|
@ -330,11 +285,9 @@ tbl, pic, eqn
|
|||
は
|
||||
.MAILTO gaius@glam.ac.uk "Gaius Mulley"
|
||||
が書きました。
|
||||
.LINE
|
||||
.SH バグ
|
||||
バグレポートは
|
||||
.MAILTO bug-groff@gnu.org "Groff Bug Mailing List"
|
||||
へ送ってください。
|
||||
バグが再現できるように、完全で自己完結している例を付けてください。
|
||||
また、どのバージョンの groff を使っているかも伝えてください。
|
||||
.LINE
|
||||
|
|
@ -1,380 +0,0 @@
|
|||
.\" Copyright (c) 1998.
|
||||
.\" The FreeBSD Project. All rights reserved.
|
||||
.\"
|
||||
.\" Redistribution and use in source and binary forms, with or without
|
||||
.\" modification, are permitted provided that the following conditions
|
||||
.\" are met:
|
||||
.\" 1. Redistributions of source code must retain the above copyright
|
||||
.\" notice, this list of conditions and the following disclaimer.
|
||||
.\" 2. Redistributions in binary form must reproduce the above copyright
|
||||
.\" notice, this list of conditions and the following disclaimer in the
|
||||
.\" documentation and/or other materials provided with the distribution.
|
||||
.\" 3. All advertising materials mentioning features or use of this software
|
||||
.\" must display the following acknowledgement:
|
||||
.\" This product includes software developed by the University of
|
||||
.\" California, Berkeley and its contributors.
|
||||
.\" 4. Neither the name of the University nor the names of its contributors
|
||||
.\" may be used to endorse or promote products derived from this software
|
||||
.\" without specific prior written permission.
|
||||
.\"
|
||||
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
|
||||
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
||||
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
|
||||
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
||||
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
||||
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||||
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
||||
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
||||
.\" SUCH DAMAGE.
|
||||
.\"
|
||||
.\" %FreeBSD: src/share/man/man7/man.7,v 1.4 2000/03/03 14:04:59 sheldonh Exp %
|
||||
.\" jpman %Id: man.7,v 1.3 1999/02/10 13:32:51 horikawa Stab %
|
||||
.\"
|
||||
.\" WORD: format (roffで)書式整形(する)[man.7]
|
||||
.\" WORD: indent インデント[man.7]
|
||||
.\"
|
||||
.Dd November 30, 1998
|
||||
.Os
|
||||
.Dt MAN 7
|
||||
.Sh 名称
|
||||
.Nm man
|
||||
.Nd
|
||||
.Nm \-man
|
||||
マクロパッケージのクイックリファレンスガイド
|
||||
.Sh 書式
|
||||
.Nm groff
|
||||
.Fl m Ns Ar an
|
||||
.Ar
|
||||
.Sh 解説
|
||||
.Nm \-man
|
||||
パッケージは、
|
||||
.Ux
|
||||
マニュアルページの書式整形に使用するマクロの集合です。
|
||||
.Bx
|
||||
システムでは、
|
||||
.Nm
|
||||
の使用は非推奨とされており、代わりに、それより表現力に富んだ
|
||||
.Nm mdoc
|
||||
パッケージが推奨されています。
|
||||
.Sh 使用法
|
||||
.Ss 慣習
|
||||
.Nm
|
||||
で使用するマクロは、1 文字か 2 文字のアルファベット大文字を用いて名前が
|
||||
付けられています。
|
||||
.Xr troff 1
|
||||
で通常使われる慣習に従い、各マクロリクエストは、行の先頭に
|
||||
.Li "."
|
||||
をつけて始まります。
|
||||
マクロリクエストの引数には、印字可能なテキストをとることが期待されています。
|
||||
マクロリクエストの引数は、0 個から 6 個までの単語 (word) からなります。マクロリクエスト
|
||||
によっては、引数をとらないときに次の入力行を処理するものもあります。例えば、
|
||||
.Li ".I"
|
||||
リクエストがそれだけで 1 行になっている場合、次の入力行が斜体 (italic) に
|
||||
なります。
|
||||
空白やタブ文字 (whitespace characters) は、クォートで囲むことで引数に
|
||||
含めることができます。各パラグラフが始まる直前
|
||||
およびフォントサイズ・フォントフェース変更マクロが処理された後では、
|
||||
フォントとサイズはデフォルト値に戻されます。
|
||||
.Ss インデント
|
||||
.\" WORD: prevailing indent 通常インデント[man.7]
|
||||
通常インデント (prevailing indent) の間隔は、その後インデント状態の
|
||||
パラグラフが継続する間、保持されていますが、非インデント状態の
|
||||
パラグラフに到達するとデフォルト値にリセットされます。インデントに
|
||||
おけるデフォルトの単位は、
|
||||
.Dq en
|
||||
です。
|
||||
.Ss 前処理 (Preprocessing)
|
||||
伝統的に、マニュアルページの書式整形と表示には
|
||||
.Xr man 1
|
||||
プログラムが用いられます。マニュアルページのソースコードの1行目が、
|
||||
文字列
|
||||
.Li \&\'\e"
|
||||
.\" " bring emacs's font-lock mode back in sync ...
|
||||
で始まる場合、
|
||||
その行の残りの文字は、
|
||||
.Xr troff 1
|
||||
で文書を整形する前に実行する必要があるプリプロセッサを表します。
|
||||
サポートしているプリプロセッサ指示子は次のとおりです。
|
||||
.Bl -column "文字" "プリプロセッサ" -offset indent
|
||||
.It Em 文字 Ta Em プリプロセッサ
|
||||
.It e Ta Xr eqn 1
|
||||
.It g Ta Xr grap 1
|
||||
.It p Ta Xr pic 1
|
||||
.It r Ta Xr refer 1
|
||||
.It t Ta Xr tbl 1
|
||||
.It v Ta Xr vgrind 1
|
||||
.El
|
||||
.Ss 利用可能な文字列
|
||||
.Nm
|
||||
パッケージで事前に定義されている文字列は次のとおりです。
|
||||
.Bl -column "文字列" "XXXXXXXXXXXXXXXXXXXXXXXXXXXX" -offset indent
|
||||
.It Em 文字列 Ta Em 説明
|
||||
.It "\e*R" Ta "登録商標のシンボル(registration symbol)"
|
||||
.It "\e*S" Ta "フォントサイズをデフォルトに戻す"
|
||||
.It "\e*(Tm" Ta "商標のシンボル(trademark symbol)"
|
||||
.It "\e*(lq" Ta "左引用符(left quote)"
|
||||
.It "\e*(rq" Ta "右引用符(right quote)"
|
||||
.El
|
||||
.Pp
|
||||
.Ss 利用可能なマクロ
|
||||
利用可能なマクロをアルファベット順に説明します。
|
||||
.Bl -tag -width "XXX XX"
|
||||
.It ".B" Op Ar words
|
||||
.Ar words
|
||||
.\" WORD: typeset 版組みする[man.7]
|
||||
.\" WORD: line break (行を)分割する[man.7]
|
||||
をボールド体で版組みします。行分割は生じません。引数を与えない
|
||||
場合、次の行が処理の対象になります。
|
||||
.It ".BI" Op Ar words
|
||||
ボールド体と斜体を交互にして、
|
||||
.Ar words
|
||||
を結合します。行分割は生じません。
|
||||
引数を与えない場合、次の行が処理の対象になります。
|
||||
.It ".BR" Op Ar words
|
||||
ボールド体とローマン体を交互にして、
|
||||
.Ar words
|
||||
を結合します。行分割は生じません。
|
||||
引数を与えない場合、次の行が処理の対象になります。
|
||||
.It ".DT"
|
||||
デフォルトのタブ間隔を 0.5 インチに戻します。
|
||||
行分割は生じません。
|
||||
.It ".HP" Op Ar indent
|
||||
パラグラフを、ハンギングインデント (hanging indent) で始め、
|
||||
以後の通常インデント幅を
|
||||
.Ar indent
|
||||
に設定します。このリクエストが実行されると、強制的に行分割が
|
||||
生じます。
|
||||
.Ar indent
|
||||
が指定されない場合、通常インデント幅が使用されます。
|
||||
.It ".I" Op Ar words
|
||||
.Ar words
|
||||
を斜体で版組みします。行分割は生じません。
|
||||
引数を与えない場合、次の行が処理の対象になります。
|
||||
.It ".IB" Op Ar words
|
||||
斜体とボールド体を交互にして、
|
||||
.Ar words
|
||||
を結合します。行分割は生じません。
|
||||
引数を与えない場合、次の行が処理の対象になります。
|
||||
.It ".IP" Op Ar tag Op Ar indent
|
||||
インデントされたパラグラフを、タグ
|
||||
.Ar tag
|
||||
を付けて始めます。
|
||||
また、以後の通常インデント幅を
|
||||
.Ar indent
|
||||
に設定します。
|
||||
.Ar tag
|
||||
が指定されていない場合、
|
||||
.Ar tag
|
||||
は空文字列
|
||||
.Qq ""
|
||||
と見なされます。
|
||||
.Ar indent
|
||||
が指定されない場合、
|
||||
通常インデント幅と見なされます。
|
||||
.It ".IR" Op Ar words
|
||||
斜体とローマン体を交互にして、
|
||||
.Ar words
|
||||
を結合します。行分割は生じません。
|
||||
引数を与えない場合、次の行が処理の対象となります。
|
||||
.It ".LP"
|
||||
左整列 (left-aligned) パラグラフを開始します。
|
||||
通常インデント幅はデフォルト値に設定されます。このリクエスト
|
||||
が実行されると、強制的に行分割が生じます。
|
||||
.It "\&.P"
|
||||
\&.LP の別名です。
|
||||
.It ".PD" Op Ar distance
|
||||
パラグラフ間の垂直方向の間隔を
|
||||
.Ar distance
|
||||
に設定します。
|
||||
.Ar distance
|
||||
が指定されない場合、値 0.4v が使用されます。
|
||||
.It ".PP"
|
||||
\&.LP の別名です。
|
||||
.It ".RE"
|
||||
相対インデント (以下の \&.RS を参照して下さい) を終了します。
|
||||
このリクエストが実行されると強制的に行分割が生じ、
|
||||
通常インデント値が、以前使用されていた値に戻されます。
|
||||
.It ".RB" Op Ar words
|
||||
ローマン体とボールド体を交互にして、
|
||||
.Ar words
|
||||
を結合します。行分割は生じません。
|
||||
引数を与えない場合、次の行が処理の対象となります。
|
||||
.It ".RI" Op Ar words
|
||||
ローマン体と斜体を交互にして、
|
||||
.Ar words
|
||||
を結合します。行分割は生じません。
|
||||
引数を与えない場合、次の行が処理の対象となります。
|
||||
.It ".RS" Op Ar indent
|
||||
相対インデントを開始します。インデント幅を
|
||||
.Ar indent
|
||||
だけ増加させます。
|
||||
引数
|
||||
.Ar indent
|
||||
が指定されていない場合、通常インデント幅の値が使用されます。
|
||||
.It ".SB" Op Ar words
|
||||
フォントサイズを 1 ポイント小さくしてからボールド体で
|
||||
.Ar words
|
||||
を版組みします。行分割は生じません。引数が指定されない場合、
|
||||
次の行が処理の対象となります。
|
||||
.It ".SH" Op Ar words
|
||||
セクションの表題 (section heading) を指定します。このリクエストが
|
||||
実行されると、
|
||||
強制的に行分割が生じます。また、通常インデント幅とマージンを
|
||||
デフォルト値に戻します。
|
||||
.It ".SM" Op Ar words
|
||||
フォントサイズを 1 ポイント小さくしてから
|
||||
.Ar words
|
||||
を版組みします。行分割は生じません。引数が指定されない場合、
|
||||
次の行が処理の対象となります。
|
||||
.It ".SS" Op Ar words
|
||||
セクション副表題 (section subheading) を指定します。このリクエストが
|
||||
実行されると、
|
||||
強制的に行分割が生じます。引数が指定されない場合、次の行が
|
||||
処理の対象となります。このリクエストは、通常インデント幅とマージンを
|
||||
デフォルト値に戻します。
|
||||
.It ".TH" Ar name Ar section Ar date Xo
|
||||
.Op Ar footer Op Ar center
|
||||
.Xc
|
||||
セクション
|
||||
.Ar section
|
||||
に属するリファレンスページ
|
||||
.Ar name
|
||||
を開始します。
|
||||
第 3 引数
|
||||
.Ar date
|
||||
は、最終更新日です。
|
||||
.Ar footer
|
||||
が存在する場合、
|
||||
これは左側に表示されるページフッタテキストを指定します。さらに、
|
||||
.Ar center
|
||||
が存在する場合、
|
||||
これはページ中央のヘッダテキストを指定します。このリクエストは、
|
||||
マニュアルページの一番最初のリクエストでなければなりません。
|
||||
.It ".TP" Op Ar indent
|
||||
タグ付きのインデントされたパラグラフを
|
||||
開始します。付加するタグはこのリクエストの次の行で指定します。引数
|
||||
.Ar indent
|
||||
を指定すると、通常インデント幅の値を新しく指定できます。
|
||||
このリクエストが実行されると、強制的に行分割が生じます。
|
||||
.El
|
||||
.Sh ページ構造
|
||||
マニュアルページは、一般的に以下に説明する構造の概略に従うことがほとんどです。
|
||||
.Bl -tag -width ".SH 名称"
|
||||
.It ".TH" Ar title Op Ar section-number
|
||||
マニュアルページの最初のマクロリクエストは、\&.TH でなくてはなりません。
|
||||
このリクエストを使用することで、マニュアルページのタイトルと名称が決定できます。
|
||||
\&.TH リクエストでは、マニュアルページのセクション番号も決定できます。
|
||||
.It ".SH NAME"
|
||||
コマンドを呼び出す名前、または名前のリストの後には、ダッシュ
|
||||
.Pq Dq -
|
||||
とコマンドの動作の要約を一行で続けます。このセクションには
|
||||
.Nm troff
|
||||
コマンド、エスケープシーケンス、マクロリクエストを一切置いてはいけません。
|
||||
この部分は、
|
||||
.Xr whatis 1
|
||||
コマンドが使用するデータベースを生成するために使用されます。
|
||||
.It ".SH SYNOPSIS"
|
||||
説明するコマンドや関数の用法の簡単な要約を書きます。
|
||||
.Bl -tag -width "コマンド"
|
||||
.It コマンド
|
||||
コマンドと引数の構文を、コマンド行で入力するように記述します。書かれた通りに
|
||||
入力しなければならない語はボールド体で表します。引数は斜体で
|
||||
表します。このように引数とコマンド名を表す場合、たとえ文の始まりで
|
||||
あっても、大文字にしてはいけません。
|
||||
.Pp
|
||||
構文上のシンボルとして使用するものはローマン体で表さなくてはなりません。
|
||||
.Bl -tag -width "XXX"
|
||||
.It "[]"
|
||||
角括弧は、オプション扱いの引数を表す際に使用します。
|
||||
.It "|"
|
||||
垂直バーは、複数の選択肢から一つだけ選択することを表す際に使用します。垂直バーで区切った
|
||||
リストの中の項目一つだけを選択すべきということです。
|
||||
.It "..."
|
||||
引数の後ろに省略符号を続ける場合、その引数が繰り返し指定可能で
|
||||
あることを表します。角括弧で囲んだ式の後ろに省略符号を続ける場合、
|
||||
角括弧内の式が繰り返し指定可能であることを表します。
|
||||
.El
|
||||
.It 関数
|
||||
必要なデータの宣言もしくは
|
||||
.Li "#include"
|
||||
指示子を最初に置きます。その後ろに関数宣言を置きます。
|
||||
.El
|
||||
.It ".SH DESCRIPTION"
|
||||
コマンドや関数の外部挙動の概要を記述します。それには、ファイルや
|
||||
データとのやりとりや、標準入力、標準出力、標準エラー出力がどのように
|
||||
扱われるかが含まれます。通常、内部挙動や実装の詳細をここでは示しません。
|
||||
このセクションで解くべき疑問は、「これはなにをするのか?」もしくは、
|
||||
「これは何のためのものか?」です。
|
||||
.Pp
|
||||
リテラルテキスト、ファイル名、リファレンスマニュアルの他の場所にある
|
||||
項目への参照は、固定幅書体で表さねばなりません。引数は斜体を用いて
|
||||
表さねばなりません。
|
||||
.It ".SH OPTIONS"
|
||||
オプションの一覧を、各オプションがコマンドの挙動にどのような
|
||||
影響を与えるかの説明と共に与えます。
|
||||
.It ".SH USAGE"
|
||||
このセクションはオプションであり、サブコマンドの詳細な説明や、その
|
||||
コマンドが理解する入力の文法を含めます。
|
||||
.It ".SH RETURN VALUES"
|
||||
ライブラリルーチンが呼び出し元へ返しうる戻り値の一覧と、それらの
|
||||
値が返る原因となる条件を記述します。
|
||||
.It ".SH EXIT STATUS"
|
||||
.\" WORD: exit status 終了ステータス
|
||||
そのコマンドが終了ステータス (exit status) として返す値の一覧と、それらの
|
||||
値が返る原因となる条件を記述します。
|
||||
.It ".SH FILES"
|
||||
そのコマンドや関数に関連するファイルの一覧です。
|
||||
.It ".SH SEE ALSO"
|
||||
関連マニュアルページの一覧に続けて、他の参考となる刊行物の一覧を、
|
||||
コンマで区切って並べます。
|
||||
.It ".SH DIAGNOSTICS"
|
||||
診断メッセージと対応する説明の一覧です。
|
||||
.It ".SH BUGS"
|
||||
既知の障害や使用上の制限があれば、それを記述します。
|
||||
.El
|
||||
.Sh 関連ファイル
|
||||
.Bl -tag -width "/usr/share/tmac/tmac.groff_an"
|
||||
.It "/usr/share/tmac/tmac.an"
|
||||
.Nm
|
||||
パッケージを定義する初期ファイル。
|
||||
.It "/usr/share/tmac/tmac.groff_an"
|
||||
マクロ定義のための
|
||||
.Nm groff
|
||||
のソース。
|
||||
.It "/usr/share/tmac/man.local"
|
||||
.Nm
|
||||
パッケージに対するローカルな変更。
|
||||
.El
|
||||
.Sh 関連項目
|
||||
.Xr apropos 1 ,
|
||||
.Xr groff 1 ,
|
||||
.Xr man 1 ,
|
||||
.Xr nroff 1 ,
|
||||
.Xr troff 1 ,
|
||||
.Xr whatis 1 ,
|
||||
.Xr mdoc 7 ,
|
||||
.Xr mdoc.samples 7
|
||||
.Sh 歴史
|
||||
このマニュアルページは
|
||||
.An Joseph Koshy Aq jkoshy@FreeBSD.org
|
||||
が記述しました。
|
||||
.Sh 訳注
|
||||
この日本語訳マニュアルページにおけるセクションタイトルの英和対応は次の
|
||||
とおりです。
|
||||
.Bl -column "RETURN VALUES" "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" -offset indent
|
||||
.It Em 英文 Ta Em 和訳
|
||||
.It NAME Ta 名称
|
||||
.It SYNOPSIS Ta 書式
|
||||
.It DESCRIPTION Ta 解説
|
||||
.It OPTIONS Ta オプション
|
||||
.It USAGE Ta 使用法
|
||||
.It RETURN VALUES Ta 戻り値
|
||||
.It EXIT STATUS Ta 終了ステータス
|
||||
.It FILES Ta 関連ファイル
|
||||
.It SEE ALSO Ta 関連項目
|
||||
.It DIAGNOSTICS Ta 診断
|
||||
.It BUGS Ta バグ
|
||||
.El
|
||||
.\"ZZZ: 3.0-19990129-SNAP by Norihiro Kumagai
|
||||
|
|
@ -1,430 +0,0 @@
|
|||
.\" Copyright (c) 1991, 1993
|
||||
.\" The Regents of the University of California. All rights reserved.
|
||||
.\"
|
||||
.\" Redistribution and use in source and binary forms, with or without
|
||||
.\" modification, are permitted provided that the following conditions
|
||||
.\" are met:
|
||||
.\" 1. Redistributions of source code must retain the above copyright
|
||||
.\" notice, this list of conditions and the following disclaimer.
|
||||
.\" 2. Redistributions in binary form must reproduce the above copyright
|
||||
.\" notice, this list of conditions and the following disclaimer in the
|
||||
.\" documentation and/or other materials provided with the distribution.
|
||||
.\" 3. All advertising materials mentioning features or use of this software
|
||||
.\" must display the following acknowledgement:
|
||||
.\" This product includes software developed by the University of
|
||||
.\" California, Berkeley and its contributors.
|
||||
.\" 4. Neither the name of the University nor the names of its contributors
|
||||
.\" may be used to endorse or promote products derived from this software
|
||||
.\" without specific prior written permission.
|
||||
.\"
|
||||
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
|
||||
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
||||
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
|
||||
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
||||
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
||||
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||||
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
||||
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
||||
.\" SUCH DAMAGE.
|
||||
.\"
|
||||
.\" @(#)mdoc.7 8.2 (Berkeley) 12/30/93
|
||||
.\" %FreeBSD: src/share/man/man7/mdoc.7,v 1.17.2.3 2000/12/08 14:59:18 ru Exp %
|
||||
.\"
|
||||
.\" jpman %Id: mdoc.7,v 1.5 1999/01/21 18:02:11 kuma Stab %
|
||||
.\"
|
||||
.\" WORD: display ディスプレイ (表示よりも展示に意味が近いと思います)
|
||||
.\" WORD: enclose 囲む、囲み
|
||||
.\" WORD: quote クォート
|
||||
.\" WORD: open (quote) 開き…
|
||||
.\" WORD: close (quote) 閉じ…
|
||||
.\" WORD: content macro コンテントマクロ
|
||||
.\" WORD: parse 解析する
|
||||
.Dd December 30, 1993
|
||||
.Os
|
||||
.Dt MDOC 7
|
||||
.Sh 名称
|
||||
.Nm mdoc
|
||||
.Nd マクロパッケージ
|
||||
.Nm \-mdoc
|
||||
のクイックリファレンスガイド
|
||||
.Sh 書式
|
||||
.Nm groff
|
||||
.Fl m Ns Ar doc
|
||||
.Ar files ...
|
||||
.Sh 解説
|
||||
.Nm \-mdoc
|
||||
パッケージは、
|
||||
.Bx
|
||||
マニュアルページをフォーマットするのに
|
||||
使うコンテントベースおよび領域ベースのマクロのセットです。
|
||||
マクロ名とその意味はクイックリファレンスとして以下に一覧が
|
||||
あります。パッケージを使う上での詳細な説明は、サンプルチュートリアルの
|
||||
.Xr mdoc.samples 7
|
||||
を見て下さい。
|
||||
.Pp
|
||||
マクロは 2 つのグループに分けて述べられています。1 つ目は
|
||||
構造的なページレイアウトマクロと物理的な
|
||||
ページレイアウトマクロです。
|
||||
2 つ目は、
|
||||
マニュアル領域マクロと
|
||||
一般テキスト領域マクロであり、
|
||||
.Nm -\mdoc
|
||||
パッケージを他の
|
||||
.Xr troff
|
||||
フォーマットパッケージとは異なるものとしています。
|
||||
.Sh ページ構造領域
|
||||
.Ss タイトルマクロ
|
||||
正しいマニュアルを生成するために、以下の 3 つのマクロがこの順序で
|
||||
必要になります:
|
||||
.Bl -tag -width "xxxx.Os OPERATINGxSYSTEM [version/release]" -compact
|
||||
.It Li "\&.Dd " Ar "Month day, year"
|
||||
ドキュメントの日付
|
||||
.It Li "\&.Dt " Ar "DOCUMENT_TITLE [section] [volume]"
|
||||
大文字で記述したタイトル
|
||||
.It Li "\&.Os " Ar "OPERATING_SYSTEM [version/release]"
|
||||
オペレーティングシステム
|
||||
.Pq Tn BSD
|
||||
.El
|
||||
.Ss ページレイアウトマクロ
|
||||
セクションヘッダ、段落の区切り、リスト、ディスプレイです。
|
||||
.Bl -tag -width flag -compact
|
||||
.It Li \&.Sh
|
||||
セクションヘッダ。
|
||||
正しいヘッダを、登場する順に示します:
|
||||
.Bl -tag -width "IMPLEMENTATION NOTES" -compact
|
||||
.It Ar NAME
|
||||
名称セクション。
|
||||
.Ql \&.Nm
|
||||
もしくは
|
||||
.Ql \&.Fn
|
||||
と、
|
||||
.Ql \&.Nd
|
||||
マクロを含む必要があります。
|
||||
.It Ar LIBRARY
|
||||
関数が組み込まれるライブラリ。
|
||||
.Ql \&.Lb
|
||||
マクロのみをインクルードすべきです。
|
||||
.It Ar SYNOPSIS
|
||||
使用方法。
|
||||
.It Ar DESCRIPTION
|
||||
一般的な解説。オプションとパラメータを含む必要があります。
|
||||
.It Ar IMPLEMENTATION NOTES
|
||||
実装に固有の情報。
|
||||
.It Ar RETURN VALUES
|
||||
セクション 2, 3 の関数呼び出しが使用します。
|
||||
.It Ar ENVIRONMENT
|
||||
環境変数を記述します。
|
||||
.It Ar FILES
|
||||
その題材に関係があるファイル群。
|
||||
.It Ar EXAMPLES
|
||||
例と助言。
|
||||
.It Ar DIAGNOSTICS
|
||||
普通、セクション 4 のデバイスインタフェースの診断のために使用します。
|
||||
.It Ar COMPATIBILITY
|
||||
既知の互換性に関する事柄を扱います。
|
||||
.It Ar ERRORS
|
||||
セクション 2, 3 で、エラーとシグナルを取り扱います。
|
||||
.It Ar SEE ALSO
|
||||
クロスリファレンスと引用。
|
||||
.It Ar STANDARDS
|
||||
適用できるなら、規格準拠を示します。
|
||||
.It Ar HISTORY
|
||||
規格が適用できない場合、題材の歴史が必要です。
|
||||
.It Ar AUTHORS
|
||||
必要であれば、クレジットをここに書きます。
|
||||
.It Ar BUGS
|
||||
思い違い (gotcha) と警告。
|
||||
.It Ar その他
|
||||
著者の裁量によりカスタマイズしたヘッダを加えてもかまいません。
|
||||
.El
|
||||
.It Li \&.Ss
|
||||
サブセクションヘッダ。
|
||||
.It Li \&.Pp
|
||||
段落区切り。
|
||||
垂直な空白 (1 行) です。
|
||||
.It Li \&.D1
|
||||
(D-one) 1 個分のディスプレイ。
|
||||
インデントして、1 テキスト行をディスプレイします。
|
||||
.It Li \&.Dl
|
||||
(D-ell) 1 個分のリテラルディスプレイ。
|
||||
インデントして、リテラルテキストを 1 行でディスプレイします。
|
||||
.It Li \&.Bd
|
||||
ディスプレイブロックを開始します。
|
||||
表示オプション:
|
||||
.Bl -tag -width "xoffset string " -compact
|
||||
.It Fl ragged
|
||||
揃えない(行末はちぎれた状態)。
|
||||
.It Fl filled
|
||||
揃える。
|
||||
.It Fl literal
|
||||
リテラルテキストやコード。
|
||||
.It Fl file Ar name
|
||||
.Ar file
|
||||
を読み込み、ディスプレイします。
|
||||
.It Fl offset Ar string
|
||||
オフセットディスプレイ。使用可能な
|
||||
.Ar string
|
||||
値:
|
||||
.Bl -tag -width indent-two -compact
|
||||
.It Ar left
|
||||
ブロックの左寄せ (デフォルト)。
|
||||
.It Ar center
|
||||
センタリングするように余白を取ります。
|
||||
.It Ar indent
|
||||
6 つの一定幅の空白 (タブ 1 個)。
|
||||
.It Ar indent-two
|
||||
タブ 2 個。
|
||||
.It Ar right
|
||||
右から 2 インチのところにブロックを左寄せします。
|
||||
.It Ar xx Ns Cm n
|
||||
.Ar xx
|
||||
には、
|
||||
.No \&4 Ns Cm n
|
||||
から
|
||||
.No \&9\&9 Ns Cm n
|
||||
までの数字。
|
||||
.It Ar Aa
|
||||
.Ar Aa
|
||||
は、呼び出し可能なマクロ名。
|
||||
.It Ar string
|
||||
.Ar string
|
||||
の幅が使われます。
|
||||
.El
|
||||
.El
|
||||
.It Li \&.Ed
|
||||
ディスプレイの終り (\&.Bd に対応)。
|
||||
.It Li \&.Bl
|
||||
リストの開始。リストまたは列を作成します。
|
||||
オプション:
|
||||
.Bl -tag -width flag -compact
|
||||
.It Ar リストの型
|
||||
.Bl -column xbullet -compact
|
||||
.It Fl bullet Ta "丸印付きの項目リスト"
|
||||
.It Fl item Ta "ラベル無しのリスト"
|
||||
.It Fl enum Ta "番号付けしたリスト"
|
||||
.It Fl tag Ta "タグラベルのリスト"
|
||||
.It Fl diag Ta "診断リスト"
|
||||
.It Fl hang Ta "ぶら下がりラベルのリスト"
|
||||
.It Fl ohang Ta "突き出したラベルのリスト"
|
||||
.It Fl inset Ta "挿入または追い込みラベルのリスト"
|
||||
.El
|
||||
.It リストのパラメータ
|
||||
.Bl -tag -width "xcompact " -compact
|
||||
.It Fl offset
|
||||
(すべてのリスト)
|
||||
上記の
|
||||
.Ql \&.Bd
|
||||
ディスプレイ開始を参照。
|
||||
.It Fl width
|
||||
.Pf ( Fl tag
|
||||
と
|
||||
.Fl hang
|
||||
リストのみ)
|
||||
.Ql \&.Bd
|
||||
を参照。
|
||||
.It Fl compact
|
||||
(すべてのリスト)
|
||||
空行を作らない。
|
||||
.El
|
||||
.El
|
||||
.It Li \&.El
|
||||
リストの終り。
|
||||
.It Li \&.It
|
||||
リストの項目。
|
||||
.El
|
||||
.Sh マニュアル領域と一般テキスト領域のマクロ
|
||||
マニュアル領域マクロと一般テキスト領域マクロは、
|
||||
そのほとんどが呼び出し可能なマクロに解析されるという点で特別です。例えば:
|
||||
.Bl -tag -width ".Op Fl s Ar filex" -offset indent
|
||||
.It Li "\&.Op Fl s Ar file"
|
||||
は
|
||||
.Op Fl s Ar file
|
||||
を生成します。
|
||||
.El
|
||||
.Pp
|
||||
この例では、オプション囲みマクロ
|
||||
.Ql \&.Op
|
||||
が解析されると、引数
|
||||
.Ql s
|
||||
を操作する
|
||||
呼び出し可能なコンテントマクロ
|
||||
.Ql \&Fl
|
||||
を呼び出してから、引数
|
||||
.Ql file
|
||||
を操作する
|
||||
呼び出し可能なコンテントマクロ
|
||||
.Ql \&Ar
|
||||
を呼びます。
|
||||
呼び出し可能ではあるものの解析はされないマクロがありますし、
|
||||
その逆もあります。
|
||||
これらのマクロを、後述の
|
||||
.Em 解析対象 (parsed)
|
||||
と
|
||||
.Em 呼出可 (callable)
|
||||
の列に示します。
|
||||
.Pp
|
||||
言及していなければ、マニュアル領域マクロは、次の共通の構文をとります:
|
||||
.Pp
|
||||
.Dl \&.Va argument [\ .\ ,\ ;\ :\ (\ )\ [\ ]\ argument \...\ ]
|
||||
.Pp
|
||||
.Sy 注意 :
|
||||
開く句読点文字と閉じる句読点文字
|
||||
(訳注: 句読点文字には括弧なども含みます)
|
||||
がそのように認識されるのは、
|
||||
ひとつずつ登場する場合だけです。
|
||||
文字列
|
||||
.Ql "),"
|
||||
は、句読点とは認識されず、
|
||||
先行する空白文字とともに呼び出しマクロが使用しているフォントで出力されます。
|
||||
引数リスト
|
||||
.Ql "] ) ,"
|
||||
は 3 つの連続した閉じる句読点と認識され、
|
||||
文字間および (存在する場合には) 先行する引数との間には、
|
||||
先行する空白文字は出力されません。
|
||||
句読点文字の特別の意味は、文字列
|
||||
.Ql \e&
|
||||
によりエスケープされます。
|
||||
例えば、次の文字列
|
||||
.Bl -tag -width "&.Ar file1\ , file2\ , file3\ )\ ." -offset indent
|
||||
.It Li "\&.Ar file1\ , file2\ , file3\ )\ ."
|
||||
は
|
||||
.Ar file1 , file2 , file3 ) .
|
||||
を生成します。
|
||||
.El
|
||||
.Ss マニュアル領域のマクロ
|
||||
.Bl -column "名称" "解析対象" "呼出可" -compact
|
||||
.It Em 名称 解析対象 呼出可 解説
|
||||
.It Li \&Ad Ta Yes Ta Yes Ta "アドレス (このマクロは使用しないように言われています)。"
|
||||
.It Li \&An Ta Yes Ta Yes Ta "著者名。"
|
||||
.It Li \&Ar Ta Yes Ta Yes Ta "コマンドラインの引数。"
|
||||
.It Li \&Cd Ta \&No Ta \&No Ta "コンフィギュレーション宣言 (セクション 4 のみ)。"
|
||||
.It Li \&Cm Ta Yes Ta Yes Ta "コマンドライン引数修飾子。"
|
||||
.It Li \&Dv Ta Yes Ta Yes Ta "定義された変数 (ソースコード)。"
|
||||
.It Li \&Er Ta Yes Ta Yes Ta "エラー番号 (ソースコード)。"
|
||||
.It Li \&Ev Ta Yes Ta Yes Ta "環境変数。"
|
||||
.It Li \&Fa Ta Yes Ta Yes Ta "関数の引数。"
|
||||
.It Li \&Fd Ta Yes Ta Yes Ta "関数の定義。"
|
||||
.It Li \&Fn Ta Yes Ta Yes Ta "関数呼び出し (.Fo や .Fc も同様)。"
|
||||
.It Li \&Ic Ta Yes Ta Yes Ta "対話的なコマンド。"
|
||||
.It Li \&Lb Ta \&No Ta \&No Ta "ライブラリ名。既知のライブラリ一覧は"
|
||||
.Xr mdoc.samples 7
|
||||
の
|
||||
.Sx ライブラリ名
|
||||
の節を参照。
|
||||
.It Li \&Li Ta Yes Ta Yes Ta "リテラルテキスト。"
|
||||
.It Li \&Nm Ta Yes Ta Yes Ta "コマンド名。"
|
||||
.It Li \&Op Ta Yes Ta Yes Ta "オプション (.Oo や .Oc も同様)。"
|
||||
.It Li \&Ot Ta Yes Ta Yes Ta "古いスタイルの関数型 (Fortran のみ)。"
|
||||
.It Li \&Pa Ta Yes Ta Yes Ta "パス名やファイル名。"
|
||||
.It Li \&St Ta Yes Ta Yes Ta "規格。既知の規格の完全なリストに関しては、"
|
||||
.Xr mdoc.samples 7
|
||||
の
|
||||
.Sx 規格
|
||||
の節を参照。
|
||||
.It Li \&St Ta Yes Ta Yes Ta "規格 (-p1003.2 や -p1003.1 や -ansiC)。"
|
||||
.It Li \&Ta Ta Yes Ta Yes Ta "次のタブコラムへのタブ揃え。"
|
||||
.It Li \&Va Ta Yes Ta Yes Ta "変数名。"
|
||||
.It Li \&Vt Ta Yes Ta Yes Ta "変数の型 (Fortran のみ)。"
|
||||
.It Li \&Xr Ta Yes Ta Yes Ta "マニュアルのクロスリファレンス。"
|
||||
.El
|
||||
.Ss 一般テキスト領域のマクロ
|
||||
.Bl -column "名称" "解析対象" "呼出可" -compact
|
||||
.It Em "名称 解析対象 呼出可 解説"
|
||||
.It Li \&%A Ta Yes Ta \&No Ta "参照の著者。"
|
||||
.It Li \&%B Ta Yes Ta Yes Ta "参照の図書タイトル。"
|
||||
.It Li \&%\&C Ta \&No Ta \&No Ta "参照の発行場所(市)。"
|
||||
.It Li \&%\&D Ta \&No Ta \&No Ta "参照の日付。"
|
||||
.It Li \&%J Ta Yes Ta Yes Ta "参照の雑誌タイトル。"
|
||||
.It Li \&%N Ta \&No Ta \&No Ta "参照の刊行番号。"
|
||||
.It Li \&%\&O Ta \&No Ta \&No Ta "参照の追加的な情報。"
|
||||
.It Li \&%P Ta \&No Ta \&No Ta "参照のページ番号。"
|
||||
.It Li \&%R Ta \&No Ta \&No Ta "参照のレポート名。"
|
||||
.It Li \&%T Ta Yes Ta Yes Ta "参照の記事タイトル。"
|
||||
.It Li \&%V Ta \&No Ta \&No Ta "参照の巻名。"
|
||||
.It Li \&Ac Ta Yes Ta Yes Ta "カギ括弧(angle)閉じクォート。"
|
||||
.It Li \&Ao Ta Yes Ta Yes Ta "カギ括弧(angle)開きクォート。"
|
||||
.It Li \&Ap Ta Yes Ta Yes Ta "アポストロフィ。"
|
||||
.It Li \&Aq Ta Yes Ta Yes Ta "カギ括弧(angle)クォート。"
|
||||
.It Li \&At Ta \&No Ta \&No Ta Tn "AT&T UNIX。"
|
||||
.It Li \&Bc Ta Yes Ta Yes Ta "角括弧(bracket)閉じクォート。"
|
||||
.It Li \&Bf Ta \&No Ta \&No Ta "フォントモード始点。"
|
||||
.It Li \&Bo Ta Yes Ta Yes Ta "角括弧(bracket)開きクォート。"
|
||||
.It Li \&Bq Ta Yes Ta Yes Ta "角括弧(bracket)クォート。"
|
||||
.It Li \&Bx Ta Yes Ta Yes Ta "BSD UNIX。"
|
||||
.It Li \&Db Ta \&No Ta \&No Ta "デバッグ (デフォルトは \\*qoff\\*q)。"
|
||||
.It Li \&Dc Ta Yes Ta Yes Ta "ダブル(double)閉じクォート。"
|
||||
.It Li \&Do Ta Yes Ta Yes Ta "ダブル(double)開きクオート。"
|
||||
.It Li \&Dq Ta Yes Ta Yes Ta "ダブル(double)クォート。"
|
||||
.It Li \&Ec Ta Yes Ta Yes Ta "文字列で囲む閉じクォート。"
|
||||
.It Li \&Ef Ta \&No Ta \&No Ta "フォントモード終了。"
|
||||
.It Li \&Em Ta Yes Ta Yes Ta "強調 (古風な英語)。"
|
||||
.It Li \&Eo Ta Yes Ta Yes Ta "文字列で囲む開きクォート。"
|
||||
.It Li \&Fx Ta Yes Ta Yes Ta Tn "FreeBSD オペレーティングシステム。"
|
||||
.It Li \&No Ta Yes Ta Yes Ta "通常のテキスト (no-op)。"
|
||||
.It Li \&Ns Ta Yes Ta Yes Ta "空白なし。"
|
||||
.It Li \&Nx Ta Yes Ta Yes Ta Tn "NetBSD オペレーティングシステム。"
|
||||
.It Li \&Pc Ta Yes Ta Yes Ta "丸括弧(parenthesis)閉じクォート。"
|
||||
.It Li \&Pf Ta Yes Ta \&No Ta "接頭文字列。"
|
||||
.It Li \&Po Ta Yes Ta Yes Ta "丸括弧(parenthesis)開きクォート。"
|
||||
.It Li \&Pq Ta Yes Ta Yes Ta "丸括弧クォート。"
|
||||
.It Li \&Qc Ta Yes Ta Yes Ta "まっすぐなダブル(double)閉じクォート。"
|
||||
.It Li \&Ql Ta Yes Ta Yes Ta "クォートされたリテラル。"
|
||||
.It Li \&Qo Ta Yes Ta Yes Ta "まっすぐなダブル(double)開きクォート。"
|
||||
.It Li \&Ox Ta Yes Ta Yes Ta Tn "OpenBSD オペレーティングシステム。"
|
||||
.It Li \&Qq Ta Yes Ta Yes Ta "まっすぐなダブル(double)クォート。"
|
||||
.It Li \&Re Ta \&No Ta \&No Ta "参照終了。"
|
||||
.It Li \&Rs Ta \&No Ta \&No Ta "参照開始。"
|
||||
.It Li \&Rv Ta \&No Ta \&No Ta "戻り値 (セクション 2 と 3 のみ)。"
|
||||
.It Li \&Sc Ta Yes Ta Yes Ta "(single)閉じクォート。"
|
||||
.It Li \&So Ta Yes Ta Yes Ta "(single)開きクォート。"
|
||||
.It Li \&Sq Ta Yes Ta Yes Ta "(single)クォート。"
|
||||
.It Li \&Sm Ta \&No Ta \&No Ta "空白モード(デフォルトは \\*qon\\*q)。"
|
||||
.It Li \&Sx Ta Yes Ta Yes Ta "セクションクロスリファレンス。"
|
||||
.It Li \&Sy Ta Yes Ta Yes Ta "シンボリック (古風な英語)。"
|
||||
.It Li \&Tn Ta Yes Ta Yes Ta "商標またはタイプ名 (小さい大文字)。"
|
||||
.It Li \&Ux Ta Yes Ta Yes Ta "UNIX。"
|
||||
.It Li \&Xc Ta Yes Ta Yes Ta "拡張引数リスト終了。"
|
||||
.It Li \&Xo Ta Yes Ta Yes Ta "拡張引数リスト開始。"
|
||||
.El
|
||||
.\" .It Sy \&Hf Ta \&No Ta \&No Ta "Include file with header"
|
||||
.Pp
|
||||
.Ql q
|
||||
で終わるマクロ名は、引数リストの残りの項目をクォートします。
|
||||
.Ql o
|
||||
で終わるマクロ名はクォートの開始であり、複数行の入力に渡ります。
|
||||
.Ql c
|
||||
で終わる対応するマクロ名は、このクォートを閉じます。
|
||||
囲みマクロは入れ子になっても良く、引数は 8 個に制限されます。
|
||||
.Pp
|
||||
注意: 拡張引数リストマクロ
|
||||
.Pf ( Ql \&.Xo ,
|
||||
.Ql \&.Xc )
|
||||
と関数囲みマクロ
|
||||
.Pf ( Ql \&.Fo ,
|
||||
.Ql \&.Fc )
|
||||
は、変則です。
|
||||
拡張リストマクロは、マクロ引数が
|
||||
.Xr troff
|
||||
の制限である 9 個を越える場合に使われます。
|
||||
.Sh 関連ファイル
|
||||
.Bl -tag -width "tmac.doc-ditroff" -compact
|
||||
.It Pa tmac.doc
|
||||
マニュアル領域と一般テキスト領域のマクロ。
|
||||
.It Pa doc-common
|
||||
共通構造マクロと定義。
|
||||
.It Pa doc-nroff
|
||||
サイト依存の
|
||||
.Xr nroff
|
||||
スタイルファイル。
|
||||
.It Pa doc-ditroff
|
||||
サイト依存の
|
||||
.Xr troff
|
||||
スタイルファイル。
|
||||
.It Pa doc-syms
|
||||
(標準マクロのような) 特殊定義。
|
||||
.El
|
||||
.Sh 関連項目
|
||||
.Xr mdoc.samples 7
|
||||
.\"ZZZ: 3.0-RELEASE compliant by N. Kumagai 99-1.21
|
||||
File diff suppressed because it is too large
Load diff
Loading…
Reference in a new issue