Manpages

名 前

PolyglotMan, rman - マ ニ ュ ア ル ペ ー ジ を 整 形 済 み の 状 態 か ら 、 各 種 ソ ー ス 形 式 に 逆 コ ン パ イ ル す る

書 式

rman [ options ] [ file ]

説 明

PolyglotMan は UNIX 系 OS の ほ と ん ど で 使 わ れ て い る マ ニ ュ ア ル ペ ー ジ を 入 力 と し 、 こ れ ら を 各 種 テ キ ス ト の ソ ー ス 形 式 に 変 換 す る 。 PolyglotMan は 以 前 は RosettaMan と 呼 ば れ て い た 。 バ イ ナ リ の 名 前 は rman の ま ま で あ る が 、 こ れ は こ の ツ ー ル を 使 っ て い る ス ク リ プ ト の た め で あ る 。 覚 え る た め に は 単 に "reverse man" と 考 え て お け ば よ い だ ろ う 。 以 前 の PolyglotMan で は 処 理 の 前 に ペ ー ジ を nroff で 整 形 し て お く 必 要 が あ っ た 。 バ ー ジ ョ ン 3.0 か ら は 、 こ の プ ロ グ ラ ム は [tn]roff の ソ ー ス を 入 力 す る ほ う が よ く 、 普 通 は そ の 方 が 良 い 出 力 を 得 ら れ る 。 ま た 、 ソ ー ス 処 理 は 表 組 を 変 換 す る 唯 一 の 方 法 で あ る 。 し か し 、 ソ ー ス 形 式 を 変 換 し た 結 果 は 整 形 済 み の テ キ ス ト を 変 換 し た も の ほ ど 表 現 力 が な い の で 、 整 形 済 み の テ キ ス ト を 予 備 と し て 変 換 し て み る と よ い 。

[tn]roff の ソ ー ス を 解 析 す る に あ た っ て は 、 い く ら で も 大 き な [tn]roff の サ ブ セ ッ ト を 実 装 で き る だ ろ う 。 し か し 作 者 は そ れ を 行 わ な か っ た し 、 行 う つ も り も な い の で 、 変 換 結 果 が 足 り な い こ と が あ る か も し れ な い 。 し か し 、 マ ニ ュ ア ル ペ ー ジ 使 わ れ る 重 要 な 部 分 は 実 装 し て お り 、 そ れ に は tbl (た だ し eqn は 実 装 し て い な い )、 if に よ る 評 価 、 汎 用 マ ク ロ 定 義 な ど が あ る 。 し た が っ て 、 普 通 は 変 換 結 果 は き れ い に 見 え る 。 き れ い に 見 え な い 場 合 は 、 PolyglotMan に か け る 前 に nroff で ペ ー ジ を 処 理 す る こ と 。 た だ し 、 あ る 種 の ペ ー ジ 群 で 使 わ れ て い る 重 要 な マ ク ロ を PolyglotMan が 識 別 で き な い 場 合 は 、 筆 者 に ソ ー ス と nroff 処 理 し た ペ ー ジ を uuencode し た も の を 送 っ て も ら え れ ば 手 伝 え る こ と が あ る だ ろ う 。 .so (ソ ー ス 指 定 ま た は 取 り 込 み )マ ク ロ を 使 っ て 他 の [tn]roff ソ ー ス を 取 り 込 ん だ り リ ダ イ レ ク ト し て い る マ ニ ュ ア ル ペ ー ジ の ソ ー ス を PolyglotMan に か け る 場 合 は 、 そ の ペ ー ジ の 親 デ ィ レ ク ト リ に い な け れ ば な ら な い 。 と い う の も 、 そ の 前 提 の 下 に ペ ー ジ が 書 き 出 さ れ る か ら で あ る 。 例 え ば /usr/man/man1/ls.1 を 変 換 す る 場 合 は 、 最 初 に /usr/man に cd す る こ と 。

PolyglotMan は 次 の OS に 付 属 す る マ ニ ュ ア ル ペ ー ジ を 処 理 で き る : SunOS, Sun Solaris, Hewlett-Packard HP-UX, AT&T System V, OSF/1 (別 名 Digital UNIX), DEC Ultrix, SGI IRIX, Linux, FreeBSD, SCO。 ソ ー ス 処 理 は 次 の OS の も の で 動 作 す る : SunOS, Sun Solaris, Hewlett-Packard HP-UX, AT&T System V, OSF/1 (別 名 Digital UNIX), DEC Ultrix。 こ の プ ロ グ ラ ム は 印 刷 可 能 な ASCII の み の テ キ ス ト (制 御 文 字 は 削 除 さ れ る ) や セ ク シ ョ ン ヘ ッ ダ の み の 出 力 、 Tk, TkMan, [tn]roff (従 来 の マ ニ ュ ア ル ペ ー ジ の ソ ー ス ), SGML, HTML, MIME, LaTeX, LaTeX2e, RTF, Perl 5 POD を 作 成 で き る 。 モ ジ ュ ー ル 化 さ れ た ア ー キ テ ク チ ャ を 使 っ て い る の で 、 新 し い 出 力 形 式 の 追 加 は 容 易 で あ る 。

PolyglotMan の 最 新 版 は い つ で も ftp://ftp.cs.berkeley.edu/ucb/people/phelps/tcltk/rman.tar.Z か ら 入 手 で き る 。

オ プ シ ョ ン

以 下 の オ プ シ ョ ン は 他 の オ プ シ ョ ン と 組 み 合 わ せ て 使 っ て は な ら な い 。 こ れ ら は 入 力 を ま っ た く 処 理 せ ず に PolyglotMan を 終 了 さ せ る 。

-f|--filter
<ASCII|roff|TkMan|Tk|Sections|HTML|SGML|MIME|LaTeX|LaTeX2e|RTF|POD> 出 力 フ ィ ル タ を 指 定 す る 。 デ フ ォ ル ト 値 は ASCII で あ る 。

-F|--format|--formatted

PolyglotMan は 入 力 が ソ ー ス 形 式 か 整 形 済 み テ キ ス ト か を 自 動 的 に 判 別 し よ う と す る 。 こ の オ プ シ ョ ン は 入 力 が 整 形 済 み テ キ ス ト で あ る こ と を 指 定 す る 。

-l|--title printf-string

HTML モ ー ド に お い て 、 マ ニ ュ ア ル ペ ー ジ の <TITLE> オ プ シ ョ ン を 設 定 す る 。 パ ラ メ ー タ は -r と 同 じ 形 式 で 与 え る 。

-r|--reference|--manref printf-string

HTML モ ー ド お よ び SGML モ ー ド に お い て 、 他 の マ ニ ュ ア ル ペ ー ジ を 取 得 す る た め の URL を 設 定 す る 。 こ の 文 字 列 か ら は 指 定 さ れ た 2 つ の パ ラ メ ー タ を 利 用 で き る 。 つ ま り マ ニ ュ ア ル ペ ー ジ の 名 前 と セ ク シ ョ ン 番 号 で あ る (後 述 の 実 行 例 を 参 照 す る こ と )。 文 字 列 が 空 (シ ェ ル で "-r ’’" を 指 定 す る な ど )や ’-’, ’off’ で あ る 場 合 、 HREF に よ る マ ニ ュ ア ル ペ ー ジ の 参 照 は 行 わ れ ず 、 単 に 斜 体 文 字 で 表 示 さ れ る だ け で あ る 。 シ ス テ ム 側 の printf が XPG3 の 位 置 指 示 子 に 対 応 し て い れ ば 、 こ の オ プ シ ョ ン は か な り 柔 軟 に 利 用 で き る 。

-V|--volumes <colon-separated list> 他 の マ ニ ュ ア ル ペ ー ジ と の 相 互 参 照 を 探 す 時 の チ ェ ッ ク に 使 う 正 し い ボ リ ュ ー ム 文 字 の リ ス ト を 設 定 す る 。 デ フ ォ ル ト 値 は 1:2:3:4:5:6:7:8:9:o:l:n:p で あ る (ボ リ ュ ー ム 名 で は 複 数 個 の 文 字 が 使 え る )。 ペ ー ジ 中 の 空 白 を 含 ま な い 文 字 列 の 直 後 に 左 括 弧 が あ り 、 そ の 後 に 正 し い ボ リ ュ ー ム 文 字 の 列 が 続 き 、 最 後 に 右 括 弧 で 終 わ る 場 合 に は 、 そ の 文 字 列 は 他 の マ ニ ュ ア ル ペ ー ジ の 参 照 で あ る と 判 定 さ れ る 。 -V に 指 定 す る 文 字 が 等 号 (=)で 始 ま る 場 合 、 有 効 な ボ リ ュ ー ム 文 字 に 一 致 す る 文 字 列 と 右 括 弧 の 間 に は 他 の 文 字 は あ っ て は な ら な い 。 (こ の オ プ シ ョ ン は SCO UNIX の た め に 必 要 で あ る )。 以 下 の オ プ シ ョ ン は 、 入 力 と し て 整 形 済 み の ペ ー ジ が 与 え ら れ た 場 合 だ け 有 効 で あ る 。 ソ ー ス を 与 え た 場 合 は 使 わ れ な い の で 、 正 し く 処 理 さ れ る こ と に な る 。
-b|--subsections セ ク シ ョ ン の 題 名 に 加 え て 、 サ ブ セ ク シ ョ ン の 題 名 を 識 別 し よ う と す る 。 一 部 の UNIX 系 OS で は 問 題 を 起 こ す か も し れ な い 。

(古 め の nroff の -man マ ク ロ は 必 ず 改 ペ ー ジ を 入 れ る が 、 最 近 は ベ ン ダ に よ っ て は 印 刷 を troff 経 由 で 行 い 、 画 面 表 示 を nroff の -man マ ク ロ で 行 う の で 、 改 ペ ー ジ が 削 除 さ れ て い る 。 ) PolyglotMan は 普 通 は こ の フ ラ グ が な く て も 正 し く 動 作 す る 。 )

(Tcl/Tk の マ ニ ュ ア ル ペ ー ジ で そ う な っ て い る よ う に )チ ェ ン ジ バ ー を 左 へ 寄 せ る 。

(デ フ ォ ル ト 動 作 )で は 、 ペ ー ジ 解 析 に よ り ヘ ッ ダ や フ ッ タ 、 セ ク シ ョ ン 指 定 な ど が 削 除 さ れ る 。

フ ァ イ ル 名 が 「 " name . section "」 の 形 式 で 指 定 さ れ て い る 場 合 、 名 前 と セ ク シ ョ ン は 自 動 的 に 決 め ら れ る 。 ペ ー ジ が [tn]roff の ソ ー ス か ら 解 析 さ れ て い て 、 か つ .TH 行 が あ る 場 合 は 、 こ の 情 報 は そ の 行 か ら 取 り 出 さ れ る 。

nroff が 行 う

よ う に 改 行 を 行 う か ど う か 、 あ る い は 複 数 行 を ま と め て パ ラ グ ラ フ に す る か ど う か を 決 め る 。 主 に 内 部 的 に 使 わ れ る 。

る (roff 形 式 で 使 わ れ る )。 --tables テ ー ブ ル の 解 析 を 攻 撃 的 に 行 う 。

-t|--tabstops # 文 字 数 を 減 ら す た め に 空 白 文 字 の 代 わ り に タ ブ 文 字 を 使 う マ ク ロ セ ッ ト の た め に 、 # カ ラ ム お き に タ ブ 停 止 位 置 を 設 定 す る 。 デ フ ォ ル ト 値 は 8 で あ る 。

各 種 フ ィ ル タ に つ い て の 注 意

ROFF 一 部 の UNIX 系 OS に は 、 マ ニ ュ ア ル ペ ー ジ の [tn]roff ソ ー ス が 付 属 し て い な い 。 そ の た め 、 レ ー ザ ー プ リ ン タ も タ イ プ ラ イ タ と 大 差 な く な っ て し ま う 。 こ の フ ィ ル タ は 元 の [tn]roff の デ ィ レ ク テ ィ ブ を 推 定 し よ う と す る 。 こ れ は 後 で [tn]roff を 使 っ て 再 コ ン パ イ ル で き る 。

TkMan
TkMan (ハ イ パ ー テ キ ス ト 型 の マ ニ ュ ア ル ペ ー ジ ブ ラ ウ ザ )は 、 PolyglotMan を 使 っ て マ ニ ュ ア ル ペ ー ジ を 表 示 す る 。 こ の 際 に (普 通 は )各 ペ ー ジ の 不 要 な ヘ ッ ダ や フ ッ タ は 表 示 し な い 。 こ の プ ロ グ ラ ム は ま た 、 セ ク シ ョ ン と (オ プ シ ョ ン で )サ ブ セ ク シ ョ ン の ヘ ッ ダ を 集 め 、 プ ル ダ ウ ン メ ニ ュ ー か ら 直 接 ア ク セ ス で き る よ う に す る 。 TkMan と Tcl/Tk (TkMan が 使 っ て い る ツ ー ル キ ッ ト )は ftp://ftp.smli.com/pub/tcl/か ら anonymous FTP で 入 手 で き る 。

Tk こ の オ プ シ ョ ン は 、 テ キ ス ト を Tcl の リ ス ト の 並 び と し て 出 力 さ せ る 。 こ の リ ス ト は テ キ ス ト と タ グ の ペ ア を 持 っ て お り 、 こ の タ グ 名 は だ い た い HTML と 同 じ で あ る 。 こ の 出 力 は Tk の テ キ ス ト ウ ィ ジ ェ ッ ト に 差 し 込 む こ と が で き る 。 差 し 込 む た め に は eval <textwidget> insert end <text> を 使 う 。 こ の 形 式 は 、 テ キ ス ト と タ グ を 使 う 他 の プ ロ グ ラ ム で も 比 較 的 容 易 に 解 析 で き る は ず で あ る 。 ASCII も 参 照 す る こ と 。

ASCII ラ イ ン プ リ ン タ に 印 刷 す る と き 、 マ ニ ュ ア ル ペ ー ジ は 文 字 を 重 ね 打 ち す る こ と に よ っ て 特 殊 な テ キ ス ト 効 果 を 出 そ う と す る 。 重 ね 打 ち す る の は 同 じ 文 字 (ボ ー ル ド )や ア ン ダ ー ス コ ア (下 線 )で あ る 。 他 の テ キ ス ト 処 理 ソ フ ト ウ ェ ア (テ キ ス ト エ デ ィ タ 、 検 索 プ ロ グ ラ ム 、 イ ン デ ッ ク ス 作 成 プ ロ グ ラ ム 等 )は こ れ に 対 応 し な け れ ば な ら な い 。 ASCII フ ィ ル タ は こ の 整 形 処 理 を 取 り 除 く 。 nroff の 出 力 を パ イ プ で col -b に 渡 し て も 整 形 処 理 を 取 り 除 く こ と が で き る が 、 こ の プ ロ グ ラ ム は 見 苦 し い ペ ー ジ ヘ ッ ダ や フ ッ タ も 取 り 除 く 。 Tk も 参 照 す る こ と 。

Sections セ ク シ ョ ン と (オ プ シ ョ ン で )サ ブ セ ク シ ョ ン の 題 名 を 出 力 す る 。 こ れ は マ ニ ュ ア ル ペ ー ジ を 処 理 す る 他 の プ ロ グ ラ ム と 組 み 合 わ せ る と 便 利 で あ る 。

HTML
HTTP サ ー バ に Mosaic や 他 の WWW ブ ラ ウ ザ の た め の 簡 単 な 拡 張 を 加 え る と 、 PolyglotMan は 高 品 質 な HTML を 動 的 に 生 成 で き る 。 こ う い っ た 拡 張 や 、 そ の 他 の 拡 張 へ の ポ イ ン タ が PolyglotMan の contrib デ ィ レ ク ト リ に 入 っ て い る 。

SGML こ れ は Docbook DTD へ の ア プ ロ ー チ で あ る が 、 誰 か こ の 分 野 に 本 当 に 興 味 を 持 っ て い る 人 が 、 生 成 さ れ る タ グ を 改 善 し て く れ る こ と を 期 待 し て い る 。 現 在 、 ど れ だ け タ グ が 近 い か を 確 認 し て み て ほ し い 。

MIME
MIME (Multipurpose Internet Mail Extensions, RFC 1563 で 定 義 さ れ て い る ) は MIME 対 応 の メ ー ラ や Emacs (19.29 以 降 ) の 書 式 付 き 文 書 で 使 う と よ い 。

LaTeX お よ び LaTeX2e ど う し て な い の だ ろ う ?

RTF
Mac や NeXT 等 で 使 え る 出 力 で あ る 。 適 当 な マ ニ ュ ア ル ペ ー ジ を 拾 っ て 、 NeXT の 文 書 シ ス テ ム と 統 合 し て よ り よ く で き る だ ろ う 。 NeXT は た ぶ ん 、 こ れ を 行 う た め の 独 自 の マ ニ ュ ア ル ペ ー ジ 用 マ ク ロ を 持 っ て い る 。

PostScript お よ び FrameMaker
PostScript を 生 成 す る に は 、 groff ま た は psroff を 使 う 。 FrameMaker MIF を 生 成 す る に は 、 FrameMaker の 組 み 込 み フ ィ ル タ を 使 う 。 ど ち ら の 場 合 も 、 [tn]roff の ソ ー ス が 必 要 な の で 、 整 形 済 み の マ ニ ュ ア ル ペ ー ジ し か な い 場 合 に は 、 PolyglotMan の roff フ ィ ル タ を 先 に 使 う こ と 。

実 行 例

整 形 済 み の マ ニ ュ ア ル ペ ー ジ で あ る ls.1 を [tn]roff ソ ー ス の 形 式 に 戻 す に は 次 の コ マ ン ド を 実 行 す る :

rman -f roff /usr/local/man/cat1/ls.1 > /usr/local/man/man1/ls.1 大 き な マ ニ ュ ア ル ペ ー ジ は デ ィ ス ク の 節 約 の た め に 圧 縮 さ れ て い る こ と が 多 い (圧 縮 は 整 形 済 み の マ ニ ュ ア ル ペ ー ジ に 対 し て は 特 に 有 効 で あ る 。 と い う の も 、 文 字 と 空 白 が 多 い か ら で あ る )。 こ れ は 長 い マ ニ ュ ア ル ペ ー ジ で あ り 、 た ぶ ん サ ブ セ ク シ ョ ン を 持 つ 構 成 な の で 、 分 割 を 試 み る (マ ク ロ セ ッ ト に よ っ て は 、 サ ブ セ ク シ ョ ン を 区 別 し て い な い の で 、 PolyglotMan が う ま く 検 出 で き な い )。 こ れ を LaTeX 形 式 に 変 換 し て み よ う :

pcat /usr/catman/a_man/cat1/automount.z | rman -b -n automount -s 1 -f latex > automount.man 別 の 指 定 方 法 と し て は man 1 automount | rman -b -n automount -s 1 -f latex > automount.man が あ る 。

HTML/Mosaic の ユ ー ザ の た め に 、 PolyglotMan は ソ ー ス コ ー ド を 修 正 し な く て も 他 の HTML マ ニ ュ ア ル ペ ー ジ を 指 す HTML リ ン ク を 生 成 で き る 。 HTML マ ニ ュ ア ル ペ ー ジ は 予 め 生 成 し て お い て も 動 的 に 作 っ て も よ い 。 ま ず 、 予 め 生 成 し て お く HTML マ ニ ュ ア ル ペ ー ジ は /usr/man/html に 置 く も の と す る 。 こ れ ら を ひ と つ ず つ 作 る に は 以 下 の よ う に す る :
rman -f html -r ’http:/usr/man/html/%s.%s.html’ /usr/man/cat1/ls.1 > /usr/man/html/ls.1.html

HTML ク ラ イ ア ン ト が 拡 張 し て あ り HTML を 動 的 に 生 成 で き る な ら 、 HTML を 生 成 す る 時 に は 以 下 の よ う に す る :
rman -f html -r ’http:~/bin/man2html?%s:%s’ /usr/man/cat1/ls.1

バ グ /互 換 性 が な い 部 分

PolyglotMan は ど ん な 場 合 で も 完 璧 に 動 作 す る わ け で は な い が 、 た い て い は う ま く 動 作 し 、 ど ん な 場 合 で も マ ニ ュ ア ル ペ ー ジ を 編 集 し や す い 形 に 変 換 す る 際 の 手 間 を 軽 減 で き る 。 整 形 済 み の ペ ー ジ の 表 組 (特 に HP の も の )は あ ま り う ま く 扱 え な い 。 表 組 を 認 識 さ せ る に は そ の ペ ー ジ の ソ ー ス を 渡 す よ う に す る こ と 。 マ ニ ュ ア ル 用 の ペ ー ジ ャ で あ る woman は マ ニ ュ ア ル ペ ー ジ の 整 形 に 独 自 の 考 え 方 を 適 用 し て い る 。 こ れ は PolyglotMan を 混 乱 さ せ る 。 整 形 済 み の マ ニ ュ ア ル ペ ー ジ の テ キ ス ト を 直 接 PolyglotMan に 渡 す こ と に よ り 、 woman を 回 避 す る こ と 。

[tn] roff の 出 力 形 式 で は fB で ボ ー ル ド 体 へ の 切 り 替 え を 行 う 。 シ ス テ ム の 持 つ マ ク ロ セ ッ ト が .B を 要 求 す る 場 合 に は 、 PolyglotMan の 出 力 に 後 処 理 を 加 え る 必 要 が あ る 。

関 連 項 目

tkman(1) , xman(1) , man(1) , man(7) ま た は man(5) (こ れ は 使 っ て い る UNIX 系 OS ご と に 異 な る )

作 者

PolyglotMan
Thomas A. Phelps ( phelps [AT] ACM.org ) が University of California, Berkeley の Computer Science Division で 開 発 し た 。 マ ニ ュ ア ル ペ ー ジ の 最 終 更 新 日 : $Date: 2001/01/13 14:56:25 $