release/man7/mdoc.7

   1 .\" Copyright (c) 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)mdoc.7      8.2 (Berkeley) 12/30/93
  33 .\"     $Id: mdoc.7,v 1.8 1998/12/04 00:51:17 jkoshy Exp $
  34 .\"
  35 .\" The December 30, 1993 version
  36 .\" Modified by David A. Wheeler (dwheeler@ida.org) on 1999-07-11
  37 .\" to conform to Linux.
  38 .\"
  39 .\"
  40 .\"*******************************************************************
  41 .\"
  42 .\" This file was generated with po4a. Translate the source file.
  43 .\"
  44 .\"*******************************************************************
  45 .Dd July 11, 1999
  46 .Dt MDOC 7
  47 .Os Linux
  48 .Sh 名前
  49 .Nm mdoc
  50 .Nd Macro Package
  51 .Nm \-mdoc
  52 のクイックリファレンスガイド
  53 .Sh 書式
  54 .Nm groff
  55 .Fl m Ns Ar doc
  56 .Ar files ...
  57 .Sh 説明
  58 .Nm \-mdoc
  59 パッケージは
  60 .Bx
  61 man ページに用いられる内容ベース・ドメインベースのマクロである。
  62 以下ではクイックリファレンスとしてマクロの名前とその意味をリストする。 このパッケージの利用法に関する詳細な説明は、 チュートリアル用の見本である
  63 .Xr mdoc.samples 7
  64 を参照すること。
  65 .Pp
  66 これは Linux の文書で通常用いられているマクロパッケージとは異なる。 しかし広く用いられているいくつかのプログラムの文書で、
  67 このマクロが利用されている。
  68 .Xr man 7
  69 を見よ。
  70 .Pp
  71 マクロは 2 つのグループに分けて説明する。 最初のグループは構造や物理的なページレイアウトに関するマクロである。 2 つめはマニュアルドメインマクロ
  72 (manual domain macro)  や一般テキストドメインマクロ (general text domain macro)  で、
  73 .Nm \-mdoc
  74 パッケージを他の
  75 .Xr troff
  76 フォーマットパッケージと差別化しているものである。
  77 .Sh ページ構造のドメイン
  78 .Ss タイトルマクロ
  79 正しいマニュアルページを生成するためには、これらの 3 つのマクロを この順番で書く必要がある。
  80 .Bl -tag -width "xxxx.Os OPERATINGxSYSTEM [version/release]" -compact
  81 .It Li "\&.Dd  " Ar "Month day, year"
  82 文書の日付。
  83 .It Li "\&.Dt  " Ar "DOCUMENT_TITLE [section] [volume]"
  84 タイトルを大文字で。
  85 .It Li "\&.Os  " Ar "OPERATING_SYSTEM [version/release]"
  86 オペレーティングシステム
  87 .Pq Tn BSD .
  88 .El
  89 .Ss ページレイアウトマクロ
  90 セクションヘッダ、段落の終わり、リスト、表示など。
  91 .Bl -tag -width flag -compact
  92 .It Li \&.Sh
  93 セクションのヘッダ。 正しいヘッダは、現れる順に:
  94 .Bl -tag -width "RETURN VALUE" -compact
  95 .It Ar NAME
  96 名前のセクション。
  97 .Ql \&.Nm
  98 ,
  99 .Ql \&.Fn
 100 ,
 101 .Ql \&.Nd
 102 などのマクロを含む。
 103 .It Ar SYNOPSIS
 104 利用法。
 105 .It Ar DESCRIPTION
 106 一般的な説明。オプションやパラメータの説明も含む。
 107 .It Ar RETURN VALUE
 108 セクション 2 や 3 の関数コール。
 109 .It Ar ENVIRONMENT
 110 環境変数を説明する。
 111 .It Ar FILES
 112 内容に関係するファイル。
 113 .It Ar EXAMPLES
 114 例やおすすめ。
 115 .It Ar DIAGNOSTICS
 116 通常セクション 4 のデバイスインターフェースの診断用。
 117 .It Ar ERRORS
 118 セクション 2 や 3 のエラーやシグナル処理。
 119 .It Ar SEE ALSO
 120 相互参照や引用。
 121 .It Ar CONFORMING TO
 122 可能なら標準への準拠。
 123 .It Ar HISTORY
 124 標準が適用されていない場合は、 歴史的な内容を与えるべきである。
 125 .It Ar BUGS
 126 瑕疵や警告。
 127 .It Ar other
 128 筆者の判断でヘッダをあつらえてもよい。
 129 .El
 130 .It Li \&.Ss
 131 サブセクションのヘッダ。
 132 .It Li \&.Pp
 133 段落の区切り。 垂直スペース (一行)。
 134 .It Li \&.D1
 135 (D-one) Display-one インデントしてテキストを一行表示。
 136 .It Li \&.Dl
 137 (D-ell) Displey-one literal。 インデントしてリテラルなテキストを一行表示。
 138 .It Li \&.Bd
 139 表示ブロックの開始。 表示オプション:
 140 .Bl -tag -width "xoffset string " -compact
 141 .It Fl ragged
 142 揃えない (両端は不揃い)。
 143 .It Fl filled
 144 揃える。
 145 .It Fl literal
 146 リテラルなテキストまたはコード。
 147 .It Fl file Ar name
 148 指定された
 149 .Ar file
 150 を読んで表示する。
 151 .It Fl offset Ar string
 152 オフセット表示。 受付ける
 153 .Ar string
 154 の値は:
 155 .Bl -tag -width indent-two -compact
 156 .It Ar left
 157 ブロックを左に揃える (デフォルト)。
 158 .It Ar center
 159 大まかなセンターマージン。
 160 .It Ar indent
 161 定数幅の空白 6 つ (タブ 1 つ)。
 162 .It Ar indent-two
 163 タブ 2 つ。
 164 .It Ar right
 165 揃えブロックを右から 2 インチの位置に残す。
 166 .It Ar xx Ns Cm n
 167 .Ar xx
 168 は
 169 .No \&4 Ns Cm n
 170 から
 171 .No \&9\&9 Ns Cm n
 172 までの数字。
 173 .It Ar Aa
 174 .Ar Aa
 175 は呼びだし可能なマクロの名前。
 176 .It Ar string
 177 .Ar string
 178 の幅が用いられる。
 179 .El
 180 .El
 181 .It Li \&.Ed
 182 表示終了 (\&.Bd にマッチする)。
 183 .It Li \&.Bl
 184 リスト開始。 リストまたはコラムを生成する。オプションは以下:
 185 .Bl -tag -width flag -compact
 186 .It Ar リスト形式
 187 .Bl -column xbullet -compact
 188 .It Fl bullet Ta 中黒のアイテムリスト
 189 .It Fl item Ta ラベルなしリスト
 190 .It Fl enum Ta 数値付きリスト
 191 .It Fl tag Ta タグラベル付きリスト
 192 .It Fl diag Ta "診断リスト (diagnostic list)"
 193 .It Fl hang Ta ぶらさがりラベルリスト
 194 .It Fl ohang Ta 飛び出しラベルリスト
 195 .It Fl inset Ta ラベル付きリストの挿入・継続
 196 .El
 197 .It リストパラメータ
 198 .Bl -tag -width "xcompact " -compact
 199 .It Fl offset
 200 (全てのリスト) 上記の
 201 .Ql \&.Bd
 202 ディスプレイ開始 (begin-display) を見よ。
 203 .It Fl width
 204 .Pf ( Fl tag
 205 および
 206 .Fl hang
 207 リストのみ)
 208 .Ql \&.Bd .
 209 を見よ。
 210 .It Fl compact
 211 (全てのリスト)  空行を抑制する。
 212 .El
 213 .El
 214 .It Li \&.El
 215 リストの終わり。
 216 .It Li \&.It
 217 リスト項目。
 218 .El
 219 .Sh マニュアルドメインマクロと一般テキストドメインマクロ
 220 マニュアルドメインマクロと一般テキストドメインマクロとが 他と異なっているのは、 呼びだし可能マクロ (callable macro) の内部では、
 221 そのほとんどがパーズされるという点である。 例えば以下のように変換される:
 222 .Bl -tag -width ".Op Fl s Ar filex" -offset indent
 223 .It Li "\&.Op Fl s Ar file"
 224 →
 225 .Op Fl s Ar file
 226 .El
 227 .Pp
 228 この例では、囲みマクロ
 229 .Ql \&.Op
 230 に与えられたオプションがパーズされ、 中身の呼びだし可能なマクロである
 231 .Ql \&Fl
 232 が呼ばれ、引数である
 233 .Ql s
 234 に対して作用する。そして次に中身の呼びだし可能なマクロ
 235 .Ql \&Ar
 236 が呼ばれ、引数である
 237 .Ql file
 238 に作用する。呼びだし可能であるがパースされないマクロや、 その逆のマクロも存在する。このようなマクロは以下の
 239 .Em parsed
 240 カラムや
 241 .Em callable
 242 カラムで示す。
 243 .Pp
 244 特に記述がなければ、マニュアルドメインマクロは共通の書式をとる:
 245 .Pp
 246 .Dl \&.Va argument [\ .\ ,\ ;\ :\ (\ )\ [\ ]\ argument ...\ ]
 247 .Pp
 248 .Sy 注意 :
 249 句読文字 (punctuation character) の開き・閉じは、
 250 それらが一度に単一の文字で現れた場合のみそのように解釈される。 文字列
 251 .Ql "),"
 252 は、句読区切りとはみなされず、その前に空白文字があれば
 253 その文字とともに、また呼び出したマクロが用いるフォントで出力される。 引数リスト
 254 .Ql "] ) ,"
 255 は 3
 256 つの連続した閉じ句読文字と解釈され、 それぞれの前にある空白文字は、各文字や (もしあれば) その前にある 引数との間には出力されない。
 257 特殊な意味を持つ句読文字は、文字列
 258 .Ql \e&
 259 によってエスケープできる。 例えば以下の左の文字列は右のように変換される。
 260 .Bl -tag -width "&.Ar file1\ , file2\ , file3\ )\ ." -offset indent
 261 .It Li "\&.Ar file1\ , file2\ , file3\ )\ ."
 262 →
 263 .Ar file1 , file2 , file3 ) .
 264 .El
 265 .ne 1i
 266 .Ss マニュアルドメインマクロ
 267 .Bl -column Name Parsed Callable\(dq -compact
 268 .It Em "名前  Parsed  Callable        説明"
 269 .It Li \&Ad Ta Yes Ta Yes Ta "アドレス (このマクロは使わない方が良い)"
 270 .It Li \&An Ta Yes Ta Yes Ta 著者の名前
 271 .It Li \&Ar Ta Yes Ta Yes Ta コマンドライン引数
 272 .It Li \&Cd Ta \&No Ta \&No Ta "設定の宣言 (セクション 4 のみ)"
 273 .It Li \&Cm Ta Yes Ta Yes Ta コマンドライン引数の修正子
 274 .It Li \&Dv Ta Yes Ta Yes Ta "定義済み変数 (ソースコード)"
 275 .It Li \&Er Ta Yes Ta Yes Ta "エラー番号 (ソースコード)"
 276 .It Li \&Ev Ta Yes Ta Yes Ta 環境変数
 277 .It Li \&Fa Ta Yes Ta Yes Ta 関数の引き数
 278 .It Li \&Fd Ta Yes Ta Yes Ta 関数の宣言
 279 .It Li \&Fn Ta Yes Ta Yes Ta "関数呼びだし (.Fo と .Fc も)"
 280 .It Li \&Ic Ta Yes Ta Yes Ta インタラクティブなコマンド
 281 .It Li \&Li Ta Yes Ta Yes Ta リテラルなテキスト
 282 .It Li \&Nm Ta Yes Ta Yes Ta コマンドの名前
 283 .It Li \&Op Ta Yes Ta Yes Ta "オプション (.Oo と .Oc も)"
 284 .It Li \&Ot Ta Yes Ta Yes Ta "古い形式の関数型 (Fortran のみ)."
 285 .It Li \&Pa Ta Yes Ta Yes Ta パス名またはファイル名
 286 .It Li \&St Ta Yes Ta Yes Ta "標準 (\-p1003.2, \-p1003.1, \-ansiC のどれか)"
 287 .It Li \&Va Ta Yes Ta Yes Ta 変数の名前
 288 .It Li \&Vt Ta Yes Ta Yes Ta "変数の型 (Fortran のみ)"
 289 .It Li \&Xr Ta Yes Ta Yes Ta マニュアルページの相互参照
 290 .El
 291 .Ss 一般テキストドメインマクロ
 292 .Bl -column Name Parsed Callable\(dq -compact
 293 .It Em "名前  Parsed  Callable        説明"
 294 .It Li \&%A Ta Yes Ta \&No Ta 参考文献の著者
 295 .It Li \&%B Ta Yes Ta Yes Ta 参考文献の書籍タイトル
 296 .It Li \&%\&C Ta \&No Ta \&No Ta "参考文献の出版地 (街)"
 297 .It Li \&%\&D Ta \&No Ta \&No Ta 参考文献の日付
 298 .It Li \&%J Ta Yes Ta Yes Ta 参考文献の雑誌名
 299 .It Li \&%N Ta \&No Ta \&No Ta 参考文献の号数
 300 .It Li \&%\&O Ta \&No Ta \&No Ta 参考文献の補助情報
 301 .It Li \&%P Ta \&No Ta \&No Ta 参考文献のページ
 302 .It Li \&%R Ta \&No Ta \&No Ta 参考文献のリポート名
 303 .It Li \&%T Ta Yes Ta Yes Ta 参考文献の記事タイトル
 304 .It Li \&%V Ta \&No Ta \&No Ta 参考文献の巻数
 305 .It Li \&Ac Ta Yes Ta Yes Ta アングルクォートの閉じ
 306 .It Li \&Ao Ta Yes Ta Yes Ta アングルクォートの開き
 307 .It Li \&Ap Ta Yes Ta Yes Ta アポストロフィ
 308 .It Li \&Aq Ta Yes Ta Yes Ta アングルクォート
 309 .It Li \&At Ta \&No Ta \&No Ta Tn "AT&T UNIX"
 310 .It Li \&Bc Ta Yes Ta Yes Ta ブラケットクォートの閉じ
 311 .It Li \&Bf Ta \&No Ta \&No Ta フォントモードの開始
 312 .It Li \&Bo Ta Yes Ta Yes Ta ブラケットクォートの開き
 313 .It Li \&Bq Ta Yes Ta Yes Ta ブラケットクォート
 314 .It Li \&Bx Ta Yes Ta Yes Ta Bx .
 315 .It Li \&Db Ta \&No Ta \&No Ta "デバッグ (デフォルトは \*qoff\*q)"
 316 .It Li \&Dc Ta Yes Ta Yes Ta ダブルクォートの閉じ
 317 .It Li \&Do Ta Yes Ta Yes Ta ダブルクォートの開き
 318 .It Li \&Dq Ta Yes Ta Yes Ta ダブルクォート
 319 .It Li \&Ec Ta Yes Ta Yes Ta エンクローズ文字列引用の閉じ
 320 .It Li \&Ef Ta \&No Ta \&No Ta フォントモードの終了
 321 .It Li \&Em Ta Yes Ta Yes Ta "強調 (traditional English)."
 322 .It Li \&Eo Ta Yes Ta Yes Ta エンクローズ文字列引用の開き
 323 .It Li \&Fx Ta \&No Ta \&No Ta Tn "FreeBSD operating system"
 324 .It Li \&No Ta Yes Ta Yes Ta "通常のテキスト (効果なし)"
 325 .It Li \&Ns Ta Yes Ta Yes Ta スペース無し
 326 .It Li \&Pc Ta Yes Ta Yes Ta 括弧クォートの閉じ
 327 .It Li \&Pf Ta Yes Ta \&No Ta 前置文字
 328 .It Li \&Po Ta Yes Ta Yes Ta 括弧クォートの開き
 329 .It Li \&Pq Ta Yes Ta Yes Ta 括弧クォート
 330 .It Li \&Qc Ta Yes Ta Yes Ta ダブルストレートクォートの閉じ
 331 .It Li \&Ql Ta Yes Ta Yes Ta クォートされたリテラル
 332 .It Li \&Qo Ta Yes Ta Yes Ta ダブルストレートクォートの閉じ
 333 .It Li \&Qq Ta Yes Ta Yes Ta ダブルストレートクォートの閉じ
 334 .It Li \&Re Ta \&No Ta \&No Ta 参考文献の終了
 335 .It Li \&Rs Ta \&No Ta \&No Ta 参考文献の開始
 336 .It Li \&Rv Ta \&No Ta \&No Ta "返り値 (セクション 2, 3 のみ)"
 337 .It Li \&Sc Ta Yes Ta Yes Ta シングルクォートの閉じ
 338 .It Li \&So Ta Yes Ta Yes Ta シングルクォートの開き
 339 .It Li \&Sq Ta Yes Ta Yes Ta シングルクォート
 340 .It Li \&Sm Ta \&No Ta \&No Ta "スペースモード (デフォルトは \*qon\*q)"
 341 .It Li \&Sx Ta Yes Ta Yes Ta セクションの相互参照
 342 .It Li \&Sy Ta Yes Ta Yes Ta "シンボリック (traditional English)."
 343 .It Li \&Tn Ta Yes Ta Yes Ta "Trade または型名 (small Caps)."
 344 .It Li \&Ux Ta Yes Ta Yes Ta Ux
 345 .It Li \&Xc Ta Yes Ta Yes Ta 拡張引数リストの閉じ
 346 .It Li \&Xo Ta Yes Ta Yes Ta 拡張引数リストの開き
 347 .El
 348 .\" .It Sy \&Hf Ta \&No Ta \&No Ta "Include file with header"
 349 .Pp
 350 .Ql q
 351 で終わる名前のマクロは、引数リストの残りの項目をクォートする。
 352 .Ql o
 353 で終わる名前のマクロは一行以上にわたる入力のクォートを開始し、 これは対応する名前の
 354 .Ql c
 355 でおわる名前のマクロで終了する。
 356 囲みマクロはネストでき、引数は 8 つまで取れる。
 357 .Pp
 358 注意: 拡張引数リストマクロ
 359 .Pf ( Ql \&.Xo ,
 360 .Ql \&.Xc )
 361 および関数の囲みマクロ
 362 .Pf ( Ql \&.Fo ,
 363 .Ql \&.Fc )
 364 は変則である。 拡張リストマクロはマクロの引数が
 365 .Xr troff
 366 の制限である 9
 367 個を越えるときに用いられる。
 368 .Pp
 369 .\" The following does not apply on Linux:
 370 .\" .Sh CONFIGURATION
 371 .\" For site specific configuration of the macro package,
 372 .\" see the file
 373 .\" .Pa /usr/src/share/tmac/README .
 374 UR マクロ (URI/URL ハイパーテキスト参照の開始), UE マクロ (終了), UN マクロ (参照用ターゲットの指定) も利用できる。
 375 これらのマクロに関するより詳しい情報は
 376 .Xr man 7
 377 を見よ。
 378 .Sh ファイル
 379 .Bl -tag -width tmac.doc-ditroff -compact
 380 .It Pa doc.tmac
 381 マニュアルドメインマクロと一般テキストドメインマクロ。
 382 .It Pa tmac/doc-common
 383 共通の構造マクロと定義。
 384 .It Pa tmac/doc-nroff
 385 サイト依存の
 386 .Xr nroff
 387 スタイルファイル。
 388 .It Pa tmac/doc-ditroff
 389 サイト依存の
 390 .Xr troff
 391 スタイルファイル。
 392 .It Pa tmac/doc-syms
 393 特殊定義 (標準マクロなど)。
 394 .El
 395 .Sh "関連項目"
 396 .Xr groff_mdoc 7 ,
 397 .Xr mdoc.samples 7 ,
 398 .Xr man 7 ,
 399 .Xr man-pages 7