名 前
mdoc.samples —
−mdoc を 使 っ て BSD
マ ニ ュ ア ル を
書 く た め の チ
ュ ー ト リ ア ル
サ ン プ ル 書 式
man mdoc.samples 説 明
troff(1) 用 の コ ン テ
ン ト ベ ー ス で
か つ 領 域 ベ ー
ス な フ ォ ー マ
ッ ト パ ッ ケ ー
ジ で あ る −mdoc
マ ク ロ パ ッ ケ
ー ジ を 使 っ て BSD
マ ニ ュ ア ル を
書 く た め の チ
ュ ー ト リ ア ル
サ ン プ ル で す
。 前 身 で あ る
−man(7) パ ッ ケ ー ジ
は フ ォ ン ト の
操 作 や 他 の 写
植 方 法 の 詳 細
は 個 々 の 作 者
に 任 せ た ペ ー
ジ レ イ ア ウ ト
ベ ー ス の も の
で し た 。 −mdoc
で は 、 ペ ー ジ
レ イ ア ウ ト マ
ク ロ は タ イ ト
ル 、 セ ク シ ョ
ン の ヘ ッ ダ ー
、 デ ィ ス プ レ
イ 、 リ ス ト の
マ ク ロ か ら な
る ペ ー ジ 構 造
領 域 を 形 成 し
て い ま す 。 こ
れ ら の 項 目 は
整 形 さ れ た ペ
ー ジ で の テ キ
ス ト の 物 理 的
な 位 置 に 影 響
を 持 ち ま す 。
ペ ー ジ 構 造 領
域 に 加 え 、 さ
ら に マ ニ ュ ア
ル 領 域 お よ び
一 般 テ キ ス ト
領 域 の 2 つ の 領
域 が あ り ま す
。 一 般 テ キ ス
ト 領 域 は テ キ
ス ト の 一 部 を
ク ォ ー ト し た
り 、 強 調 す る
と い っ た よ う
な 作 業 を 実 行
す る マ ク ロ と
し て 定 義 さ れ
て い ま す 。 マ
ニ ュ ア ル 領 域
は コ マ ン ド や
ル ー チ ン 、 そ
れ に BSD の 関 連 フ
ァ イ ル を 記 述
す る た め の 日
常 使 用 さ れ る
イ ン フ ォ ー マ
ル な 言 葉 の サ
ブ セ ッ ト で あ
る マ ク ロ と し
て 定 義 さ れ て
い ま す 。 マ ニ
ュ ア ル 領 域 の
マ ク ロ は コ マ
ン ド 名 、 コ マ
ン ド 行 の 引 数
と オ プ シ ョ ン
、 関 数 名 、 関
数 の パ ラ メ ー
タ ー 、 パ ス 名
、 変 数 名 、 他
の マ ニ ュ ア ル
ペ ー ジ へ の ク
ロ ス リ フ ァ レ
ン ス な ど を 扱
い ま す 。 こ れ
ら の 領 域 の 項
目 は 作 者 と マ
ニ ュ ア ル ペ ー
ジ の 将 来 の ユ
ー ザ ー の 両 者
に と っ て 価 値
の あ る も の で
す 。 マ ニ ュ ア
ル 間 で 一 貫 性
を 高 め る こ と
に よ っ て 将 来
の ド キ ュ メ ン
ト ツ ー ル へ の
移 行 が 容 易 に
な る こ と が 望
ま れ ま す 。 マ
ニ ュ ア ル の エ
ン ト リ ー は 、
実 際 の 長 さ に
関 わ ら ず 、 ま
た 男 女 の 区 別
を す る よ う な
意 図 な し で 、 UNIX
の マ ニ ュ ア ル
ペ ー ジ を 通 し
て 、 単 純 に man ペ
ー ジ と し て 参
照 さ れ て い ま
す 。 さ あ 、 始
め よ う 通 常 チ
ュ ー ト リ ア ル
ド キ ュ メ ン ト
は 、 そ こ に 示
さ れ た 題 材 を
す ぐ に 使 い た
い 時 に 読 む も
の で す の で 、
こ の ド キ ュ メ
ン ト の ユ ー ザ
ー は せ っ か ち
な 人 だ と 仮 定
し て い ま す 。
こ の ド キ ュ メ
ン ト の 残 り の
部 分 で 説 明 さ
れ て い る 題 材
は 以 下 の よ う
な 構 成 に な っ
て い ま す 。
1.
TROFF に 特 有 な 表 現 マ ク ロ の 使 用 方 法 引 数 に 空 白 文 字 を 指 定 す る 行 末 の 空 白 文 字 (警 告 ) 特 殊 文 字 の エ ス ケ ー プ
2.
MAN ペ ー ジ の 分 析 マ ニ ュ ア ル ペ ー ジ の テ ン プ レ ー ト
3. タ イ ト ル マ ク ロ
4. マ ニ ュ ア ル と 一 般 テ キ ス ト 領 域 の 紹 介 こ の 名 前 に は 何 が ...? 一 般 的 な 構 文
5. マ ニ ュ
ア ル 領 域 ア ド
レ ス 作 者 名 引
数 コ ン フ ィ ギ
ュ レ ー シ ョ ン
宣 言 (セ ク シ ョ
ン 4 の み ) コ マ ン
ド 修 飾 子 定 義
済 み の 変 数
errno (セ ク シ ョ ン 2
の み ) 環 境 変 数
関 数 の 引 数 関
数 の 宣 言 フ ラ
グ 関 数 (ラ イ ブ
ラ リ ル ー チ ン )
関 数 の 型 対 話
的 な コ マ ン ド
名 前 オ プ シ ョ
ン パ ス 名 変 数
相 互 参 照
6. 一 般 テ キ ス ト
領 域
AT&T マ ク ロ
BSD マ ク ロ
FreeBSD マ ク ロ
UNIX マ ク ロ 囲 い /ク
ォ ー ト マ ク ロ
カ ギ 括 弧 <> に
よ る ク ォ ー ト
/囲 い 角 括 弧 [] に
よ る ク ォ ー ト
/囲 い 二 重 引 用
符 マ ク ロ /囲 い
括 弧 () に よ る ク
ォ ー ト /囲 い 一
重 引 用 符 に よ
る ク ォ ー ト /囲
い プ レ フ ィ ッ
ク ス マ ク ロ
no−op も し く は 通
常 テ キ ス ト マ
ク ロ 空 白 な し
マ ク ロ セ ク シ
ョ ン の 相 互 参
照 相 互 参 照 と
引 用 返 り 値 (セ
ク シ ョ ン 2, 3 の み )
商 標 名 (頭 字 語
と タ イ プ 名 ) 拡
張 引 数
7. ペ ー ジ 構 造 領 域 セ ク シ ョ ン ヘ ッ ダ ー 段 落 と 行 ス ペ ー ス キ ー プ デ ィ ス プ レ イ フ ォ ン ト モ ー ド (強 調 、 リ テ ラ ル 、 お よ び シ ン ボ リ ッ ク ) リ ス ト と 列
8. 定 義 済 み の 文 字 列
9. 診 断
10.
GROFF、 TROFF、 NROFF を 使 用 し た フ ォ ー マ ッ テ ィ ン グ
11. バ グ
TROFF に 特 有 な 表 現
−mdoc パ
ッ ケ ー ジ は man ペ
ー ジ を 記 述 す
る プ ロ セ ス を
簡 単 に す る こ
と を 目 的 と し
て い ま す 。
−mdoc を 使 う た
め に troff(1) の ゴ タ
ゴ タ し た 詳 細
を 学 ぶ 必 要 が
な い の が 理 想
で す が 、 い く
つ か 片 付 け る
べ き 避 け ら れ
な い 制 限 事 項
が あ り ま す 。
ま た 、 こ の パ
ッ ケ ー ジ は 高
速 で な い と い
う こ と も 予 め
警 告 し て お き
ま す 。 マ ク ロ
の 使 用 方 法
troff(1) の よ う に 、
マ ク ロ は ’.’
(ド ッ ト 文 字 ) を
行 頭 に 置 き 、
そ れ に 続 け て 2
文 字 か ら な る
マ ク ロ の 名 称
を 指 定 す る こ
と に よ っ て 呼
び 出 さ れ ま す
。 引 数 は マ ク
ロ の 後 に ス ペ
ー ス で 区 切 っ
て 指 定 す る こ
と が で き ま す
。 行 頭 に ド ッ
ト 文 字 を 指 定
す る こ と に よ
っ て troff(1) に そ れ
に 続 く 2 文 字 を
マ ク ロ 名 と し
て 解 釈 す る よ
う 指 示 し て い
ま す 。 マ ク ロ
を 起 動 せ ず に
、 あ る 文 脈 の
行 の 先 頭 に ’.’
(ド ッ ト 文 字 ) を
置 く た め に は
、 ’.’ (ド ッ ト )
の 前 に エ ス ケ
ー プ シ ー ケ ン
ス ’\&’ を 指 定
し ま す 。 ’\&’
は 文 字 通 り ス
ペ ー ス 幅 が 0 と
し て 解 釈 さ れ
、 出 力 に は 現
れ ま せ ん 。 一
般 的 に troff(1) マ ク
ロ は 引 数 を 9 つ
ま で 取 る こ と
が で き 、 そ れ
以 上 指 定 さ れ
た 引 数 は 無 視
さ れ ま す 。
−mdoc で の ほ と
ん ど の マ ク ロ
は 9 つ の 引 数 を
取 る こ と が で
き 、 限 ら れ た
場 合 に の み 引
数 は 次 の 行 に
続 け て 指 定 す
る こ と が で き
ま す ( 拡 張 引
数 セ ク シ ョ ン
を 参 照 )。 い く
つ か の マ ク ロ
は 引 用 符 に 囲
ま れ た 引 数 を
扱 う こ と が で
き ま す (下 の 引
数 に 空 白 文 字
を 指 定 す る セ
ク シ ョ ン を 参
照 )。
−mdoc で の 一 般 テ キ ス ト 領 域 と マ ニ ュ ア ル 領 域 の ほ と ん ど の マ ク ロ は 特 別 で あ り 、 そ の 引 数 の リ ス ト は 呼 び 出 し 可 能 な マ ク ロ 名 と し て 解 析 さ れ ま す 。 こ れ は 一 般 テ キ ス ト 領 域 ま た は マ ニ ュ ア ル 領 域 の マ ク ロ 名 に 一 致 し 、 呼 び 出 し 可 能 で あ る と 判 断 さ れ た 引 数 リ ス ト の 中 の 引 数 は 、 実 行 さ れ る か 、 そ れ が 処 理 さ れ る 時 に 呼 び 出 さ れ る こ と を 意 味 し て い ま す 。 こ の 場 合 、 引 数 は マ ク ロ 名 に も 関 わ ら ず 、 ’.’ (ド ッ ト ) で 前 置 さ れ ま せ ん 。 こ の よ う に し て た く さ ん の マ ク ロ を 入 れ 子 に す る こ と が で き ま す 。 例 え ば オ プ シ ョ ン マ ク ロ ’.Op’ は フ ラ グ マ ク ロ ’Fl’ と 引 数 マ ク ロ ’Ar’ を 呼 び 出 し て 、 オ プ シ ョ ン の フ ラ グ を 引 数 と と も に 指 定 す る こ と が で き ま す 。
[−s bytes] は .Op Fl s Ar bytes に よ っ て 生 成 さ れ る
2 文 字 か ら な る 文 字 列 を マ ク ロ 名 と し て 解 釈 さ れ な い よ う に す る に は 、 そ の 文 字 列 の 前 に エ ス ケ ー プ シ ー ケ ン ス ’\&’ を 指 定 し ま す 。
[Fl s Ar bytes] は .Op \&Fl s \&Ar bytes に よ っ て 生 成 さ れ る こ こ で 文 字 列 ’Fl’ と ’Ar’ は マ ク ロ と し て 解 釈 さ れ て い ま せ ん 。 本 ド キ ュ メ ン ト と 関 連 の ク イ ッ ク リ フ ァ レ ン ス マ ニ ュ ア ル mdoc(7) を 通 し て 、 引 数 リ ス ト が 呼 び 出 し 可 能 な 引 数 と し て 解 析 さ れ る マ ク ロ は 「 解 析 さ れ る 」 、 引 数 リ ス ト か ら 呼 び 出 さ れ る こ と が で き る マ ク ロ は 「 呼 び 出 し 可 能 」 と 表 現 し ま す 。 −mdoc の ほ と ん ど す べ て の マ ク ロ は 解 析 さ れ る の で す か ら 、 こ れ は 技 術 的 に は 不 謹 慎 な こ と で す が 、 常 に マ ク ロ を 「 呼 び 出 し 可 能 で あ る 」 と か 「 他 の マ ク ロ を 呼 び 出 す こ と が で き る 」 と 表 現 す る の は 面 倒 な こ と で あ る た め 、 「 解 析 さ れ る 」 と い う 用 語 が 使 わ れ て い ま す 。 引 数 に 空 白 文 字 を 指 定 す る ひ と つ 以 上 の 空 白 文 字 を 含 む 文 字 列 を ひ と つ の 引 数 と し て 指 定 し た い 場 合 が よ く あ り ま す 。 こ れ は 9 個 を 越 え る 引 数 を 指 定 で き な い と い う 制 限 に 対 処 し た り 、 引 数 の リ ス ト に あ る 特 有 な 配 置 を お こ な う こ と が 必 要 な マ ク ロ に 引 数 を 指 定 す る よ う な 場 合 に 必 要 と な る こ と が あ り ま す 。 た と え ば 、 関 数 マ ク ロ ’.Fn’ で は 最 初 の 引 数 は 関 数 名 で あ り 、 残 り の 引 数 が 関 数 の パ ラ メ ー タ ー で あ る こ と が 必 要 で す 。 ANSI C の 括 弧 で 囲 ま れ た パ ラ メ ー タ ー リ ス ト に お け る 関 数 の パ ラ メ ー タ ー の 宣 言 の 規 定 に よ り 、 各 パ ラ メ ー タ ー は 最 低 で も 2 語 の 文 字 列 と な り ま す 。 た と え ば int foo の よ う に な り ま す 。 空 白 を 含 む 引 数 を 指 定 す る に は 2 通 り の 方 法 が あ り ま す 。 実 装 上 の 注 意 : 解 析 の 前 に 個 々 の 引 数 を 再 割 り 当 て す る こ と に よ っ て 、 引 用 符 の 間 に 空 白 を 含 め て 渡 す の が 最 も 便 利 な 方 法 な の で す が 、 AT&T の troff の す べ て の マ ク ロ を 実 装 す る に は 処 理 速 度 お よ び メ モ リ ー 使 用 量 の 点 で か な り 高 価 な 方 法 と な り ま す 。 groff で は 高 価 な 処 理 に は な り ま せ ん が 、 移 植 性 の た め 、 こ の 方 法 は 空 白 を 含 め る こ と が 最 も 必 要 で あ る 以 下 の マ ク ロ だ け に 限 っ て い ま す 。
Cd コ ン フ
ィ ギ ュ レ ー シ
ョ ン 宣 言 (セ ク
シ ョ ン 4 の SYNOPSIS)
Bl リ ス ト 開 始 (幅
指 定 用 )
Em テ キ ス ト 強 調
Fn 関 数 (セ ク シ ョ
ン 2 と 4)
It リ ス ト の 項 目
Li リ テ ラ ル テ キ
ス ト
Sy シ ン ボ リ ッ ク
テ キ ス ト
%B 書 籍 の タ イ ト
ル
%J 定 期 刊 行 物 の
タ イ ト ル
%O 参 照 の 追 加 的
な 注 釈
%R 報 告 書 の タ イ
ト ル (参 照 の 中
で )
%T 書 籍 や 定 期 刊
行 物 の 中 の 記
事 の タ イ ト ル
空 白 を 含 む 文
字 列 を 渡 す の
に 、 固 定 空 白
、 す な わ ち 詰
め 込 ま れ な い
空 白 文 字 ’\ ’
を 使 う 方 法 が
あ り ま す 。 す
な わ ち 、 空 白
の 前 に エ ス ケ
ー プ 文 字 ’\’ を
指 定 す る 方 法
で す 。 こ の 方
法 は ど の マ ク
ロ で も 使 う こ
と が で き ま す
が 、 1 行 を 越 え
る 長 さ の テ キ
ス ト の 調 整 の
邪 魔 に な る と
い う 副 作 用 が
あ り ま す 。 Troff で
は 固 定 空 白 は
他 の 印 刷 可 能
文 字 と 同 様 に
扱 わ れ 、 通 常
期 待 さ れ る よ
う に 、 そ こ で
文 字 列 を 空 白
や 改 行 で 分 け
る こ と を 行 な
わ な く な り ま
す 。 こ の 方 法
は 文 字 列 が 行
の 境 界 を ま た
が な い で あ ろ
う 場 合 に 有 用
で す 。 例 え ば
、
fetch(char *str) は ’.Fn fetch char\ *str’ に よ っ て 生 成 さ れ る
fetch(char *str) は ’.Fn fetch "char *str"’ で も 生 成 さ れ る も し ’\’ や 引 用 符 が 省 か れ る と 、 ’.Fn’ は 引 数 を 3 つ 取 り 、 そ の 結 果 は 以 下 の よ う に な り ま す 。
fetch(char, *str) パ ラ メ ー タ ー の リ ス ト が 改 行 の 境 界 を ま た ぐ 場 合 に 何 が お こ る か に つ い て は 、 バ グ の セ ク シ ョ ン を 参 照 し て く だ さ い 。 行 末 の 空 白 文 字
Troff は 行 末 に 空 白 文 字 が あ る と 混 乱 し て し ま う こ と が あ り ま す 。 <空 白 > <行 末 > の 文 字 シ ー ケ ン ス か ら す べ て の 空 白 文 字 を 取 り 除 く の は 良 い 予 防 策 で す 。 ど う し て も 行 末 に 空 白 文 字 を お く 必 要 性 が 出 て き た 場 合 は 、 詰 め 込 ま れ な い 空 白 と エ ス ケ ー プ 文 字 ’\&’ を 使 用 す る こ と に よ っ て 対 応 で き ま す 。 例 え ば 、 ’string\ \&’ の よ う に し ま す 。 特 殊 文 字 の エ ス ケ ー プ 改 行 ’\n’ の よ う な 特 殊 文 字 は ’\’ を ’\e’ で 置 き 換 え る (す な わ ち ’\en’ と す る ) こ と に よ っ て 、 バ ッ ク ス ラ ッ シ ュ を 残 し て 扱 う こ と が で き ま す 。
MAN ペ ー ジ の 分 析
man ペ ー ジ の 本 文 は フ ァ イ ル /usr/share/misc/mdoc.template の 基 本 テ ン プ レ ー ト を 使 っ て 容 易 に 作 り 上 げ る こ と が で き ま す 。 /usr/share/examples/mdoc に は い く つ か の サ ン プ ル の man ペ ー ジ が 収 め ら れ て い ま す 。 マ ニ ュ ア ル ペ ー ジ の テ ン プ レ ー ト
.\" 以 下
の 項 目 は す べ
て の man ペ ー ジ で
必 要 な 項 目 で
す 。
.Dd 月 日 , 年
.Os オ ペ レ ー テ ィ
ン グ シ ス テ ム
[バ ー ジ ョ ン /リ
リ ー ス ]
.Dt ド キ ュ メ ン ト
タ イ ト ル [セ ク
シ ョ ン 番 号 ] [ボ
リ ュ ー ム ]
.Sh NAME
.Nm 名 前
.Nd 名 前 の 1 行 で の
説 明
.Sh SYNOPSIS
.Sh DESCRIPTION
.\" 以 下 の 項 目
に つ い て は 、
必 要 に 応 じ て
コ メ ン ト を は
ず し て
.\" 使 用 し て く
だ さ い 。
.\" こ の 次 の 項
目 は セ ク シ ョ
ン 2, 3, 9 で の み 必
要 な 、 関 数 の
.\" 戻 り 値 で す
。
.\" .Sh RETURN VALUE
.\" 次 の 項 目 は
セ ク シ ョ ン 1, 6, 7, 8, 9
で の み 必 要 な
も の で す 。
.\" .Sh ENVIRONMENT
.\" .Sh FILES
.\" .Sh EXAMPLES
.\" 次 の 項 目 は
セ ク シ ョ ン 1, 6, 7, 8, 9
で の み 必 要 な
も の で す 。
.\" ((シ ェ ル へ の )
コ マ ン ド の 戻
り 値 と
|
.\" |
fprintf/stderr の 型 の 診 断 で す 。 ) |
.\" .Sh DIAGNOSTICS
.\" 次 の 項 目 は
セ ク シ ョ ン 2, 3, 9
で の み 必 要 な
、
.\" エ ラ ー ハ ン
ド リ ン グ と シ
グ ナ ル ハ ン ド
リ ン グ で す 。
.\" .Sh ERRORS
.\" .Sh SEE ALSO
.\" .Sh CONFORMING TO
.\" .Sh HISTORY
.\" .Sh AUTHORS
.\" .Sh BUGS こ の テ ン
プ レ ー ト に お
け る 最 初 の 項
目 は マ ク ロ (.Dd, .Os, .Dt)
で あ り 、 そ れ
ぞ れ ド キ ュ メ
ン ト の 日 付 、 man
ペ ー ジ も し く
は 題 材 と な っ
て い る ソ ー ス
の 開 発 や 変 更
の ベ ー ス と な
っ た オ ペ レ ー
テ ィ ン グ シ ス
テ ム 、 (大 文 字
で ) man ペ ー ジ タ
イ ト ル を そ の
ペ ー ジ が 属 す
る マ ニ ュ ア ル
の セ ク シ ョ ン
番 号 と と も に
指 定 し た も の
、 と な っ て い
ま す 。 こ れ ら
の マ ク ロ は そ
の ペ ー ジ を 識
別 す る も の で
あ り 、 後 述 の
タ イ ト ル マ ク
ロ で 議 論 さ れ
て い ま す 。 テ
ン プ レ ー ト 中
の 残 り の 項 目
は セ ク シ ョ ン
の ヘ ッ ダ ー (.Sh) で
あ り 、 そ れ ら
の う ち NAME と
SYNOPSIS と DESCRIPTION は
必 須 項 目 で す
。 こ れ ら の ヘ
ッ ダ ー に つ い
て は マ ニ ュ ア
ル 領 域 を 説 明
し た 後 、 ペ ー
ジ 構 造 領 域 で
議 論 さ れ ま す
。 い く つ か の
コ ン テ ン ト マ
ク ロ は ペ ー ジ
レ イ ア ウ ト マ
ク ロ の 説 明 に
使 わ れ て い ま
す の で 、 ペ ー
ジ レ イ ア ウ ト
マ ク ロ の 前 に
コ ン テ ン ト マ
ク ロ に つ い て
読 む こ と を 推
奨 し ま す 。 タ
イ ト ル マ ク ロ
タ イ ト ル マ ク
ロ は ペ ー ジ 構
造 領 域 の 最 初
の 部 分 で す が
、 man ペ ー ジ を 前
日 に 書 き 始 め
た い と い う 人
の た め に 、 最
初 に 分 け て 記
述 さ れ ま す 。 3
つ の ヘ ッ ダ ー
マ ク ロ で ド キ
ュ メ ン ト か man ペ
ー ジ の タ イ ト
ル 、 オ ペ レ ー
テ ィ ン グ シ ス
テ ム 、 お よ び
原 著 の 日 付 を
指 定 し ま す 。
こ れ ら の マ ク
ロ は ド キ ュ メ
ン ト の 最 初 に
一 度 だ け 呼 び
出 さ れ る も の
で 、 ヘ ッ ダ ー
と フ ッ タ を 構
成 す る た め だ
け に 使 用 さ れ
ま す 。
.Dt ド キ ュ メ ン ト タ イ ト ル セ ク シ ョ ン 番 号 [ボ リ ュ ー ム ] ド キ ュ メ ン ト タ イ ト ル は man ペ ー ジ の 主 題 で あ り 、 troff の 制 限 に よ り 大 文 字 で な け れ ば い け ま せ ん 。 セ ク シ ョ ン 番 号 は 1, ..., 8 と な り 、 こ れ が 指 定 さ れ る と ボ リ ュ ー ム タ イ ト ル を 省 略 し て も か ま い ま せ ん 。 で は 、 次 の セ ク シ ョ ン 番 号 と 解 説 に つ い て 後 述 し ま す : ボ リ ュ ー ム タ イ ト ル に は 任 意 の も の か 次 の い ず れ か を 指 定 し ま す 。
|
AMD |
UNIX Ancestral Manual Documents | |
|
SMM |
UNIX System Manager’s Manual | |
|
URM |
UNIX Reference Manual | |
|
PRM |
UNIX Programmer’s Manual デ フ ォ ル ト の ボ リ ュ ー ム ラ ベ ル は セ ク シ ョ ン |
1, 6, 7 で は URM 、 セ ク シ ョ ン 8 で は SMM 、 セ ク シ ョ ン 2, 3, 4, 5 で は PRM と な っ て い ま す 。
.Os オ ペ レ ー テ ィ ン グ シ ス テ ム リ リ ー ス 番 号 オ ペ レ ー テ ィ ン グ シ ス テ ム の 名 称 に は 一 般 的 な 頭 字 語 (略 称 ) を 使 わ な け れ ば な り ま せ ん 。 例 え ば 、 BSD や FreeBSD や ATT と い っ た も の で す 。 リ リ ー ス 番 号 は 、 例 え ば 4.3, 4.3+Tahoe, V.3, V.4 と い う よ う な 各 シ ス テ ム で の 標 準 の リ リ ー ス の 命 名 法 を 使 用 し ま す 。 認 識 さ れ な い 引 数 は ペ ー ジ の フ ッ タ 中 に 記 述 さ れ た 通 り に 表 示 さ れ ま す 。 以 下 に フ ッ タ の 典 型 的 な 例 を 示 し ま す 。
.Os 4.3BSD
や
.Os FreeBSD 2.2 や ロ ー カ ル
で 生 成 さ れ た
セ ッ ト
.Os CS Department
Berkeley で の デ フ ォ ル ト で あ る 、 引 数 な し の ’.Os’ は サ イ ト 固 有 の フ ァ イ ル /usr/share/tmac/mdoc/doc-common に お い て BSD と し て 定 義 さ れ て い ま す 。 こ れ は 実 際 に は LOCAL と し て 定 義 す べ き で す 。 ’.Os’ マ ク ロ が な い 場 合 は 、 ペ ー ジ の 左 下 角 は 見 に く く な る で あ ろ う こ と に 注 意 し て く だ さ い 。
.Dd 月 日 , 年 日 付 は 次 の よ う に フ ォ ー マ ル な 形 式 で 記 述 し な け れ ば な り ま せ ん 。
January 25, 1989 マ ニ ュ ア ル と 一 般 テ キ ス ト 領 域 の 紹 介 こ の 名 前 に は 何 が ...? マ ニ ュ ア ル 領 域 の マ ク ロ 名 は コ マ ン ド や サ ブ ル ー チ ン 、 そ れ に 関 連 フ ァ イ ル を 説 明 す る た め に 使 わ れ て い る 日 常 の イ ン フ ォ ー マ ル な 言 葉 か ら 取 ら れ て い ま す 。 こ の 言 葉 と 少 し 違 う バ リ エ ー シ ョ ン の も の が man ペ ー ジ を 書 く 上 で の 3 つ の 異 な っ た 面 を 記 述 す る の に 使 わ れ ま す 。 最 初 の も の は −mdoc マ ク ロ 使 用 方 法 の 説 明 で す 。 2 番 目 の も の は −mdoc マ ク ロ を 用 い た UNIX コ マ ン ド の 記 述 で す 。 3 番 目 は コ マ ン ド を 通 常 の 言 葉 の 感 覚 で ユ ー ザ ー に 示 し た も の で す 。 こ れ は す な わ ち 、 man ペ ー ジ の テ キ ス ト 中 で の コ マ ン ド の 議 論 と な り ま す 。 最 初 の ケ ー ス で は 、 troff(1) マ ク ロ は そ れ 自 身 、 一 種 の コ マ ン ド と な っ て い ま す 。 troff コ マ ン ド は 一 般 的 に 以 下 の よ う な 形 式 を と り ま す 。
.Va argument1 argument2 ... argument9
’.Va’ は マ ク ロ コ マ ン ド も し く は 要 求 を 示 し て お り 、 そ れ に 続 く も の は す べ て 引 数 と し て 処 理 さ れ ま す 。 2 番 目 の ケ ー ス で は 、 コ ン テ ン ト マ ク ロ を 使 用 す る UNIX コ マ ン ド の 記 述 が も う 少 し 含 ま れ ま す 。 典 型 的 な SYNOPSIS コ マ ン ド 行 は こ の よ う に 表 示 さ れ ま す 。
filter [−flag] infile outfile こ こ で filter は コ マ ン ド 名 で あ り 、 角 括 弧 で 囲 ま れ た 文 字 列 −flag は フ ラ グ 引 数 で 、 こ れ は 角 括 弧 で 囲 む こ と に よ っ て オ プ シ ョ ン で あ る こ と を 示 し て い ま す 。 −mdoc の 用 語 で は infile と outfile は 引 数 と 称 さ れ て い ま す 。 上 の 例 の フ ォ ー マ ッ ト を 行 な っ た マ ク ロ は 以 下 の も の で す 。
.Nm filter
.Op Fl flag
.Ar infile outfile
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=value
.Bk -words
.Op Ar target ...
.Ek マ ク ロ ’.Bk’ と
’.Ek’ は キ ー プ
セ ク シ ョ ン に
お い て 解 説 さ
れ て い ま す 。
一 般 的 な 構 文
マ ニ ュ ア ル 領
域 と 一 般 テ キ
ス ト 領 域 の マ
ク ロ は い く つ
か の 小 さ な 違
い が あ る も の
の 、 同 様 な 構
文 を 使 用 し て
い ま す 。 ’.Ar’,
’.Fl’, ’.Nm’, ’.Pa’
は 引 数 な し で
呼 び 出 さ れ た
時 の み 異 な り
ま す 。 ’.Fn’ と
’.Xr’ は 引 数 の
リ ス ト の 順 番
が 異 な り ま す
。 マ ク ロ ’.Op’
と ’.Fn’ に は 入
れ 子 の 制 限 が
あ り ま す 。 す
べ て の コ ン テ
ン ト マ ク ロ が
句 読 点 を 認 識
し 、 正 し く 扱
う に は 、 各 々
の 句 読 点 文 字
が 先 行 す る 空
白 で 分 離 さ れ
て い る 必 要 が
あ り ま す 。 以
下 の よ う に 指
定 さ れ て い る
場 合 、
.Li sptr, ptr), 結 果 は 以 下 の よ う に な り ま す 。
sptr, ptr), こ こ で は 句 読 点 は 認 識 さ れ ず す べ て の 出 力 は リ テ ラ ル な フ ォ ン ト で 行 な わ れ て い ま す 。 句 読 点 が 空 白 文 字 で 区 切 ら れ て い る 場 合 、
.Li sptr , ptr ) , 結 果 は 以 下 の よ う に な り ま す 。
sptr, ptr), 今 度 は 句 読 点 が 認 識 さ れ 、 出 力 は デ フ ォ ル ト の フ ォ ン ト で 行 な わ れ リ テ ラ ル フ ォ ン ト の 文 字 列 と 区 別 さ れ て い ま す 。
’\&’ で エ ス ケ ー プ す る こ と に よ っ て 句 読 点 文 字 の 特 別 な 意 味 を 取 り 除 く こ と が で き ま す 。 troff は マ ク ロ 言 語 と し て の 限 界 か ら 、 数 学 、 論 理 学 、 も し く は 以 下 の 引 用 符 の 集 合 の メ ン バ を 含 ん だ 文 字 列 を 表 現 す る の は 困 難 で す 。
{+,−,/,*,%,<,>,<=,>=,=,==,&,’,’,"}
troff が 文 字 に よ っ て 示 唆 さ れ て い る 操 作 も し く は 評 価 を 実 際 に 行 な っ て い る こ と が 、 そ の 問 題 の 原 因 と な っ て い ま す 。 ’\&’ で こ れ ら を エ ス ケ ー プ す る こ と に よ っ て 、 こ れ ら の 文 字 が 予 期 せ ず に 評 価 さ れ る こ と を 防 止 す る こ と が で き ま す 。 最 初 の コ ン テ ン ト マ ク ロ は 、 以 下 の ’.Ad’ に お い て 、 そ の 典 型 的 な 構 文 が 示 さ れ て い ま す 。 マ ニ ュ ア ル 領 域 ア ド レ ス マ ク ロ ア ド レ ス マ ク ロ は addr1[,addr2[,addr3]] の 形 式 か ら な る ア ド レ ス を 識 別 し ま す 。 使 い 方 : .Ad address ... [.,:;()[]?!]
.Ad addr1
addr1
.Ad addr1 .
addr1.
.Ad addr1 , file2
addr1, file2
.Ad f1 , f2 , f3 :
f1, f2, f3:
.Ad addr ) ) ,
addr) ),
’.Ad’
を 引 数 な し で
呼 び 出 す の は
エ ラ ー で す 。
’.Ad’ は 他 の マ
ク ロ か ら 呼 び
出 し 可 能 で 解
析 さ れ ま す 。
作 者 名
’.An’ マ ク ロ は
文 書 化 さ れ て
い る 項 目 の 作
者 の 名 前 、 も
し く は 実 際 の
マ ニ ュ ア ル ペ
ー ジ の 作 者 の
名 前 を 指 定 す
る た め に 使 わ
れ ま す 。 名 前
の 情 報 の 後 の
す べ て の 引 数
は 句 読 点 と し
て 扱 わ れ ま す
。 使 い 方 : .An author_name
[.,:;()[]?!]
.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) ),
’.An’ マ ク ロ は 解 析 さ れ 、 呼 び 出 し 可 能 で す 。 ’.An’ を 引 数 な し で 呼 び 出 す の は エ ラ ー で す 。 引 数 マ ク ロ 引 数 マ ク ロ ’.Ar’ は コ マ ン ド 行 の 引 数 を 参 照 す る 際 に 使 用 す る こ と が で き ま す 。 使 い 方 : .Ar argument ... [.,:;()[]?!]
.Ar
file ...
.Ar file1
file1
.Ar file1 .
file1.
.Ar file1 file2
file1 file2
.Ar f1 f2 f3 :
f1 f2 f3:
.Ar file ) ) ,
file) ),
’.Ar’
が 引 数 な し で
呼 び 出 さ れ る
と 、 ’.Ar’ と し
て 扱 わ れ ま す
。 ’.Ar’ マ ク ロ
は 解 析 さ れ 、
呼 び 出 し 可 能
で す 。 コ ン フ
ィ ギ ュ レ ー シ
ョ ン 宣 言 (セ ク
シ ョ ン 4 の み )
’.Cd’ マ ク ロ は
セ ク シ ョ ン 4 の
マ ニ ュ ア ル に
お い て 、 デ バ
イ ス イ ン タ ー
フ ェ ー ス の config(8)
に よ る 宣 言 の
説 明 に 使 わ れ
ま す 。 こ の マ
ク ロ は 引 用 符
(二 重 引 用 符 の
み ) で 囲 ま れ た
引 数 を 取 る こ
と が で き ま す
。
device le0 at scode?
は ’.Cd device le0 at scode?’ に
よ っ て 生 成 さ
れ ま す 。 コ マ
ン ド 修 飾 子 コ
マ ン ド 修 飾 子
は ’.Cm’ マ ク ロ
が す べ て の 引
数 の 前 に ダ ッ
シ ュ 文 字 を 付
け な い こ と を
除 い て 、 ’.Fl’
(フ ラ グ ) コ マ ン
ド と 同 じ で す
。 伝 統 的 に フ
ラ グ は ダ ッ シ
ュ 文 字 に 引 き
続 い て 指 定 さ
れ ま す が 、 い
く つ か の コ マ
ン ド や コ マ ン
ド の サ ブ セ ッ
ト は こ の 方 法
を 使 っ て い ま
せ ん 。 コ マ ン
ド 修 飾 子 は エ
デ ィ タ コ マ ン
ド の よ う な 対
話 的 な コ マ ン
ド で も 指 定 さ
れ る こ と が あ
り ま す 。 フ ラ
グ の セ ク シ ョ
ン を 参 照 し て
く だ さ い 。 定
義 済 み の 変 数
イ ン ク ル ー ド
フ ァ イ ル に お
い て 定 義 さ れ
て い る 変 数 は
’.Dv’ マ ク ロ に
よ っ て 指 定 し
ま す 。 使 い 方 : .Dv
defined_variable ... [.,:;()[]?!]
.Dv MAXHOSTNAMELEN
MAXHOSTNAMELEN
.Dv TIOCGPGRP )
TIOCGPGRP)
’.Dv’ を 引 数 な し で 呼 び 出 す の は エ ラ ー で す 。 ’.Dv’ は 解 析 さ れ 、 呼 び 出 し 可 能 で す 。
errno (セ ク シ ョ ン 2 の み ) エ ラ ー マ ク ロ ’.Er’ は セ ク シ ョ ン 2 の ラ イ ブ ラ リ ル ー チ ン に お け る エ ラ ー の 戻 り 値 を 指 定 し ま す 。 下 記 の 2 番 目 の 例 で は ’.Er’ は 一 般 テ キ ス ト 領 域 マ ク ロ で あ る ’.Bq’ (こ れ は セ ク シ ョ ン 2 の マ ニ ュ ア ル ペ ー ジ で 使 わ れ て い ま す ) と 共 に 使 わ れ て い ま す 。 使 い 方 : .Er ERRNOTYPE ... [.,:;()[]?!]
.Er ENOENT
ENOENT
.Er ENOENT ) ;
ENOENT);
.Bq Er ENOTDIR
[ENOTDIR]
’.Er’
を 引 数 な し で
呼 び 出 す の は
エ ラ ー で す 。
’.Er’ は 解 析 さ
れ 、 呼 び 出 し
可 能 で す 。 環
境 変 数
’.Ev’ マ ク ロ は
環 境 変 数 を 指
定 し ま す 。 使
い 方 : .Ev argument ... [.,:;()[]?!]
.Ev DISPLAY
DISPLAY
.Ev PATH .
PATH.
.Ev PRINTER ) ) ,
PRINTER) ),
’.Ev’
を 引 数 な し で
呼 び 出 す の は
エ ラ ー で す 。
’.Ev’ は 解 析 さ
れ 、 呼 び 出 し
可 能 で す 。 関
数 の 引 数
’.Fa’ マ ク ロ は
関 数 の 引 数 (パ
ラ メ ー タ ー ) を
マ ニ ュ ア ル の
SYNOPSIS の セ ク シ ョ
ン 外 、 も し く
は SYNOPSIS の セ ク シ
ョ ン 内 で 参 照
す る 場 合 に 使
わ れ ま す 。 パ
ラ メ ー タ ー の
リ ス ト が ’.Fn’
マ ク ロ で は 長
す ぎ る 場 合 は
、 囲 っ て 使 う
マ ク ロ ’.Fo’ と
’.Fc’ を 使 わ な
け れ ば な り ま
せ ん 。 ’.Fa’ は
構 造 体 の メ ン
バ を 参 照 す る
場 合 に も 使 わ
れ ま す 。 使 い
方 : .Fa function_argument ... [.,:;()[]?!]
.Fa d_namlen ) ) ,
d_namlen) ),
.Fa iov_len
iov_len
’.Fa’
を 引 数 な し で
呼 び 出 す の は
エ ラ ー で す 。
’.Fa’ は 解 析 さ
れ 、 呼 び 出 し
可 能 で す 。 関
数 の 宣 言
’.Fd’ マ ク ロ は
SYNOPSIS セ ク シ ョ ン
に お い て 、 セ
ク シ ョ ン 2 ま た
は 3 の 関 数 の 説
明 で 使 わ れ ま
す 。 ’.Fd’ マ ク
ロ か ら 他 の マ
ク ロ を 呼 び 出
す こ と は な く
、 他 の マ ク ロ
か ら 呼 び 出 す
こ と も で き ま
せ ん 。 使 い 方 : .Fd
include_file (or defined variable)
SYNOPSIS
セ ク シ ョ ン に
お い て 、 関 数
が す で に 示 さ
れ て い て 改 行
が 入 っ て い な
い 場 合 、 ’.Fd’
に よ っ て 改 行
が 挿 入 さ れ ま
す 。 こ れ に よ
っ て 前 の 関 数
呼 び 出 し と 次
の 関 数 の 宣 言
の 間 に 最 適 な
行 間 が 設 定 さ
れ ま す 。 フ ラ
グ
’.Fl’ マ ク ロ は
コ マ ン ド 行 の
フ ラ グ を 扱 い
ま す 。 フ ラ グ
の 前 に は ダ ッ
シ ュ ’−’ が 挿
入 さ れ ま す 。
対 話 的 な コ マ
ン ド の フ ラ グ
で は 、 ダ ッ シ
ュ が フ ラ グ の
前 に は 挿 入 さ
れ ま せ ん が 、
’.Cm’ (コ マ ン ド
修 飾 子 ) マ ク ロ
は 、 ダ ッ シ ュ
を 付 け な い こ
と を 除 き 、 同
じ 働 き を し ま
す 。 使 い 方 : .Fl argument
... [.,:;()[]?!]
.Fl
−
.Fl cfv
−cfv
.Fl cfv .
−cfv.
.Fl s v t
−s −v −t
.Fl - ,
−−,
.Fl xyz ) ,
−xyz), 引 数 な し で ’.Fl’ マ ク ロ を 指 定 す る と 、 標 準 入 力 /標 準 出 力 を 意 味 す る ダ ッ シ ュ と な り ま す 。 ひ と つ の ダ ッ シ ュ に ’.Fl’ マ ク ロ を 使 用 す る と 、 2 つ ダ ッ シ ュ と な る こ と に 注 意 し て 下 さ い 。 ’.Fl’ マ ク ロ は 解 析 さ れ 、 呼 び 出 し 可 能 で す 。 関 数 (ラ イ ブ ラ リ ル ー チ ン )
’.Fn’ マ ク ロ は ANSI C の 記 法 を 規 範 と し て い ま す 。 使 い 方 : .Fn [type] function [[type] parameters ... [ .,:;()[]?! ]]
.Fn getchar
getchar()
.Fn strlen ) ,
strlen()),
.Fn "int align" "const * char *sptrs",
int align(const * char *sptrs),
’.Fn’ を 引 数 を 指 定 せ ず に 呼 び 出 す の は エ ラ ー で す 。 ’.Fn’ マ ク ロ は 解 析 さ れ 、 呼 び 出 し 可 能 で す 。 他 の マ ク ロ の 呼 び 出 し は ’.Fn’ の 呼 び 出 し の 終 了 を 意 味 す る こ と に 注 意 し て 下 さ い (閉 じ 括 弧 が そ の 点 で 挿 入 さ れ ま す )。
9 個 以 上 の パ ラ メ ー タ ー を と る 関 数 (こ れ は 滅 多 に な い こ と で す が ) で は 、 ’.Fo’ マ ク ロ (関 数 オ ー プ ン ) と ’.Fc’ マ ク ロ (関 数 ク ロ ー ズ ) を ’.Fa’ (関 数 引 数 ) と 共 に 使 っ て 、 こ の 制 限 を 回 避 す る こ と が で き ま す 。 以 下 に そ の 例 を 示 し ま す 。
.Fo "int
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)
’.Fo’ と ’.Fc’ マ ク ロ は 解 析 さ れ 、 呼 び 出 し 可 能 で す 。 SYNOPSIS セ ク シ ョ ン で は 、 関 数 は 常 に 行 の 先 頭 か ら 開 始 さ れ ま す 。 SYNOPSIS セ ク シ ョ ン に お い て 、 複 数 の 関 数 が 示 さ れ て お り 、 関 数 の 型 が 示 さ れ な い 場 合 、 改 行 が 挿 入 さ れ 、 現 在 の 関 数 名 と そ の 前 の 関 数 名 の 間 に 最 適 な 改 行 量 が 設 定 さ れ ま す 。 現 在 、 ’.Fn’ は troff の 行 の 長 さ に 対 し て 、 語 の 境 界 を チ ェ ッ ク し て お ら ず 、 予 期 し な い 場 所 で 改 行 が 挿 入 さ れ て し ま う こ と が あ り ま す 。 こ れ は 近 い 将 来 修 正 さ れ る で し ょ う 。 関 数 の 型 こ の マ ク ロ は SYNOPSIS セ ク シ ョ ン で 使 う も の で す 。 man ペ ー ジ 中 の 他 の 場 所 で も 問 題 な く 使 う こ と が で き ま す が 、 セ ク シ ョ ン 2 と 3 の SYNOPSIS セ ク シ ョ ン で カ ー ネ ル の 通 常 の 形 式 で 関 数 の 型 を 示 す こ と が こ の マ ク ロ の 目 的 で す (こ の マ ク ロ は 関 数 名 が 次 の 行 に 置 か れ る よ う に 改 行 を 挿 入 し ま す )。 使 い 方 : .Ft type ... [.,:;()[]?!]
.Ft struct stat
struct stat
’.Ft’
は 他 の マ ク ロ
か ら は 呼 び 出
せ ま せ ん 。 対
話 的 な コ マ ン
ド
’.Ic’ マ ク ロ は
対 話 的 な コ マ
ン ド 、 も し く
は 内 部 コ マ ン
ド を 指 定 し ま
す 。 使 い 方 : .Ic argument
... [.,:;()[]?!]
.Ic :wq : wq
.Ic do while {...}
do while {...}
.Ic setenv , unsetenv
setenv, unsetenv
’.Ic’
を 引 数 な し で
呼 び 出 す の は
エ ラ ー で す 。
’.Ic’ マ ク ロ は
解 析 さ れ 、 呼
び 出 し 可 能 で
す 。 名 前 マ ク
ロ
’.Nm’ マ ク ロ は
文 書 の タ イ ト
ル や サ ブ ジ ェ
ク ト 名 を 指 定
す る た め に 使
わ れ ま す 。 こ
の マ ク ロ は 最
初 に 呼 び 出 さ
れ た 時 の 引 数
を 覚 え て お く
と い う 特 性 を
持 っ て お り 、
そ れ は 常 に そ
の ペ ー ジ の サ
ブ ジ ェ ク ト 名
で あ る べ き で
す 。 引 数 な し
で 呼 び 出 さ れ
る と ’.Nm’ は 作
者 の 作 業 を 少
な く す る た め
だ け の 目 的 で
、 最 初 の 名 称
を 出 力 し ま す
。 注 意 : セ ク シ
ョ ン 2 ま た は 3 の
ド キ ュ メ ン ト
の 関 数 名 は NAME
セ ク シ ョ ン に
お い て ’.Nm’ で
指 定 さ れ 、 SYNOPSIS
セ ク シ ョ ン や
残 り の セ ク シ
ョ ン で は ’.Fn’
で 指 定 さ れ ま
す 。 csh(1) で の
’while’ コ マ ン ド
の キ ー ワ ー ド
の よ う な 対 話
的 な コ マ ン ド
で は ’.Ic’ マ ク
ロ を 使 う べ き
で す 。 ’.Ic’ は
ほ と ん ど ’.Nm’
と 同 一 で す が
、 そ れ が 最 初
に 使 わ れ た と
き の 引 数 を 記
憶 す る こ と は
で き ま せ ん 。
使 い 方 : .Nm argument ...
[.,:;()[]?!]
.Nm mdoc.sample
mdoc.sample
.Nm \-mdoc
−mdoc.
.Nm foo ) ) ,
foo) ),
.Nm
mdoc.samples
’.Nm’
マ ク ロ は 解 析
さ れ 、 呼 び 出
し 可 能 で す 。
オ プ シ ョ ン
’.Op’ マ ク ロ は
コ マ ン ド 行 の
残 り の す べ て
の 引 数 を オ プ
シ ョ ン で あ る
こ と を 示 す 角
括 弧 で 囲 み 、
末 尾 の 句 読 点
は 角 括 弧 の 外
に 置 き ま す 。
’.Oc’ マ ク ロ と
’.Oo’ マ ク ロ は
複 数 行 に 渡 っ
て 使 う こ と が
で き ま す 。 使
い 方 : .Op options ... [.,:;()[]?!]
.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]
’.Oc’ マ ク ロ と ’.Oo’ マ ク ロ :
.Oo
.Op Fl k Ar kilobytes
.Op Fl i Ar interval
.Op Fl c Ar count
.Oc 生 成 結 果 : [
[−k kilobytes] [−i interval] [−c count] ]
’.Op’
と ’.Oc’ と ’.Oo’
マ ク ロ は 解 析
さ れ 、 呼 び 出
し 可 能 で す 。
パ ス 名
’.Pa’ マ ク ロ は
パ ス 名 も し く
は フ ァ イ ル 名
を フ ォ ー マ ッ
ト し ま す 。 使
い 方 : .Pa pathname [.,:;()[]?!]
.Pa /usr/share
/usr/share
.Pa /tmp/fooXXXXX ) .
/tmp/fooXXXXX).
’.Pa’ マ ク ロ は 解 析 さ れ 、 呼 び 出 し 可 能 で す 。 変 数 一 般 的 な 変 数 へ の 参 照 で す 。 使 い 方 : .Va variable ... [.,:;()[]?!]
.Va count
count
.Va settimer,
settimer,
.Va int *prt ) :
int *prt):
.Va char s ] ) ) ,
char s] )),
’.Va’
を 引 数 な し で
呼 び 出 す の は
エ ラ ー で す 。
’.Va’ マ ク ロ は
解 析 さ れ 、 呼
び 出 し 可 能 で
す 。 マ ニ ュ ア
ル ペ ー ジ の 相
互 参 照
’.Xr’ マ ク ロ は
最 初 の 引 数 に
マ ニ ュ ア ル ペ
ー ジ の 名 称 を
取 り 、 も し あ
れ ば 次 の 引 数
に セ ク シ ョ ン
の ペ ー ジ 数 か
句 読 点 を 取 り
ま す 。 す べ て
の 残 り の 引 数
は 句 読 点 と 見
な さ れ ま す 。
使 い 方 : .Xr man_page [1,...,8]
[.,:;()[]?!]
.Xr mdoc
mdoc
.Xr mdoc ,
mdoc,
.Xr mdoc 7
.Xr mdoc 7 ) ) ,
mdoc(7)) ),
’.Xr’
マ ク ロ は 解 析
さ れ 、 呼 び 出
し 可 能 で す 。
’.Xr’ を 引 数 な
し で 呼 び 出 す
の は エ ラ ー で
す 。 一 般 テ キ
ス ト 領 域
AT&T マ ク ロ 使 い
方 : .At [v6 | v7 | 32v | V.1 | V.4] ... [ .,:;()[]?!
]
.At
AT&T UNIX
.At v6 .
Version 6 AT&T UNIX.
’.At’ マ ク ロ は 解 析 さ れ ず 、 呼 び 出 し 不 可 で す 。 最 大 2 つ ま で の 引 数 を 取 る こ と が で き ま す 。
BSD マ ク ロ 使 い 方 : .Bx [Version/release] ... [.,:;()[]?!]
.Bx
BSD
.Bx 4.3 .
4.3BSD.
’.Bx’ マ ク ロ は 解 析 さ れ 、 呼 び 出 し 可 能 で す 。
FreeBSD マ ク ロ 使 い 方 : .Fx Version.release ... [ .,:;()[]?! ]
.Fx 2.2 .
FreeBSD 2.2.
’.Fx’ マ ク ロ は 解 析 さ れ ず 、 呼 び 出 し 不 可 で す 。 最 大 2 つ ま で の 引 数 を 取 る こ と が で き ま す 。
UNIX マ ク ロ 使 い 方 : .Ux ... [.,:;()[]?!]
.Ux
UNIX
’.Ux’ マ ク ロ は 解 析 さ れ 、 呼 び 出 し 可 能 で す 。 囲 い /ク ォ ー ト マ ク ロ 囲 い の 概 念 は ク ォ ー ト と 似 た も の で す 。 1 つ 以 上 の 文 字 列 が 引 用 符 や 括 弧 の よ う な 文 字 の ペ ア で 囲 ま れ て い る オ ブ ジ ェ ク ト を 指 し ま す 。 ク ォ ー ト と 囲 い と い う 用 語 は こ の 文 書 を 通 し て 同 じ 意 味 で 使 わ れ ま す 。 ほ と ん ど の 1 行 の 囲 い マ ク ロ は ク ォ ー ト (quote) の ヒ ン ト と す る た め に 、 小 文 字 の ’q’ で 終 了 し ま す が 、 い く つ か の 例 外 が あ り ま す 。 各 々 の 囲 い マ ク ロ に 対 し 、 開 始 マ ク ロ と 終 了 マ ク ロ の ペ ア も あ り 、 そ れ ぞ れ 小 文 字 の ’o’ と ’c’ で 終 了 し ま す 。 こ れ ら は 1 行 以 上 の テ キ ス ト に 渡 っ て 使 う こ と が で き ま す が 、 入 れ 子 に す る 場 合 に 制 限 が あ り ま す 。 そ の 中 で は 1 行 形 式 の ク ォ ー ト マ ク ロ の み 使 用 す る こ と が で き ま す 。 ク ォ ー ト 終 了 開 始 機 能 結 果
|
.Ac |
.Ao |
カ ギ 括 弧 に よ る 囲 い |
<文 字 列 > |
|||
|
.Bc |
.Bo |
角 括 弧 に よ る 囲 い |
[文 字 列 ] |
|||
|
.Dc |
.Do |
二 重 引 用 符 |
’’文 字 列 ’’ |
|||
|
.Ec |
.Eo |
囲 い 文 字 列 (XXに よ る ) |
XX文 字 列 XX |
|||
|
.Pc |
.Po |
括 弧 に よ る 囲 い |
(文 字 列 ) |
|||
|
ク ォ ー ト さ れ た リ テ ラ ル |
’st’ or 文 字 列 |
|||||
|
.Qc |
.Qo |
ま っ す ぐ な 二 重 引 用 符 |
"文 字 列 " |
|||
|
.Sc |
.So |
一 重 引 用 符 |
’文 字 列 ’ 下 記 の 不 正 な マ ク ロ を 除 き 、 す べ て の ク ォ ー ト マ ク ロ は 解 析 さ れ 、 呼 び 出 し 可 能 で す 。 句 読 点 が ひ と つ ず つ 置 か れ て い て 、 ス ペ ー ス で 区 切 ら れ て い れ ば 、 す べ て の ク ォ ー ト マ ク ロ は 句 読 点 を 適 切 に 扱 い ま す 。 ク ォ ー ト マ ク ロ は 開 く 句 読 点 、 閉 じ る 句 読 点 |
(訳 注 : 句 読 点 に は 括 弧 な ど も 含 み ま す ) を 調 べ 、 そ れ が 囲 む 文 字 列 よ り 前 か 後 か を 決 め ま す 。 こ れ に よ っ て 、 あ る 程 度 の 入 れ 子 が 可 能 に な っ て い ま す 。
.Ec, .Eo こ れ ら の マ ク ロ は 各 々 開 始 お よ び 終 了 の 文 字 列 を 最 初 の 引 数 に 取 り ま す 。
.Ql リ テ ラ ル を ク ォ ー ト す る マ ク ロ は troff で は nroff と 異 な っ た 処 理 を 行 な い ま す 。 nroff で フ ォ ー マ ッ ト さ れ た 場 合 、 ク ォ ー ト 指 定 さ れ た リ テ ラ ル は 常 に ク ォ ー ト さ れ ま す 。 troff で フ ォ ー マ ッ ト さ れ た 場 合 は 、 ア イ テ ム の 幅 が 固 定 幅 文 字 3 つ 分 よ り 狭 い 場 合 に の み ク ォ ー ト さ れ ま す 。 こ れ は リ テ ラ ル (固 定 幅 ) の フ ォ ン ト の 変 更 が あ ま り 気 づ か れ な い も の で あ る た め 、 短 い 文 字 列 を 良 く 見 え る よ う に す る た め で す 。
.Pf プ レ フ ィ ッ ク ス マ ク ロ は 呼 び 出 し 可 能 で は あ り ま せ ん が 、 解 析 さ れ ま す 。
.Pf ( Fa name2 は (name2 と な り ま す 。
’.Ns’ (空 白 な し ) マ ク ロ は サ フ ィ ッ ク ス 機 能 と 同 様 の 作 用 が あ り ま す 。 ク ォ ー ト の 例 :
.Aq
⟨ ⟩
.Aq Ar 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 string ) ,
"string"),
.Qq string Ns ),
"string),"
.Sq
’’
.Sq string
’string’ 囲 い マ ク ロ の 入 れ 子 に つ い て の 良 い 例 に つ い て は 、 オ プ シ ョ ン マ ク ロ ’.Op’ を 参 照 し て く だ さ い 。 こ の マ ク ロ は 上 で リ ス ト さ れ て い る よ う な 囲 い マ ク ロ と 同 じ ベ ー ス の 上 に 作 ら れ て い ま す 。 拡 張 引 数 リ ス ト マ ク ロ ’.Xo’ と ’.Xc’ も ま た 同 じ ル ー チ ン を ベ ー ス に 作 ら れ て お り 、 −mdoc マ ク ロ の 使 い 方 の 非 常 に 良 い 例 と な っ て い ま す 。
no−op
も し く は 通 常
テ キ ス ト マ ク
ロ
’.No’ マ ク ロ は
マ ク ロ コ マ ン
ド 行 に お い て
、 コ ン テ ン ト
マ ク ロ の 構 文
形 式 に 従 う が
、 フ ォ ー マ ッ
ト さ れ て は な
ら な い 単 語 を
ハ ッ ク す る も
の で す 。 空 白
な し マ ク ロ
’.Ns’ マ ク ロ は
マ ク ロ 間 で の
不 要 な 空 白 を
除 去 し ま す 。
こ れ は フ ラ グ
と 引 数 の 間 に
空 白 を 含 ま な
い 古 い ス タ イ
ル の 引 数 リ ス
ト を 使 う 場 合
に 便 利 で す 。
.Op Fl I Ns Ar directory は [−Idirectory] と い う 結 果 に な り ま す 。 注 : ’.Ns’ マ ク ロ は 他 の マ ク ロ 名 が 続 か な け れ ば 、 ス ペ ー ス を 除 去 し た あ と に ’.No’ マ ク ロ を 常 に 起 動 し ま す 。 ’.Ns’ マ ク ロ は 解 析 さ れ 、 呼 び 出 し 可 能 で す 。 セ ク シ ョ ン の 相 互 参 照
’.Sx’ マ ク ロ は 同 一 文 書 内 で の セ ク シ ョ ン の ヘ ッ ダ ー へ の 参 照 を 指 定 し ま す 。 こ れ は 解 析 さ れ 、 呼 び 出 し 可 能 で す 。
.Sx FILES
FILES 相 互 参 照 と 引 用 以 下 の マ ク ロ は 多 少 な り と も 参 考 文 献 を 扱 え る よ う に と 意 図 し た も の で す 。 こ れ ら の マ ク ロ は 、 せ い ぜ い 参 照 ス タ イ ル の 参 考 文 献 の サ ブ セ ッ ト を 手 動 で 作 成 し や す く す る 程 度 で す 。
.Rs 参 考 文
献 の 開 始 。 改
行 を 挿 入 し て
か ら 、 参 考 文
献 の 終 了 マ ク
ロ が 読 み 込 ま
れ る ま で 参 考
文 献 の 情 報 を
収 集 す る 。
.Re 参 考 文 献 の 終
了 。 参 考 文 献
が 表 示 さ れ る
。
.%A 参 考 文 献 の 作
者 名 。 1 回 の 呼
び 出 し に つ き
、 作 者 名 を ひ
と つ 指 定 す る
。
.%B 書 籍 の タ イ ト
ル 。
.%C 都 市 /場 所 。
.%D 日 付 。
.%J 定 期 刊 行 物 の
名 称 。
.%N 発 行 番 号 。
.%O 追 加 の 情 報 。
.%P ペ ー ジ 番 号 。
.%R 報 告 書 の 名 称
。
.%T 記 事 の タ イ ト
ル 。
.%V 巻 数 。
’%’
で 始 ま る マ ク
ロ は 呼 び 出 し
不 可 能 で す が
、 呼 び 出 し 側
に 戻 る 商 標 名
マ ク ロ だ け は
解 析 さ れ ま す
。 (現 時 点 で は
予 期 で き な い
こ と で す 。 ) 商
標 名 の み 解 析
さ れ る の は troff/ditroff
の 出 力 を き れ
い に す る た め
で す 。 返 り 値
’.Rv’ マ ク ロ は
RETURN VALUE の セ ク シ
ョ ン で 使 う テ
キ ス ト を 生 成
し ま す 。 使 い
方 : .Rv [-std function]
’.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 の マ ニ ュ ア ル ペ ー ジ で の み 有 効 で す 。 商 標 名 (頭 文 字 と タ イ プ 名 ) 商 標 名 マ ク ロ は 一 般 的 に 長 さ が 2 文 字 を 越 え る す べ て が 大 文 字 の 単 語 用 に 使 わ れ る 小 さ な 大 文 字 の マ ク ロ で す 。 使 い 方 : .Tn symbol ... [.,:;()[]?!]
.Tn DEC
DEC
.Tn ASCII
ASCII
’.Tn’
マ ク ロ は 解 析
さ れ 、 他 の マ
ク ロ か ら 呼 び
出 し 可 能 で す
。 拡 張 引 数
’.Xo’ と ’.Xc’ マ
ク ロ で マ ク ロ
の 境 界 に お け
る 引 数 リ ス ト
を 拡 張 す る こ
と が で き ま す
。 引 数 リ ス ト
は ’.Op’ の よ う
な す べ て の 引
数 が 1 行 中 に 指
定 さ れ て い る
こ と を 前 提 と
し て い る マ ク
ロ の 中 で は 行
に 渡 っ て 拡 張
す る こ と が で
き ま せ ん 。 以
下 に 空 白 モ ー
ド マ ク ロ を ス
ペ ー シ ン グ を
オ フ に す る た
め に 使 っ た
’.Xo’ で の 例 を
示 し ま す 。
.Sm off
.It Xo Sy I Ar operation
.No \en Ar count No \en
.Xc
.Sm on こ れ は 以 下 の
よ う な 結 果 に
な り ま す 。
Ioperation\ncount\n 例 を も う ひ と つ :
.Sm off
.It Cm S No / Ar old_pattern Xo
.No / Ar new_pattern
.No / Op Cm g
.Xc
.Sm on こ れ は 以 下 の
よ う な 結 果 に
な り ま す 。
S/old_pattern
/new_pattern/[g] 囲 い マ
ク ロ を 使 っ た
’.Xo’ の 他 の 例 :
変 数 の 値 を テ
ス ト し て 下 さ
い 。
.It Xo
.Ic .ifndef
.Oo \&! Oc Ns Ar variable
.Op Ar operator variable ...
.Xc こ れ は 以 下 の
よ う な 結 果 に
な り ま す 。
.ifndef [
!]variable [operator variable ...] 上
の す べ て の 例
で は ’.It’ (リ ス
ト 項 目 ) マ ク ロ
の 引 数 リ ス ト
に ’.Xo’ マ ク ロ
を 使 用 し て い
ま す 。 拡 張 マ
ク ロ が 使 わ れ
る こ と は あ ま
り あ り ま せ ん
。 使 わ れ る と
す れ ば 、 リ ス
ト 項 目 の 引 数
リ ス ト を 拡 張
す る 場 合 で す
。 残 念 な こ と
に 、 こ れ が 拡
張 マ ク ロ が 最
も 懲 り 性 で あ
る と こ ろ で も
あ り ま す 。 最
初 の 2 つ の 例 で
は 、 ス ペ ー シ
ン グ は オ フ に
な っ て い ま す
。 3 番 目 で は 、
あ る 箇 所 に は
ス ペ ー シ ン グ
を 入 れ る こ と
が 望 ま し い の
で す が 、 出 力
全 体 に 入 れ た
い わ け で は あ
り ま せ ん 。 そ
の よ う な 状 況
で こ れ ら の マ
ク ロ が 適 切 に
動 作 す る た め
に は 、 ’.Xo’ と
’.Xc’ マ ク ロ が 3
番 目 の 例 に あ
る よ う に 指 定
さ れ て い る こ
と を 確 認 し て
く だ さ い 。
’.Xo’ マ ク ロ が
置 か れ た ’.It’
の 引 数 リ ス ト
に 他 の も の が
置 か れ る と 、
ス ペ ー シ ン グ
が ど う な る か
は 予 測 不 可 能
で す 。 こ の 場
合 、 ’.Ns’ (空 白
な し マ ク ロ ) は
行 中 の 最 初 も
し く は 最 後 の
マ ク ロ に 指 定
し て は い け ま
せ ん 。 現 在 BSD で
リ リ ー ス さ れ
て い る 900 の マ ニ
ュ ア ル ペ ー ジ
(実 際 の ペ ー ジ
で は 約 1500 ペ ー ジ )
の う ち 15 の マ ニ
ュ ア ル ペ ー ジ
で の み し か
’.Xo’ が 使 わ れ
て い ま せ ん 。
ペ ー ジ 構 造 の
ド メ イ ン セ ク
シ ョ ン ヘ ッ ダ
ー 以 下 に リ ス
ト さ れ て い る
、 最 初 の 3 つ の
セ ク シ ョ ン ヘ
ッ ダ ー マ ク ロ
’.Sh’ は す べ て
の man ペ ー ジ で 必
須 の も の で す
。 残 り の セ ク
シ ョ ン ヘ ッ ダ
ー は マ ニ ュ ア
ル ペ ー ジ の 作
者 の 裁 量 に お
い て 、 推 奨 さ
れ て い る も の
で す 。 ’.Sh’ マ
ク ロ は 9 つ ま で
の 引 数 を 取 る
こ と が で き ま
す 。 こ れ は 解
析 さ れ ま す が
、 呼 び 出 し 不
可 能 で す 。
.Sh 名 前 名 前
(NAME) マ ク ロ は 必 須 の も の で す 。 こ れ が 指 定 さ れ て い な い と 、 ヘ ッ ダ ー と フ ッ タ 、 そ れ に デ フ ォ ル ト の ペ ー ジ レ イ ア ウ ト が 設 定 さ れ ず 、 結 果 は か な り 好 ま し く な い も の に な る で し ょ う 。 NAME セ ク シ ョ ン は 最 低 3 つ の 項 目 か ら な り ま す 。 最 初 の も の は 名 称 マ ク ロ ’.Nm’ で あ り 、 man ペ ー ジ の サ ブ ジ ェ ク ト と な り ま す 。 2 番 目 の も の は 名 称 説 明 マ ク ロ ’.Nd’ で あ り 、 サ ブ ジ ェ ク ト 名 を 3 つ め の 項 目 、 す な わ ち そ の 名 称 の 説 明 と 分 離 し ま す 。 説 明 に 割 り 当 て ら れ る ス ペ ー ス は 小 さ い も の で す の で 、 で き る だ け 簡 潔 で 分 か り や す い も の で な け れ ば な り ま せ ん 。 書 式 (SYNOPSIS) セ ク シ ョ ン は そ の man ペ ー ジ の サ ブ ジ ェ ク ト と な っ て い る 項 目 の 典 型 的 な 使 用 法 を 説 明 し ま す 。 必 須 の マ ク ロ は ’.Nm’, ’.Cd’, ’.Fn’ の い ず れ か で す 。 (他 に は ’.Fo’, ’.Fc’, ’.Fd’, ’.Ft’ の マ ク ロ も 必 要 な 場 合 が あ り ま す 。 ) 関 数 名 マ ク ロ ’.Fn’ は セ ク シ ョ ン 2 と 3 の マ ニ ュ ア ル ペ ー ジ に お い て 必 須 の も の で 、 コ マ ン ド と 一 般 名 称 マ ク ロ ’.Nm’ は セ ク シ ョ ン 1, 5, 6, 7, 8 で 必 須 の 項 目 で す 。 セ ク シ ョ ン 4 の マ ニ ュ ア ル で は ’.Nm’ か ’.Fd’ 、 も し く は コ ン フ ィ ギ ュ レ ー シ ョ ン デ バ イ ス 使 用 法 マ ク ロ ’.Cd’ が 必 要 で す 。 そ の 他 の い く つ か の マ ク ロ が 下 に 示 す よ う な 書 式 行 を 生 成 す る た め に 必 要 な こ と が あ り ま す 。
cat [−benstuv] [−] file ... 以 下 の マ ク ロ が 使 わ れ て い ま す 。
.Nm cat
.Op Fl benstuv
.Op Fl
.Ar 注 : マ ク ロ
’.Op’, ’.Fl’, ’.Ar’
は パ イ プ の 文
字 ’|’ を 認 識 し
、 下 記 の よ う
な コ マ ン ド 行
.Op Fl a | Fl b は う ま く い き ま せ ん 。 troff は 通 常 | を 特 別 の オ ペ レ ー タ と し て 解 釈 し ま す 。 こ の 他 で | が 使 え る 場 合 に つ い て は 定 義 済 み の 文 字 列 セ ク シ ョ ン を 参 照 し て 下 さ い 。
.Sh 説 明 説 明 (DESCRIPTION) セ ク シ ョ ン で の 最 初 の テ キ ス ト は 、 ほ と ん ど の 場 合 で は そ の コ マ ン ド 、 関 数 も し く は フ ァ イ ル に つ い て の 短 い 段 落 で 、 オ プ シ ョ ン の 構 文 リ ス ト と そ れ ぞ れ の 説 明 が そ れ に 続 き ま す 。 そ の よ う な リ ス ト を 作 成 す る に は リ ス ト 開 始 マ ク ロ ’.Bl’ 、 リ ス ト 項 目 マ ク ロ ’.It’ 、 リ ス ト 終 了 マ ク ロ ’.El’ を 使 い ま す (後 述 の リ ス ト と 列 セ ク シ ョ ン を 参 照 )。 以 下 の ’.Sh’ の セ ク シ ョ ン ヘ ッ ダ ー は マ ニ ュ ア ル ペ ー ジ の 好 ま し い レ イ ア ウ ト の 一 部 で あ り 、 一 貫 性 を 保 つ た め に 適 切 に 使 わ れ な け れ ば な り ま せ ん 。 こ れ ら は 使 わ れ る 順 番 に リ ス ト さ れ て い ま す 。
.Sh 環 境 変 数 環 境 変 数 (ENVIRONMENT) セ ク シ ョ ン は 関 連 す る 環 境 変 数 を 明 ら か に し 、 そ れ ら の 振 舞 い や 使 用 方 法 を 示 し ま す 。
.Sh 例 使 用 例 、 実 行 例 を 作 成 す る に は 様 々 な 方 法 が あ り ま す 。 詳 細 に つ い て は 、 下 の 例 の セ ク シ ョ ン を 参 照 し て く だ さ い 。
.Sh フ ァ イ ル
man ペ ー ジ の サ ブ ジ ェ ク ト に よ っ て 使 用 さ れ る か 生 成 さ れ る フ ァ イ ル で 、 フ ァ イ ル の セ ク シ ョ ン 中 で マ ク ロ ’.Pa’ に よ っ て リ ス ト さ れ ま す 。
.Sh 関 連 項 目 関 連 項 目 (SEE ALSO) セ ク シ ョ ン に は 、 そ の man ペ ー ジ の 題 材 に 関 す る 資 料 へ の 参 照 と 他 の 関 連 す る man ペ ー ジ へ の ク ロ ス リ フ ァ レ ン ス が 記 載 さ れ ま す 。 ク ロ ス リ フ ァ レ ン ス は ’.Xr’ マ ク ロ に よ っ て 指 定 さ れ ま す 。 関 連 項 目 セ ク シ ョ ン で の ク ロ ス リ フ ァ レ ン ス は セ ク シ ョ ン 番 号 順 に 並 べ 、 セ ク シ ョ ン 中 で は カ ン マ で 区 切 っ て ア ル フ ァ ベ ッ ト 順 に 並 べ な け れ ば な り ま せ ん 。 以 下 に 例 を 示 し ま す 。
ls(1), ps(1), group(5), passwd(5). こ こ で 参 考 ス タ イ ル で あ る refer(1) は 適 応 さ れ て い ま せ ん 。
.Sh 準 拠 コ マ ン ド や ラ イ ブ ラ リ 関 数 や フ ァ イ ル が 、 IEEE Std 1003.2 (’’POSIX.2’’) や ANSI X3.159-1989 (’’ANSI C89’’) の よ う な 特 定 の 実 装 に よ る も の で あ れ ば 、 こ こ で 記 述 し ま す 。 コ マ ン ド が ど の 規 格 に も 基 づ い て い な け れ ば 、 そ の 歴 史 は 歴 史 (HISTORY)の セ ク シ ョ ン で 説 明 さ れ な け れ ば な り ま せ ん 。
.Sh 歴 史 特 定 の 規 格 に 基 づ い て い な い コ マ ン ド は 、 こ の セ ク シ ョ ン で そ の 歴 史 の 概 要 が 説 明 さ れ る べ き で す 。
.Sh 作 者 ク レ ジ ッ ト が 必 要 で あ れ ば 、 こ こ で 入 れ ま す 。
.Sh 診 断 コ マ ン ド か ら の 診 断 は こ の セ ク シ ョ ン に 入 れ ま す 。
.Sh エ ラ ー 特 定 の エ ラ ー ハ ン ド リ ン グ 、 特 に ラ イ ブ ラ リ 関 数 (man ペ ー ジ の セ ク シ ョ ン 2, 3, 9) で の エ ラ ー ハ ン ド リ ン グ は 、 こ こ で 説 明 し ま す 。 ’.Er’ マ ク ロ が errno を 記 述 す る た め に 使 わ れ ま す 。
.Sh バ グ あ き ら か な 問 題 は こ こ で 記 述 し ま す ... ユ ー ザ ー 指 定 の ’.Sh’ セ ク シ ョ ン を 追 加 す る こ と が で き ま す 。 た と え ば 、 こ の セ ク シ ョ ン は 以 下 の よ う に 設 定 さ れ て い ま す 。
.Sh ペ ー ジ 構 造 領 域 段 落 と 行 ス ペ ー ス
.Pp
’.Pp’ 段 落 コ マ ン ド は 必 要 な 場 合 に 行 ス ペ ー ス を 指 定 す る た め に 使 わ れ ま す 。 こ の マ ク ロ は 、 ’.Sh’ マ ク ロ や ’.Ss’ マ ク ロ の 後 や 、 ’.Bl’ マ ク ロ の 前 で は 必 要 あ り ま せ ん 。 ( ’.Bl’ マ ク ロ は -compact フ ラ グ が 指 定 さ れ て い な け れ ば 、 縦 方 向 の 距 離 を 宣 言 し ま す )。 キ ー プ 現 在 実 装 さ れ て い る キ ー プ は 単 語 に 対 す る も の だ け で す 。 そ れ ら は ’.Bk’ (キ ー プ 開 始 ) マ ク ロ と ’.Ek’ (キ ー プ 終 了 ) マ ク ロ で す 。 ’.Bk’ に 指 定 で き る オ プ シ ョ ン は −words の み で あ り 、 こ れ は オ プ シ ョ ン の 途 中 で 改 行 が 入 ら な い よ う に す る の に 便 利 で す 。 コ マ ン ド 行 の 引 数 を 生 成 す る 例 ( こ の 名 前 に は 何 が ...? セ ク シ ョ ン を 参 照 ) に お い て 、 キ ー プ は nroff が フ ラ グ と 引 数 を 別 の 行 に 分 け な い よ う に 使 わ れ て い ま す 。 (実 際 に は 、 オ プ シ ョ ン マ ク ロ が こ の 目 的 で 使 わ れ て い ま し た が 、 オ プ シ ョ ン が 行 中 に わ た っ て 散 ら ば っ て し ま う と 一 般 的 に 見 栄 え が 悪 く な る と い う 理 由 に よ り troff で 右 揃 え の マ ー ジ ン を 強 制 的 に 行 な う (宗 教 的 な ) 決 定 が な さ れ て か ら 、 オ プ シ ョ ン マ ク ロ を こ の 目 的 で 使 わ な い よ う に な り ま し た 。 キ ー プ マ ク ロ に つ い て は も っ と 機 能 を 向 上 す る 作 業 が 必 要 で あ り 、 −line オ プ シ ョ ン を 追 加 し て い く 必 要 が あ り ま す 。 ) 例 や デ ィ ス プ レ イ デ ィ ス プ レ イ に は 5 つ の タ イ プ が あ り ま す 。 即 席 1 行 イ ン デ ン ト デ ィ ス プ レ イ ’.D1’ 、 即 席 1 行 リ テ ラ ル デ ィ ス プ レ イ ’.Dl’ 、 そ れ に デ ィ ス プ レ イ 開 始 マ ク ロ ’.Bd’ と デ ィ ス プ レ イ 終 了 マ ク ロ ’.Ed’ を 使 用 す る リ テ ラ ル ブ ロ ッ ク 、 フ ィ ル ブ ロ ッ ク お よ び 凸 凹 ブ ロ ッ ク で す 。
.D1
(D-い ち ) イ ン デ ン ト さ れ た テ キ ス ト を 1 行 表 示 し ま す 。 こ の マ ク ロ は 解 析 さ れ ま す が 、 呼 び 出 し 不 可 能 で す 。
−ldghfstru こ れ は 次 の 指 定 で 生 成 さ れ ま す : .Dl −ldghfstru
.Dl
(D-エ ル ) イ ン デ ン ト さ れ た リ テ ラ ル テ キ ス ト を 1 行 表 示 し ま す 。 ’.Dl’ マ ク ロ の 例 は 本 フ ァ イ ル の 中 に 渡 っ て 使 わ れ て い ま す 。 こ れ に よ っ て 1 行 の テ キ ス ト の イ ン デ ン ト (表 示 ) が 可 能 に な り ま す 。 こ の マ ク ロ は 解 析 さ れ 、 他 の マ ク ロ を 認 識 す る こ と が で き ま す が 、 デ フ ォ ル ト の フ ォ ン ト は 固 定 幅 (リ テ ラ ル ) に セ ッ ト さ れ て い ま す 。 し か し な が ら 、 呼 び 出 し は 不 可 能 で す 。
% ls -ldg /usr/local/bin こ れ は 次 の 指 定 で 生 成 さ れ ま す : .Dl % ls -ldg /usr/local/bin.
.Bd デ ィ ス プ レ イ 開 始 で す 。 ’.Bd’ に よ る デ ィ ス プ レ イ は ’.Ed’ マ ク ロ に よ っ て 終 了 し な け れ ば な り ま せ ん 。 デ ィ ス プ レ イ は デ ィ ス プ レ イ 内 お よ び リ ス ト 内 で 入 れ 子 に す る こ と が で き ま す 。 ’.Bd’ は 以 下 の 書 式 を と り ま す 。
.Bd デ ィ ス プ レ イ タ イ プ [-offset オ フ セ ッ ト 値 ] [-compact] デ ィ ス プ レ イ タ イ プ は 以 下 の 4 つ の タ イ プ の 内 の 1 つ で な け れ ば な ら ず 、 イ ン デ ン ト ’.Bd’ の オ フ セ ッ ト 値 を 指 定 す る こ と が で き ま す 。
−ragged テ
キ ス ト の ブ ロ
ッ ク を タ イ プ
さ れ た 通 り に
表 示 し ま す 。
右 マ ー ジ ン (と
左 マ ー ジ ン ) の
エ ッ ジ は 左 に
不 揃 い に 寄 せ
ら れ ま す 。
−filled フ ィ ル (フ
ォ ー マ ッ ト ) さ
れ た ブ ロ ッ ク
を 表 示 し ま す
。 テ キ ス ト の
ブ ロ ッ ク が フ
ォ ー マ ッ ト さ
れ ま す (エ ッ ジ
は 左 非 揃 え で
は な く 、 フ ィ
ル さ れ ま す )。
−literal リ テ ラ ル
な ブ ロ ッ ク を
表 示 し ま す 。
ソ ー ス コ ー ド
や 、 単 純 に タ
ブ も し く は ス
ペ ー ス で 整 え
ら れ た テ キ ス
ト で 便 利 で す
。
−file フ ァ イ ル
名
−file フ ラ グ に 続 く 名 称 の フ ァ イ ル が 読 み 込 ま れ 、 表 示 さ れ ま す 。 表 示 は リ テ ラ ル な モ ー ド で 行 わ れ 、 タ ブ は 定 幅 文 字 8 つ 分 に 固 定 さ れ ま す が 、 フ ァ イ ル 中 の す べ て の troff/−mdoc コ マ ン ド は 解 釈 さ れ ま す 。
−offset string
−offset が 以 下 の 文 字 列 の い ず れ か と と も に 指 定 さ れ て い る と 、 そ の 文 字 列 は 次 の テ キ ス ト の ブ ロ ッ ク の イ ン デ ン ト の レ ベ ル を 示 す も の と し て 解 釈 さ れ ま す 。
left ブ ロ
ッ ク を 現 在 の
左 マ ー ジ ン に
揃 え ま す 。 こ
れ は ’.Bd’ の デ
フ ォ ル ト の モ
ー ド で す 。
center ブ ロ ッ ク を
中 央 揃 え に し
ま す 。 残 念 な
が ら 現 時 点 で
は 、 単 に ブ ロ
ッ ク の 左 側 を
仮 想 的 な 中 央
マ ー ジ ン に 揃
え る だ け で す
。
indent デ フ ォ ル ト
の イ ン デ ン ト
値 も し く は タ
ブ の 分 だ け イ
ン デ ン ト し ま
す 。 デ フ ォ ル
ト の イ ン デ ン
ト 値 は デ ィ ス
プ レ イ ’.D1’ で
も 使 わ れ 、 こ
れ ら 2 つ の タ イ
プ の デ ィ ス プ
レ イ を 使 っ た
場 合 、 行 が 揃
う こ と が 保 証
さ れ て い ま す
。 こ の イ ン デ
ン ト は 通 常 6n か
約 2/3 イ ン チ (定 幅
文 字 6 つ 分 ) で す
。
indent-two デ フ ォ ル ト
の イ ン デ ン ト
値 の 2 倍 分 イ ン
デ ン ト し ま す
。
right こ れ は ブ ロ
ッ ク を ペ ー ジ
の 右 端 か ら 約 2
イ ン チ 離 し て
左 揃 え し ま す
。 こ の マ ク ロ
は ち ゃ ん と 動
作 す る 必 要 が
あ る の で す が
、 troff で は ま っ た
く ち ゃ ん と 動
作 し て く れ て
い ま せ ん 。
.Ed デ ィ ス プ レ イ
終 了 。 フ ォ ン
ト モ ー ド マ ニ
ュ ア ル ペ ー ジ
の テ キ ス ト の
見 栄 え を 変 更
す る マ ク ロ は 5
つ あ り ま す 。
.Em テ キ ス
ト は ’.Em’ マ ク
ロ で 強 調 す る
こ と が で き ま
す 。 強 調 の 場
合 、 通 常 イ タ
リ ッ ク 体 の フ
ォ ン ト が 使 わ
れ ま す 。 使 い
方 : .Em argument ... [.,:;()[]?!]
.Em does not
does not
.Em exceed 1024 .
exceed 1024.
.Em vide infra ) ) ,
vide infra) ),
’.Em’ マ ク ロ は 解 析 さ れ 、 呼 び 出 し 可 能 で す 。 ’.Em’ を 引 数 な し で 呼 び 出 す の は エ ラ ー で す 。
.Li リ テ ラ
ル マ ク ロ ’.Li’
は 特 殊 文 字 や
変 数 定 数 、 そ
の 他 タ イ プ さ
れ た 通 り に 表
示 す る 必 要 が
あ る も の に 使
用 す る こ と が
で き ま す 。 使
い 方 : .Li argument ... [.,:;()[]?!]
.Li \en
\n
.Li M1 M2 M3 ;
M1 M2 M3;
.Li cntrl-D ) ,
cntrl-D),
.Li 1024 ...
1024 ...
’.Li’ マ ク ロ は 解 析 さ れ 、 呼 び 出 し 可 能 で す 。
.Sy シ ン ボ
リ ッ ク 体 強 調
マ ク ロ は シ ン
ボ リ ッ ク の 意
味 で も 伝 統 的
な 英 語 の 使 い
か た に お い て
も 、 通 常 は ボ
ー ル ド マ ク ロ
と な っ て い ま
す 。 使 い 方 : .Sy symbol
... [.,:;()[]?!]
.Sy Important Notice
Important Notice
’.Sy’ マ ク ロ は 解 析 さ れ 、 呼 び 出 し 可 能 で す 。 ’.Sy’ の 引 数 は 引 用 符 で 囲 む こ と が で き ま す 。
.Bf フ ォ ン ト モ ー ド 開 始 。 フ ォ ン ト モ ー ド ’.Bf’ は ’.Ef’ マ ク ロ で 終 了 し な け れ ば な り ま せ ん 。 フ ォ ン ト モ ー ド は 他 の フ ォ ン ト モ ー ド と 入 れ 子 に す る こ と が で き ま す 。 ’.Bf’ は 次 の 構 文 を 取 り ま す 。
.Bf font-mode
font-mode は 以 下 の 3 つ の タ イ プ の う ち の い ず れ か で な け れ ば な り ま せ ん 。
Em |
−emphasis 強 調 モ ー
ド 。 ’.Em’ マ ク
ロ が テ キ ス ト
ブ ロ ッ ク 全 体
に 使 わ れ て い
る の と 同 様 で
す 。
Li | −literal リ テ ラ
ル モ ー ド 。
’.Li’ マ ク ロ が
テ キ ス ト ブ ロ
ッ ク 全 体 に 使
わ れ て い る の
と 同 様 で す 。
Sy | −symbolic シ ン ボ
リ ッ ク モ ー ド
。 ’.Sy’ マ ク ロ
が テ キ ス ト ブ
ロ ッ ク 全 体 に
使 わ れ て い る
の と 同 様 で す
。
.Ef フ ォ ン ト モ ー ド の 終 了 。 タ グ 付 き リ ス ト と 列 リ ス ト 開 始 マ ク ロ ’.Bl’ で 開 始 さ れ る リ ス ト に は い く つ か の タ イ プ が あ り ま す 。 リ ス ト 中 の 項 目 は 項 目 マ ク ロ ’.It’ で 指 定 さ れ 、 各 リ ス ト は ’.El’ マ ク ロ で 終 了 し な け れ ば な り ま せ ん 。 リ ス ト は リ ス ト 自 身 や デ ィ ス プ レ イ の 中 で 入 れ 子 に す る こ と が で き ま す 。 列 は リ ス ト の 中 で 使 う こ と が で き ま す が 、 リ ス ト が 列 の 中 で 使 え る か ど う か は 検 証 さ れ て い ま せ ん 。 さ ら に 、 タ グ の 幅 、 リ ス ト の オ フ セ ッ ト 、 コ ン パ ク ト さ (項 目 間 の 空 白 行 が 許 さ れ て い る か ど う か ) の よ う な 、 い く つ か の リ ス ト の 属 性 を 指 定 す る こ と が で き ま す 。 本 ド キ ュ メ ン ト の ほ と ん ど は タ グ (−tag) ス タ イ ル リ ス ト で フ ォ ー マ ッ ト さ れ て い ま す 。 各 種 リ ス ト タ イ プ は 、 調 子 を 変 え る た め に オ ー バ ー ハ ン グ (−ohang) で リ ス ト し ま し た 。 こ の リ ス ト の タ イ プ は TeX の ユ ー ザ ー に 非 常 に 人 気 の あ る も の で す が 、 tag リ ス ト で 構 成 さ れ た ペ ー ジ を 何 ペ ー ジ も 読 ん だ 後 に は 幾 分 変 に 見 え る で し ょ う 。 以 下 の リ ス ト タ イ プ を ’.Bl’ で 使 う こ と が で き ま す 。
−bullet
−item
−enum こ れ ら 3 つ
は 最 も 単 純 な
リ ス ト の タ イ
プ で す 。 一 旦
’.Bl’ マ ク ロ が
与 え ら れ る と
、 リ ス ト 中 の
項 目 は 単 に
’.It’ マ ク ロ に
よ っ て の み 構
成 さ れ る 行 で
指 定 さ れ ま す
。 例 と し て 、
簡 単 な 列 挙 リ
ス ト の ソ ー ス
テ キ ス ト は 、
こ の よ う に な
り ま す 。
.Bl -enum
-compact
.It ひ と つ め は こ
こ 。
.It そ し て ふ た つ
め 。
.It 最 後 に み っ つ
め は こ こ 。
.El こ れ ら の 結 果
は 以 下 の よ う
に な り ま す 。
1. ひ と つ
め は こ こ 。
2. そ し て ふ た つ
め 。
3. 最 後 に み っ つ
め は こ こ 。 簡
単 な bullet リ ス ト 構
成 の 例 を 示 し
ま す 。
.Bl -bullet
-compact
.It ひ と つ め の
bullet。
.It こ れ は ふ た つ
め の
bullet。
.El こ れ は 以 下 の
よ う な 結 果 に
な り ま す 。
• ひ と つ め
の bullet。
• こ れ は ふ た
つ め の bullet。
−tag
−diag
−hang
−ohang
−inset こ れ ら の
リ ス ト タ イ プ
は ’.It’ マ ク ロ
に よ っ て 指 定
さ れ て い る 引
数 か ら ラ ベ ル
を 生 成 し ま す
。 そ し て 、 inset
で は 、 次 の テ
キ ス ト へ そ の
ラ ベ ル を 挿 入
し ま す 。 hang で
は 、 次 の テ キ
ス ト を ラ ベ ル
の 位 置 へ イ ン
デ ン ト し ま す
。 ohang (オ ー バ ー
ハ ン グ ) で は 、
次 の テ キ ス ト
を ラ ベ ル の 位
置 に ぶ ら 下 げ
、 イ ン デ ン ト
し ま せ ん 。 tag
で は 、 タ グ つ
き テ キ ス ト の
形 式 に し ま す
。 ち な み に 上
の リ ス ト は ’Fl
ohang’ リ ス ト タ イ
プ で 構 成 さ れ
て い ま す 。
’.It’ マ ク ロ は inset,
hang, tag の リ ス ト タ
イ プ で の み 解
析 さ れ 、 呼 び
出 し 不 可 能 で
す 。 以 下 に inset ラ
ベ ル の 例 を 示
し ま す 。
Tag
tag リ ス ト (tag 段 落 と も 呼 ば れ る ) は 、 Berkely マ ニ ュ ア ル で 使 わ れ て い る リ ス ト の う ち 最 も 一 般 的 な タ イ プ で す 。
Diag 診 断 リ ス ト は セ ク シ ョ ン 4 の 診 断 リ ス ト を 生 成 す る も の で 、 呼 び 出 し 可 能 な マ ク ロ が 無 視 さ れ る こ と を 除 き 、 inset リ ス ト と 似 て い ま す 。
Hang
hang ラ ベ ル は 好 み の 問 題 で す 。
Ohang
ohang ラ ベ ル は ス ペ ー ス に 制 限 が あ る 時 に 便 利 で す 。
Inset
inset ラ ベ ル は 段 落 の ブ ロ ッ ク を 制 御 す る の に 便 利 で 、 −mdoc マ ニ ュ ア ル を 他 の 形 式 に 変 換 す る 時 に 役 立 ち ま す 。 上 の 例 を 生 成 し た ソ ー ス テ キ ス ト は こ う な っ て い ま す 。
.Bl -inset
-offset indent
.It Em Tag
tag リ ス ト (tag 段 落
と も 呼 ば れ る )
は 、
Berkely マ ニ ュ ア ル
で 使 わ れ て い
る リ ス ト の う
ち 最 も 一 般 的
な タ イ プ で す
。
.It Em Diag 診 断 リ ス ト
は セ ク シ ョ ン
4 の 診 断 リ ス ト
を 生 成 す る も
の で 、 呼 び 出
し 可 能 な マ ク
ロ が 無 視 さ れ
る こ と を 除 き
、
inset リ ス ト と 似 て
い ま す 。
.It Em Hang
hang ラ ベ ル は 好 み
の 問 題 で す 。
.It Em Ohang
ohang ラ ベ ル は ス ペ
ー ス に 制 限 が
あ る 時 に 便 利
で す 。
.It Em Inset
inset ラ ベ ル は 段 落
の ブ ロ ッ ク を
制 御 す る の に
便 利 で 、
.Nm −mdoc マ ニ ュ ア ル
を 他 の 形 式 に
変 換 す る 時 に
役 立 ち ま す 。
.El 以 下 は 2 つ の 項
目 を 持 つ hang リ ス
ト で す 。
Hanged ラ ベ ル が ラ ベ ル の 幅 よ り 小 さ い と き に は 、 ラ ベ ル は tag リ ス ト と 同 じ よ う に な り ま す 。 長 い
hang リ ス ト ラ ベ ル は 、 tag 段 落 の ラ ベ ル と は 異 な り 、 段 落 の 中 に 埋 め 込 ま れ ま す 。 こ れ を 生 成 し て い る 元 の テ キ ス ト は 以 下 の 通 り で す 。
.Bl -hang
-offset indent
.It Em Hanged ラ ベ ル が ラ
ベ ル の 幅 よ り
小 さ い と き に
は 、 ラ ベ ル は
tag リ ス ト と 同 じ
よ う に な り ま
す 。
.It Em 長 い hang リ ス ト
ラ ベ ル は 、
tag 段 落 の ラ ベ ル
と は 異 な り 、
段 落 の 中 に 埋
め 込 ま れ ま す
。
.El タ グ 幅 を 制 御
す る た め の オ
プ シ ョ ン の 幅
指 定 を 使 っ た
タ グ つ き リ ス
ト は 以 下 の 通
り で す 。
SL プ ロ セ
ス が sleep し て い る
時 間 (ブ ロ ッ ク
さ れ た 秒 数 )
PAGEIN そ の プ ロ セ ス
に よ る コ ア に
ロ ー ド さ れ て
い な い ペ ー ジ
へ の 参 照 に よ
る デ ィ ス ク I/O の
回 数
UID プ ロ セ ス の 所
有 者 の 数 字 表
記 に よ る ユ ー
ザ ー ID
PPID 親 プ ロ セ ス の
数 字 表 記 に よ
る ID、 プ ロ セ ス
の 優 先 度 (割 り
込 み 不 可 の ウ
エ イ ト で あ る
と き に は 非 正
値 )
The raw text:
.Bl -tag -width
"PAGEIN" -compact -offset indent
.It SL プ ロ セ ス が
sleep し て い る 時 間
(ブ ロ ッ ク さ れ
た 秒 数 )
.It PAGEIN そ の プ ロ セ
ス に よ る コ ア
に ロ ー ド さ れ
て い な い ペ ー
ジ へ の 参 照 に
よ る デ ィ ス ク
.Tn I/O の 回 数
.It UID プ ロ セ ス の
所 有 者 の 数 字
表 記 に よ る ユ
ー ザ ー
ID
.It PPID 親 プ ロ セ ス
の 数 字 表 記 に
よ る
ID、 プ ロ セ ス の
優 先 度
(割 り 込 み 不 可
の ウ エ イ ト で
あ る と き に は
非 正 値 )
.El 幅 指 定 と し て
以 下 の も の を
使 う こ と が で
き ま す 。
−width Fl そ の フ ラ グ で の デ フ ォ ル ト の 幅 を 指 定 し ま す 。 す べ て の 呼 び 出 し 可 能 な マ ク ロ は 各 々 デ フ ォ ル ト の 幅 の 値 を 持 っ て い ま す 。 現 在 、 ’.Fl’ の 値 は 定 幅 文 字 10 個 分 、 も し く は 約 5/6 イ ン チ と な っ て い ま す 。
−width 24n 定 幅 文 字 24 個 分 の 幅 、 も し く は 約 2 イ ン チ の 幅 を セ ッ ト し ま す 。 こ れ が 正 し く 動 作 す る に は ’n’ が 必 ず 必 要 と な り ま す 。
−width ENAMETOOLONG 指 定 さ れ た 文 字 列 の 固 定 長 に 幅 を セ ッ ト し ま す 。
|
−width "int mkfifo" こ れ も 、 指 定 さ れ た 文 字 列 の 固 定 長 に 幅 を セ ッ ト し ま す 。 タ グ つ き リ ス ト タ イ プ で 幅 が 指 定 さ れ て い な い と 、 ’.It’ が 最 初 に 起 動 さ れ た 時 に 適 し た 幅 を 決 定 す る こ と が 試 み ら れ ま す 。 ’.It’ の 最 初 の 引 数 が 呼 び 出 し 可 能 な マ ク ロ で あ れ ば 、 そ の マ ク ロ の デ フ ォ ル ト の 幅 が そ の マ ク ロ 名 が 幅 と し て 指 定 さ れ た よ う に 使 用 さ れ ま す 。 し か し な が ら 、 そ の リ ス ト 中 に 他 の 項 目 が 別 の 呼 び 出 し 可 能 な マ ク ロ 名 で 与 え ら れ て い る と 、 新 し く 入 れ 子 と な っ た リ ス ト と し て 処 理 さ れ ま す 。 定 義 済 み の 文 字 列 以 下 の 文 字 列 は あ ら か じ め 定 義 さ れ て い る も の で あ り 、 |
troff の 文 字 列 解 釈 シ ー ケ ン ス ’\*(xx’ も し く は ’\*x’ を 前 に 伴 っ て 使 わ れ ま す 。 こ こ で 、 xx も し く は x は 定 義 さ れ て い る 文 字 列 の 名 称 で す 。 解 釈 シ ー ケ ン ス は テ キ ス ト の ど こ で も 使 う こ と が で き ま す 。 文 字 列 Nroff Troff
|
<= |
<= |
≤ >= |
||
|
>= |
≥ |
|||
|
Rq |
’’ |
’’ |
||
|
Lq |
’’ |
’’ |
||
|
ua |
^ |
^ |
||
|
aa |
’ |
´ |
||
|
ga |
` |
` |
||
|
q |
" |
" |
||
|
Pi |
pi |
pi |
||
|
Ne |
!= |
≠ |
||
|
Le |
<= |
≤ |
||
|
Ge |
>= |
≥ |
||
|
Lt |
< |
> |
||
|
Gt |
> |
< |
||
|
Pm |
+- |
± |
||
|
If |
infinity |
infinity |
||
|
Na |
NaN |
NaN |
||
|
Ba |
| |
| 注 : |
’q’ の 名 称 が つ け ら れ て い る 文 字 列 は 、 1 文 字 で あ る た め ’\*q’ と 書 か な け れ ば な り ま せ ん 。 診 断
−mdoc は 限 ら れ た デ バ ッ グ 機 能 し か 持 っ て い ま せ ん が 、 引 数 名 と 内 部 レ ジ ス タ ー や マ ク ロ 名 と の 衝 突 の よ う な 潜 在 的 な エ ラ ー を 検 出 す る の に 役 立 ち ま す 。 (A っ て 何 ?) レ ジ ス タ ー は troff で の 演 算 用 記 憶 ク ラ ス で あ り 、 1 文 字 か 2 文 字 の 名 称 が つ い て い ま す 。 troff と ditroff で の −mdoc の す べ て の 内 部 レ ジ ス タ ー は ’Ar’ の よ う に 2 文 字 か ら な る <大 文 字 ><小 文 字 > の 形 式 か 、 ’aR’ の よ う に <小 文 字 ><大 文 字 > の 形 式 か 、 ’C1’ の よ う に <大 文 字 も し く は 小 文 字 ><数 字 > の 形 式 を 取 り ま す 。 さ ら に 混 乱 す る こ と に 、 troff は そ れ 自 身 の 内 部 レ ジ ス タ ー を 持 ち 、 そ れ ら す べ て は 小 文 字 2 文 字 か 、 ド ッ ト に 文 字 も し く は メ タ 文 字 が 続 く 形 式 を 取 り ま す 。 紹 介 例 の 1 つ に 、 エ ス ケ ー プ シ ー ケ ン ス ’\&’ で マ ク ロ 名 を 解 釈 さ せ な い 方 法 が あ り ま し た 。 こ れ は 内 部 レ ジ ス タ ー 名 に も 有 効 で す 。 エ ス ケ ー プ さ れ て い な い レ ジ ス タ ー 名 が 引 数 リ ス ト に 指 定 さ れ る と 、 予 期 で き な い 振 舞 い と な り ま す 。 一 般 的 に は 、 テ キ ス ト の か な り 大 き な 部 分 が 出 力 さ れ る べ き と こ ろ に 出 力 さ れ な い と か 、 リ ス ト の タ グ の よ う な 小 さ な 文 字 列 が 消 え て し ま う と か 、 引 数 リ ス ト の 中 の 引 数 の タ イ プ が 間 違 っ て 解 釈 さ れ る と か い う こ と が 、 起 こ り 得 ま す 。 き っ と あ な た の お 母 さ ん は 、 あ な た に こ ん な 面 倒 な こ と を 覚 え る よ う に と は 考 え て い な い で し ょ う 。 そ こ で 、 与 え ら れ た 引 数 が 有 効 か 無 効 か を 判 断 す る 方 法 が あ り ま す 。 そ ん な と き に は 、 ’.Db’ (デ バ ッ グ ) マ ク ロ に よ っ て ほ と ん ど の マ ク ロ の 引 数 リ ス ト が ど う 解 釈 さ れ る か を 表 示 す る こ と が で き ま す 。 ’.Pp’ (段 落 ) マ ク ロ の よ う な マ ク ロ は デ バ ッ グ 情 報 を 含 ん で い ま せ ん 。 呼 び 出 し 可 能 な マ ク ロ は す べ て デ バ ッ グ 情 報 を 含 ん で お り 、 疑 い が あ る 場 合 は い つ で も ’.Db’ マ ク ロ を オ ン に す る こ と を 強 く お 勧 め し ま す 。 使 い 方 : .Db [on | off] 以 下 の 例 で は 、 問 題 が 故 意 に 発 生 す る よ う に さ れ た 部 分 の 上 と 下 で デ バ ッ グ マ ク ロ が 指 定 さ れ て い ま す (フ ラ グ 引 数 ’aC’ は 正 し く 動 作 す る た め に は ’\&aC’ で な け れ ば な り ま せ ん )。
.Db on
.Op Fl aC Ar file )
.Db off こ の 結 果 の
出 力 は 以 下 の
通 り で す 。
DEBUGGING ON
DEBUG(argv) MACRO: ’.Op’ Line #: 2
|
Argc: 1 Argv: ’Fl’ Length: 2 |
||
|
Space: ’’ Class: Executable |
||
|
Argc: 2 Argv: ’aC’ Length: 2 |
||
|
Space: ’’ Class: Executable |
||
|
Argc: 3 Argv: ’Ar’ Length: 2 |
||
|
Space: ’’ Class: Executable |
||
|
Argc: 4 Argv: ’file’ Length: 4 |
||
|
Space: ’ ’ Class: String |
||
|
Argc: 5 Argv: ’)’ Length: 1 |
||
|
Space: ’ ’ Class: Closing Punctuation or suffix |
||
|
MACRO REQUEST: .Op Fl aC Ar file ) |
DEBUGGING OFF こ の 情 報 の 最 初 の 行 で は 呼 び 出 さ れ て い る マ ク ロ の 名 称 が 出 力 さ れ て い ま す 。 こ こ で は ’.Op’ と そ れ が 現 れ た 行 番 号 が 表 示 さ れ て い ま す 。 複 数 の フ ァ イ ル が 処 理 さ れ て い る 場 合 (特 に テ キ ス ト が 他 の フ ァ イ ル か ら イ ン ク ル ー ド さ れ て い る 場 合 )、 行 番 号 は 正 し く な い で し ょ う 。 フ ァ イ ル が 1 つ だ け の 場 合 に は 正 し い 行 番 号 が 出 力 さ れ ま す 。 2 番 目 の 行 で は 引 数 の 個 数 と 引 数 (’Fl’) と そ の 長 さ が 出 力 さ れ て い ま す 。 引 数 の 長 さ が 2 文 字 で あ れ ば 、 そ の 引 数 が 実 行 可 能 (ゼ ロ で な い 値 を 含 む す べ て の レ ジ ス タ ー は 実 行 可 能 な よ う に 見 え ま す ) か ど う か テ ス ト さ れ ま す 。 3 番 目 の 行 で は そ の ク ラ ス で 指 定 さ れ て い る ス ペ ー ス と ク ラ ス タ イ プ が 出 力 さ れ て い ま す 。 こ こ で の 問 題 は 引 数 aC が 実 行 不 可 能 で な け れ ば な ら な い こ と で す 。 ク ラ ス の 4 つ の タ イ プ は 文 字 列 、 実 行 可 能 、 閉 じ る 句 読 点 、 開 く 句 読 点 で す 。 最 後 の 行 で は 引 数 リ ス ト 全 体 が 読 み 込 ま れ た 通 り に 表 示 さ れ て い ま す 。 次 の 例 で は 問 題 の 原 因 と な っ て い る ’aC’ が エ ス ケ ー プ さ れ て い ま す 。
.Db on
.Em An escaped \&aC
.Db off
DEBUGGING ON
DEBUG(fargv) MACRO: ’.Em’ Line #: 2
|
Argc: 1 Argv: ’An’ Length: 2 | |
|
Space: ’ ’ Class: String | |
|
Argc: 2 Argv: ’escaped’ Length: 7 | |
|
Space: ’ ’ Class: String | |
|
Argc: 3 Argv: ’aC’ Length: 2 | |
|
Space: ’ ’ Class: String | |
|
MACRO REQUEST: .Em An escaped &aC |
DEBUGGING OFF
’\&’ シ ー ケ ン ス は 長 さ が 0 と な る た め に 引 数 ’\&aC’ は 先 の 例 と 同 様 に 長 さ 2 と 表 示 さ れ て い ま す 。 し か し 、 ’\&aC’ と い う 名 称 の レ ジ ス タ ー が 見 つ か ら ず 、 タ イ プ は 文 字 列 と 判 断 さ れ て い ま す 。 こ の 他 の 診 断 は 使 用 方 法 を 報 告 す る も の で あ り 、 そ れ 自 身 が 説 明 を 含 ん で い ま す 。
GROFF, TROFF, NROFF
−mdoc パ ッ ケ ー ジ は groff と の 互 換 モ ー ド は 必 要 で は あ り ま せ ん 。 こ の パ ッ ケ ー ジ で は 改 ペ ー ジ と 、 nroff で 改 ペ ー ジ 時 に 通 常 挿 入 さ れ る ヘ ッ ダ ー と フ ッ タ は 禁 止 さ れ て お り 、 マ ニ ュ ア ル を オ ン ラ イ ン で 効 率 良 く 見 る こ と が で き る よ う に な っ て い ま す 。 現 在 の 所 、 −Tascii が 指 定 さ れ た groff は ペ ー ジ 内 容 の 無 い フ ァ イ ル 末 の 残 り の 部 分 ま で 出 力 し ま す 。 改 ペ ー ジ を 禁 止 す る こ と に よ っ て nroff に よ る 出 力 は ハ ー ド コ ピ ー に は 適 さ な い も の と な っ て い ま す 。 サ イ ト 依 存 の ス タ イ ル フ ァ イ ル /usr/src/share/tmac/doc-nroff に お い て 0 に セ ッ ト す る こ と が で き る ’cR’ の 名 称 を 持 つ レ ジ ス タ ー が 古 い ス タ イ ル の 振 る 舞 い を 実 現 す る た め に 用 意 さ れ て い ま す 。 フ ァ イ ル
/usr/share/tmac/doc.tmac マ ニ
ュ ア ル マ ク ロ
パ ッ ケ ー ジ
/usr/share/misc/mdoc.template
man ペ ー ジ を 書 く た め の テ ン プ レ ー ト
/usr/share/examples/mdoc/*
man ペ ー ジ の い く つ か の 例 バ グ フ ラ グ 引 き 数 の ダ ッ シ ュ が 意 図 せ ず ハ イ フ ン に よ り 折 り 返 し に な る バ グ は ま だ 修 正 さ れ て お ら ず 、 DESCRIPTION セ ク シ ョ ン で と き ど き 意 図 し な い 動 作 (ハ イ フ ン で の 改 行 ) が 起 こ る こ と が あ る 。 あ ら か じ め 定 義 さ れ て い る 文 字 列 は 文 書 に お い て 宣 言 さ れ て い ま せ ん 。 セ ク シ ョ ン 3f は ヘ ッ ダ ー ル ー チ ン に は 追 加 さ れ て い ま せ ん 。
’.Nm’ フ ォ ン ト は 名 前 セ ク シ ョ ン に お い て 変 更 さ れ る べ き で す 。
’.Fn’ は 分 割 さ れ る の を 防 止 す る た め に 、 行 の 長 さ が 短 す ぎ な い か ど う か を チ ェ ッ ク す る 必 要 が あ り ま す 。 と き ど き 、 最 後 の 括 弧 が 分 割 さ れ る こ と が あ り 、 行 が フ ィ ル モ ー ド で あ る と き に は 全 く お か し な 結 果 に な る こ と が あ り ま す 。
nroff 使
用 時 に 、 (最 初
の ヘ ッ ダ ー と
フ ッ タ 以 外 の )
改 ペ ー ジ 時 の
ヘ ッ ダ ー と フ
ッ タ の 挿 入 を
行 わ な い よ う
に す る の に 使
用 さ れ る 命 令
に よ っ て 、 と
き ど き 見 る に
耐 え な い 部 分
的 な 行 詰 め (や
空 行 ) が ペ ー ジ
の 末 尾 に 発 生
す る 場 合 が あ
る 。 リ ス ト マ
ク ロ と デ ィ ス
プ レ イ マ ク ロ
は キ ー プ を 行
い ま せ ん が 、
こ れ は キ ー プ
を 行 う べ き で
す 。 関 連 項 目
man(1), troff(1), groff_mdoc(7), mdoc(7) こ
の 文 書 に つ い
て こ の man ペ ー
ジ は Linux man-pages プ ロ
ジ ェ ク ト の リ
リ ー ス 3.79 の 一 部
で あ る 。 プ ロ
ジ ェ ク ト の 説
明 と バ グ 報 告
に 関 す る 情 報
は http://www.kernel.org/doc/man-pages/ に
書 か れ て い る
。