Manpages

名 称

groff_tmac − roff 清 書 シ ス テ ム 内 に あ る マ ク ロ フ ァ イ ル

解 説

roff(7) 清 書 シ ス テ ム は 、 特 殊 な 用 途 の ド キ ュ メ ン ト に 適 し た マ ク ロ パ ッ ケ ー ジ を 提 供 し て い ま す 。 そ れ ぞ れ の マ ク ロ パ ッ ケ ー ジ は 、 そ の パ ッ ケ ー ジ の tmac フ ァ イ ル と 呼 ば れ る フ ァ イ ル 中 に マ ク ロ お よ び 定 義 を 格 納 し て い ま す 。 tmac と い う 名 前 は 、 ’Troff MACros’ を 縮 め た も の で す 。

tmac フ ァ イ ル は 、 普 通 の roff ソ ー ス ド キ ュ メ ン ト で す 。 た だ し 、 通 常 こ の フ ァ イ ル に は 定 義 お よ び 設 定 コ マ ン ド し か 含 ま れ て お ら ず 、 テ キ ス ト は 入 っ て い ま せ ん 。 tmac フ ァ イ ル は す べ て tmac デ ィ レ ク ト リ と い う 1 つ あ る い は 少 数 の デ ィ レ ク ト リ 内 に 保 管 さ れ て い ま す 。

名 称 付 け

古 く か ら あ る roff シ ス テ ム に は 、 奇 妙 な 名 称 付 け の 体 系 が あ り ま し た 。 マ ク ロ パ ッ ケ ー ジ の 名 称 が ’m’ で 始 ま っ て い る 場 合 に は 、 こ の 文 字 は 省 略 さ れ ま し た 。 例 え ば 、 マ ニ ュ ア ル ペ ー ジ 用 の マ ク ロ パ ッ ケ ー ジ manan と 呼 ば れ 、 そ の パ ッ ケ ー ジ の マ ク ロ フ ァ イ ル は tmac.an と 呼 ば れ ま し た (現 在 の バ ー ジ ョ ン の groff で は 、 こ の フ ァ イ ル は 代 り に an.tmac と 呼 ば れ る こ と に 注 意 し て く だ さ い )。 似 た よ う な 理 由 で 、 名 称 が ’m’ で 始 ま ら な い マ ク ロ パ ッ ケ ー ジ は 、 ’m’ を つ け て 表 さ れ る こ と が よ く あ り ま し た 。 例 え ば 、 tmac.doc に 対 応 す る パ ッ ケ ー ジ は 、 mdoc と 呼 ば れ ま し た 。 な ぜ な ら 、 こ の パ ッ ケ ー ジ を ア ク テ ィ ブ に す る た め の コ マ ン ド ラ イ ン は 、 次 の よ う に 表 さ れ る か ら で す 。

troff −mdoc 現 在 の groff(1) の バ ー ジ ョ ン で は 、 パ ッ ケ ー ジ 名 に ’m’ が 付 こ う が 付 く ま い が 、 こ の 悩 ま し い マ ク ロ パ ッ ケ ー ジ の 名 称 付 け 体 系 を ど ち ら も 提 供 し て い ま す 。 で す の で 、 groff で は 、 man マ ク ロ パ ッ ケ ー ジ は 、 次 の い ず れ で も 指 定 可 能 で す 。

groff −m man
groff −m
an
groff −m
man
groff −m
an シ ス テ ム で ど の マ ク ロ パ ッ ケ ー ジ が 利 用 可 能 で あ る か を 判 別 す る の に 最 も 簡 単 な 方 法 は 、 tmac デ ィ レ ク ト リ 群 の 中 身 を 調 べ る こ と で す 。 例 え ば 、 tmac.anything ま た は anything.tmac と 呼 ば れ る フ ァ イ ル は 、 anything と い う 名 前 の マ ク ロ パ ッ ケ ー ジ を 決 定 し て い ま す 。

groff で は 、 マ ク ロ パ ッ ケ ー ジ の 大 部 分 は 、 古 く か ら あ る パ ッ ケ ー ジ に 対 し て ’m’ を 先 頭 に 付 け た groff_<name>(7) と い う 名 前 の マ ニ ュ ア ル ペ ー ジ で 説 明 が さ れ て い ま す 。

取 り 込 み

ド キ ュ メ ン ト 中 で マ ク ロ パ ッ ケ ー ジ を 使 う た め の 方 法 は い く つ か あ り ま す 。 実 行 時 に 、 groff の オ プ シ ョ ン −m name を 用 い て マ ク ロ フ ァ イ ル name.tmac 内 の 定 義 を 名 称 付 け の セ ク シ ョ ン で 述 べ た よ う に 利 用 可 能 に し ま す 。 こ の フ ァ イ ル が 見 付 か ら な い 場 合 、 tmac.name が 探 さ れ ま す 。

groff リ ク エ ス ト .so あ る い は .mso を 用 い て マ ク ロ フ ァ イ ル を ド キ ュ メ ン ト に 取 り 込 む こ と も 可 能 で す 。 .so に つ い て は 、 マ ク ロ フ ァ イ ル の フ ル パ ス で の フ ァ イ ル 名 を 指 定 し な く て は い け ま せ ん — そ の マ ク ロ フ ァ イ ル が 保 存 さ れ て い る デ ィ レ ク ト リ を 含 む 必 要 が あ り ま す 。 マ ク ロ フ ァ イ ル が tmac デ ィ レ ク ト リ 群 の ど れ か 1 つ に 格 納 さ れ て い る 場 合 、 代 わ り に .mso を 使 用 す る ほ う が 便 利 で す 。 な ぜ な ら 、 こ の リ ク エ ス ト は tmac パ ス を 探 索 し て フ ァ イ ル 名 を 見 つ け る か ら で す 。 更 に 、 イ ン ク ル ー ド さ れ る フ ァ イ ル の 名 前 が name.tmac と い う 書 式 の 場 合 で こ れ が 見 付 か ら な い 場 合 、 .mso は 代 り に tmac.name を オ ー プ ン し よ う と し ま す 。 ま た 、 こ の 逆 も 行 い ま す 。

.so お よ び .mso リ ク エ ス ト を 解 決 す る た め に 、 roff プ リ プ ロ セ ッ サ soelim が 呼 ば れ な く て は な ら な い こ と に 注 意 し て く だ さ い 。 た だ し 、 イ ン ク ル ー ド さ れ る フ ァ イ ル が 前 処 理 が 必 要 な 場 合 に 限 り ま す 。 こ れ は 、 コ マ ン ド ラ イ ン 上 で パ イ プ ラ イ ン か ら 直 接 呼 ぶ か 、 ま た は groff−s オ プ シ ョ ン を 使 う か す れ ば で き ま す 。 約 束 事 の セ ク シ ョ ン で 述 べ て い る よ う に 、 プ リ プ ロ セ ッ サ ワ ー ド 中 に 文 字 ’s’ を 入 れ て も 良 い で す 。 例 え ば 、 マ ク ロ フ ァ イ ル が /usr/share/tmac/macros.tmac に 保 存 さ れ て お り 、 docu.roff と い う 名 前 の ド キ ュ メ ン ト で 使 用 さ れ て い る と し ま す 。 実 行 時 に お い て 、 こ の ド キ ュ メ ン ト に 対 す る フ ォ ー マ ッ タ 呼 び 出 し は 次 の よ う に 行 い ま す 。

groff −m macros docu.roff ド キ ュ メ ン ト 内 に 直 接 マ ク ロ フ ァ イ ル を 取 り 込 む に は 、
.mso macros.tmac あ る い は
.so /usr/share/tmac/macros.tmac を 使 用 し ま す 。 ど ち ら の 場 合 で も 、 フ ォ ー マ ッ タ は
groff −s docu.roff を 使 用 し て 呼 び 出 さ れ ま す 。

約 束 事

最 近 の roff 清 書 シ ス テ ム の 多 く で サ ポ ー ト さ れ て い る 約 束 事 が あ り ま す 。 次 に 述 べ ら れ て い る よ う な プ リ プ ロ セ ッ サ ワ ー ド が そ れ で す 。 ド キ ュ メ ン ト の 1 行 目 が コ メ ン ト で あ る 場 合 、 最 初 の 単 語 (コ メ ン ト 文 字 お よ び 空 白 の 後 ) は プ リ プ ロ セ ッ サ ワ ー ド で 構 成 さ れ ま す 。 こ れ は つ ま り 、 こ の ワ ー ド の 文 字 が 、 ド キ ュ メ ン ト を 整 形 す る 際 に 起 動 し な く て は な ら な い プ リ プ ロ セ ッ サ コ マ ン ド の 省 略 形 で あ る と 解 釈 さ れ る と い う こ と で す 。 ほ と ん ど の 場 合 、 プ リ プ ロ セ ッ サ の オ プ シ ョ ン に 対 応 し た 文 字 だ け が 認 識 さ れ ま す 。 そ れ は 、 ’e’, ’G’, ’g’, ’p’, ’R’, ’s’, ’t’ で す ( roff(7) を 参 照 )。 さ ら に 、 ユ ー ザ へ の 良 き 忘 備 録 と し て 書 い て お き ま す が 、 フ ォ ー マ ッ タ に よ っ て は ( man(1) プ ロ グ ラ ム の よ う に ) プ リ プ ロ セ ッ サ ワ ー ド で 指 定 さ れ た プ リ プ ロ セ ッ サ を 自 動 的 に 起 動 さ せ る こ と ま で も で き る も の が あ り ま す 。 た だ し 、 こ の こ と を あ て に し て は い け ま せ ん 。

マ ク ロ フ ァ イ ル を 記 述 す る

マ ク ロ フ ァ イ ル を 記 述 す る の は 簡 単 で す 。 マ ク ロ 、 文 字 列 、 レ ジ ス タ な ど の セ ッ ト を 設 計 し て く だ さ い 。 そ し て そ れ を 1 つ の フ ァ イ ル に 保 存 し て く だ さ い 。 記 述 し た マ ク ロ を 使 用 す る ド キ ュ メ ン ト は 、 取 り 込 み セ ク シ ョ ン で 述 べ た よ う に .so リ ク エ ス ト を 使 っ て マ ク ロ を 取 り 込 み ま す 。

tmac の 機 能 を 使 用 す る に は 、 マ ク ロ フ ァ イ ル whatever.tmac (ま た は tmac.whatever) を 呼 び 出 し 、 tmac パ ス の ど れ か の デ ィ レ ク ト リ に フ ァ イ ル を 置 き ま す 。 関 連 フ ァ イ ル セ ク シ ョ ン を 参 照 し て く だ さ い 。 そ う す る と 、 ド キ ュ メ ン ト は 取 り 込 み セ ク シ ョ ン で 述 べ た よ う に .mso リ ク エ ス ト あ る い は groff −m オ プ シ ョ ン を 使 っ て マ ク ロ フ ァ イ ル を 取 り 込 む こ と が で き ま す 。 も し あ な た が 書 い た マ ク ロ が 一 般 用 途 に 使 え る か も し れ な い も の な ら 、 groff メ ン テ ナ に 連 絡 を 取 っ て 、 そ の マ ク ロ が groff の contrib ソ ー ス デ ィ レ ク ト リ に 含 ま れ る よ う に し て く だ さ い 。 マ ク ロ を 書 く 際 に は 、 い く つ か 一 般 的 な ガ イ ド ラ イ ン が あ れ ば 役 に 立 つ で し ょ う 。

• 機 能 の あ る バ ッ ク ス ラ ッ シ ュ は す べ て

2 重 に し ま す 。 ’\’ -> ’\\

• 印 字 可 能 な バ ッ ク ス ラ ッ シ ュ は す べ て

\e’ と い う よ う に 書 か な く て は な り

ま せ ん 。

• ド ッ ト は す べ て エ ス ケ ー プ し て く だ さ い 。

.’ -> ’\.

• テ キ ス ト 部 分 に は 、 印 字 で き な い 文 字

\&’ を 広 く 使 用 す る よ う に し て く だ さ い 。 特 に 、 ’\’ の 前 や 行 頭 で 使 用 し て く だ さ い 。 た だ し 、 遅 延 コ マ ン ド の 前 で は 使 用 し な い で く だ さ い 。

• 文 字

@’ を 一 時 的 な 変 数 名 に 使 用 し て く だ さ い 。

• あ な た

が 書 い た マ ク ロ を テ キ ス ト お よ び グ ラ フ ィ ッ ク デ バ イ ス に 対 し て テ ス ト し て く だ さ い 。 例 え ば 、 latin1ps が そ う で す 。

関 連 フ ァ イ ル

tmac メ カ ニ ズ ム を 使 用 し た い マ ク ロ 名 は す べ て 、 name.tmac ま た は tmac.name の 書 式 に 従 っ て 名 付 け ら れ な け れ ば な り ま せ ん 。 マ ク ロ フ ァ イ ル は 、 tmac デ ィ レ ク ト リ 群 に 保 存 さ れ て い ま す 。 こ の デ ィ レ ク ト リ 群 す べ て が tmac パ ス を 構 成 し て い ま す 。 マ ク ロ フ ァ イ ル を 検 索 す る パ ス の 要 素 は (順 番 に ) 次 の 通 り で す :

troff に 対 応 す る groff の −M コ マ ン ド ラ イ ン オ プ シ ョ ン で 指 定 さ れ る デ ィ レ ク ト リ command line option

GROFF_TMAC_PATH 環 境 変 数 で 与 え ら れ る デ ィ レ ク ト リ

現 在 の デ ィ レ ク ト リ ( −U コ マ ン ド ラ イ ン ス イ ッ チ を 使 用 し て 、 安 全 で は な い モ ー ド で あ る 場 合 の み )

ホ ー ム デ ィ レ ク ト リ

• サ イ ト 固 有 の

(プ ラ ッ ト フ ォ ー ム 非 依 存 の ) デ ィ レ ク ト リ 、 プ ラ ッ ト

フ ォ ー ム 固 有 デ ィ レ ク ト リ 、 そ し て メ イ ン tmac デ ィ レ ク ト リ :

/usr/share/tmac

/usr/share/tmac
/usr/share/tmac

環 境 変 数

GROFF_TMAC_PATH コ ロ ン 区 切 り の 追 加 の tmac デ ィ レ ク ト リ リ ス ト で あ り 、 こ の リ ス ト か ら マ ク ロ フ ァ イ ル を 探 し ま す 。 詳 細 に つ い て は 、 前 の 節 を 参 照 し て く だ さ い 。

バ グ

groff ド キ ュ メ ン ト は 、 現 在 発 展 中 で す 。 一 時 的 に 他 の ド キ ュ メ ン ト と の 間 で 小 さ な 食 い 違 い が で き て し ま う 可 能 性 が あ り ま す 。

作 者

こ の ド キ ュ メ ン ト は groff、 す な わ ち GNU roff 配 布 物 の 一 部 で す 。 こ の ド キ ュ メ ン ト は Bernd Warken <bwarken [AT] mayn.de> が 書 き ま し た 。 こ の ド キ ュ メ ン ト は FDL (GNU Free Documentation License) バ ー ジ ョ ン 1.1 以 降 の 条 項 の も と で 配 布 さ れ て い ま す 。 お 使 い の シ ス テ ム に は FDL の コ ピ ー が あ る は ず で す 。 ま た 、

<http://www.gnu.org/copyleft/fdl.html>; か ら オ ン ラ イ ン で も 入 手 可 能 で す 。

関 連 項 目

groff シ ス テ ム の 詳 細 す べ て に つ い て 信 頼 で き る 情 報 源 は 、 groff の info(1) フ ァ イ ル で す 。

groff の 概 要 に つ い て は 、 roff(7) お よ び groff ソ ー ス パ ッ ケ ー ジ 中 の README フ ァ イ ル を 参 照 し て く だ さ い 。

groff tmac マ ク ロ パ ッ ケ ー ジ は 、 groff_man(7), groff_mwww(7), groff_mdoc(7), groff_mdoc.samples(7), groff_me(7), groff_mm(7), groff_mmroff(7), groff_ms(7) で す 。

groff の 言 語 に つ い て は groff(7) で 、 フ ォ ー マ ッ タ に つ い て は groff(1), troff(1) で 説 明 さ れ て い ま す 。 フ ァ イ ル シ ス テ ム 階 層 標 準 (FHS) は http://www.pathname.com/fhs/ で 入 手 可 能 で す 。

COMMENTS