Manpages

名 前

mdoc — Macro Package −mdoc の ク イ ッ ク リ フ ァ レ ン ス ガ イ ド 書 式
groff −mdoc files ... 説 明
−mdoc パ ッ ケ ー ジ は BSD man ペ ー ジ に 用 い ら れ る 内 容 ベ ー ス ・ ド メ イ ン ベ ー ス の マ ク ロ で あ る 。 以 下 で は ク イ ッ ク リ フ ァ レ ン ス と し て マ ク ロ の 名 前 と そ の 意 味 を リ ス ト す る 。 こ の パ ッ ケ ー ジ の 利 用 法 に 関 す る 詳 細 な 説 明 は 、 チ ュ ー ト リ ア ル 用 の 見 本 で あ る mdoc.samples(7) を 参 照 す る こ と 。 こ れ は Linux の 文 書 で 通 常 用 い ら れ て い る マ ク ロ パ ッ ケ ー ジ と は 異 な る 。 し か し 広 く 用 い ら れ て い る い く つ か の プ ロ グ ラ ム の 文 書 で 、 こ の マ ク ロ が 利 用 さ れ て い る 。 man(7) を 見 よ 。 マ ク ロ は 2 つ の グ ル ー プ に 分 け て 説 明 す る 。 最 初 の グ ル ー プ は 構 造 や 物 理 的 な ペ ー ジ レ イ ア ウ ト に 関 す る マ ク ロ で あ る 。 2 つ め は マ ニ ュ ア ル ド メ イ ン マ ク ロ (manual domain macro) や 一 般 テ キ ス ト ド メ イ ン マ ク ロ (general text domain macro) で 、 −mdoc パ ッ ケ ー ジ を 他 の troff フ ォ ー マ ッ ト パ ッ ケ ー ジ と 差 別 化 し て い る も の で あ る 。 ペ ー ジ 構 造 の ド メ イ ン タ イ ト ル マ ク ロ 正 し い マ ニ ュ ア ル ペ ー ジ を 生 成 す る た め に は 、 こ れ ら の 3 つ の マ ク ロ を こ の 順 番 で 書 く 必 要 が あ る 。

.Dd Month day, year 文 書 の 日 付 。
.Dt DOCUMENT_TITLE [section] [volume] タ イ ト ル を 大 文 字 で 。
.Os OPERATING_SYSTEM [version/release] オ ペ レ ー テ ィ ン グ シ ス テ ム (BSD). ペ ー ジ レ イ ア ウ ト マ ク ロ セ ク シ ョ ン ヘ ッ ダ ー 、 段 落 の 終 わ り 、 リ ス ト 、 表 示 な ど 。
.Sh セ ク シ ョ ン の ヘ ッ ダ ー 。 正 し い ヘ ッ ダ ー は 、 現 れ る 順 に :
NAME 名 前 の セ ク シ ョ ン 。 ’.Nm’ , ’.Fn’ , ’.Nd’ な ど の マ ク ロ を 含 む 。
SYNOPSIS 利 用 法 。
DESCRIPTION 一 般 的 な 説 明 。 オ プ シ ョ ン や パ ラ メ ー タ ー の 説 明 も 含 む 。
RETURN VALUE セ ク シ ョ ン 2 や 3 の 関 数 コ ー ル 。
ENVIRONMENT 環 境 変 数 を 説 明 す る 。
FILES 内 容 に 関 係 す る フ ァ イ ル 。
EXAMPLES 例 や お す す め 。
DIAGNOSTICS 通 常 セ ク シ ョ ン 4 の デ バ イ ス イ ン タ ー フ ェ ー ス の 診 断 用 。
ERRORS セ ク シ ョ ン 2 や 3 の エ ラ ー や シ グ ナ ル 処 理 。
SEE ALSO 相 互 参 照 や 引 用 。
CONFORMING TO 可 能 な ら 標 準 へ の 準 拠 。
HISTORY 標 準 が 適 用 さ れ て い な い 場 合 は 、 歴 史 的 な 内 容 を 与 え る べ き で あ る 。
BUGS 瑕 疵 や 警 告 。
other 筆 者 の 判 断 で ヘ ッ ダ ー を あ つ ら え て も よ い 。
.Ss サ ブ セ ク シ ョ ン の ヘ ッ ダ ー 。
.Pp 段 落 の 区 切 り 。 垂 直 ス ペ ー ス (一 行 )。
.D1

(D-one) Display-one イ ン デ ン ト し て テ キ ス ト を 一 行 表 示 。

.Dl

(D-ell) Displey-one literal。 イ ン デ ン ト し て リ テ ラ ル な テ キ ス ト を 一 行 表 示 。

.Bd 表 示 ブ ロ ッ ク の 開 始 。 表 示 オ プ シ ョ ン :
−ragged 揃 え な い (両 端 は 不 揃 い )。
−filled 揃 え る 。
−literal リ テ ラ ル な テ キ ス ト ま た は コ ー ド 。
−file name 指 定 さ れ た file を 読 ん で 表 示 す る 。
−offset string オ フ セ ッ ト 表 示 。 受 付 け る string の 値 は :
left ブ ロ ッ ク を 左 に 揃 え る (デ フ ォ ル ト )。
center 大 ま か な セ ン タ ー マ ー ジ ン 。
indent 定 数 幅 の 空 白 6 つ (タ ブ 1 つ )。
indent-two タ ブ 2 つ 。
right 揃 え ブ ロ ッ ク を 右 か ら 2 イ ン チ の 位 置 に 残 す 。
xxn

xx は 4n か ら 99n ま で の 数 字 。

Aa

Aa は 呼 び だ し 可 能 な マ ク ロ の 名 前 。

string

string の 幅 が 用 い ら れ る 。

.Ed 表 示 終 了 (.Bd に マ ッ チ す る )。
.Bl リ ス ト 開 始 。 リ ス ト ま た は コ ラ ム を 生 成 す る 。 オ プ シ ョ ン は 以 下 : リ ス ト 形 式

−bullet 中 黒 の ア イ テ ム リ ス ト
−item ラ ベ ル な し リ ス ト
−enum 数 値 付 き リ ス ト
−tag タ グ ラ ベ ル 付 き リ ス ト
−diag 診 断 リ ス ト (diagnostic list)
−hang ぶ ら さ が り ラ ベ ル リ ス ト
−ohang 飛 び 出 し ラ ベ ル リ ス ト
−inset ラ ベ ル 付 き リ ス ト の 挿 入 ・ 継 続 リ ス ト パ ラ メ ー タ ー

−offset

(全 て の リ ス ト ) 上 記 の ’.Bd’ デ ィ ス プ レ イ 開 始 (begin-display) を 見 よ 。

−width

(−tag お よ び −hang リ ス ト の み ) ’.Bd’. を 見 よ 。

−compact

(全 て の リ ス ト ) 空 行 を 抑 制 す る 。

.El リ ス ト の 終 わ り 。
.It リ ス ト 項 目 。 マ ニ ュ ア ル ド メ イ ン マ ク ロ と 一 般 テ キ ス ト ド メ イ ン マ ク ロ マ ニ ュ ア ル ド メ イ ン マ ク ロ と 一 般 テ キ ス ト ド メ イ ン マ ク ロ と が 他 と 異 な っ て い る の は 、 呼 び だ し 可 能 マ ク ロ (callable macro) の 内 部 で は 、 そ の ほ と ん ど が パ ー ズ さ れ る と い う 点 で あ る 。 例 え ば 以 下 の よ う に 変 換 さ れ る :

.Op Fl s Ar file

→ [−s file] こ の 例 で は 、 囲 み マ ク ロ ’.Op’ に 与 え ら れ た オ プ シ ョ ン が パ ー ズ さ れ 、 中 身 の 呼 び だ し 可 能 な マ ク ロ で あ る ’Fl’ が 呼 ば れ 、 引 数 で あ る ’s’ に 対 し て 作 用 す る 。 そ し て 次 に 中 身 の 呼 び だ し 可 能 な マ ク ロ ’Ar’ が 呼 ば れ 、 引 数 で あ る ’file’ に 作 用 す る 。 呼 び だ し 可 能 で あ る が パ ー ス さ れ な い マ ク ロ や 、 そ の 逆 の マ ク ロ も 存 在 す る 。 こ の よ う な マ ク ロ は 以 下 の parsed カ ラ ム や callable カ ラ ム で 示 す 。 特 に 記 述 が な け れ ば 、 マ ニ ュ ア ル ド メ イ ン マ ク ロ は 共 通 の 書 式 を と る :

.Va argument [ . , ; : ( ) [ ] argument ... ] 注 意 : 句 読 文 字 (punctuation character) の 開 き ・ 閉 じ は 、 そ れ ら が 一 度 に 単 一 の 文 字 で 現 れ た 場 合 の み そ の よ う に 解 釈 さ れ る 。 文 字 列 ’),’ は 、 句 読 区 切 り と は み な さ れ ず 、 そ の 前 に 空 白 文 字 が あ れ ば そ の 文 字 と と も に 、 ま た 呼 び 出 し た マ ク ロ が 用 い る フ ォ ン ト で 出 力 さ れ る 。 引 数 リ ス ト ’] ) ,’ は 3 つ の 連 続 し た 閉 じ 句 読 文 字 と 解 釈 さ れ 、 そ れ ぞ れ の 前 に あ る 空 白 文 字 は 、 各 文 字 や (も し あ れ ば ) そ の 前 に あ る 引 数 と の 間 に は 出 力 さ れ な い 。 特 殊 な 意 味 を 持 つ 句 読 文 字 は 、 文 字 列 ’\&’ に よ っ て エ ス ケ ー プ で き る 。 例 え ば 以 下 の 左 の 文 字 列 は 右 の よ う に 変 換 さ れ る 。

.Ar file1 , file2 , file3 ) .

→ file1, file2, file3). マ ニ ュ ア ル ド メ イ ン マ ク ロ 名 前 Parsed Callable 説 明

Ad Yes Yes ア ド レ ス (こ の マ ク ロ は 使 わ な い 方 が 良 い )
An Yes Yes 著 者 の 名 前
Ar Yes Yes コ マ ン ド ラ イ ン 引 数
Cd No No 設 定 の 宣 言 (セ ク シ ョ ン 4 の み )
Cm Yes Yes コ マ ン ド ラ イ ン 引 数 の 修 正 子
Dv Yes Yes 定 義 済 み 変 数 (ソ ー ス コ ー ド )
Er Yes Yes エ ラ ー 番 号 (ソ ー ス コ ー ド )
Ev Yes Yes 環 境 変 数
Fa Yes Yes 関 数 の 引 き 数
Fd Yes Yes 関 数 の 宣 言
Fn Yes Yes 関 数 呼 び だ し (.Fo と .Fc も )
Ic Yes Yes イ ン タ ラ ク テ ィ ブ な コ マ ン ド
Li Yes Yes リ テ ラ ル な テ キ ス ト
Nm Yes Yes コ マ ン ド の 名 前
Op Yes Yes オ プ シ ョ ン (.Oo と .Oc も )
Ot Yes Yes 古 い 形 式 の 関 数 型 (Fortran の み ).
Pa Yes Yes パ ス 名 ま た は フ ァ イ ル 名
St Yes Yes 標 準 (−p1003.2, −p1003.1, −ansiC の ど れ か )
Va Yes Yes 変 数 の 名 前
Vt Yes Yes 変 数 の 型 (Fortran の み )
Xr Yes Yes マ ニ ュ ア ル ペ ー ジ の 相 互 参 照 一 般 テ キ ス ト ド メ イ ン マ ク ロ 名 前 Parsed Callable 説 明
%A Yes No 参 考 文 献 の 著 者
%B Yes Yes 参 考 文 献 の 書 籍 タ イ ト ル
%C No No 参 考 文 献 の 出 版 地 (街 )
%D No No 参 考 文 献 の 日 付
%J Yes Yes 参 考 文 献 の 雑 誌 名
%N No No 参 考 文 献 の 号 数
%O No No 参 考 文 献 の 補 助 情 報
%P No No 参 考 文 献 の ペ ー ジ
%R No No 参 考 文 献 の リ ポ ー ト 名
%T Yes Yes 参 考 文 献 の 記 事 タ イ ト ル
%V No No 参 考 文 献 の 巻 数
Ac Yes Yes ア ン グ ル ク ォ ー ト の 閉 じ
Ao Yes Yes ア ン グ ル ク ォ ー ト の 開 き
Ap Yes Yes ア ポ ス ト ロ フ ィ
Aq Yes Yes ア ン グ ル ク ォ ー ト
At No No AT&T UNIX
Bc Yes Yes ブ ラ ケ ッ ト ク ォ ー ト の 閉 じ
Bf No No フ ォ ン ト モ ー ド の 開 始
Bo Yes Yes ブ ラ ケ ッ ト ク ォ ー ト の 開 き
Bq Yes Yes ブ ラ ケ ッ ト ク ォ ー ト
Bx Yes Yes BSD.
Db No No デ バ ッ グ (デ フ ォ ル ト は "off")
Dc Yes Yes ダ ブ ル ク ォ ー ト の 閉 じ
Do Yes Yes ダ ブ ル ク ォ ー ト の 開 き
Dq Yes Yes ダ ブ ル ク ォ ー ト
Ec Yes Yes エ ン ク ロ ー ズ 文 字 列 引 用 の 閉 じ
Ef No No フ ォ ン ト モ ー ド の 終 了
Em Yes Yes 強 調 (traditional English).
Eo Yes Yes エ ン ク ロ ー ズ 文 字 列 引 用 の 開 き
Fx No No FreeBSD operating system
No Yes Yes 通 常 の テ キ ス ト (効 果 な し )
Ns Yes Yes ス ペ ー ス 無 し
Pc Yes Yes 括 弧 ク ォ ー ト の 閉 じ
Pf Yes No 前 置 文 字
Po Yes Yes 括 弧 ク ォ ー ト の 開 き
Pq Yes Yes 括 弧 ク ォ ー ト
Qc Yes Yes ダ ブ ル ス ト レ ー ト ク ォ ー ト の 閉 じ
Ql Yes Yes ク ォ ー ト さ れ た リ テ ラ ル
Qo Yes Yes ダ ブ ル ス ト レ ー ト ク ォ ー ト の 閉 じ
Qq Yes Yes ダ ブ ル ス ト レ ー ト ク ォ ー ト の 閉 じ
Re No No 参 考 文 献 の 終 了
Rs No No 参 考 文 献 の 開 始
Rv No No 返 り 値 (セ ク シ ョ ン 2, 3 の み )
Sc Yes Yes シ ン グ ル ク ォ ー ト の 閉 じ
So Yes Yes シ ン グ ル ク ォ ー ト の 開 き
Sq Yes Yes シ ン グ ル ク ォ ー ト
Sm No No ス ペ ー ス モ ー ド (デ フ ォ ル ト は "on")
Sx Yes Yes セ ク シ ョ ン の 相 互 参 照
Sy Yes Yes シ ン ボ リ ッ ク (traditional English).
Tn Yes Yes Trade ま た は 型 名 (small Caps).
Ux Yes Yes UNIX
Xc Yes Yes 拡 張 引 数 リ ス ト の 閉 じ
Xo Yes Yes 拡 張 引 数 リ ス ト の 開 き

’q’ で 終 わ る 名 前 の マ ク ロ は 、 引 数 リ ス ト の 残 り の 項 目 を ク ォ ー ト す る 。 ’o’ で 終 わ る 名 前 の マ ク ロ は 一 行 以 上 に わ た る 入 力 の ク ォ ー ト を 開 始 し 、 こ れ は 対 応 す る 名 前 の ’c’ で お わ る 名 前 の マ ク ロ で 終 了 す る 。 囲 み マ ク ロ は ネ ス ト で き 、 引 数 は 8 つ ま で 取 れ る 。 注 意 : 拡 張 引 数 リ ス ト マ ク ロ (’.Xo’, ’.Xc’) お よ び 関 数 の 囲 み マ ク ロ (’.Fo’, ’.Fc’) は 変 則 で あ る 。 拡 張 リ ス ト マ ク ロ は マ ク ロ の 引 数 が troff の 制 限 で あ る 9 個 を 越 え る と き に 用 い ら れ る 。

UR マ ク ロ (URI/URL ハ イ パ ー テ キ ス ト 参 照 の 開 始 ), UE マ ク ロ (終 了 ), UN マ ク ロ (参 照 用 タ ー ゲ ッ ト の 指 定 ) も 利 用 で き る 。 こ れ ら の マ ク ロ に 関 す る よ り 詳 し い 情 報 は man(7) を 見 よ 。 フ ァ イ ル

doc.tmac マ ニ ュ ア ル ド メ イ ン マ ク ロ と 一 般 テ キ ス ト ド メ イ ン マ ク ロ 。
tmac/doc-common 共 通 の 構 造 マ ク ロ と 定 義 。
tmac/doc-nroff サ イ ト 依 存 の nroff ス タ イ ル フ ァ イ ル 。
tmac/doc-ditroff サ イ ト 依 存 の troff ス タ イ ル フ ァ イ ル 。
tmac/doc-syms 特 殊 定 義 (標 準 マ ク ロ な ど )。 関 連 項 目

groff_mdoc(7), mdoc.samples(7), man(7), man-pages(7) こ の 文 書 に つ い て こ の man ペ ー ジ は Linux man-pages プ ロ ジ ェ ク ト の リ リ ー ス 3.79 の 一 部 で あ る 。 プ ロ ジ ェ ク ト の 説 明 と バ グ 報 告 に 関 す る 情 報 は http://www.kernel.org/doc/man-pages/ に 書 か れ て い る 。