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