Manpages

名 前

xman − オ ン ラ イ ン マ ニ ュ ア ル 表 示 プ ロ グ ラ ム

書 式

xman [ −options ... ]

説 明

xman は オ ン ラ イ ン マ ニ ュ ア ル の ブ ラ ウ ザ で あ る 。 xman の 起 動 時 の ウ ィ ン ド ウ の デ フ ォ ル ト サ イ ズ は 小 さ い の で 、 ユ ー ザ は ロ グ イ ン セ ッ シ ョ ン の 間 ず っ と xman の ウ ィ ン ド ウ を 出 し た ま ま に で き る 。 初 期 ウ ィ ン ド ウ に は 3つ の コ マ ン ド が 選 択 で き る : Help ボ タ ン は オ ン ラ イ ン ヘ ル プ の ウ ィ ン ド ウ を ポ ッ プ ア ッ プ さ せ 、 Quit は xman を 終 了 さ せ 、 Manual Page は マ ニ ュ ア ル ペ ー ジ ブ ラ ウ ザ を 含 む ウ ィ ン ド ウ を ポ ッ プ ア ッ プ さ せ る 。 Control-S を 入 力 す る と 、 表 示 す る 特 定 の マ ニ ュ ア ル を 問 い 合 わ せ る ウ ィ ン ド ウ が ポ ッ プ ア ッ プ す る 。 こ れ に よ り 、 xman を 一 つ 実 行 す る だ け で 複 数 の マ ニ ュ ア ル ブ ラ ウ ザ の ウ ィ ン ド ウ を 表 示 す る こ と が で き る 。

xman の よ り 詳 し い 情 報 に つ い て は 、 オ ン ラ イ ン ヘ ル プ を 参 照 す る こ と 。 こ の マ ニ ュ ア ル の ほ と ん ど は xman の カ ス タ マ イ ズ に 関 す る 説 明 で あ る 。

オ プ シ ョ ン

xman は X ツ ー ル キ ッ ト 標 準 の コ マ ン ド 行 オ プ シ ョ ン (X(1) 参 照 ) を 全 て サ ポ ー ト し て い る 。 こ れ に 加 え て 、 以 下 の オ プ シ ョ ン も サ ポ ー ト し て い る 。
−helpfile filename デ フ ォ ル ト で な い ヘ ル プ フ ァ イ ル を 使 用 す る 。
−bothshown マ ニ ュ ア ル ペ ー ジ と マ ニ ュ ア ル デ ィ レ ク ト リ を 同 時 に ス ク リ ー ン に 表 示 す る 。
−notopbox 起 動 時 に 3つ の ボ タ ン が あ る ト ッ プ メ ニ ュ ー を 出 さ な い 。
−geometry WxH+X+Y

3つ の ボ タ ン が あ る ト ッ プ メ ニ ュ ー の サ イ ズ と 位 置 を セ ッ ト す る 。

−pagesize WxH+X+Y 全 て の マ ニ ュ ア ル ペ ー ジ の サ イ ズ と 位 置 を セ ッ ト す る 。

XMANの カ ス タ マ イ ズ

xman で は 、 マ ニ ュ ア ル ペ ー ジ を 探 す た め の デ ィ レ ク ト リ と Sections メ ニ ュ ー で デ ィ レ ク ト リ が 対 応 す る 名 前 の 両 方 を カ ス タ マ イ ズ す る こ と が で き る 。 xman は 環 境 変 数 MANPATH を 使 っ て 、 xman が 検 索 す る デ ィ レ ク ト リ を 決 定 す る 。 MANPATH が セ ッ ト さ れ て い な い 場 合 、 POSIX シ ス テ ム な ら ば デ ィ レ ク ト リ /usr/man が 検 索 さ れ る 。 こ の 環 境 変 数 は xman が 検 索 す る デ ィ レ ク ト リ を コ ロ ン で 区 切 っ て 並 べ た も の で あ る 。

セ ク シ ョ ン 名

BSD AND LINUX SYSTEMS

最 近 の BSD お よ び Linux で は 、 xman は /etc/man.conf と い う フ ァ イ ル を 検 索 す る 。 こ の フ ァ イ ル に は オ ン ラ イ ン マ ニ ュ ア ル が 置 か れ て い る デ ィ レ ク ト リ の リ ス ト が 書 か れ て い る 。 こ の フ ァ イ ル の 書 式 の 詳 し い 説 明 に つ い て は man.conf(5) を 参 照 す る こ と 。

MANDESC フ ァ イ ル

ユ ー ザ や シ ス テ ム 管 理 者 は 、 mandesc フ ァ イ ル を 使 っ て 、 Sections メ ニ ュ ー の メ ニ ュ ー 項 目 に 現 れ る そ れ ぞ れ の セ ク シ ョ ン に お い て ど の マ ニ ュ ア ル ペ ー ジ が 表 示 さ れ る か を 細 か く 制 御 す る こ と が で き る 。 こ の 機 能 は セ ク シ ョ ン だ け に 基 づ く も の で あ り 、 個 々 の マ ニ ュ ア ル ペ ー ジ を 扱 う こ と は で き な い 。 (た だ し 、 シ ン ボ リ ッ ク リ ン ク — ln(1) 参 照 —を 大 量 に 使 え ば 、 ほ と ん ど ど ん な 設 定 も 可 能 で あ る 。 )

mandesc フ ァ イ ル の フ ォ ー マ ッ ト は 1つ の 文 字 の 後 に ラ ベ ル を 続 け た も の で あ る 。 こ の 文 字 は 、 こ の ラ ベ ル の 下 に 追 加 さ れ る セ ク シ ョ ン を 決 め る 。 例 え ば 、 内 容 全 て が プ ロ グ ラ マ 用 の サ ブ ル ー チ ン で あ る 新 し い メ ニ ュ ー 項 目 を 作 る 場 合 を 考 え る 。 こ の ラ ベ ル は セ ク シ ョ ン 2と 3の 全 て の マ ニ ュ ア ル ペ ー ジ を 含 ま な け れ ば な ら な い 。 こ の よ う な 場 合 の mandesc フ ァ イ ル の 記 述 は 次 の よ う に な る :

2Programmer Subroutines
3Programmer Subroutines こ の 指 定 に よ り Sections メ ニ ュ ー に 対 し て 、 プ ロ グ ラ マ ズ マ ニ ュ ア ル の セ ク シ ョ ン 2と 3の マ ニ ュ ア ル ペ ー ジ を 全 て 含 む 項 目 が 追 加 さ れ る 。 ラ ベ ル 名 は 全 く 同 じ な の で 、 こ れ ら は 同 じ セ ク シ ョ ン に 追 加 さ れ る 。 し か し 、 元 の セ ク シ ョ ン は 存 在 し 続 け る 点 に 注 意 す る こ と 。 マ ニ ュ ア ル デ ィ レ ク ト リ の デ フ ォ ル ト の セ ク シ ョ ン を 完 全 に 無 視 し た い 場 合 に は 、 次 の 行 を mandesc フ ァ イ ル の ど こ か に 追 加 す る こ と :

no default sections こ れ に よ り 、 xman は そ の デ ィ レ ク ト リ に 限 っ て デ フ ォ ル ト の マ ニ ュ ア ル セ ク シ ョ ン の 検 索 を 行 わ な く な る 。 例 え ば 、 先 の 例 と 目 的 は ほ ぼ 同 じ で あ る が 、 シ ス テ ム コ ー ル ま た は サ ブ ル ー チ ン セ ク シ ョ ン は も は や 不 要 で あ る 場 合 を 考 え る 。 こ の 場 合 に は デ フ ォ ル ト の エ ン ト リ を 複 製 し て 、 新 し い も の を 加 え る 必 要 が あ る 。

no default sections
1(1) User Commands
2Programmer Subroutines
3Programmer Subroutines
4(4) Devices
5(5) File Formats
6(6) Games
7(7) Miscellaneous
8(8) Sys. Administration
l(l) Local
n(n) New
o(o) Old

xman は man<character> と い う 形 の セ ク シ ョ ン を 全 て 読 み 込 む 。 こ こ で <character> は 大 文 字 、 小 文 字 (両 者 は 区 別 さ れ る )ま た は 数 値 (0-9)の い ず れ か で あ る 。 た だ し 、 man(1) と catman(8) は 非 標 準 の デ ィ レ ク ト リ は 検 索 し な い 点 に 注 意 す る こ と 。

ウ ィ ジ ェ ッ ト

リ ソ ー ス を 指 定 す る 際 に は 、 xman を 構 成 す る ウ ィ ジ ェ ッ ト の 階 層 を 知 っ て お く と 便 利 で あ る 。 以 下 の 記 法 に お い て は 、 イ ン デ ン ト で 階 層 構 造 を 示 す 。 ま た 、 先 に ウ ィ ジ ェ ッ ト の ク ラ ス 名 を 示 し 、 そ の 後 に ウ ィ ジ ェ ッ ト の イ ン ス タ ン ス 名 を 示 す 。

ア プ リ ケ ー シ ョ ン の リ ソ ー ス

xman 特 有 の カ ス タ マ イ ズ を 行 う た め の 、 ア プ リ ケ ー シ ョ ン 固 有 の リ ソ ー ス を 以 下 に 示 す 。
manualFontNormal (Class Font) マ ニ ュ ア ル ペ ー ジ の 通 常 の テ キ ス ト に 使 う フ ォ ン ト 。
manualFontBold (Class Font) マ ニ ュ ア ル ペ ー ジ の ボ ー ル ド 体 の テ キ ス ト に 使 う フ ォ ン ト 。
manualFontItalic (Class Font) マ ニ ュ ア ル ペ ー ジ の イ タ リ ッ ク 体 の テ キ ス ト に 使 う フ ォ ン ト 。
directoryFontNormal (Class Font) デ ィ レ ク ト リ の テ キ ス ト 表 示 に 使 う フ ォ ン ト 。
bothShown (Class Boolean)

’true’ か ’false’ の 値 を 持 ち 、 起 動 時 に デ ィ レ ク ト リ と マ ニ ュ ア ル ペ ー ジ の 両 方 を 表 示 す る か ど う か を 指 定 す る 。

directoryHeight (Class DirectoryHeight) デ ィ レ ク ト リ と マ ニ ュ ア ル ペ ー ジ を 同 時 に 表 示 す る 場 合 に 、 デ ィ レ ク ト リ 表 示 部 分 の 高 さ を ピ ク セ ル 数 で 指 定 す る 。
topCursor (Class Cursor) ト ッ プ ボ ッ ク ス 内 で 用 い る カ ー ソ ル 。
helpCursor (Class Cursor) ヘ ル プ ウ ィ ン ド ウ 内 で 用 い る カ ー ソ ル 。
manpageCursor (Class Cursor) マ ニ ュ ア ル ペ ー ジ 表 示 ウ ィ ン ド ウ で 用 い る カ ー ソ ル 。
searchEntryCursor (Class Cursor) テ キ ス ト ウ ィ ジ ェ ッ ト の 検 索 エ ン ト リ で 用 い る カ ー ソ ル 。
pointerColor (Class Foreground) 上 述 の カ ー ソ ル (ポ イ ン タ )全 て の 色 を 指 定 す る 。 色 の 名 前 は xterm と 互 換 で あ る 。
helpFile (Class File) シ ス テ ム の デ フ ォ ル ト の 代 わ り に 使 う ヘ ル プ フ ァ イ ル を 指 定 す る 。
topBox (Class Boolean)

’true’ ま た は ’false’ の 値 を 持 ち 、 起 動 時 に ト ッ プ ボ ッ ク ス (Help, Quit, Manual Page ボ タ ン を 持 つ ウ ィ ン ド ウ )と マ ニ ュ ア ル ペ ー ジ の ど ち ら を 表 示 す る か 指 定 す る 。 デ フ ォ ル ト 値 は True で あ る 。

verticalList (Class Boolean)

’true’ ま た は ’false’ の 値 を 持 ち 、 デ ィ レ ク ト リ の リ ス ト を 縦 に 並 べ る か 横 に 並 べ る か 指 定 す る 。 デ フ ォ ル ト で は 横 に 並 べ る (値 が False)。

グ ロ ー バ ル な ア ク シ ョ ン

xman は ユ ー ザ と の 対 話 処 理 は 全 て グ ロ ー バ ル な ア ク シ ョ ン で 定 義 し て い る 。 こ れ に よ り 、 ユ ー ザ は 任 意 の ウ ィ ジ ェ ッ ト の ト ラ ン ス レ ー シ ョ ン テ ー ブ ル を 変 更 し 、 任 意 の イ ベ ン ト を 新 し い ユ ー ザ ア ク シ ョ ン に 割 り 当 て る こ と が で き る 。 xman が サ ポ ー ト し て い る ア ク シ ョ ン を 以 下 に 示 す :

page は Directory ま た は ManualPage で あ る 。

Search(type, action) 検 索 ポ ッ プ ア ッ プ 内 で 使 っ た と き し か 役 に 立 た な い が 、 こ の ア ク シ ョ ン は 検 索 ポ ッ プ ア ッ プ の value ウ ィ ジ ェ ッ ト 内 の 文 字 列 に つ い て 、 指 定 さ れ た タ イ プ の 検 索 を 検 索 ウ ィ ジ ェ ッ ト に 実 行 さ せ る 。 引 き 数 type は Apropos, Manpage, Cancel の い ず れ か で あ る 。 action が Open で あ れ ば 、 xman は 検 索 の 結 果 を 表 示 す る た め に 新 し い マ ニ ュ ア ル ペ ー ジ を 開 く 。 そ う で な い 場 合 に は 、 xman は 検 索 ポ ッ プ ア ッ プ の 親 ウ ィ ジ ェ ッ ト 内 に 結 果 を 表 示 し よ う と す る 。

ポ ッ プ ア ッ プ さ せ る 。

CreateNewManpage() こ の ア ク シ ョ ン は ど こ で も 使 用 で き 、 新 し い マ ニ ュ ア ル ペ ー ジ 表 示 ウ ィ ン ド ウ を 開 く 。
RemoveThisManpage() こ の ア ク シ ョ ン は マ ニ ュ ア ル ペ ー ジ 表 示 ウ ィ ン ド ウ か ヘ ル プ 表 示 ウ ィ ン ド ウ 内 で 使 用 で き る 。 こ の ア ク シ ョ ン は ウ ィ ン ド ウ を 削 除 し 、 こ れ に 関 連 す る 全 て の リ ソ ー ス を 消 去 す る 。
SaveFormattedPage(action) こ の ア ク シ ョ ン は likeToSave ポ ッ プ ア ッ プ ウ ィ ジ ェ ッ ト 内 で の み 使 用 で き 、 フ ォ ー マ ッ ト し た マ ニ ュ ア ル ペ ー ジ を セ ー ブ す る か ど う か (Save ま た は Cancel)を xman に 指 示 す る 。

xman の 現 在 の バ ー ジ ョ ン を 表 示 さ せ る 。

フ ァ イ ル

<manpath directory>/man<character>
<manpath directory>/cat<character>
<manpath directory>/mandesc
<XRoot>/lib/X11/app-defaults/Xman 必 要 な リ ソ ー ス を 指 定 す る 。 <XRoot> は X11 の イ ン ス ト ー ル ツ リ ー の ル ー ト を 指 す 。

関 連 項 目

X(7), man(1), apropos(1), catman(8), Athena ウ ィ ジ ェ ッ ト セ ッ ト

環 境 変 数

(例 : /usr/man:/mit/kit/man:/foo/bar/man)。

著 者

Chris Peterson, MIT X コ ン ソ ー シ ア ム 。 Boston University(当 時 )の Barry Shein に よ る V10 バ ー ジ ョ ン か ら 作 成 し た 。