名称

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 で指定された） を探索して、マニュアルページを捜します。 マニュアルページがそのディレクトリ内に存在する場合は、対応する メニュー項目に対するマニュアルページのリストに追加されます。 メニュー項目だけが、実際にマニュアルページをもつマニュアルのセクションに 対して表示されます。

 ディレクトリセクション名
---------------------
man1User Commands       (1)
man2System Calls        (2)
man3Subroutines         (3)
man4Devices             (4)
man5File Formats        (5)
man6Games               (6)
man7Miscellaneous       (7)
man8Sys. Administration (8)
manlLocal               (l)
mannNew                 (n)
manoOld                 (o)
 

たとえば、ユーザはマニュアルパスに 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
1User Commands       (1)
2Programmer Subroutines
3Programmer Subroutines
4Devices             (4)
5File Formats        (5)
6Games               (6)
7Miscellaneous       (7)
8Sys. Administration (8)
lLocal               (l)
nNew                 (n)
oOld                 (o)
 

xman は、man<character> からの任意のセクションを読み込みます。 ここで <character> は大文字か小文字（これらは区別して扱われます）か または数字（0 〜 9）です。 ただし、man(1) と catman(8) は、 標準でないディレクトリは探索しないことに注意してください。

xman は、すべてのフォーマットされていないマンページおよびすべての適切な 探索のための一時ファイルを /tmp に作成します。

コマンド行オプション

-helpfile filename
デフォルト以外に使用する helpfile を指定します。

-bothshown
マニュアルページとマニュアルディレクトリの両方を同時にスクリーン上に 表示することができます。

-notopbox
3 つのボタンをもつ Top Menu なしで開始します。

-geometry WxH+X+Y
3 つのボタンをもつ Top Menu サイズと位置を設定します。

-pagesize WxH+X+Y
すべてのマニュアルページのサイズと位置を設定します。

-bw pixels or -borderwidth pixels
xman でのすべてのウィンドウのボーダの幅を指定します。

-bd color or -bordercolor color
xman でのすべてのウィンドウのボーダの色を指定します。

-fg color or -foreground color
使用するフォアグラウンドの色を指定します。

-bg color or -background color
使用するバックグラウンドの色を指定します。

-fn font or -font font
すべてのボタンとラベルに使用するフォントを指定します。

-display host:display[.screen]
環境変数 DISPLAY により指定されるデフォルト以外のディスプレイを指定します。

-name name
リソース検索時に使用する名前を指定します。

-title title
このアプリケーションのタイトルを指定します。

-xrm resources
コマンド行上にリソースを指定することができます。

X のデフォルト

 
xman は次の X リソースを使用することができます。 foreground, background, width, height, borderWidth, and borderColor. 

ウィジェットリソースに対するデフォルト値を変更するためには、 ウィジェット名を知る必要があります。 以下に、最も一般的ないくつかのウィジェットの名前をリストします。 クラスによってもウィジェットを参照することができます。 最も一般的なクラスは、 Label, Command および Text です。

topBox トップメニュー

help ヘルプウィンドウ

manualBrowser
マニュアルページのディスプレイウィンドウ

xmanCommands
マニュアルページのコマンドポップアップメニュー

xmanSections マニュアルページのセクションポップアップメニュー

xmanSearch マニュアルページの探索ポップアップメニュー

さらに、xman は、一意の xman カスタマイズを許す アプリケーション固有のリソースももっています。

manualFontNormal
マニュアルページ中のノーマルテキストに使用するフォント

manualFontBold マニュアルページ中のボールドテキストに使用するフォント

manualFontItalic マニュアルページ中のイタリックのテキストに使用するフォント

directoryFontNormal
ディレクトリのテキストに使用するフォント

bothShown ‘真’ か ‘偽’ のいずれかで、ディレクトリとマニュアルページの両方を 起動時に表示してほしいか否かを指定します。

directoryHeight ディレクトリとマニュアルページが同時に表示されるときのディレクトリの 高さ（ピクセル単位）

topCursor トップボックスで使用するカーソル

helpCursor ヘルプウィンドウで使用するカーソル

manpageCursor マニュアルページのウィンドウで使用するカーソル

searchEntryCursor
探索エントリテキストのウィジェットで使用するカーソル

helpFile システムのデフォルトの helpfile ではなくこれを使用します。

topBox ‘真’ か ‘偽’ のいずれかで、トップボックス（ヘルプ、終了、マニュアル ページボタンを含む）またはマニュアルページを起動時にスクリーン上に 置くか否かを決定します。 デフォルトは ‘真’ です。

verticalList ‘真’ か ‘偽’ のいずれかで、ディレクトリのリスティングを垂直または水平の いずれかに編成することを決定します。 デフォルトは水平（偽）です。

この情報すべてを、−xrm フラグを使用してコマンド行上で使用することの できる、または .Xresource や .Xdefaults ファイルに付加することのできる リソース仕様に入れて並べる方法の例がいくつかあります。

xman∗Command.foreground: Blue コマンドのボタンはすべて青です。

xman∗topBox∗foreground: Blue トップメニュー内のすべてのものは青のフォアグラウンドをもっています。

xman∗Text.border: Red テキストウィジェットはすべて赤のボーダをもっています。

xman∗Label.font: 9x15 ラベルボタンすべては 9x15 のフォントをもっています。

ファイル

/usr/man/∗ or those specified in the MANPATH. 
mandesc

関連事項

X(1), X(8C), man(1), apropos(1), catman(8)

環境変数

DISPLAY − 使用するためのデフォルトのホストとディスプレイを得るためのもの。
MANPATH − マニュアルページ用の探索パス。 ディレクトリはコロンで区切られます （たとえば、 /usr/man:/mit/kit/man:/foo/bar/man）。

バグ

−fn および −font オプションは、マンページやディレクトリのテキストではなく、 コマンドボタン用のフォントだけを指定します。
"Remove This Manpage" を選択したときのプロトコルエラー。
mandesc ファイルフォーマットの仕様はマンページには指定されて いません。

版権

Copyright 1988 by Massachusetts Institute of Technology. 
権利と許可の声明文については X(1) を参照のこと。

著者

Chris Peterson, Boston 大学の Barry Shein により書かれた V10 バージョン からの MIT Project Athena 

NEWS-OSRelease 3.3