XMAN(1) — NEWS-OS Programmer’s Manual
名称
xman − X ウィンドウシステム用のマニュアルページのディスプレイプログラム
形式
xman [−options ...]
解説
xman は、マニュアルページのブラウザーです。 最初の xman ウィンドウのデフォルトサイズは、ログインセッションの 間中、そのウィンドウを実行したままにしておけるように、小さいものです。 最初のウィンドウには、 3 つのオプションがあります。 Help は、 on-line ヘルプをもつウィンドウをポップアップします。 Quit は、終了します。 そして Manual Page はウィンドウ中のマニュアルページブラウザーをもつ ウィンドウをポップアップします。 xman を一度実行することにより、 2 つ以上のマニュアルブラウザーを ポップアップすることができます。
xman の使用に関する情報については、on-line ヘルプ情報を 読んでください。 このマニュアルの残りのページでは、xman のカスタマイズについて 記述します。
xman は、マニュアルページを捜すためのディレクトリと、各ディレクトリが Manual Sections メニュー中にマップする名前の両方をカスタマイズ することを許します。 xman は、環境変数 MANPATH を読み込むことにより、どのディレクトリ を探索するかを決定します。 この環境は、 xman が探索できるようにコロンで区切られたリストの ディレクトリであると期待されます。
setenv MANPATH /mit/kit/man:/usr/man
デフォルトにより、 xman は、以下のディレクトリ（各ディレクトリは、ユーザの MANPATH で指定された） を探索して、マニュアルページを捜します。 マニュアルページがそのディレクトリ内に存在する場合は、対応する メニュー項目に対するマニュアルページのリストに追加されます。 メニュー項目だけが、実際にマニュアルページをもつマニュアルのセクションに 対して表示されます。
ディレクトリセクション名
---------------------
man1 (1) User Commands
man2 (2) System Calls
man3 (3) Subroutines
man4 (4) Devices
man5 (5) File Formats
man6 (6) Games
man7 (7) Miscellaneous
man8 (8) Sys. Administration
manl (l) Local
mann (n) New
mano (o) Old
たとえば、ユーザはマニュアルパスに 3 つのディレクトリをもち、 そのそれぞれが man3 と呼ばれるディレクトリを含んでいるとします。 これらのマニュアルページのすべては、ユーザが、 Subroutines(3) と 呼ばれるメニュー上でクリックしたとき、アルファベット順にソートされて 現れます。 ユーザの MANPATH 内のどのディレクトリにも mano と呼ばれる ディレクトリが存在しない場合、または mano と呼ばれるどの ディレクトリにもマニュアルページがない場合は、 Old(o) と呼ばれる セクションに対してはメニュー項目は表示されません。
mandesc ファイルを使用することにより、ユーザまたはシステム マネージャは、 Manual Sections メニュー内のメニュー項目により 表される各セクションには、どのマニュアルページが現れるかをより厳密に 制御することができます。 この機能は、セクション基準によりセクション上でだけ利用できます。 個々のマニュアルページはこの方法では処理することはできません （記号リンク ln(1) の様々な使用法により想像できる任意の構成のほとんどを 行うことができるけれども）。 mandesc ファイルのフォーマットは、文字の次にラベルがくるものです。 文字は、どのセクションをこのラベルのもとに付加するかを決定します。 たとえば、すべてのプログラマサブルーチンを含む特別なメニュー項目を 作成したいと想定します。 このラベルは、セクション 2 と 3 の両方におけるすべてのマニュアルページ を含まなければなりません。 mandesc ファイルは、このように見えるでしょう。
2Programmer Subroutines
3Programmer Subroutines
これは、メニュー項目を Unix プログラマーズマニュアルのセクション 2 と 3 内のすべてのマニュアルページをもち出すであろう Manual Sections メニューへ付加します。 なぜならば、ラベル名は、同じセクションに付加されるものとまったく 同じだからです。 ただし、オリジナルのセクションもまだ存在することに注意してください。
マニュアルディレクトリ内のデフォルトのセクションを完全に無視したい場合は、 次の行を付加してください。
no default sections
これを付加するのは mandesc ファイル内ならどこでもかまいません。 これにより、 xman がそのディレクトリに関してだけ、デフォルトの マニュアルセクションを探索しないようにすることができます。 たとえば、あなたが上述したことと同じことを行いたいと想定しますが、 System Calls または Subroutines セクションをもつと 役に立つとはもはや思わないでしょう。 デフォルトのエントリを複写し、新しいデフォルトエントリを付加することが 必要でしょう。
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 は、すべてのフォーマットされていないマンページおよびすべての適切な 探索のための一時ファイルを /tmp に作成します。
コマンド行オプション
xman は、標準 X ツールキットのコマンド行オプションをすべて受け付けます
(see X(1))。さらに、以下のオプションを受け付けます。
-helpfile filename
デフォルト以外に使用するヘルプファイルを指定します。
-bothshown
マニュアルページとマニュアルディレクトリの両方を同時にスクリーン上に 表示することができます。
-notopbox
3 つのボタンをもつ Top Menu なしで開始します。
-geometry WxH+X+Y
3 つのボタンをもつ Top Menu サイズと位置を設定します。
-pagesize WxH+X+Y
すべてのマニュアルページのサイズと位置を設定します。
ウィジェット
リソースを記述するために、xman を構成するウィジェットの階層を 知ることは役に立ちます。以下に、インデントを使って階層構造を記述します。 ウィジェットクラスの名前が最初に、次に、ウィジェットインスタンスの名前がきます。
Xman xman (This widget is never used)
TopLevelShell topbox
Form form
Label topLabel
Command helpButton
Command quitButton
Command manpageButton
TransientShell search
DialogWidgetClass dialog
Label label
Text value
Command manualPage
Command apropos
Command cancel
TransientShell pleaseStandBy
Label label
TopLevelShell manualBrowser
Paned Manpage_Vpane
Paned horizPane
MenuButton options
MenuButton sections
Label manualBrowser
Viewport directory
List directory
List directory
.
. (1 つのセクションに
. 1 つずつ作られる。)
.
ScrollByLine manualPage
SimpleMenu optionMenu
SmeBSB displayDirectory
SmeBSB displayManualPage
SmeBSB help
SmeBSB search
SmeBSB showBothScreens
SmeBSB removeThisManpage
SmeBSB openNewManpage
SmeBSB showVersion
SmeBSB quit
SimpleMenu sectionMenu
SmeBSB <name of section>
.
. ( セクションに同じ )
.
TransientShell search
DialogWidgetClass dialog
Label label
Text value
Command manualPage
Command apropos
Command cancel
TransientShell pleaseStandBy
Label label
TransientShell likeToSave
Dialog dialog
Label label
Text value
Command yes
Command no
TopLevelShell help
Paned Manpage_Vpane
Paned horizPane
MenuButton options
MenuButton sections
Label manualBrowser
ScrollByLine manualPage
SimpleMenu optionMenu
SmeBSB displayDirectory
SmeBSB displayManualPage
SmeBSB help
SmeBSB search
SmeBSB showBothScreens
SmeBSB removeThisManpage
SmeBSB openNewManpage
SmeBSB showVersion
SmeBSB quit
アプリケーションリソース
xman は、以下のリソースを使用してカスタマイズできます。
manualFontNormal ( クラス Font)
マニュアルページ中のノーマルテキストに使用するフォント
manualFontBold ( クラス Font)
マニュアルページ中のボールドテキストに使用するフォント
manualFontItalic ( クラス Font)
マニュアルページ中のイタリックのテキストに使用するフォント
directoryFontNormal ( クラス Font)
ディレクトリのテキストに使用するフォント
bothShown ( クラス Boolean)
‘真’ か ‘偽’ のいずれかで、ディレクトリとマニュアルページの両方を 起動時に表示してほしいか否かを指定します。
directoryHeight ( クラス DirectoryHeight)
ディレクトリとマニュアルページが同時に表示されるときのディレクトリの 高さ（ピクセル単位）
topCursor ( クラス Cursor)
トップボックスで使用するカーソル
helpCursor ( クラス Cursor)
ヘルプウィンドウで使用するカーソル
manpageCursor (クラス Cursor)
マニュアルページのウィンドウで使用するカーソル
searchEntryCursor ( クラス Cursor)
探索エントリテキストのウィジェットで使用するカーソル
pointerColor ( クラス Foreground)
これは、上で記述されたすべてのカーソルの色を表します。 この名前は、xterm とのコンパチビリティのために選ばれました。
helpFile ( クラス File)
システムのデフォルトの helpfile ではなくこれを使用します。
topBox ( クラス Boolean)
‘真’ か ‘偽’ のいずれかで、トップボックス（ヘルプ、終了、マニュアル ページボタンを含む）またはマニュアルページを起動時にスクリーン上に 置くか否かを決定します。 デフォルトは ‘真’ です。
verticalList ( クラス Boolean)
‘真’ か ‘偽’ のいずれかで、ディレクトリのリスティングを垂直または水平の いずれかに編成することを決定します。 デフォルトは水平（偽）です。
グローバルアクション
xman は、グローバルアクションを通じてユーザの相互作用を定義します。 これによって、ユーザがウィジェットの翻訳表を修正したり、あるイベントに 対する動作をユーザが新しく定義することができます。 xman には、以下の動作がサポートされてます。
GotoPage(page) マニュアルページを表示するウインドウを使用している時に、 ディレクトリと、マニュアルページの表示を移動することができます。 page は Directory か ManualPage のどちらかです。
Quit() これは、どこでも使用することができ、xman を終了します。
Search(type, action)
これは、サーチのポップアップメニュの中で使用されている時だけ有効です。 サーチのポップアップメニュの文字列入力のウィジェットにおいて、 入力された文字列によってサーチウィジェットが、文字列検索を行ないます。 type は、Apropos か、Manpage か、Cancel のどれかです。 Open の action が、記述されていれば、検索の結果を表示するための マニュアルページをオープンします。さもなければ、サーチのポップアップメニュの 親のウインドウに表示しようとします。
PopupHelp() これは、どこでも使用することができ、ヘルプウィジェットを表示します。
PopupSearch() これは、ヘルプウインドウを除いてどこでも使用できます。 検索のポップアップメニュをアクティブにし、スクリーン上に表示させ、 ユーザの検索を可能にします。
CreateNewManpage()
これは、どこでも使用することができ、新しいマニュアルページウインドウを 表示します。
RemoveThisManpage()
これは、どのマニュアルページや、ヘルプウインドウでも使用できます。 これが呼ばれると、ウインドウを取り除いて、そのウインドウのリソースを 消し去ります。
SaveFormattedPage(action)
これは、"likeToSave" ポップアップウィジェットの中でしか使用できません。 フォーマットされたマニュアルページを保存するかどうかを尋ねます。
ShowVersion() これは、どのマニュアルページや、ヘルプウインドウでも使用できます。 xman のバージョンを表示します。
関連ファイル
<manpath directory>/man<character>
<manpath directory>/cat<character>
<manpath directory>/mandesc
/usr/lib/X11/app-defaults/Xmanリソースを記述します。
/tmpXman は、テンポラリファイルを /tmp につくります。
関連事項
X(1), X(8C), man(1), apropos(1), catman(8), Athena Widget Set
環境変数
DISPLAY デフォルトのホストと、ディスプレイを得るためのもの。
MANPATH マニュアルページ用の探索パス。ディレクトリはコロンで区切られます （たとえば、 /usr/man:/mit/kit/man:/foo/bar/man）。
XENVIRONMENT
RESOURCE_MANAGER プロパティに読み込むリソースを記述したリソースファイルの 名前を得るためのもの。
XAPPLRESDIR この変数の後に Xman という文字列が追加されます。 システムのアプリケーションデフォルトファイルの後に、リソースを リソースデータベースに登録するためのユーザのアプリケーションデフォルト ファイルのフルパスを表します。
バグ
いくらかあります。
著作権
Copyright 1988 by Massachusetts Institute of Technology.
権利と許可の声明文については X(1) を参照のこと。
著者
Chris Peterson, Boston 大学の Barry Shein により書かれた V10バージョン からの MIT Project Athena
NEWS-OSRelease 4.1C