release/man7/mdoc.7

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