Manpages

名 称

groff_man − マ ニ ュ ア ル ペ ー ジ 生 成 サ ポ ー ト 用 groff ’man’ マ ク ロ

書 式

groff −man [ options... ] [ files... ]
groff −m man [ options... ] [ files... ]

解 説

groff で マ ニ ュ ア ル ペ ー ジ を 生 成 す る の に 使 用 さ れ る man マ ク ロ は 、 James Clark が 書 き ま し た 。 こ の ド キ ュ メ ン ト は 、 パ ッ ケ ー ジ 中 の 各 マ ク ロ の 使 い 方 を 、 短 く ま と め た も の で す 。

オ プ シ ョ ン

man マ ク ロ は 、 次 の よ う な コ マ ン ド ラ イ ン オ プ シ ョ ン を 理 解 し ま す (レ ジ ス タ を い く つ か 定 義 し ま す )。

に 、 長 い 単 一 ペ ー ジ を 出 力 し ま す 。 無 効 に す る に は 、 −rcR=0 と し て く だ さ い 。

1 か ら 始 ま る の で は な く 、 連 続 し た 番 号 に な り ま す 。

1 で は な く nnn か ら に し ま す 。

ト に し ま す (xx に は 10, 11, 12 の い ず れ か が 使 用 で き ま す )。

ま す 。 例 え ば 、 ’−rX2’ と い う オ プ シ ョ ン の 場 合 、 ペ ー ジ を 1, 2, 2a, 2b, 2c と い う よ う に 割 り 振 り ま す 。

使 用 法

こ の セ ク シ ョ ン は 、 マ ニ ュ ア ル ペ ー ジ 用 に 使 用 可 能 な マ ク ロ に つ い て 述 べ て い ま す 。 さ ら に カ ス タ マ イ ズ し た い 場 合 は 、 man.local フ ァ イ ル 中 に 追 加 の マ ク ロ お よ び リ ク エ ス ト を 置 い て く だ さ い 。 こ の フ ァ イ ル は man の 直 後 に ロ ー ド さ れ ま す 。

.TH title section [extra1] [extra2] [extra3] こ の マ ニ ュ ア ル ペ ー ジ の タ イ ト ル を title に 、 セ ク シ ョ ン を section に 設 定 し ま す 。 セ ク シ ョ ン は 、 1 か ら  8 ま で の 値 を と ら な く て は な り ま せ ん 。 section 値 に は 、 後 ろ に 文 字 列 を 置 く こ と も で き ま す 。 例 え ば 、 ’.pm’ と す る と 、 マ ニ ュ ア ル ペ ー ジ の 特 定 の サ ブ セ ク シ ョ ン を 示 し ま す 。 title と section は 、 と も に ヘ ッ ダ 行 の 左 端 と 右 端 に 置 か れ ま す (括 弧 で く く ら れ た section が title の 直 後 に 付 き ま す )。 extra1 は 、 フ ッ タ 行 の 中 央 に 置 か れ ま す 。 extra2 は 、 フ ッ タ 行 の 左 に 置 か れ ま す (両 面 印 字 が ア ク テ ィ ブ に な っ て い る 場 合 、 偶 数 ペ ー ジ に は 左 に 、 奇 数 ペ ー ジ に は 右 に 、 置 か れ ま す )。 extra3 は ヘ ッ ダ 行 の 中 央 に 置 か れ ま す 。

HTML 出 力 用 に は 、 ヘ ッ ダ お よ び フ ッ タ は 完 全 に 取 り 除 か れ ま す 。 さ ら に 、 こ の マ ク ロ は 改 ペ ー ジ し ま す 。 新 し い 行 番 号 は 、 再 度  1 に な り ま す (コ マ ン ド ラ イ ン で ’-rC1’ オ プ シ ョ ン が 指 定 さ れ て い る 場 合 を 除 き ま す )。 こ の 機 能 は 、 複 数 の マ ニ ュ ア ル ペ ー ジ を 整 形 す る 場 合 の た め だ け に あ り ま す 。 マ ニ ュ ア ル ペ ー ジ が 1 つ の 場 合 、 TH は 、 フ ァ イ ル の 先 頭 に お い て 、 ま さ に 1 つ だ け 存 在 す べ き で す 。

.SH [text for a heading] 番 号 づ け を し な い セ ク シ ョ ン 用 の 見 出 し を 設 定 し ま す 。 こ れ は 左 詰 め に な り ま す 。 SH に 続 い た テ キ ス ト ( SH に 引 数 が な い 場 合 は 次 の 行 の テ キ ス ト ) は 、 行 末 ま で の も の が す べ て ボ ー ル ド 体 で 、 そ し て ベ ー ス ド キ ュ メ ン ト サ イ ズ よ り も 1 だ け 大 き な フ ォ ン ト サ イ ズ で 表 示 さ れ ま す 。 さ ら に 、 テ キ ス ト の 左 側 の 余 白 は デ フ ォ ル ト 値 に 戻 さ れ ま す 。
.SS [text for a heading] 番 号 づ け し な い セ ク シ ョ ン の 2 番 目 の 見 出 し を 設 定 し ま す 。 SS に 続 い た テ キ ス ト ( SS に 引 数 が な い 場 合 は 次 の 行 の テ キ ス ト ) は 、 行 末 ま で の も の が す べ て ボ ー ル ド 体 で 、 そ し て ベ ー ス ド キ ュ メ ン ト サ イ ズ と 同 じ 大 き さ の フ ォ ン ト で 表 示 さ れ ま す 。 さ ら に 、 テ キ ス ト の 左 側 の 余 白 は デ フ ォ ル ト 値 に 戻 さ れ ま す 。
.TP [nnn] イ ン デ ン ト さ れ た 、 ラ ベ ル つ き の 段 落 を 設 定 し ま す 。 イ ン デ ン ト 幅 は 、 引 数 が 与 え ら れ て い れ ば nnn に 設 定 さ れ ま す (省 略 さ れ て い れ ば 、 デ フ ォ ル ト の 単 位 は ’n’ で す )。 引 数 が 与 え ら れ て い な け れ ば 、 イ ン デ ン ト 幅 は デ フ ォ ル ト 値 に 設 定 さ れ ま す 。 こ の マ ク ロ の 後 に 続 い た テ キ ス ト の 1 行 目 は 、 左 詰 め に 表 示 す る 文 字 列 と し て 解 釈 さ れ 、 ラ ベ ル と し て 使 用 す る の に 適 切 な も の と な り ま す 。 こ れ は 段 落 の 一 部 で あ る と は 解 釈 は さ れ ま せ ん の で 、 引 き 続 く 入 力 行 の テ キ ス ト で 1 行 目 を 満 た そ う と は し ま せ ん 。 そ れ で も 、 ラ ベ ル が イ ン デ ン ト 幅 ほ ど 広 が っ て い な い 場 合 に は 、 同 じ 行 か ら 段 落 が 始 ま り (た だ し 、 イ ン デ ン ト は さ れ ま す )、 次 の 行 へ と 続 い て い き ま す 。 ラ ベ ル が イ ン デ ン ト 幅 よ り も 広 い 場 合 は 、 段 落 の 説 明 部 分 は ラ ベ ル の 次 の 行 か ら 始 ま り 、 す べ て イ ン デ ン ト さ れ ま す 。 ラ ベ ル の フ ォ ン ト の 形 も サ イ ズ も デ フ ォ ル ト 値 に は 設 定 さ れ な い こ と に 注 意 し て く だ さ い 。 こ れ に 対 し て 、 残 り の テ キ ス ト は デ フ ォ ル ト の フ ォ ン ト 設 定 に な り ま す 。 TP マ ク ロ は 、 あ な た が 今 ち ょ う ど 読 ん で い る こ の 解 説 に 使 用 さ れ て い る マ ク ロ で す 。

PD マ ク ロ で 指 定 し た 量 だ け 垂 直 方 向 に ス ペ ー ス を 置 き ま す 。 フ ォ ン ト の サ イ ズ お よ び 形 は デ フ ォ ル ト 値 に 戻 さ れ ま す (10pt ロ ー マ ン 体 )。 最 後 に 、 現 在 の 左 側 の 余 白 の 量 を 復 元 し ま す 。
.IP [designator] [nnn] イ ン デ ン ト さ れ た 段 落 を 設 定 し ま す 。 そ の 際 、 designator を 段 落 の 始 ま り に 印 を つ け る た め の タ グ と し て 使 用 し ま す 。 イ ン デ ン ト 幅 は 、 引 数 が 与 え ら れ て い る 場 合 は nnn に 設 定 さ れ ま す (デ フ ォ ル ト の 単 位 は ’n’ で す )。 引 数 が 与 え ら れ て い な い 場 合 は 、 デ フ ォ ル ト の イ ン デ ン ト 幅 が 使 用 さ れ ま す 。 こ の 段 落 (た だ し 、 指 示 子 (designator) を 含 ま ず ) の フ ォ ン ト サ イ ズ お よ び フ ェ ー ス は デ フ ォ ル ト 値 に 戻 さ れ ま す 。 特 定 の イ ン デ ン ト を す る が 指 示 子 を つ け な い 段 落 を 開 始 す る に は 、 第 2 引 数 に ’""’ (ダ ブ ル ク ォ ー ト 2 つ ) を 使 用 し て く だ さ い 。 例 え ば 次 の 段 落 は 、 ’.IP \(bu 4’ を 用 い て 、 す べ て 指 示 子 と し て 中 点 を つ け て 設 定 さ れ ま す :

.HP [nnn] 左 側 に ぶ ら 下 げ イ ン デ ン ト さ れ た 段 落 を 設 定 し ま す 。 引 数 が 与 え ら れ て い る 場 合 、 イ ン デ ン ト 幅 は nnn に 設 定 さ れ ま す (デ フ ォ ル ト の 単 位 は ’n’ で す )。 引 数 が 与 え ら れ て い な い 場 合 、 デ フ ォ ル ト の イ ン デ ン ト 幅 が 使 用 さ れ ま す 。 フ ォ ン ト サ イ ズ お よ び フ ェ ー ス は デ フ ォ ル ト 値 に 戻 さ れ ま す 。 次 の 段 落 は 、 イ ン デ ン ト 幅 を  4 に 設 定 さ れ て い る と き の こ の マ ク ロ の 効 果 を 示 し た も の で す :

の マ ク ロ は 、 最 初 の 行 を 除 い た 行 す べ て が イ ン デ ン ト さ れ た 段 落 を 生 成 し て い ま す 。

.RS [nnn] こ の マ ク ロ は 、 値 が 与 え ら れ て い れ ば (デ フ ォ ル ト 単 位 は ’n’ で す ) そ の 値 だ け 左 側 の 余 白 を 右 に 移 動 し ま す 。 値 が 与 え ら れ て い な け れ ば 、 デ フ ォ ル ト の イ ン デ ン ト 幅 が 使 用 さ れ ま す 。 RS マ ク ロ の 呼 び 出 し は 入 れ 子 に で き ま す 。
.RE [nnn] こ の マ ク ロ は 、 左 側 の 余 白 を nnn レ ベ ル ま で 戻 し ま す 。 引 数 が 与 え ら れ て い な け れ ば 、 こ の マ ク ロ は レ ベ ル を 1 つ だ け 戻 し ま す 。 第 1 レ ベ ル (す な わ ち 、 ま だ RS を 呼 び 出 し て い な い ) は 番 号  1 を 持 っ て お り 、 RS マ ク ロ を 呼 び 出 す ご と に レ ベ ル が  1 ず つ 増 加 し ま す 。 ま と め る と 、 次 の マ ク ロ は 、 垂 直 方 向 に ス ペ ー ス を 入 れ た 行 の 折 り 返 し を 行 い ま す (ス ペ ー ス の 量 は PD マ ク ロ を 使 用 す る と 変 更 で き ま す ): SH, SS, TP, LP (PP, P), IP, HP 。 マ ク ロ RS お よ び RE も 行 を 折 り 返 し ま す が 、 垂 直 方 向 に ス ペ ー ス を 入 れ ま せ ん 。

フ ォ ン ト を 設 定 す る た め の マ ク ロ

標 準 フ ォ ン ト は ロ ー マ ン 体 で す 。 そ し て 、 デ フ ォ ル ト の テ キ ス ト サ イ ズ は 10 ポ イ ン ト で す 。

.SM [text] 同 じ 行 に あ る テ キ ス ト あ る い は 次 の 行 に あ る テ キ ス ト が 、 デ フ ォ ル ト の フ ォ ン ト よ り も 1 ポ イ ン ト だ け 小 さ い フ ォ ン ト で 表 示 さ れ る よ う に な り ま す 。
.SB [text] 同 じ 行 に あ る テ キ ス ト あ る い は 次 の 行 に あ る テ キ ス ト が 、 ボ ー ル ド 体 の フ ォ ン ト で 、 そ し て デ フ ォ ル ト の フ ォ ン ト よ り も 1 ポ イ ン ト だ け 小 さ い フ ォ ン ト で 表 示 さ れ る よ う に な り ま す 。
.BI text 同 じ 行 に あ る テ キ ス ト が 、 ボ ー ル ド 体 と イ タ リ ッ ク 体 を 交 互 に 使 っ て 表 示 さ れ る よ う に な り ま す 。 テ キ ス ト は マ ク ロ 呼 び 出 し と 同 じ 行 に あ る こ と が 必 要 で す 。 し た が っ て 、

.BI this "word and" that と い う 行 は 、 ’this’ と ’that’ が ボ ー ル ド 体 で 表 示 さ れ 、 そ れ に 対 し て ’word and’ の 部 分 は イ タ リ ッ ク 体 で 表 示 さ れ ま す 。

.IB text テ キ ス ト が 、 イ タ リ ッ ク 体 と ボ ー ル ド 体 を 交 互 に 使 っ て 表 示 さ れ る よ う に な り ま す 。 テ キ ス ト は マ ク ロ 呼 び 出 し と 同 じ 行 に あ る こ と が 必 要 で す 。
.RI text マ ク ロ 呼 び 出 し と 同 じ 行 に あ る テ キ ス ト が 、 ロ ー マ ン 体 と イ タ リ ッ ク 体 を 交 互 に 使 っ て 表 示 さ れ る よ う に な り ま す 。 テ キ ス ト は 、 マ ク ロ 呼 び 出 し と 同 じ 行 に あ る こ と が 必 要 で す 。
.IR text マ ク ロ 呼 び 出 し と 同 じ 行 に あ る テ キ ス ト が 、 イ タ リ ッ ク 体 と ロ ー マ ン 体 を 交 互 に 使 っ て 表 示 さ れ る よ う に な り ま す 。 テ キ ス ト は 、 マ ク ロ 呼 び 出 し と 同 じ 行 に あ る こ と が 必 要 で す 。
.BR text マ ク ロ 呼 び 出 し と 同 じ 行 に あ る テ キ ス ト が 、 ボ ー ル ド 体 と ロ ー マ ン 体 を 交 互 に 使 っ て 表 示 さ れ る よ う に な り ま す 。 テ キ ス ト は 、 マ ク ロ 呼 び 出 し と 同 じ 行 に あ る こ と が 必 要 で す 。
.RB text マ ク ロ 呼 び 出 し と 同 じ 行 に あ る テ キ ス ト が 、 ロ ー マ ン 体 と ボ ー ル ド 体 を 交 互 に 使 っ て 表 示 さ れ る よ う に な り ま す 。 テ キ ス ト は 、 マ ク ロ 呼 び 出 し と 同 じ 行 に あ る こ と が 必 要 で す 。
.R [text]

text が ロ ー マ ン 体 フ ォ ン ト で 表 示 さ れ る よ う に な り ま す 。 マ ク ロ が 呼 び 出 さ れ た 行 に テ キ ス ト が な い 場 合 は 、 次 の 行 の テ キ ス ト が ロ ー マ ン 体 で 表 示 さ れ ま す 。 こ れ が 、 他 の マ ク ロ を 処 理 し 終 わ っ た と き に 返 さ れ る テ キ ス ト の デ フ ォ ル ト の フ ォ ン ト で す 。

.B [text]

text が ボ ー ル ド 体 で 表 示 さ れ る よ う に な り ま す 。 マ ク ロ が 呼 び 出 さ れ た 行 に テ キ ス ト が な い 場 合 は 、 次 の 行 の テ キ ス ト が ボ ー ル ド 体 で 表 示 さ れ ま す 。

.I [text]

text が イ タ リ ッ ク 体 で 表 示 さ れ る よ う に な り ま す 。 マ ク ロ が 呼 び 出 さ れ た 行 に テ キ ス ト が な い 場 合 は 、 次 の 行 の テ キ ス ト が イ タ リ ッ ク 体 で 表 示 さ れ ま す 。

そ の 他

grohtml を 除 い た 出 力 デ バ イ ス 用 の イ ン デ ン ト 幅 は す べ て 7.2n で す 。 grohtml の 場 合 は イ ン デ ン ト を 無 視 し ま す 。

.PD [nnn] 新 し い 段 落 (セ ク シ ョ ン ) の 前 の ス ペ ー ス を 調 整 し ま す 。 オ プ シ ョ ン の 引 数 は 、 ス ペ ー ス の 量 を 与 え ま す (デ フ ォ ル ト の 単 位 は ’v’)。 パ ラ メ ー タ 無 し の 場 合 、 こ の 値 は デ フ ォ ル ト 値 に 戻 さ れ ま す (tty デ バ イ ス で は 1 行 で 、 そ れ 以 外 で は 0.4v)。 こ の リ ク エ ス ト は 、 SH, SS, TP, LP (そ れ ぞ れ PP お よ び P), IP, HP マ ク ロ に 影 響 を 与 え ま す 。 次 の 文 字 列 が 定 義 さ れ て い ま す :

じ で す 。

tbl あ る い は eqn の よ う な プ リ プ ロ セ ッ サ が 必 要 な 場 合 、 マ ニ ュ ア ル ペ ー ジ の 1 行 目 を 次 の よ う に 見 え る よ う に す る 例 に な り ま す :

.\" word ダ ブ ル ク ォ ー ト の 後 に は 空 白 文 字 1 つ が 入 る こ と に 注 意 し て く だ さ い 。 word は 、 必 要 な プ リ プ ロ セ ッ サ を 表 す 文 字 で 成 り 立 っ て い ま す 。 ’e’ は eqn を 表 し 、 ’r’ は refer を 、 そ し て ’t’ は tbl を 表 し ま す 。 最 近 の man プ ロ グ ラ ム の 実 装 で は 、 こ の 1 行 目 を 読 ん で 自 動 的 に 正 し い プ リ プ ロ セ ッ サ を 呼 び 出 し ま す 。

関 連 フ ァ イ ル

man.tmac
an.tmac こ れ ら は 、 andoc.tmac を 呼 び 出 す ラ ッ パ フ ァ イ ル で す 。
andoc.tmac こ の フ ァ イ ル は 、 man マ ク ロ ま た は mdoc パ ッ ケ ー ジ の い ず れ を 使 用 す べ き か を 判 定 し ま す 。
an-old.tmac 全 man マ ク ロ が 、 こ の フ ァ イ ル に 含 ま れ ま す 。
man.local ロ ー カ ル の 修 正 と カ ス タ マ イ ズ は 、 こ の フ ァ イ ル に 入 れ ま す 。

関 連 項 目

man マ ク ロ は 、 groff リ ク エ ス ト の 集 ま り で で き て い ま す の で 、 原 理 的 に は 、 必 要 が あ る 場 合 に は 自 己 流 の groff リ ク エ ス ト を 作 っ て man の 機 能 を 追 加 す る こ と が で き ま す 。 こ れ ら の リ ク エ ス ト の 完 全 な リ ス ト は WWW ペ ー ジ

http://www.cs.pdx.edu/~trent/gnu/groff/groff_toc.html か ら 入 手 で き ま す 。

tbl(1), eqn(1), refer(1), man(1)

作 者

こ の マ ニ ュ ア ル ペ ー ジ は 、 本 来 Debian GNU/Linux シ ス テ ム 用 に Susan G. Kleinmann <sgk [AT] debian.org> が 書 い た も の で す 。 そ れ を Werner Lemberg <wl [AT] gnu.org> が 修 正 し 、 更 新 し ま し た 。 そ れ が 今 で は GNU troff 配 布 物 の 一 部 に な っ て い ま す 。