Manpages

名 称

groff_mdoc — groff mdoc の 実 装 に 関 す る リ フ ァ レ ン ス 書 式
groff −mdoc file ... 解 説
GNU troff(1) 用 の コ ン テ ン ト ベ ー ス で か つ 領 域 ベ ー ス な 整 形 用 パ ッ ケ ー ジ で あ る −mdoc マ ク ロ パ ッ ケ ー ジ を 使 っ て UNIX マ ニ ュ ア ル ペ ー ジ を 書 く た め の 完 全 な リ フ ァ レ ン ス で す 。 前 身 で あ る −man(7) パ ッ ケ ー ジ は 、 フ ォ ン ト の 操 作 や 他 の 写 植 方 法 の 詳 細 は 個 々 の 作 者 に 任 せ 、 ペ ー ジ の レ イ ア ウ ト を 取 り 扱 っ て き ま し た 。 −mdoc で は 、 ペ ー ジ レ イ ア ウ ト マ ク ロ は タ イ ト ル 、 セ ク シ ョ ン の ヘ ッ ダ 、 デ ィ ス プ レ イ 、 リ ス ト の マ ク ロ か ら な る ペ ー ジ 構 造 領 域 を 形 成 し て い ま す 。 本 質 的 に こ れ ら の 要 素 は 整 形 さ れ た ペ ー ジ に お け る テ キ ス ト の 物 理 的 位 置 に 影 響 を 与 え ま す 。 ペ ー ジ 構 造 領 域 に 加 え 、 さ ら に マ ニ ュ ア ル 領 域 お よ び 一 般 テ キ ス ト 領 域 の 2 つ の 領 域 が あ り ま す 。 一 般 テ キ ス ト 領 域 は 、 テ キ ス ト の 一 部 を ク ォ ー ト し た り 強 調 し た り と い っ た よ う な 作 業 を 実 行 す る マ ク ロ と し て 定 義 さ れ て い ま す 。 マ ニ ュ ア ル 領 域 は コ マ ン ド や ル ー チ ン 、 そ れ に UNIX の 関 連 フ ァ イ ル を 記 述 す る た め の 日 常 使 用 さ れ る イ ン フ ォ ー マ ル な 言 葉 の サ ブ セ ッ ト で あ る マ ク ロ と し て 定 義 さ れ て い ま す 。 マ ニ ュ ア ル 領 域 の マ ク ロ は コ マ ン ド 名 、 コ マ ン ド 行 の 引 数 と オ プ シ ョ ン 、 関 数 名 、 関 数 の パ ラ メ ー タ 、 パ ス 名 、 変 数 名 、 他 の マ ニ ュ ア ル ペ ー ジ へ の ク ロ ス リ フ ァ レ ン ス な ど を 扱 い ま す 。 こ れ ら の 領 域 の 項 目 は 作 者 と マ ニ ュ ア ル ペ ー ジ の 将 来 の ユ ー ザ の 両 者 に と っ て 価 値 の あ る も の で す 。 マ ニ ュ ア ル 間 で 一 貫 性 を 高 め る こ と に よ っ て 将 来 の ド キ ュ メ ン ト ツ ー ル へ の 移 行 が 容 易 に な る こ と が 期 待 さ れ ま す 。

UNIX マ ニ ュ ア ル ペ ー ジ 全 体 を 通 し て 、 マ ニ ュ ア ル の エ ン ト リ は 単 純 に マ ニ ュ ア ル ペ ー ジ (a man page) と み な さ れ ま す 。 こ れ は 実 際 の ペ ー ジ 数 と 関 係 あ り ま せ ん し 、 性 差 別 を す る 意 図 も あ り ま せ ん 。 さ あ 、 始 め よ う こ の ド キ ュ メ ン ト の 残 り の 部 分 で 説 明 さ れ て い る 題 材 は 以 下 の よ う な 構 成 に な っ て い ま す 。

1.

TROFF に 特 有 な 表 現 マ ク ロ の 使 用 方 法 引 数 に 空 白 文 字 を 指 定 す る 行 末 の 空 白 文 字 特 殊 文 字 の エ ス ケ ー プ そ の 他 の 注 意 点

2. マ ニ ュ ア ル ペ ー ジ の テ ン プ レ ー ト

3. 使 用 法

4. タ イ ト ル マ ク ロ

5. マ ニ ュ ア ル 領 域 お よ び 一 般 テ キ ス ト 領 域 の 紹 介 こ の 名 前 に は 何 が ... 一 般 的 な 構 文

6. マ ニ ュ ア ル 領 域 ア ド レ ス 作 者 名 引 数 コ ン フ ィ ギ ュ レ ー シ ョ ン 宣 言 (セ ク シ ョ ン 4 の み ) コ マ ン ド 修 飾 子 定 義 済 み の 変 数
errno (セ ク シ ョ ン 2 の み ) 環 境 変 数 フ ラ グ 関 数 の 宣 言 関 数 の 型 関 数 (ラ イ ブ ラ リ ル ー チ ン ) 関 数 の 引 数 戻 り 値 終 了 ス テ ー タ ス 対 話 的 な コ マ ン ド ラ イ ブ ラ リ 名 リ テ ラ ル 名 称 オ プ シ ョ ン パ ス 名 標 準 変 数 の 型 変 数 マ ニ ュ ア ル ペ ー ジ の ク ロ ス リ フ ァ レ ン ス

7. 一 般 テ キ ス ト 領 域
AT&T マ ク ロ
BSD マ ク ロ
NetBSD マ ク ロ
FreeBSD マ ク ロ
OpenBSD マ ク ロ
BSD/OS マ ク ロ
UNIX マ ク ロ 強 調 マ ク ロ フ ォ ン ト モ ー ド 囲 い /ク ォ ー ト マ ク ロ 無 操 作 も し く は 通 常 テ キ ス ト マ ク ロ 空 白 な し マ ク ロ セ ク シ ョ ン の ク ロ ス リ フ ァ レ ン ス 記 号 数 式 記 号 参 考 文 献 と 引 用 商 標 名 (頭 字 語 と タ イ プ 名 ) 拡 張 引 数

8. ペ ー ジ 構 造 領 域 セ ク シ ョ ン ヘ ッ ダ サ ブ セ ク シ ョ ン ヘ ッ ダ 段 落 と 行 ス ペ ー ス キ ー プ 例 示 と デ ィ ス プ レ イ リ ス ト と カ ラ ム

9. そ の 他 の マ ク ロ

10. 定 義 済 み の 文 字 列

11. 診 断

12.

GROFF, TROFF お よ び NROFF を 使 用 し た 整 形

13. 関 連 フ ァ イ ル

14. 関 連 項 目

15. バ グ

TROFF に 特 有 な 表 現

−mdoc パ ッ ケ ー ジ は 、 マ ニ ュ ア ル ペ ー ジ を 記 述 す る プ ロ セ ス を 簡 単 に す る こ と を 目 的 と し て い ま す 。 −mdoc を 使 う た め に GNU troff(1) の ゴ タ ゴ タ し た 詳 細 を 学 ぶ 必 要 が な い の が 理 想 で す が 、 い く つ か 片 付 け る べ き 避 け ら れ な い 制 限 事 項 が あ り ま す 。 ま た 、 こ の パ ッ ケ ー ジ は 高 速 で な い と い う こ と も 予 め 警 告 し て お き ま す 。 マ ク ロ の 使 用 方 法
GNU troff(1) の よ う に 、 マ ク ロ は ’.’ (ド ッ ト ) を 行 頭 に 置 き 、 そ れ に 続 け て 2 文 字 (ま た は 3 文 字 ) か ら な る マ ク ロ の 名 称 を 指 定 す る こ と に よ っ て 呼 び 出 さ れ ま す 。 ド ッ ト と マ ク ロ の 間 に は ス ペ ー ス を 置 く こ と が で き ま す (た だ し 、 タ ブ を 置 く こ と は で き ま せ ん )。 引 数 は マ ク ロ の 後 に ス ペ ー ス で 区 切 っ て 指 定 す る こ と が で き ま す (や は り 、 タ ブ は 使 用 で き ま せ ん )。 行 頭 に ド ッ ト を 指 定 す る こ と に よ っ て GNU troff(1) に そ れ に 続 く 2 文 字 (あ る い は そ れ よ り 多 い 文 字 ) を マ ク ロ 名 と し て 解 釈 す る よ う 指 示 し て い ま す 。 最 初 に ド ッ ト 1 文 字 を と り 、 そ の 後 ろ に 何 も 来 な い 場 合 は 無 視 さ れ ま す 。 マ ク ロ を 起 動 さ せ た く な い よ う な 文 脈 で 、 入 力 行 の 先 頭 に ’.’ (ド ッ ト ) を 置 く た め に は 、 ’.’ (ド ッ ト ) の 前 に エ ス ケ ー プ シ ー ケ ン ス ’\&’ を 指 定 し ま す 。 ’\&’ は 文 字 通 り ス ペ ー ス 幅 が 0 と し て 解 釈 さ れ 、 出 力 に は 現 れ ま せ ん 。 一 般 的 に GNU troff(1) マ ク ロ は 取 り 得 る 引 数 の 数 に 制 限 は あ り ま せ ん (9 つ 以 上 の 引 数 を 扱 う こ と の で き な い 他 の バ ー ジ ョ ン の troff と は 違 い ま す )。 限 ら れ た 場 合 で は あ り ま す が 、 引 数 を 次 の 行 に 続 け た り 、 拡 張 し た り す る こ と が で き ま す (後 述 の 拡 張 引 数 の セ ク シ ョ ン を 参 照 )。 ほ と ん ど す べ て の マ ク ロ で 引 用 符 に 囲 ま れ た 引 数 を 扱 う こ と が で き ま す (後 述 の 引 数 に 空 白 文 字 を 指 定 す る の セ ク シ ョ ン を 参 照 )。

−mdoc で の 一 般 テ キ ス ト 領 域 と マ ニ ュ ア ル 領 域 の ほ と ん ど の マ ク ロ は 、 呼 び 出 し 可 能 な マ ク ロ 名 を 決 定 す る た め に そ の 引 数 の リ ス ト が 構 文 解 析 さ れ る と い う 点 で 特 別 な も の で す 。 こ れ は つ ま り 、 一 般 テ キ ス ト 領 域 ま た は マ ニ ュ ア ル 領 域 の マ ク ロ 名 に 一 致 し 、 か つ 、 呼 び 出 し 可 能 で あ る と 判 断 さ れ た 引 数 リ ス ト 中 の 引 数 は 、 処 理 さ れ る 時 に 実 行 さ れ る か 、 も し く は 呼 び 出 さ れ る と い う こ と で す 。 こ の 場 合 、 引 数 が マ ク ロ の 名 前 で あ っ て も ’.’ (ド ッ ト ) で 前 置 さ れ ま せ ん 。 こ の よ う に し て た く さ ん の マ ク ロ を 入 れ 子 に す る こ と が で き ま す 。 例 え ば オ プ シ ョ ン マ ク ロ ’.Op’ は フ ラ グ マ ク ロ お よ び 引 数 マ ク ロ ’Fl’ と ’Ar’ を 呼 び 出 し て 、 オ プ シ ョ ン の フ ラ グ を 引 数 と と も に 指 定 す る こ と が で き ま す :

[−s bytes] は ’.Op Fl s Ar bytes’ で 生 成 さ れ ま す 。 文 字 列 が マ ク ロ 名 と 解 釈 さ れ な い よ う に す る に は 、 そ の 文 字 列 の 前 に エ ス ケ ー プ シ ー ケ ン ス ’\&’ を 指 定 し ま す 。

[Fl s Ar bytes] は ’.Op \&Fl s \&Ar bytes’ で 生 成 さ れ ま す 。 こ こ で 文 字 列 ’Fl’ と ’Ar’ は マ ク ロ と し て 解 釈 さ れ て い ま せ ん 。 こ の ド キ ュ メ ン ト を 通 じ て 、 呼 び 出 し 可 能 な 引 数 を 調 べ る た め に 引 数 リ ス ト が 構 文 解 析 さ れ る マ ク ロ は 構 文 解 析 さ れ る マ ク ロ と し て 参 照 し 、 引 数 リ ス ト か ら 呼 び 出 さ れ る こ と が で き る マ ク ロ は 呼 び 出 し 可 能 な マ ク ロ と し て 参 照 し ま す 。 −mdoc の マ ク ロ は ほ と ん ど す べ て が 構 文 解 析 さ れ る の で す か ら 、 こ れ は 技 術 的 に は 適 当 で な い 表 現 で す が 、 常 に マ ク ロ を 「 呼 び 出 し 可 能 で あ る 」 と か 「 他 の マ ク ロ を 呼 び 出 す こ と が で き る 」 と 表 現 す る の は 面 倒 な こ と で あ る た め 、 「 構 文 解 析 さ れ る 」 と い う 用 語 を 使 い ま す 。 引 数 に 空 白 文 字 を 指 定 す る

1 つ 以 上 の 空 白 文 字 を 含 む 文 字 列 を 引 数 と し て 指 定 し た い 場 合 が あ り ま す 。 引 数 リ ス ト 中 の 要 素 が 特 定 の 並 び を し て い る こ と を 期 待 し て い る マ ク ロ に 引 数 を 指 定 す る 時 に 必 要 に な る こ と が あ り ま す 。 さ ら に 、 こ う す る と −mdoc が 速 く 実 行 さ れ る よ う に な る の で す 。 例 え ば 、 関 数 マ ク ロ ’.Fn’ で は 第 1 引 数 は 関 数 名 で あ り 、 残 り の 引 数 が 関 数 の パ ラ メ ー タ で あ る と 想 定 さ れ て い ま す 。 ANSI C で は 、 関 数 の パ ラ メ ー タ 宣 言 を 括 弧 で 囲 ま れ た パ ラ メ ー タ リ ス ト 中 に 明 示 す る こ と を 規 定 し て い る の で 、 各 パ ラ メ ー タ は 最 低 で も 2 語 の 文 字 列 と な り ま す 。 例 え ば 、 int foo の よ う に な り ま す 。 空 白 を 含 む 引 数 を 指 定 す る に は 2 通 り の 方 法 が あ り ま す 。 1 つ は 、 空 白 を 含 む 文 字 列 を 渡 す の に 、 固 定 の 空 白 、 つ ま り パ デ ィ ン グ さ れ な い 空 白 文 字 ’\ ’ を 使 う 方 法 で す 。 す な わ ち 、 空 白 の 前 に エ ス ケ ー プ 文 字 ’\’ を 指 定 し ま す 。 こ の 方 法 は ど の マ ク ロ で も 使 う こ と が で き ま す が 、 1 行 が 長 く な り 過 ぎ た テ キ ス ト を 調 整 す る と き の 邪 魔 に な る と い う 副 作 用 が あ り ま す 。 troff で は 、 固 定 の 空 白 は 他 の 印 刷 可 能 な 文 字 と 同 様 に 扱 わ れ 、 通 常 期 待 さ れ る よ う に そ の 箇 所 で 文 字 列 を 空 白 や 改 行 で 分 け る こ と は 行 わ れ な く な り ま す 。 こ の 方 法 は 文 字 列 が 行 の 境 界 に ま た が る こ と が 好 ま し く な い 場 合 に 有 用 で す 。 代 替 案 と し て は 、 パ デ ィ ン グ 可 能 (す な わ ち 伸 長 可 能 ) で 分 割 不 可 能 な 空 白 ’\~’ を 使 う こ と が あ り ま す (こ れ は 、 GNU troff(1) 拡 張 で す )。 2 つ 目 の 方 法 は 、 文 字 列 を ダ ブ ル ク ォ ー ト で 括 る こ と で す 。 例 え ば 、 次 の よ う に し ま す :

fetch(char *str) は ’.Fn fetch char\ *str’ で 生 成 さ れ ま す 。

fetch(char *str) も ’.Fn fetch "char *str"’ で 生 成 す る こ と が で き ま す 。 も し 、 空 白 お よ び ダ ブ ル ク ォ ー ト の 前 の ’\’ が 省 略 さ れ て い た 場 合 に は ’.Fn’ は 引 数 が 3 つ で あ る と み な し 、 そ の 結 果 は

fetch(char, *str) と な り ま す 。 行 末 の 空 白 文 字

Troff は 行 末 に 空 白 文 字 が あ る と 混 乱 し て し ま う こ と が あ り ま す 。 ⟨ 空 白 ⟩ ⟨ 行 末 ⟩ の 文 字 の 並 び か ら す べ て の 空 白 文 字 を 取 り 除 く の は 良 い 予 防 策 で す 。 ど う し て も 行 末 に 空 白 文 字 を お く 必 要 性 が 出 て き た 場 合 は 、 パ デ ィ ン グ さ れ な い 空 白 と エ ス ケ ー プ 文 字 ’\&’ を 使 用 す る こ と に よ っ て 対 応 で き ま す 。 例 え ば 、 ’string\ \&’ の よ う に し ま す 。 特 殊 文 字 の エ ス ケ ー プ 改 行 ’\n’ の よ う な 特 殊 文 字 は 、 バ ッ ク ス ラ ッ シ ュ を 保 存 す る た め に ’\’ を ’\e’ で 置 き 換 え (た と え ば ’\en’ と す る ) て 扱 い ま す 。 そ の 他 の 注 意 点 表 示 領 域 外 で 空 の 入 力 行 が 見 つ か っ た 場 合 に は 警 告 が 発 生 し ま す (後 述 )。 代 わ り に ’.sp’ を 使 用 し て く だ さ い ( −mdoc マ ク ロ を 使 用 し て 、 低 レ ベ ル コ マ ン ド を 使 用 し な い よ う に す る と ず っ と 良 い で す )。 先 頭 に 空 白 を 置 く と 行 分 割 が 生 じ 、 そ の ま ま 出 力 さ れ て し ま い ま す 。 可 能 な ら ば こ う な る こ と を 避 け て く だ さ い 。 同 様 に 、 通 常 の テ キ ス ト 行 に お い て 単 語 間 に 2 つ 以 上 の 空 白 文 字 を 使 用 し な い で く だ さ い 。 こ れ は 、 他 の テ キ ス ト フ ォ ー マ ッ タ と は 対 照 的 で す 。 空 白 文 字 を 2 つ 以 上 置 い て も 1 つ の 空 白 文 字 に 置 き 換 わ り ま せ ん 。 引 数 と し て ’"’ を 直 接 渡 す こ と は で き ま せ ん 。 代 わ り に ’\*[q]’ (あ る い は ’\*q’) を 使 用 し て く だ さ い 。 デ フ ォ ル ト で は 、 troff(1) は 文 を 終 了 さ せ る 句 読 点 の 後 に 空 白 文 字 を 2 つ 挿 入 し ま す 。 つ ま り 、 ’)’ あ る い は ’’’ な ど の 文 字 は そ の ま ま 扱 わ れ 、 文 の 終 了 に は 影 響 を 与 え ま せ ん 。 こ の 動 作 を 変 更 す る に は 、 ド ッ ト の 前 あ る い は 後 に ’\&’ を 挿 入 し て く だ さ い 。

The
.Ql .
character.
.Pp
The
.Ql \&.
character.
.Pp
.No test .
test
.Pp
.No test.
test は 、

The ’’. character.

The ’.’ character.

test. test

test. test と な り ま す 。

1 行 目 お よ び 3 行 目 に み ら れ る よ う に 、 −mdoc は マ ク ロ 引 数 の 中 で は 句 読 点 を 特 別 に 扱 い ま す 。 こ れ に つ い て は 、 後 述 の 一 般 的 な 構 文 の 節 で 述 べ ま す 。 同 様 の 方 法 で 、 幅 0 の 空 白 を 続 け る こ と で 、 省 略 形 の 後 に 続 い た ピ リ オ ド を 保 護 し な く て は な り ま せ ん 。 例 え ば ’e.g.\&’ の よ う に し ま す 。 マ ニ ュ ア ル ペ ー ジ の ソ ー ス フ ァ イ ル 中 の コ メ ン ト は 、 独 立 し た 行 で は ’.\"’ 、 何 ら か の 入 力 が あ っ た 後 で は ’\"’ を 、 あ る い は ど の よ う な 場 所 で も 使 い た い 場 合 は ’\#’ を 使 う こ と が で き ま す (後 者 は GNU troff(1) 拡 張 で す )。 こ の よ う な 行 の 残 り の 部 分 は 無 視 さ れ ま す 。 マ ニ ュ ア ル ペ ー ジ の テ ン プ レ ー ト マ ニ ュ ア ル ペ ー ジ の 中 身 は 次 の よ う な 基 本 的 な テ ン プ レ ー ト か ら 簡 単 に 作 成 で き ま す 。

.\" 以 下 の 項 目 は す べ て の マ ニ ュ ア ル ペ ー ジ で 必 要 な 項 目 で す 。
.Dd 月 日 , 年
.Os [オ ペ レ ー テ ィ ン グ シ ス テ ム ] [バ ー ジ ョ ン /リ リ ー ス ]
.Dt ド キ ュ メ ン ト タ イ ト ル [セ ク シ ョ ン 番 号 ] [ア ー キ テ ク チ ャ /ボ リ ュ ー ム ]
.Sh NAME
.Nm 名 称
.Nd 名 称 に つ い て の 1 行 で の 説 明
.\" 次 の 項 目 は セ ク シ ョ ン 2, 3 で の み 必 要 な も の で す 。
.\" .Sh LIBRARY
.Sh SYNOPSIS
.Sh DESCRIPTION
.\" 以 下 の 項 目 に つ い て は 、 必 要 に 応 じ て コ メ ン ト を は ず し て 使 用 し て く
.\" だ さ い 。
.\" .Sh IMPLEMENTATION NOTES
.\" こ の 次 の 項 目 は セ ク シ ョ ン 2, 3, 9 で の み 必 要 な 、 関 数 の
.\" 戻 り 値 で す 。
.\" .Sh RETURN VALUES
.\" 次 の 項 目 は セ ク シ ョ ン 1, 6, 7, 8, 9 で の み 必 要 な も の で す 。
.\" .Sh ENVIRONMENT
.\" .Sh FILES
.\" .Sh EXAMPLES
.\" 次 の 項 目 は セ ク シ ョ ン 1, 6, 7, 8, 9 で の み 必 要 な も の で す 。
.\" ((シ ェ ル へ の )コ マ ン ド の 戻 り 値 と
.\" fprintf/stderr タ イ プ の 診 断 で す )
.\" .Sh DIAGNOSTICS
.\" .Sh COMPATIBILITY
.\" 次 の 項 目 は セ ク シ ョ ン 2, 3, 9 で の み 必 要 な 、
.\" エ ラ ー ハ ン ド リ ン グ と シ グ ナ ル ハ ン ド リ ン グ で す 。
.\" .Sh ERRORS
.\" .Sh SEE ALSO
.\" .Sh STANDARDS
.\" .Sh HISTORY
.\" .Sh AUTHORS
.\" .Sh BUGS こ の テ ン プ レ ー ト に お け る 最 初 の 項 目 は マ ク ロ ’.Dd’, ’.Os’, お よ び ’.Dt’ で あ り 、 そ れ ぞ れ ド キ ュ メ ン ト の 日 付 、 マ ニ ュ ア ル ペ ー ジ も し く は 題 材 と な っ て い る ソ ー ス の 開 発 や 変 更 の 対 象 と な っ た オ ペ レ ー テ ィ ン グ シ ス テ ム 、 そ し て マ ニ ュ ア ル ペ ー ジ の タ イ ト ル を 属 す る マ ニ ュ ア ル の セ ク シ ョ ン 番 号 と と も に ( 大 文 字 で ) 指 定 し た も の 、 と な っ て い ま す 。 こ れ ら の マ ク ロ は そ の ペ ー ジ を 識 別 す る も の で あ り 、 後 述 の タ イ ト ル マ ク ロ で 解 説 さ れ ま す 。 テ ン プ レ ー ト 中 の 残 り の 項 目 は セ ク シ ョ ン の ヘ ッ ダ (.Sh) で あ り 、 そ れ ら の う ち NAME, SYNOPSIS, お よ び DESCRIPTION は 必 須 項 目 で す 。 こ れ ら の ヘ ッ ダ に つ い て は マ ニ ュ ア ル 領 域 を 説 明 し た 後 、 ペ ー ジ 構 造 領 域 で 解 説 さ れ ま す 。 い く つ か の コ ン テ ン ト マ ク ロ は ペ ー ジ レ イ ア ウ ト マ ク ロ の 説 明 に 使 用 さ れ て い ま す の で 、 ペ ー ジ レ イ ア ウ ト マ ク ロ の 前 に コ ン テ ン ト マ ク ロ に つ い て 読 む こ と を 推 奨 し ま す 。 使 用 法 次 に 説 明 す る マ ク ロ は す べ て 、 オ プ シ ョ ン の 引 数 は 角 括 弧 ([]) で 括 ら れ ま す 。 省 略 符 号 (’...’) は さ ら に 0 個 以 上 の 引 数 が あ る こ と を 表 し て い ま す 。 パ ラ メ ー タ の 代 替 値 は ’|’ で 区 切 っ て 示 し ま す 。 必 須 パ ラ メ ー タ に 代 替 値 が あ る 場 合 は 、 ( ’|’ と 一 緒 に ) 中 括 弧 ({}) を 用 い 、 値 の 組 を 括 り ま す 。 メ タ 変 数 は 山 括 弧 (<>) の 中 で 指 定 さ れ ま す 。 例 :

.Xx
⟨ foo⟩ {bar1 | bar2} [−test1 [−test2 | −test3]] ... と く に 明 示 し な い 限 り 、 す べ て の マ ク ロ は 構 文 解 析 さ れ 、 呼 び 出 し 可 能 な も の で す 。 大 部 分 の マ ク ロ は デ フ ォ ル ト の 幅 の 値 を 持 っ て お り 、 こ れ を ’.Bl’ お よ び ’.Bd’ マ ク ロ 用 に ラ ベ ル width (−width) あ る い は offset (−offset) を 指 定 す る の に 使 用 す る こ と が で き ま す 。 −mdoc パ ッ ケ ー ジ の ロ ー カ ル な 変 更 に 依 存 す る こ と の な い よ う に 、 こ の と て も 曖 昧 な 機 能 は 使 わ な い こ と を 推 奨 し ま す 。 タ イ ト ル マ ク ロ タ イ ト ル マ ク ロ は ペ ー ジ 構 造 領 域 の 一 部 で す が 、 マ ニ ュ ア ル ペ ー ジ を 昨 日 書 き 始 め よ う と 思 っ た と い う 人 の た め に 、 最 初 に 、 他 の と は 別 に 記 述 さ れ て い ま す 。 3 つ の ヘ ッ ダ マ ク ロ で ド キ ュ メ ン ト ま た は マ ニ ュ ア ル ペ ー ジ の タ イ ト ル 、 オ ペ レ ー テ ィ ン グ シ ス テ ム 、 お よ び 原 著 の 日 付 を 指 定 し ま す 。 こ れ ら の マ ク ロ は ド キ ュ メ ン ト の 最 初 で 一 度 だ け 呼 び 出 さ れ る も の で 、 ヘ ッ ダ と フ ッ タ を 構 成 す る た め だ け に 使 用 さ れ ま す 。

.Dt
[⟨ ド キ ュ メ ン ト タ イ ト ル ⟩ ] [⟨ セ ク シ ョ ン 番 号 ⟩ ] [⟨ ボ リ ュ ー ム ⟩ ] ド キ ュ メ ン ト タ イ ト ル は マ ニ ュ ア ル ペ ー ジ の 主 題 で あ り 、 troff の 制 限 に よ り 大 文 字 で な け れ ば い け ま せ ん 。 省 略 さ れ た 場 合 、 ’UNTITLED’ が 使 わ れ ま す 。 セ ク シ ョ ン 番 号 は 1, ..., 9 の 範 囲 の 番 号 も し く は ’unass’, ’draft’, ’paper’ の い ず れ か を 取 る こ と が で き ま す 。 セ ク シ ョ ン 番 号 が 指 定 さ れ て お り 、 ボ リ ュ ー ム 名 が 与 え ら れ て い な い 場 合 に は 、 デ フ ォ ル ト の ボ リ ュ ー ム 名 が 使 用 さ れ ま す 。

BSD で は 、 次 の セ ク シ ョ ン が 定 義 さ れ て い ま す :

’IND’ の 代 わ り に ’MMI’ を 使 用 す る こ と が で き 、 ’LOCAL’ の 代 わ り に ’LOC’ を 使 用 で き ま す 。 先 の 表 の 値 は 、 新 し い ボ リ ュ ー ム 名 を 指 定 し ま す 。 第 3 パ ラ メ ー タ が コ ン ピ ュ ー タ ア ー キ テ ク チ ャ を 表 す キ ー ワ ー ド で あ る 場 合 、 そ の 値 は 第 2 パ ラ メ ー タ で 指 定 し た よ う に ボ リ ュ ー ム 名 に 追 加 さ れ ま す 。 デ フ ォ ル ト で は 次 の ア ー キ テ ク チ ャ に 関 す る キ ー ワ ー ド が 定 義 さ れ て い ま す :

alpha, amiga, arc, arm26, arm32, atari, bebox, cobalt, evbsh3, hp300, hpcmips, i386, luna68k, m68k, mac68k, macppc, mips, mmeye, mvme68k, news68k, newsmips, next68k, ofppc, pc532, pmax, powerpc, prep, sgimips, sh3, sparc, sparc64, sun3, tahoe, vax, x68k 次 の 例 で は 、 マ ニ ュ ア ル ペ ー ジ の ヘ ッ ダ の 左 側 (こ れ は 右 側 と 同 じ も の で す ) と 中 央 に 書 か れ る 文 字 列 を 示 し て い ま す 。

.Dt FOO 7

’FOO(7)’ ’System Reference Manual’

.Dt FOO 2 mac68k

’FOO(2)’ ’System Programmer’s Manual (mac68k Architecture)’

.Dt FOO "" bar

’FOO’ ’bar’ ロ ー カ ル な 追 加 項 目 や OS に 特 化 し た 追 加 項 目 が 、 フ ァ イ ル mdoc.local に あ る か も し れ ま せ ん 。 こ の フ ァ イ ル 中 で ’volume-ds-XXX’ (前 者 の タ イ プ に つ い て ) お よ び ’volume-as-XXX’ (後 者 の タ イ プ に つ い て ) と い う 名 前 の 文 字 列 を 検 索 し て く だ さ い 。 こ こ で ’XXX’ は ’.Dt’ マ ク ロ で 使 用 さ れ る キ ー ワ ー ド を 表 し て い ま す 。 こ の マ ク ロ は 呼 び 出 し 不 可 能 で あ り 、 構 文 解 析 も さ れ ま せ ん 。

.Os
[⟨ オ ペ レ ー テ ィ ン グ シ ス テ ム ⟩ ] [⟨ リ リ ー ス 番 号 ⟩ ] 第 1 パ ラ メ ー タ が 空 の 場 合 、 デ フ ォ ル ト 値 ’BSD’ が 使 用 さ れ ま す 。 こ れ は 、 ロ ー カ ル の 設 定 フ ァ イ ル mdoc.local で 上 書 き で き ま す 。 一 般 的 に は 、 オ ペ レ ー テ ィ ン グ シ ス テ ム の 名 称 に は 一 般 的 な 頭 字 語 (略 称 ) を 使 わ な け れ ば な り ま せ ん 。 例 え ば BSD や ATT と い っ た も の で す 。 リ リ ー ス 番 号 は 、 各 シ ス テ ム で の 標 準 の リ リ ー ス の 命 名 法 を 使 用 し ま す 。 次 の 表 で は 、 い く つ か 事 前 に 定 義 さ れ て い る オ ペ レ ー テ ィ ン グ シ ス テ ム に 対 し て 取 り 得 る 第 2 引 数 を リ ス ト し て い ま す 。 ’.Dt’ と 同 じ よ う に 、 ロ ー カ ル な 追 加 項 目 が mdoc.local に 定 義 さ れ て い る か も し れ ま せ ん 。 こ の フ ァ イ ル 中 で ’operating-system-XXX-YYY’ と い う 名 前 の 文 字 列 を 検 索 し て く だ さ い 。 こ こ で ’XXX’ は オ ペ レ ー テ ィ ン グ シ ス テ ム の 頭 字 語 (略 称 ) そ し て ’YYY’ が リ リ ー ス ID で す 。

ATT

7th, 7, III, 3, V, V.2, V.3, V.4

BSD

3, 4, 4.1, 4.2, 4.3, 4.3t, 4.3T, 4.3r, 4.3R, 4.4

NetBSD

0.8, 0.8a, 0.9, 0.9a, 1.0, 1.0a, 1.1, 1.2, 1.2a, 1.2b, 1.2c, 1.2d, 1.2e, 1.3, 1.3a, 1.4, 1.5

FreeBSD

1.0, 1.1, 1.1.5, 1.1.5.1, 2.0, 2.0.5, 2.1, 2.1.5, 2.1.6, 2.1.7, 2.2, 2.2.1, 2.2.2, 2.2.5, 2.2.6, 2.2.7, 2.2.8, 3.0, 3.1, 3.2, 3.3, 3.4, 3.5, 4.0, 4.1, 4.2, 5.0

ATT に 関 し て は 、 判 別 で き な い 第 2 パ ラ メ ー タ が あ る 時 に は そ れ を 文 字 列 UNIX に 置 き 換 え ま す 。 事 前 に 定 義 さ れ て い る そ の 他 の 頭 字 語 (略 称 ) に つ い て は 、 そ の よ う な パ ラ メ ー タ は 無 視 さ れ 、 警 告 メ ッ セ ー ジ が 出 力 さ れ ま す 。 認 識 で き な い 引 数 は 、 ペ ー ジ フ ッ タ 中 に 記 述 さ れ た 通 り に 表 示 さ れ ま す 。 例 え ば 、 典 型 的 な フ ッ タ は 次 の よ う に な る で し ょ う :

.Os BSD 4.3 は ’4.3 Berkeley Distribution’ と な り ま す 。 ま た 、 ロ ー カ ル で 作 ら れ た セ ッ ト の 例 で は 、

.Os CS Department は ’CS Department’ と な り ま す 。

’.Os’ マ ク ロ が な い 場 合 、 ペ ー ジ の 左 下 隅 は 見 苦 し く な っ て し ま う で し ょ う 。 こ の マ ク ロ は 呼 び 出 し 不 可 能 で あ り 、 構 文 解 析 も さ れ ま せ ん 。

.Dd [
⟨ 月 ⟩ ⟨ 日 ⟩ , ⟨ 年 ⟩ ]

’Dd’ に 引 数 が な い 場 合 は 、 日 付 に は ’基 準 時 点 (協 定 世 界 時 1970年 1月 1日 00:00:00)’ が 使 用 さ れ ま す 。 ち ょ う ど 3 つ 引 数 が あ る 場 合 に は 、 そ れ ら は 連 結 さ れ 、 分 割 で き な い 空 白 で 分 け ら れ た も の に な り ま す 。

.Dd January 25, 2001 そ れ 以 外 の 場 合 は 現 在 の 日 付 が 使 用 さ れ 、 パ ラ メ ー タ は 無 視 さ れ ま す 。 こ の マ ク ロ は 呼 び 出 し 不 可 能 で あ り 、 構 文 解 析 も さ れ ま せ ん 。 マ ニ ュ ア ル 領 域 お よ び 一 般 テ キ ス ト 領 域 の 紹 介 こ の 名 前 に は 何 が ... マ ニ ュ ア ル 領 域 の マ ク ロ 名 は コ マ ン ド や サ ブ ル ー チ ン 、 そ れ に 関 連 フ ァ イ ル を 説 明 す る た め に 使 わ れ て い る 日 常 の イ ン フ ォ ー マ ル な 言 葉 か ら 取 ら れ て い ま す 。 こ の 言 葉 と 少 し 違 う バ リ エ ー シ ョ ン の も の が マ ニ ュ ア ル ペ ー ジ を 書 く 上 で の 3 つ の 異 な っ た 側 面 を 記 述 す る の に 使 わ れ ま す 。 最 初 の も の は 、 −mdoc マ ク ロ 使 用 方 法 の 説 明 で す 。 2 番 目 は −mdoc マ ク ロ を 用 い た UNIX コ マ ン ド の 記 述 で す 。 3 番 目 は コ マ ン ド を 通 常 の 言 葉 の 感 覚 で ユ ー ザ に 示 し た も の で す 。 こ れ は す な わ ち 、 マ ニ ュ ア ル ペ ー ジ の テ キ ス ト 中 で の コ マ ン ド の 説 明 と な り ま す 。 最 初 の ケ ー ス で は 、 troff(1) マ ク ロ は そ れ 自 身 、 一 種 の コ マ ン ド と な っ て い ま す 。 troff コ マ ン ド は 一 般 的 に 以 下 の よ う な 形 式 を と り ま す 。

.Xx argument1 argument2 ...

’.Xx’ は マ ク ロ コ マ ン ド も し く は 要 求 を 示 し て お り 、 そ れ に 続 く も の は す べ て 処 理 さ れ る べ き 引 数 と し て 処 理 さ れ ま す 。 2 番 目 の ケ ー ス で は 、 コ ン テ ン ト マ ク ロ を 使 用 す る UNIX コ マ ン ド の 記 述 が も う 少 し 含 ま れ ま す 。 典 型 的 な SYNOPSIS コ マ ン ド 行 は こ の よ う に 表 示 さ れ ま す 。

filter [−flag] ⟨

infile ⟩ ⟨
outfile ⟩ こ こ で filter は コ マ ン ド 名 で あ り 、 角 括 弧 で 囲 ま れ た 文 字 列 −flag は フ ラ グ 引 数 で 、 こ れ は 角 括 弧 で 囲 む こ と に よ っ て オ プ シ ョ ン で あ る こ と を 示 し て い ま す 。 −mdoc の 用 語 で は 、 ⟨
infile ⟩ お よ び ⟨
outfile ⟩ は メ タ 引 数 と 称 さ れ て い ま す 。 こ の 例 で は 、 ユ ー ザ は 山 括 弧 (<>) の 中 で 与 え ら れ た メ タ 引 数 を 実 際 の フ ァ イ ル 名 に 置 き 換 え な く て は な り ま せ ん 。 こ の ド キ ュ メ ン ト で は 、 メ タ 引 数 は −mdoc コ マ ン ド を 記 述 す る の に 使 用 し て い る こ と に 注 意 し て く だ さ い 。 多 く の マ ニ ュ ア ル ペ ー ジ で は 、 メ タ 変 数 は わ ざ わ ざ 山 括 弧 を 使 っ て 書 か れ て い ま せ ん 。 上 の 例 を 整 形 し た マ ク ロ は 以 下 の も の で す 。

.Nm filter
.Op Fl flag
.Ao Ar infile Ac Ao Ar outfile Ac

3 番 目 の ケ ー ス で は 、 コ マ ン ド の 説 明 や 構 文 に 上 記 の 例 の 両 方 が 使 わ れ 、 さ ら に 細 か い 記 述 が 追 加 さ れ る で し ょ う 。 上 の 例 で の 引 数 ⟨

infile ⟩ お よ び ⟨
outfile ⟩ は オ ペ ラ ン ド も し く は フ ァ イ ル 引 数 と し て 参 照 さ れ ま す 。 コ マ ン ド 行 の 引 数 の リ ス ト は か な り 長 く な る 場 合 も あ り ま す 。

make

[−eiknqrstv] [−D variable] [−d flags] [−f makefile] [−I directory] [−j max_jobs] [variable=value] [target ...] こ こ で は コ マ ン ド make に つ い て 記 述 し て お り 、 makefile を フ ラ グ −f の 引 数 と し て い ま す 。 ま た オ プ シ ョ ン の フ ァ イ ル オ ペ ラ ン ド で あ る target に つ い て も 言 及 し て い ま す 。 言 葉 で の 説 明 で は 、 こ う い っ た 詳 細 な 記 述 が 混 乱 を 防 い で く れ ま す が 、 −mdoc パ ッ ケ ー ジ に は フ ラ グ へ の 引 数 の た め の マ ク ロ が あ り ま せ ん 。 そ の 代 わ り に target の よ う な オ ペ ラ ン ド や フ ァ イ ル 引 数 に 使 わ れ る 引 数 マ ク ロ ’Ar’ が variable の よ う な フ ラ グ へ の 引 数 と 同 様 に 使 わ れ ま す 。 こ の make コ マ ン ド 行 は 次 の 指 定 に よ り 生 成 さ れ て い ま す 。

.Nm make
.Op Fl eiknqrstv
.Op Fl D Ar variable
.Op Fl d Ar flags
.Op Fl f Ar makefile
.Op Fl I Ar directory
.Op Fl j Ar max_jobs
.Op Ar variable Ns = Ns Ar value
.Bk
.Op Ar target ...
.Ek マ ク ロ ’.Bk’ お よ び ’.Ek’ は キ ー プ セ ク シ ョ ン に お い て 解 説 さ れ て い ま す 。 一 般 的 な 構 文 マ ニ ュ ア ル 領 域 の マ ク ロ と 一 般 テ キ ス ト 領 域 の マ ク ロ と は い く つ か 小 さ な 違 い が あ る も の の 、 同 様 な 構 文 を 使 用 し て い ま す 。 と り わ け 、 ’.Ar’, ’.Fl’, ’.Nm’, お よ び ’.Pa’ は 引 数 な し で 呼 び 出 さ れ た 時 の 違 い し か あ り ま せ ん 。 ま た 、 ’.Fn’ お よ び ’.Xr’ は 引 数 の リ ス ト の 順 番 が 異 な り ま す 。 す べ て の コ ン テ ン ト マ ク ロ が 句 読 点 を 認 識 し 、 そ れ を 正 し く 扱 う に は 、 各 々 の 句 読 点 文 字 が 先 行 す る 空 白 で 分 離 さ れ て い る 必 要 が あ り ま す 。 次 の よ う に 指 定 さ れ て い る 場 合 、

.Ar sptr, ptr), そ の 結 果 は 以 下 の よ う に な り ま す 。

sptr, ptr), こ こ で は 句 読 点 は 認 識 さ れ ず 、 す べ て の 出 力 は ’.Ar’ で 使 用 さ れ る フ ォ ン ト で 行 わ れ て い ま す 。 句 読 点 が 空 白 文 字 で 区 切 ら れ て い る 場 合 、

.Ar sptr , ptr ) , 結 果 は 以 下 の よ う に な り ま す 。

sptr, ptr), 今 度 は 句 読 点 が 認 識 さ れ 、 出 力 は デ フ ォ ル ト の フ ォ ン ト で 行 わ れ 引 数 文 字 列 と は 区 別 さ れ て い ま す 。 句 読 点 文 字 の 特 別 な 意 味 を 取 り 除 く に は 、 ’\&’ で エ ス ケ ー プ し て く だ さ い 。

troff は マ ク ロ 言 語 と し て の 限 界 か ら 、 以 下 の よ う な 、 数 学 、 論 理 学 、 引 用 符 の 集 合 の メ ン バ を 含 ん だ 文 字 列 を 表 現 す る の は 困 難 で す 。

{+,−,/,*,%,<,>,<=,>=,=,==,&,’,’,"} 問 題 な の は 、 文 字 に よ っ て 示 唆 さ れ て い る 操 作 も し く は 評 価 が 、 実 行 さ れ る べ き で あ る とtroff が 仮 定 す る 場 合 が あ る こ と で す 。 こ れ ら の 文 字 が 予 期 し な い 形 で 評 価 さ れ な い よ う に す る に は 、 ’\&’ で こ れ ら を エ ス ケ ー プ し て く だ さ い 。 最 初 の コ ン テ ン ト マ ク ロ は 、 以 下 の ’.Ad’ に お い て 、 そ の 典 型 的 な 構 文 が 示 さ れ て い ま す 。 マ ニ ュ ア ル 領 域 ア ド レ ス ア ド レ ス マ ク ロ は ア ド レ ス の 構 成 を 識 別 し ま す 。 使 い 方 : .Ad ⟨ ア ド レ ス ⟩ ...

.Ad addr1

addr1

.Ad addr1 .

addr1.

.Ad addr1 , file2

addr1, file2

.Ad f1 , f2 , f3 :

f1, f2, f3:

.Ad addr ) ) ,

addr)), デ フ ォ ル ト の 文 字 幅 は 12n で す 。 作 者 名

’.An’ マ ク ロ は 文 書 化 さ れ て い る 項 目 の 作 者 の 名 前 、 も し く は 実 際 の マ ニ ュ ア ル ペ ー ジ の 作 者 の 名 前 を 指 定 す る た め に 使 わ れ ま す 。 使 い 方 : .An ⟨ 作 者 名 ⟩ ...

.An "Joe Author"

Joe Author

.An "Joe Author" ,

Joe Author,

.An "Joe Author" Aq nobody [AT] FreeBSD.org

Joe Author <nobody [AT] FreeBSD.org>

.An "Joe Author" ) ) ,

Joe Author)), デ フ ォ ル ト の 文 字 幅 は 12n で す 。

AUTHORS セ ク シ ョ ン で は 、 ’.An’ リ ク エ ス ト は 改 行 を 引 き 起 こ し 、 新 し い 名 前 が そ れ ぞ れ の 行 に 表 示 さ れ ま す 。 こ の 動 作 が 望 ま し く な い 場 合 、

.An -nosplit を 呼 び 出 す こ と で 無 効 に で き ま す 。 そ れ ぞ れ の 行 に 表 示 さ せ る 動 作 に 戻 し た い 場 合 は 、

.An -split と 記 述 し ま す 。 引 数 引 数 マ ク ロ .Ar は コ マ ン ド 行 の 引 数 を 参 照 す る 際 に は い つ で も 使 用 す る こ と が で き ま す 。 引 数 な し で 呼 ば れ た 場 合 、 ’file ...’ が 出 力 に な り ま す 。 使 い 方 : .Ar [

⟨ 引 数 ⟩ ] ...

.Ar

file ...

.Ar file1

file1

.Ar file1 .

file1.

.Ar file1 file2

file1 file2

.Ar f1 f2 f3 :

f1 f2 f3:

.Ar file ) ) ,

file)), デ フ ォ ル ト 幅 は 12n で す 。 コ ン フ ィ ギ ュ レ ー シ ョ ン 宣 言 (セ ク シ ョ ン 4 の み )

’.Cd’ マ ク ロ は セ ク シ ョ ン 4 の マ ニ ュ ア ル に お い て 、 デ バ イ ス イ ン タ フ ェ ー ス の config(8) に よ る 宣 言 の 説 明 に 使 わ れ ま す 。 使 い 方 : .Cd ⟨ 引 数 ⟩ ...

.Cd "device le0 at scode?"

device le0 at scode?

SYNOPSIS セ ク シ ョ ン で は ’.Cd’ リ ク エ ス ト は そ の 引 数 が 表 示 さ れ る 前 後 で 改 行 を 入 れ ま す 。 デ フ ォ ル ト 幅 は 12n で す 。 コ マ ン ド 修 飾 子 コ マ ン ド 修 飾 子 は ’.Cm’ マ ク ロ が す べ て の 引 数 の 前 に ダ ッ シ ュ 文 字 を 付 け な い こ と を 除 い て 、 ’.Fl’ (フ ラ グ ) コ マ ン ド と 同 じ で す 。 伝 統 的 に フ ラ グ は ダ ッ シ ュ 文 字 に 引 き 続 い て 指 定 さ れ ま す が 、 こ の 方 法 を 使 わ な い コ マ ン ド や コ マ ン ド の サ ブ セ ッ ト も あ り ま す 。 コ マ ン ド 修 飾 子 は エ デ ィ タ コ マ ン ド の よ う な 対 話 的 な コ マ ン ド で も 指 定 さ れ る こ と が あ り ま す 。 フ ラ グ セ ク シ ョ ン を 参 照 し て く だ さ い 。 デ フ ォ ル ト 幅 は 10n で す 。 定 義 済 み の 変 数 イ ン ク ル ー ド フ ァ イ ル に お い て 定 義 さ れ て い る 変 数 (も し く は 定 数 ) は マ ク ロ ’.Dv’ に よ っ て 指 定 し ま す 。 使 い 方 : .Dv ⟨ 定 義 済 み の 変 数 ⟩ ...

.Dv MAXHOSTNAMELEN

MAXHOSTNAMELEN

.Dv TIOCGPGRP )

TIOCGPGRP) デ フ ォ ル ト 幅 は 12n で す 。

errno
’.Er’ errno マ ク ロ は 、 セ ク シ ョ ン 2, 3, 9 の ラ イ ブ ラ リ ル ー チ ン に お け る エ ラ ー の 戻 り 値 を 指 定 し ま す 。 下 記 の 2 番 目 の 例 で は ’.Er’ は 一 般 テ キ ス ト 領 域 マ ク ロ で あ る ’.Bq’ (こ れ は セ ク シ ョ ン 2 の マ ニ ュ ア ル ペ ー ジ で 使 わ れ て い ま す ) と 共 に 使 わ れ て い ま す 。 使 い 方 : .Er ⟨

errno の タ イ プ ⟩ ...

.Er ENOENT

ENOENT

.Er ENOENT ) ;

ENOENT);

.Bq Er ENOTDIR

[ENOTDIR] デ フ ォ ル ト 幅 は 17n で す 。 環 境 変 数

’.Ev’ マ ク ロ は 環 境 変 数 を 指 定 し ま す 。 使 い 方 : .Ev ⟨ 引 数 ⟩ ...

.Ev DISPLAY

DISPLAY

.Ev PATH .

PATH.

.Ev PRINTER ) ) ,

PRINTER)), デ フ ォ ル ト 幅 は 15n で す 。 フ ラ グ

’.Fl’ マ ク ロ は コ マ ン ド 行 の フ ラ グ を 扱 い ま す 。 フ ラ グ の 前 に は ダ ッ シ ュ ’−’ が 挿 入 さ れ ま す 。 ダ ッ シ ュ が つ か な い 対 話 的 な コ マ ン ド の た め に ’.Cm’ (コ マ ン ド 修 飾 子 ) マ ク ロ が 用 意 さ れ て い ま す 。 こ れ は ダ ッ シ ュ を 付 け な い こ と を 除 い て 同 じ 働 き を し ま す 。 使 い 方 : .Fl ⟨ 引 数 ⟩ ...

.Fl

−

.Fl cfv

−cfv

.Fl cfv .

−cfv.

.Cm cfv .

cfv.

.Fl s v t

−s −v −t

.Fl − ,

−−,

.Fl xyz ) ,

−xyz),

.Fl |

− | 引 数 な し で ’.Fl’ マ ク ロ を 指 定 す る と 、 標 準 入 力 /標 準 出 力 を 意 味 す る ダ ッ シ ュ と な り ま す 。 ’.Fl’ マ ク ロ に ダ ッ シ ュ を 1 つ 与 え る と 、 2 つ の ダ ッ シ ュ と な る こ と に 注 意 し て 下 さ い 。 デ フ ォ ル ト 幅 は 12n で す 。 関 数 の 宣 言

’.Fd’ マ ク ロ は SYNOPSIS セ ク シ ョ ン に お い て 、 セ ク シ ョ ン 2 ま た は 3 の 関 数 の 説 明 で 使 わ れ ま す 。 こ の マ ク ロ は 呼 び 出 し 不 可 能 で あ り 、 構 文 解 析 も さ れ せ ん 。 使 い 方 : .Fd ⟨ 引 数 ⟩ ...

.Fd "#include <sys/types.h>"

#include <sys/types.h>

SYNOPSIS セ ク シ ョ ン で は 、 関 数 が す で に 示 さ れ て お り 、 改 行 が ま だ さ れ て い な い 場 合 に は ’.Fd’ リ ク エ ス ト は 改 行 を 入 れ ま す 。 こ れ に よ っ て 前 の 関 数 呼 び 出 し と 次 の 関 数 の 宣 言 の 間 に 最 適 な 行 間 が 設 定 さ れ ま す 。

’.In’ (#include 文 ) マ ク ロ は 、 以 上 の 例 を 短 く 記 述 し た も の で す 。 こ の マ ク ロ は C プ ロ グ ラ ム 中 で イ ン ク ル ー ド さ れ る C ヘ ッ ダ フ ァ イ ル を 指 定 し ま す 。 こ の マ ク ロ も 改 行 を 挿 入 し 、 呼 び 出 し 不 可 能 で あ り 、 構 文 解 析 さ れ る こ と も あ り ま せ ん 。 使 い 方 : .In ⟨ ヘ ッ ダ フ ァ イ ル ⟩

.In stdio.h

<stdio.h> 関 数 の 型 こ の マ ク ロ は SYNOPSIS セ ク シ ョ ン で 使 う も の で す 。 マ ニ ュ ア ル ペ ー ジ 中 の 他 の 場 所 で も 問 題 な く 使 う こ と が で き ま す が 、 セ ク シ ョ ン 2 と 3 の SYNOPSIS セ ク シ ョ ン に お い て カ ー ネ ル の 通 常 の 形 式 で 関 数 の 型 を 示 す こ と が こ の マ ク ロ の 目 的 で す (こ の マ ク ロ は 関 数 名 が 次 の 行 に 置 か れ る よ う に 改 行 を 挿 入 し ま す )。 使 い 方 : .Ft ⟨ 型 ⟩ ...

.Ft struct stat

struct stat 関 数 (ラ イ ブ ラ リ ル ー チ ン )

’.Fn’ マ ク ロ は ANSI C の 記 法 を 規 範 と し て い ま す 。 使 い 方 : .Fn ⟨ 関 数 ⟩ [

⟨ パ ラ メ ー タ ⟩ ] ...

.Fn getchar

getchar()

.Fn strlen ) ,

strlen()),

.Fn align "char *ptr" ,

align(char *ptr), 他 の マ ク ロ を 呼 び 出 す と ’.Fn’ 呼 び 出 し の 終 了 を 意 味 す る こ と に 注 意 し て く だ さ い (閉 じ 括 弧 が そ の 箇 所 に 挿 入 さ れ ま す )。 多 く の パ ラ メ ー タ を と る 関 数 (こ れ は 滅 多 に な い こ と で す が ) で は 、 ’.Fo’ マ ク ロ (関 数 マ ク ロ の 開 始 ) と ’.Fc’ マ ク ロ (関 数 マ ク ロ の 終 了 ) を ’.Fa’ (関 数 の 引 数 ) と 共 に 使 っ て 、 こ の 制 限 を 回 避 す る こ と が で き ま す 。 使 用 例 :

.Ft int
.Fo res_mkquery
.Fa "int op"
.Fa "char *dname"
.Fa "int class"
.Fa "int type"
.Fa "char *data"
.Fa "int datalen"
.Fa "struct rrec *newrr"
.Fa "char *buf"
.Fa "int buflen"
.Fc 生 成 結 果 :

int

res_mkquery(int op, char *dname, int class, int type, char *data, int datalen, struct rrec *newrr, char *buf, int buflen)

SYNOPSIS セ ク シ ョ ン で は 、 関 数 は 常 に 行 の 先 頭 か ら 開 始 さ れ ま す 。 SYNOPSIS セ ク シ ョ ン に お い て 複 数 の 関 数 が 示 さ れ て お り 、 関 数 の 型 が 示 さ れ な い 場 合 、 改 行 が 挿 入 さ れ 、 現 在 の 関 数 名 と そ の 前 の 関 数 名 の 間 に 最 適 な 改 行 量 が 設 定 さ れ ま す 。

’.Fn’ お よ び ’.Fo’ の デ フ ォ ル ト 幅 の 値 は そ れ ぞ れ 12n と 16n で す 。 関 数 の 引 数
’.Fa’ マ ク ロ は 関 数 の 引 数 (パ ラ メ ー タ ) を マ ニ ュ ア ル の SYNOPSIS の セ ク シ ョ ン 外 で 参 照 す る 場 合 、 あ る い は ’.Fn’ の 代 わ り に ’.Fo’ お よ び ’.Fc’ 囲 い マ ク ロ を 使 用 し た 場 合 に は SYNOPSIS の セ ク シ ョ ン 内 で 参 照 す る 場 合 に も 使 わ れ ま す 。 ’.Fa’ は 構 造 体 の メ ン バ を 参 照 す る 場 合 に も 使 わ れ ま す 。 使 い 方 : .Fa ⟨ 関 数 の 引 数 ⟩ ...

.Fa d_namlen ) ) ,

d_namlen)),

.Fa iov_len

iov_len デ フ ォ ル ト 幅 は 12n で す 。 戻 り 値

’.Rv’ マ ク ロ は RETURN VALUES の セ ク シ ョ ン で 使 う テ キ ス ト を 生 成 し ま す 。 使 い 方 : .Rv [

-std ] [⟨ 関 数 ⟩ ...] 例 え ば 、 ’.Rv -std atexit’ は 次 の テ キ ス ト を 生 成 し ま す 。

The atexit() function returns the value 0 if successful; otherwise the value -1 is returned and the global variable errno is set to indicate the error.

−std オ プ シ ョ ン は セ ク シ ョ ン 2 と 3 の マ ニ ュ ア ル ペ ー ジ で の み 有 効 で す 。 現 在 の と こ ろ 、 こ の マ ク ロ は −std フ ラ グ な し で 使 用 し て も 何 も 起 こ り ま せ ん 。 終 了 ス テ ー タ ス
’.Ex’ マ ク ロ は DIAGNOSTICS の セ ク シ ョ ン で 使 う テ キ ス ト を 生 成 し ま す 。 使 い 方 : .Ex [

-std ] [⟨ ユ ー テ ィ リ テ ィ ⟩ ...] 例 え ば ’.Ex -std cat’ は 次 の テ キ ス ト を 生 成 し ま す 。

The cat utility exits 0 on success, and >0 if an error occurs.

−std オ プ シ ョ ン は セ ク シ ョ ン 1 と 6 と 8 の マ ニ ュ ア ル ペ ー ジ で の み 有 効 で す 。 現 在 の と こ ろ 、 こ の マ ク ロ は −std フ ラ グ な し で 使 用 し て も 何 も 起 こ り ま せ ん 。 対 話 的 な コ マ ン ド
’.Ic’ マ ク ロ は 対 話 的 な コ マ ン ド 、 も し く は 内 部 コ マ ン ド を 指 定 し ま す 。 使 い 方 : .Ic ⟨ 引 数 ⟩ ...

.Ic :wq : wq
.Ic "do while {...}"

do while {...}

.Ic setenv , unsetenv

setenv, unsetenv デ フ ォ ル ト 幅 は 12n で す 。 ラ イ ブ ラ リ 名

’.Lb’ マ ク ロ は 、 関 数 が ど の ラ イ ブ ラ リ に 組 み 込 ま れ る か を 指 定 し ま す 。 使 い 方 : .Lb ⟨ 引 数 ⟩ ...

’.Lb’ マ ク ロ に 対 し て 使 用 可 能 な 引 数 と 結 果 は 次 の 通 り で す :

libarm32

ARM32 Architecture Library (libarm32, −larm32)

libc

Standard C Library (libc, −lc)

libcompat

Compatibility Library (libcompat, −lcompat)

libcrypt

Crypt Library (libcrypt, −lcrypt)

libcurses

Curses Library (libcurses, −lcurses)

libedit

Command Line Editor Library (libedit, −ledit)

libi386

i386 Architecture Library (libi386, −li386)

libipsec

IPsec Policy Control Library (libipsec, −lipsec)

libkvm

Kernel Data Access Library (libkvm, −lkvm)

libm

Math Library (libm, −lm)

libmenu

Curses Menu Library (libmenu, −lmenu)

libossaudio

OSS Audio Emulation Library (libossaudio, −lossaudio)

libposix

POSIX Compatibility Library (libposix, −lposix)

libresolv

DNS Resolver Library (libresolv, −lresolv)

libtermcap

Termcap Access Library (libtermcap, −ltermcap)

libutil

System Utilities Library (libutil, −lutil)

libz

Compression Library (libz, −lz) ロ ー カ ル な 追 加 項 目 や OS 特 有 の 追 加 項 目 が 、 フ ァ イ ル mdoc.local に あ る か も し れ ま せ ん 。 ’str-Lb-XXX’ と い う 名 前 の 文 字 列 を 検 索 し て く だ さ い 。 こ こ で ’XXX’ は ’.Lb’ マ ク ロ と と も に 使 用 さ れ る キ ー ワ ー ド を 示 し て い ま す 。 リ テ ラ ル リ テ ラ ル マ ク ロ ’.Li’ は 特 殊 文 字 や 変 数 定 数 、 そ の 他 タ イ プ さ れ た 通 り に 表 示 す る 必 要 が あ る も の に 使 用 す る こ と が で き ま す 。 使 い 方 : .Li ⟨ 引 数 ⟩ ...

.Li \en

\n

.Li M1 M2 M3 ;

M1 M2 M3;

.Li cntrl-D ) ,

cntrl-D),

.Li 1024 ...

1024 ... デ フ ォ ル ト 幅 は 16n で す 。 名 称

’.Nm’ マ ク ロ は 文 書 の タ イ ト ル や サ ブ ジ ェ ク ト 名 を 指 定 す る た め に 使 わ れ ま す 。 こ の マ ク ロ は 呼 び 出 さ れ た 時 の 第 1 引 数 を 覚 え て お く と い う 変 わ っ た 特 性 を 持 っ て お り 、 そ れ は 常 に そ の ペ ー ジ の サ ブ ジ ェ ク ト 名 で あ る べ き で す 。 引 数 な し で 呼 び 出 さ れ る と ’.Nm’ は 作 者 の た め に 最 低 限 の 仕 事 を す る と い う 意 味 で 、 こ の 初 期 化 さ れ た 名 称 を 出 力 し ま す 。 注 : セ ク シ ョ ン 2 ま た は 3 の ド キ ュ メ ン ト の 関 数 名 は NAME セ ク シ ョ ン に お い て ’.Nm’ で 指 定 さ れ 、 SYNOPSIS セ ク シ ョ ン や 残 り の セ ク シ ョ ン で は ’.Fn’ で 指 定 さ れ ま す 。 csh(1) で の ’while’ コ マ ン ド の キ ー ワ ー ド の よ う な 対 話 的 な コ マ ン ド で は ’.Ic’ マ ク ロ を 使 う 必 要 が あ り ま す 。 ’.Ic’ は ほ と ん ど ’.Nm’ と 同 一 で す が 、 そ れ が 使 わ れ た と き の 第 1 引 数 を 記 憶 す る こ と は で き ま せ ん 。 使 い 方 : .Nm [

⟨ 引 数 ⟩ ] ...

.Nm groff_mdoc

groff_mdoc

.Nm \-mdoc

−mdoc

.Nm foo ) ) ,

foo)),

.Nm :

groff_mdoc: デ フ ォ ル ト 幅 は 10n で す 。 オ プ シ ョ ン

’.Op’ マ ク ロ は コ マ ン ド 行 の 残 り の す べ て の 引 数 を オ プ シ ョ ン で あ る こ と を 示 す 角 括 弧 で 囲 み 、 末 尾 の 句 読 点 は 角 括 弧 の 外 に 置 き ま す 。 ’.Oo’ マ ク ロ と ’.Oc’ マ ク ロ (そ れ ぞ れ 開 き 角 括 弧 と 閉 じ 角 括 弧 を 生 成 し ま す ) は 複 数 行 に 渡 っ て 使 う こ と が で き 、 ま た 閉 じ 括 弧 の 正 確 な 位 置 を 指 定 す る の に 使 う こ と が で き ま す 。 使 い 方 : .Op [

⟨ オ プ シ ョ ン ⟩ ] ...

.Op

[]

.Op Fl k

[−k]

.Op Fl k ) .

[−k]).

.Op Fl k Ar kookfile

[−k kookfile]

.Op Fl k Ar kookfile ,

[−k kookfile],

.Op Ar objfil Op Ar corfil

[objfil [corfil]]

.Op Fl c Ar objfil Op Ar corfil ,

[−c objfil [corfil]],

.Op word1 word2

[word1 word2]

.Li .Op Oo Ao option Ac Oc ...

.Op [

⟨
options⟩ ] ... こ れ は 、 ’.Oo’ マ ク ロ と ’.Oc’ マ ク ロ を 使 っ た 典 型 的 な 例 で す :

.Oo
.Op Fl k Ar kilobytes
.Op Fl i Ar interval
.Op Fl c Ar count
.Oc 出 力 結 果 :

[

[−k kilobytes] [−i interval] [−c count] ]

’.Op’ マ ク ロ お よ び ’.Oo’ マ ク ロ の デ フ ォ ル ト 幅 は そ れ ぞ れ 14n と 10n で す 。 パ ス 名
’.Pa’ マ ク ロ は パ ス 名 も し く は フ ァ イ ル 名 を 整 形 し ま す 。 引 数 な し で 呼 ば れ た 場 合 、 ’~’ 文 字 列 が 出 力 と な り 、 こ れ は 現 在 の ユ ー ザ の ホ ー ム デ ィ レ ク ト リ を 表 し て い ま す 。 使 い 方 : .Pa [

⟨ パ ス 名 ⟩ ] ...

.Pa

~

.Pa /usr/share

/usr/share

.Pa /tmp/fooXXXXX ) .

/tmp/fooXXXXX). デ フ ォ ル ト 幅 は 32n で す 。 規 格

’.St’ マ ク ロ は 、 規 格 の 短 縮 名 称 を 正 式 名 称 に 置 換 し ま す 。 使 い 方 : .St ⟨ 短 縮 名 称 ⟩ ... 使 用 可 能 な ’’短 縮 名 称 /正 式 名 称 ’’ の 組 は 次 の 通 り で す :

ANSI/ISO C

-ansiC

ANSI X3.159-1989 (’’ANSI C89’’)

-ansiC-89

ANSI X3.159-1989 (’’ANSI C89’’)

-isoC

ISO/IEC 9899:1990 (’’ISO C90’’)

-isoC-99

ISO/IEC 9899:1999 (’’ISO C99’’)

POSIX パ ー ト 1: System API

-iso9945-1-90

ISO/IEC 9945-1:1990 (’’POSIX.1’’)

-iso9945-1-96

ISO/IEC 9945-1:1996 (’’POSIX.1’’)

-p1003.1

IEEE Std 1003.1 (’’POSIX.1’’)

-p1003.1-88

IEEE Std 1003.1-1988 (’’POSIX.1’’)

-p1003.1-90

ISO/IEC 9945-1:1990 (’’POSIX.1’’)

-p1003.1-96

ISO/IEC 9945-1:1996 (’’POSIX.1’’)

-p1003.1b-93

IEEE Std 1003.1b-1993 (’’POSIX.1’’)

-p1003.1c-95

IEEE Std 1003.1c-1995 (’’POSIX.1’’)

-p1003.1g-2000

IEEE Std 1003.1g-2000 (’’POSIX.1’’)

-p1003.1i-95

IEEE Std 1003.1i-1995 (’’POSIX.1’’)

POSIX パ ー ト 2: シ ェ ル と ユ ー テ ィ リ テ ィ

-iso9945-2-93

ISO/IEC 9945-2:1993 (’’POSIX.2’’)

-p1003.2

IEEE Std 1003.2 (’’POSIX.2’’)

-p1003.2-92

IEEE Std 1003.2-1992 (’’POSIX.2’’)

-p1003.2a-92

IEEE Std 1003.2a-1992 (’’POSIX.2’’)

X/Open

-susv2

Version 2 of the Single UNIX Specification (’’SUSv2’’)

-svid4

System V Interface Definition, Fourth Edition (’’SVID4’’)

-xbd5

X/Open Base Definitions Issue 5 (’’XBD5’’)

-xcu5

X/Open Commands and Utilities Issue 5 (’’XCU5’’)

-xcurses4.2

X/Open Curses Issue 4, Version 2 (’’XCURSES4.2’’)

-xns5

X/Open Networking Services Issue 5 (’’XNS5’’)

-xns5.2

X/Open Networking Services Issue 5.2 (’’XNS5.2’’)

-xpg3

X/Open Portability Guide Issue 3 (’’XPG3’’)

-xpg4

X/Open Portability Guide Issue 4 (’’XPG4’’)

-xpg4.2

X/Open Portability Guide Issue 4, Version 2 (’’XPG4.2’’)

-xsh5

X/Open System Interfaces and Headers Issue 5 (’’XSH5’’) そ の 他

-ieee754

IEEE Std 754-1985

-iso8802-3

ISO/IEC 8802-3:1989 変 数 の 型

’.Vt’ マ ク ロ は 型 を 参 照 す る と き に は い つ で も 使 用 す る こ と が で き ま す 。 SYNOPSIS セ ク シ ョ ン で は 改 行 が 挿 入 さ れ ま す (古 い ス タ イ ル の 変 数 宣 言 で は 便 利 で す )。 使 い 方 : .Vt ⟨ 型 ⟩ ...

.Vt extern char *optarg ;

extern char *optarg;

.Vt FILE *

FILE * 変 数 一 般 的 な 変 数 へ の 参 照 で す 。 使 い 方 : .Va ⟨ 変 数 ⟩ ...

.Va count

count

.Va settimer ,

settimer,

.Va "int *prt" ) :

int *prt):

.Va "char s" ] ) ) ,

char s])), デ フ ォ ル ト 幅 は 12n で す 。 マ ニ ュ ア ル ペ ー ジ の ク ロ ス リ フ ァ レ ン ス

’.Xr’ マ ク ロ は 最 初 の 引 数 に マ ニ ュ ア ル ペ ー ジ の 名 称 を と り ま す 。 オ プ シ ョ ン で あ る 第 2 引 数 は 、 文 字 列 (マ ニ ュ ア ル セ ク シ ョ ン を 定 義 し ま す ) で あ れ ば 括 弧 で 囲 わ れ ま す 。 使 い 方 : .Xr ⟨ マ ニ ュ ア ル ペ ー ジ の 名 称 ⟩ [

⟨ セ ク シ ョ ン ⟩ ] ...

.Xr mdoc

mdoc

.Xr mdoc ,

mdoc,

.Xr mdoc 7

mdoc(7)

.Xr xinit 1x ;

xinit(1x); デ フ ォ ル ト 幅 は 10n で す 。 一 般 テ キ ス ト 領 域

AT&T マ ク ロ 使 い 方 : .At [

⟨ バ ー ジ ョ ン ⟩ ] ...

.At

AT&T UNIX

.At v6 .

Version 6 AT&T UNIX.

⟨ バ ー ジ ョ ン ⟩ に は 次 の 値 を と る こ と が で き ま す :

32v, v1, v2, v3, v4, v5, v6, v7, V, V.1, V.2, V.3, V.4

BSD マ ク ロ 使 い 方 : .Bx {

-alpha | -beta | -devel} ...

.Bx [

⟨ バ ー ジ ョ ン ⟩ [
⟨ リ リ ー ス ⟩ ] ] ...

.Bx

BSD

.Bx 4.3 .

4.3BSD.

.Bx −devel

BSD (currently under development)

⟨ バ ー ジ ョ ン ⟩ が 文 字 列 ’BSD’ の 前 に つ き ま す 。 ⟨ リ リ ー ス ⟩ に は 次 の 値 を と る こ と が で き ま す :

Reno, reno, Tahoe, tahoe, Lite, lite, Lite2, lite2

NetBSD マ ク ロ 使 い 方 : .Nx [

⟨ バ ー ジ ョ ン ⟩ ] ...

.Nx

NetBSD

.Nx 1.4 .

NetBSD 1.4.

⟨ バ ー ジ ョ ン ⟩ に と り 得 る 値 に つ い て は 前 述 の タ イ ト ル マ ク ロ セ ク シ ョ ン の ’.Os’ リ ク エ ス ト の 説 明 を 参 照 し て く だ さ い 。

FreeBSD マ ク ロ 使 い 方 : .Fx [

⟨ バ ー ジ ョ ン ⟩ ] ...

.Fx

FreeBSD

.Fx 2.2 .

FreeBSD 2.2.

⟨ バ ー ジ ョ ン ⟩ に と り 得 る 値 に つ い て は 前 述 の タ イ ト ル マ ク ロ セ ク シ ョ ン の ’.Os’ リ ク エ ス ト の 説 明 を 参 照 し て く だ さ い 。

OpenBSD マ ク ロ 使 い 方 : .Ox [

⟨ バ ー ジ ョ ン ⟩ ] ...

.Ox 1.0

OpenBSD 1.0

BSD/OS マ ク ロ 使 い 方 : .Bsx [

⟨ バ ー ジ ョ ン ⟩ ] ...

.Bsx 1.0

BSD/OS 1.0

UNIX マ ク ロ 使 い 方 : .Ux ...

.Ux

UNIX 強 調 マ ク ロ テ キ ス ト は ’.Em’ マ ク ロ を 用 い て 強 調 す る こ と が で き ま す 。 通 常 強 調 に 用 い ら れ る フ ォ ン ト は イ タ リ ッ ク 体 で す 。 使 い 方 : .Em ⟨ 引 数 ⟩ ...

.Em does not

does not

.Em exceed 1024 .

exceed 1024.

.Em vide infra ) ) ,

vide infra)), デ フ ォ ル ト 幅 は 10n で す 。 フ ォ ン ト モ ー ド

’.Bf’ フ ォ ン ト モ ー ド は ’.Ef’ マ ク ロ で 終 了 し な く て は な り ま せ ん (後 者 の マ ク ロ は 引 数 を と り ま せ ん )。 フ ォ ン ト モ ー ド は 別 の フ ォ ン ト モ ー ド 内 に 入 れ 子 に で き ま す 。

’.Bf’ は 次 の 文 法 を も っ て い ま す :

.Bf ⟨ フ ォ ン ト モ ー ド ⟩

⟨ フ ォ ン ト モ ー ド ⟩ は 次 の 3 種 類 の う ち の い ず れ か で な く て は な り ま せ ん 。

Em | −emphasis

’.Em’ マ ク ロ が テ キ ス ト の ブ ロ ッ ク 全 体 に 対 し て 使 用 さ れ た 場 合 と 同 じ に な り ま す 。

Li | −literal

’.Li’ マ ク ロ が テ キ ス ト の ブ ロ ッ ク 全 体 に 対 し て 使 用 さ れ た 場 合 と 同 じ に な り ま す 。

Sy | −symbolic

’.Sy’ マ ク ロ が テ キ ス ト の ブ ロ ッ ク 全 体 に 対 し て 使 用 さ れ た 場 合 と 同 じ に な り ま す 。 い ず れ の マ ク ロ も 呼 び 出 し 不 可 能 で あ り 、 構 文 解 析 も さ れ ま せ ん 。 囲 い /ク ォ ー ト マ ク ロ 囲 い の 概 念 は ク ォ ー ト と 似 た も の で す 。 1 つ 以 上 の 文 字 列 が 引 用 符 や 括 弧 の よ う な 文 字 の ペ ア で 囲 ま れ て い る オ ブ ジ ェ ク ト を 指 し ま す 。 ク ォ ー ト と 囲 い と い う 用 語 は こ の 文 書 を 通 し て 同 じ 意 味 で 使 わ れ ま す 。 ほ と ん ど の 1 行 の 囲 い マ ク ロ は ク ォ ー ト で あ る こ と を ほ の め か す た め に 、 小 文 字 の ’q’ で 終 了 し ま す が 、 例 外 も い く つ か あ り ま す 。 各 々 の 囲 い マ ク ロ に 対 し 、 開 始 マ ク ロ と 終 了 マ ク ロ の ペ ア も あ り 、 そ れ ぞ れ 小 文 字 の ’o’ と ’c’ で 終 了 し ま す 。 ク ォ ー ト開 始 終 了 機 能 結 果

string⟩

.Bq

string]

.Brq

string}

.Dq

string’’

.Eq

string)

.Ql

string’ も し く は string

.Qq

string"

.Sq

string’

’q’ お よ び ’o’ で 終 わ る マ ク ロ は す べ て デ フ ォ ル ト 幅 が 12n で す 。

.Eo, .Ec こ れ ら の マ ク ロ は そ れ ぞ れ 第 1 引 数 に 囲 い 始 め に 使 う 文 字 列 と 囲 い 終 わ り に 使 う 文 字 列 を と り ま す 。

.Es, .En オ リ ジ ナ ル の troff プ ロ グ ラ ム で は 、 引 数 の 数 が 9 つ ま で と い う 制 限 が あ り ま し た の で 、 (Eo, Ec と は ) 別 の 2 つ の マ ク ロ が 実 装 さ れ て い ま す 。 現 在 は 非 推 奨 に な っ て い ま す 。 ’.Es’ は 第 1 引 数 と 第 2 引 数 に 左 囲 い 文 字 列 お よ び 右 囲 い 文 字 列 を と り ま す 。 こ の 文 字 列 は 、 ’.En’ の 引 数 を 囲 う の に 使 用 さ れ ま す 。 デ フ ォ ル ト 幅 は 、 ど ち ら の マ ク ロ も 12n で す 。

.Eq こ の マ ク ロ の 第 1、 第 2 引 数 は そ れ ぞ れ 囲 い 始 め に 使 う 文 字 列 と 囲 い 終 わ り に 使 う 文 字 列 で あ り 、 こ の 文 字 列 の 後 に 囲 わ れ る 引 数 が 続 き ま す 。

.Ql ク ォ ー ト さ れ た リ テ ラ ル マ ク ロ は troff モ ー ド と nroff モ ー ド で 違 っ た 挙 動 を し ま す 。 nroff で 整 形 さ れ た 場 合 、 ク ォ ー ト さ れ た リ テ ラ ル は 常 に ク ォ ー ト さ れ ま す 。 troff で 整 形 さ れ た 場 合 、 そ の 要 素 の 幅 が 固 定 幅 文 字 3 文 字 分 の 幅 よ り も 小 さ い と き の み ク ォ ー ト さ れ ま す 。 こ れ に よ り 、 リ テ ラ ル (固 定 幅 ) フ ォ ン ト へ フ ォ ン ト を 変 更 す る と 目 立 た な く な っ て し ま う よ う な 短 い 文 字 列 が よ り 見 や す く な り ま す 。 デ フ ォ ル ト 幅 は 16n で す 。

.Pf プ レ フ ィ ッ ク ス マ ク ロ は 第 1 引 数 と 第 2 引 数 の 間 の ホ ワ イ ト ス ペ ー ス を な く し ま す :

.Pf ( Fa name2

(name2 デ フ ォ ル ト 幅 は 12n で す 。

’.Ns’ マ ク ロ (後 述 参 照 ) は 同 じ よ う に サ フ ィ ッ ク ス に 働 き ま す 。

.Ap

’.Ap’ マ ク ロ は ア ポ ス ト ロ フ ィ を 追 加 し 、 特 別 な テ キ ス ト モ ー ド か ら 抜 け ま す 。 そ し て ’.No’ モ ー ド で 続 け ま す 。 ク ォ ー ト の 例 :

.Aq

⟨ ⟩

.Aq Pa ctype.h ) ,

⟨ ctype.h⟩ ),

.Bq

[]

.Bq Em Greek , French .

[Greek, French].

.Dq

’’’’

.Dq string abc .

’’string abc’’.

.Dq ´^[A-Z]´

’’´^[A-Z]´’’

.Ql man mdoc

’man mdoc’

.Qq

""

.Qq string ) ,

"string"),

.Qq string Ns ),

"string),"

.Sq

’’

.Sq string

’string’

.Em or Ap ing

or’ing 囲 い マ ク ロ の 入 れ 子 に つ い て の 良 い 例 に つ い て は 、 オ プ シ ョ ン マ ク ロ ’.Op’ を 参 照 し て く だ さ い 。 こ の マ ク ロ は 上 で リ ス ト さ れ て い る よ う な 囲 い マ ク ロ と 同 じ ベ ー ス の 上 に 作 ら れ て い ま す 。 ’.Xo’ と ’.Xc’ 拡 張 引 数 リ ス ト マ ク ロ に つ い て は 後 で 述 べ ま す 。 無 操 作 も し く は 通 常 テ キ ス ト マ ク ロ

’.No’ マ ク ロ は 、 マ ク ロ コ マ ン ド 行 に お い て 整 形 さ れ て は な ら な い パ ラ メ ー タ 用 に 使 用 で き ま す 。 こ の 英 単 語 (マ ク ロ で な く ) を パ ラ メ ー タ と し て 本 当 に 使 い た い 場 合 は 、 こ の 単 語 ’No’ に ’\&’ を 足 す よ う に 注 意 し て く だ さ い 。 使 い 方 : .No ⟨ 引 数 ⟩ ...

.No test Ta with Ta tabs

test with tabs デ フ ォ ル ト 幅 は 12n で す 。 空 白 な し マ ク ロ

’.Ns’ マ ク ロ は 、 現 在 の 位 置 と マ ク ロ の 第 1 パ ラ メ ー タ と の 間 に 空 白 を 挿 入 す る の を 抑 止 し ま す 。 例 え ば 、 フ ラ グ と 引 数 の 間 に 空 白 を 含 ま な い 古 い ス タ イ ル の 引 数 リ ス ト を 使 う 場 合 に 便 利 で す : 使 い 方 : ... ⟨ 引 数 ⟩ Ns [

⟨ 引 数 ⟩ ] ...

.Ns ⟨ 引 数 ⟩ ...

.Op Fl I Ns Ar directory

[−Idirectory] 注 : ’.Ns’ マ ク ロ は 他 の マ ク ロ 名 が 続 か な け れ ば 、 ス ペ ー ス を 除 去 し た あ と に ’.No’ マ ク ロ を 常 に 起 動 し ま す 。 リ ク エ ス ト と し て 使 用 さ れ る 場 合 (つ ま り 、 ’使 い 方 ’ の 行 で の 2 番 目 の 形 式 で す )、 ’.Ns’ マ ク ロ は ’.No’ と 同 一 で す 。 セ ク シ ョ ン の ク ロ ス リ フ ァ レ ン ス

’.Sx’ マ ク ロ は 同 一 文 書 内 で の セ ク シ ョ ン の ヘ ッ ダ へ の 参 照 を 指 定 し ま す 。 使 い 方 : .Sx ⟨ セ ク シ ョ ン の 参 照 ⟩ ...

.Sx FILES

FILES デ フ ォ ル ト 幅 は 16n で す 。 記 号 記 号 体 強 調 マ ク ロ は 、 記 号 の 意 味 で も 伝 統 的 な 英 語 の 使 い 方 に お い て も 通 常 は ボ ー ル ド 体 マ ク ロ と な っ て い ま す 。 使 い 方 : .Sy ⟨ 記 号 ⟩ ...

.Sy Important Notice

Important Notice デ フ ォ ル ト 幅 は 6n で す 。 数 学 記 号 数 学 記 号 や そ れ に 似 た も の に つ い て は 、 こ の マ ク ロ を 使 用 し て く だ さ い 。 使 い 方 : .Ms ⟨ 数 学 記 号 ⟩ ...

.Ms sigma

sigma デ フ ォ ル ト 幅 は 6n で す 。 参 考 文 献 と 引 用 次 の マ ク ロ は 多 少 な り と も 参 考 文 献 を 扱 え る よ う に と 意 図 し た も の で す 。 こ れ ら の マ ク ロ は 、 せ い ぜ い refer(1) ス タ イ ル の 参 考 文 献 の サ ブ セ ッ ト を 手 動 で 作 成 し や す く す る 程 度 で す 。

.Rs 参 考 文 献 の 開 始 (引 数 は と り ま せ ん )。 SEE ALSO セ ク シ ョ ン で は 改 行 を 挿 入 し 、 参 考 文 献 の 終 了 マ ク ロ が 読 み 込 ま れ る ま で 参 考 文 献 の 情 報 を 収 集 し ま す 。
.Re 参 考 文 献 の 終 了 (引 数 は と り ま せ ん )。 参 考 文 献 が 表 示 さ れ ま す 。
.%A 参 考 文 献 の 作 者 名 。 1 回 の 呼 び 出 し に つ き 、 作 者 名 を ひ と つ 指 定 し ま す 。
.%B 書 籍 の タ イ ト ル 。
.%C 市 / 場 所 (ま だ 実 装 さ れ て い ま せ ん )。
.%D 日 付 。
.%I 発 行 者 /出 版 社 名 。
.%J 定 期 刊 行 物 の 名 称 。
.%N 発 行 番 号 。
.%O 追 加 情 報 。
.%P ペ ー ジ 番 号 。
.%Q 組 織 内 部 、 あ る い は 外 部 の 著 者 。
.%R 報 告 書 の 名 称 。
.%T 記 事 の タ イ ト ル 。
.%V 巻 数 。

’%’ で 始 ま る マ ク ロ は 呼 び 出 し 不 可 能 で す が 、 通 常 の 方 法 で 複 数 の 引 数 を と る こ と が で き ま す 。 パ ラ メ ー タ と し て は ’.Tn’ マ ク ロ の み 扱 い ま す 。 そ の 他 の マ ク ロ を 使 う と 奇 妙 な 出 力 が 得 ら れ て し ま い ま す 。 ’.%B’ お よ び ’.%T’ を ’.Rs/.Re’ 環 境 の 外 側 で は 使 用 す る こ と が で き ま す 。 使 用 例 :

.Rs
.%A "Matthew Bar"
.%A "John Foo"
.%T "Implementation Notes on foobar(1)"
.%R "Technical Report ABC-DE-12-345"
.%Q "Drofnats College, Nowhere"
.%D "April 1991"
.Re 出 力 結 果

Matthew Bar

and

John Foo,
Implementation Notes on foobar(1),
Technical Report ABC-DE-12-345,
Drofnats College, Nowhere,
April 1991 . 商 標 名 (頭 字 語 と タ イ プ 名 ) 商 標 名 マ ク ロ は 、 引 数 を よ り 小 さ な フ ォ ン ト で 出 力 し ま す 。 意 図 さ れ る 使 い 方 は 、 大 文 字 の 頭 字 語 用 に 小 さ な 大 文 字 フ ォ ン ト を 似 せ て 作 る こ と で す 。 使 い 方 : .Tn ⟨ シ ン ボ ル ⟩ ...