Manpages

名 前

man − man ペ ー ジ を 整 形 す る マ ク ロ

書 式

groff −Tascii −man file ...

groff −Tps −man file ...

man [section] title

説 明

こ の マ ニ ュ ア ル ペ ー ジ で は 、 groff an.tmac の マ ク ロ パ ッ ケ ー ジ (man マ ク ロ パ ッ ケ ー ジ と も 呼 ば れ る こ と も 多 い ) に つ い て 説 明 す る 。 こ の マ ク ロ パ ッ ケ ー ジ は 、 Linux の man ペ ー ジ を 書 い た り 移 植 し た り す る と き に 、 開 発 者 が 用 い る も の で あ る 。 こ の マ ク ロ パ ッ ケ ー ジ は バ ー ジ ョ ン 間 で の 互 換 性 が 高 く 、 man page の 移 植 に あ た っ て は 大 き な 問 題 は な い だ ろ う (但 し 、 NET−2 BSD release は 例 外 で あ る 。 こ ち ら で は mdoc と 呼 ば れ る 全 く 異 な る マ ク ロ パ ッ ケ ー ジ が 使 用 さ れ て い る 。 mdoc(7) を 参 照 )。

NET−2 BSD の man ペ ー ジ も 、 groff の オ プ シ ョ ン と し て −man の 代 わ り に −mdoc を 指 定 す る だ け で 、 利 用 す る こ と が で き る 。 −mandoc オ プ シ ョ ン を 使 え ば ど の マ ク ロ パ ッ ケ ー ジ が 用 い ら れ て い る か 自 動 的 に 検 出 で き る の で 、 こ の オ プ シ ョ ン を 使 う の が お 薦 め で あ る 。

Linux man−pages プ ロ ジ ェ ク ト の マ ニ ュ ア ル ペ ー ジ を 書 く 際 に 従 う べ き 決 ま り 事 に つ い て は man−pages(7) を 参 照 。 タ イ ト ル 行
man ペ ー ジ の (コ メ ン ト 行 を 除 く ) 最 初 の コ マ ン ド は 、 以 下 の よ う に す る 必 要 が あ る 。 コ メ ン ト 行 と は .\" で 始 ま る 行 の こ と で あ る 。

.TH title section date source manual

TH に 渡 す 引 き 数 の 詳 細 に つ い て は man−pages(7) を 参 照 。 な お BSD の mdoc フ ォ ー マ ッ ト の ペ ー ジ は TH コ マ ン ド で は な く Dd コ マ ン ド か ら 始 ま る 。 セ ク シ ョ ン セ ク シ ョ ン は .SH で 始 ま り 、 見 出 し 名 が そ れ に 続 く 。

NAME (名 前 ) と い う 見 出 し だ け は 必 ず 置 か な い と い け な い 。 こ の 見 出 し は 一 番 最 初 の セ ク シ ョ ン に す べ き で 、 見 出 し の 次 の 行 に は プ ロ グ ラ ム の 説 明 を 一 行 で 書 く 。

.SH NAME
item \− description こ の フ ォ ー マ ッ ト に 従 い 、 コ マ ン ド 名 に 続 く シ ン グ ル ダ ッ シ ュ (−) の 前 に は 必 ず バ ッ ク ス ラ ッ シ ュ を 置 く こ と 。 こ の 文 法 は 、 mabdb(8) プ ロ グ ラ ム が whatis(1) や apropos(1) コ マ ン ド 用 の 短 い 説 明 の デ ー タ ベ ー ス を 生 成 す る 際 に 利 用 さ れ る 。 マ ニ ュ ア ル ペ ー ジ に 登 場 す る 可 能 性 の あ る こ れ 以 外 の セ ク シ ョ ン の リ ス ト に つ い て は man−pages(7) を 参 照 。 フ ォ ン ト タ イ プ フ ェ イ ス を 選 択 す る コ マ ン ド は 以 下 の よ う に 指 定 す る :

き に 便 利 )。

(頭 字 語 な ど に 用 い る ) 慣 例 と し て は 、 各 コ マ ン ド は 6 つ ま で の 引 き 数 を 持 つ 事 が 可 能 だ が 、 GNU の 実 装 で は 制 限 は な い よ う だ (し か し 移 植 性 を 保 持 す る た め に は 引 き 数 は 6 ま で に 限 っ て お く の が 良 い だ ろ う )。 引 き 数 は ス ペ ー ス で 区 切 ら れ る 。 ス ペ ー ス を 含 ん だ 引 き 数 を 与 え る に は 、 ダ ブ ル ク ォ ー ト で 囲 え ば よ い 。 す べ て の 引 き 数 は ス ペ ー ス を 取 り 除 い て 並 べ ら れ る の で 、 .BR コ マ ン ド を 使 え ば 、 単 語 は ボ ー ル ド で 、 句 読 点 を ロ ー マ ン で 表 す こ と が で き る 。 引 き 数 が 全 く 与 え ら れ な け れ ば 、 そ の コ マ ン ド は 次 の 行 の テ キ ス ト に 適 用 さ れ る 。 そ の 他 の マ ク ロ や 文 字 列 以 下 に 、 他 の マ ク ロ や 定 義 済 み の 文 字 列 を 示 す 。 特 に 記 述 が な い 限 り 、 マ ク ロ を 使 う と 改 行 が 行 わ れ る (テ キ ス ト の 現 在 の 行 を 終 了 す る )。 多 く の マ ク ロ は 「 優 先 イ ン デ ン ト (prevailing indent)」 を 設 定 し た り 、 使 用 す る 。 優 先 イ ン デ ン ト の 値 は 、 ど の マ ク ロ か ら も パ ラ メ ー タ ー i に よ っ て 指 定 で き る (以 下 に 示 す )。 マ ク ロ で は i を 省 略 す る こ と も で き 、 そ の 場 合 は 現 在 の 優 先 イ ン デ ン ト の 値 が 用 い ら れ る 。 こ れ に よ り 結 果 と し て 、 イ ン デ ン ト さ れ た 段 落 が 連 続 し て い る 場 合 、 イ ン デ ン ト の 値 を 再 指 定 し な く て も イ ン デ ン ト 量 を 同 じ に す る こ と が で き る 。 通 常 の (イ ン デ ン ト さ れ て い な い ) 段 落 が 登 場 す る と 、 優 先 イ ン デ ン ト の 値 は デ フ ォ ル ト の 値 (0.5 イ ン チ ) に リ セ ッ ト さ れ る 。 デ フ ォ ル ト で は 、 与 え た イ ン デ ン ト の 値 は ens 単 位 で あ る 。 イ ン デ ン ト の 単 位 に は ens や ems を 用 い る と よ い 。 こ れ ら の 単 位 は フ ォ ン ト サ イ ズ が 変 更 さ れ る と 自 動 的 に 調 整 さ れ る か ら で あ る 。 他 の 重 要 な マ ク ロ 定 義 は 以 下 の 通 り : 通 常 の 段 落

新 し い 段 落 を 開 始 し 、 イ ン デ ン ト を リ セ ッ ト す る 。 相 対 マ ー ジ ン イ ン デ ン ト

左 マ ー ジ ン を i だ け 右 に 移 動 す る (i が 省 略 さ れ る と 優 先 イ ン デ ン ト の 値 が 用 い ら れ る )。 新 た な 優 先 イ ン デ ン ト は 0.5 イ ン チ に セ ッ ト さ れ る 。 結 果 と し て 、 以 下 の 段 落 は 対 応 す る .RE が 現 れ る ま で イ ン デ ン ト さ れ る 。

(段 落 の 先 頭 行 は 通 常 の 段 落 の 左 マ ー ジ ン と な り 、 段 落 の 残 り の 行 は イ ン デ ン ト さ れ る )。

x が 省 略 さ れ る と 、 以 下 の 段 落 す べ て が i で イ ン デ ン ト さ れ る 。 タ グ x が 与 え ら れ る と 、 タ グ は イ ン デ ン ト さ れ た 段 落 の 前 に ぶ ら 下 げ ら れ る (.TP と ち ょ う ど 同 じ 。 た だ し タ グ を 次 の 行 に 書 く 代 わ り に コ マ ン ド に 指 定 す る )。 タ グ が 長 す ぎ る 場 合 に は 、 タ グ に 続 く テ キ ス ト は 次 の 行 に 移 動 す る (テ キ ス ト が 失 わ れ た り 混 ざ っ た り す る こ と は な い )。 箇 条 書 き を す る に は 、 \(bu (点 ) あ る い は \(em (ダ ッ シ ュ ) を タ グ に し て こ の マ ク ロ を 用 い る と よ い 。 番 号 付 き で 箇 条 書 き を す る 場 合 は 、 数 字 ま た は 文 字 に ピ リ オ ド を 付 け た も の を タ グ に す れ ば よ い 。 こ う す れ ば 他 の フ ォ ー マ ッ ト へ の 変 換 が 簡 単 に な る 。

.IP コ マ ン ド と 似 た も の に な る 。 ハ イ パ ー テ キ ス ト リ ン ク 用 の マ ク ロ
(groff だ け で サ ポ ー ト さ れ て い る 機 能 ) ハ イ パ ー テ キ ス ト リ ン ク 用 の マ ク ロ を 使 用 す る た め に は 、 www.tmac マ ク ロ パ ッ ケ ー ジ を ロ ー ド す る 必 要 が あ る 。 ロ ー ド を 行 う に は .mso www.tmac リ ク エ ス ト を 使 用 す る 。
.URL link url trailer

URI (URL) url へ の ハ イ パ ー テ キ ス ト リ ン ク を 挿 入 す る 。 link は リ ン ク 名 の テ キ ス ト で あ り 、 trailer の 内 容 は リ ン ク の 直 後 に 表 示 さ れ る 。 HTML を 生 成 す る 時 に 、 こ の マ ク ロ は <A HREF="url">link</A>trailer と い う HTML コ マ ン ド に 変 換 さ れ る 。

(troff を 含 め た ) 多 く の ツ ー ル は 未 定 義 の マ ク ロ を 単 に 無 視 す る だ け (あ る い は 最 悪 で も マ ク ロ を テ キ ス ト と し て 挿 入 す る だ け ) な の で 、 こ れ ら を 書 い て も 危 険 は な い 。

roff ビ ュ ー ア で も 表 示 さ れ る よ う に す る の も い い だ ろ う 。 こ う す る こ と で 、 URL も 、 リ ン ク 用 の テ キ ス ト も 、 (も し あ れ ば ) そ れ に 続 く テ キ ス ト も 、 表 示 で き る よ う に な る 。

.de URL
\\$2 \(laURL: \\$1 \(ra\\$3
..
.if \n[.g] .mso www.tmac
.TH ...
(later in the page)
This software comes from the
.URL "http://www.gnu.org/"; "GNU Project" " of the"
.URL "http://www.fsf.org/"; "Free Software Foundation" .

www.tmac マ ク ロ パ ッ ケ ー ジ の URL マ ク ロ の 定 義 の 方 が ロ ー カ ル で 行 わ れ た 定 義 よ り も 優 先 さ れ る 。 他 に も い く つ か の リ ン ク 用 の マ ク ロ が 用 意 さ れ て い る 。 詳 し く は groff_www(7) を 参 照 の こ と 。 そ の 他 の マ ク ロ

行 は し な い 。

な る )。

い る )。 定 義 済 み の 文 字 列

man パ ッ ケ ー ジ に は 、 以 下 の よ う な 定 義 済 み の 文 字 列 が あ る :

ン ト サ イ ズ を 変 更 す る