JMAN(1)

名称
jman - 日本語マニュアルページを含めたオンラインマニュアルのフォーマット、表示を行なう

書式
jman [-adfhktow] [-m system] [-p string] [-M path] [-P pager] [-S list] [section] name ...

解説
jman は日本語および英文オリジナルのマニュアルページをフォーマットし、表示します。 このバージョンでは、環境変数 MANPATH と PAGER を参照するので、各ユーザが固有のオンラインマニュアルを持つ事や、画面で見る際のページャを選ぶ事が可能です。 セクションを指定した場合、jman はそのセクションのみを探します。 また、コマンドラインオプションや環境変数によって、検索するセクションの順序や、ソースファイルを処理するプリプロセッサを指定することもできます。 システム管理者の設定によっては、ディスクスペースを節約するために、フォーマット済みのオンラインマニュアルを `/usr/bin/gzip -nf -9' コマンドにより圧縮し格納するようにすることもできます。 ただし、日本語マニュアルページをオリジナルのマニュアルページに優先して表示するためにはあらかじめ環境変数 LC_CTYPE か LANG を ja_JP.eucJP に設定しておく必要があります。

オプションは以下の通りです。

-M path
    別のマニュアルページを検索するパスを指定します。

-P pager
    使用するページャを指定します。 通常、jman は、 jless -s を使用します。 このオプションは環境変数 PAGER よりも優先されます。

-S list
    list はコロンで区切られた検索するマニュアルのセクションのリストです。 このオプションは環境変数 MANSECT よりも優先されます。

-a  通常、jman は最初にみつかったマニュアルページを表示した後終了しますが、このオプションを使用すると、最初にみつかったマニュアルページだけでなく、 name, にマッチしたマニュアルページを全て表示します。

-d  マニュアルページは表示せず、デバッグ用の情報を表示します。

-f  whatis と同じです。

-h  一行のヘルプメッセージを表示して終了します。

-k  apropos と同じです。

-m system
    与えられたシステム名をもとに検索する別のマニュアルセットを指定します。 このオプションは環境変数 SYSTEM よりも優先されます。

-o  環境変数の設定にかかわらず、 オリジナルのマニュアルページ以外の探索・表示を抑制します。

-p string
    nroff や troff を行う前に実行するプリプロセッサの順序を指定します。 全てのプリプロセッサがインストールされているとはかぎりません。 プリプロセッサとそれを指定するのに使われる文字は以下の通りです。 eqn (e), grap (g), pic (p), tbl (t), vgrind (v), refer (r). このオプションは環境変数 MANROFFSEQ よりも優先されます。

-t  マニュアルページをフォーマットするのに /usr/local/bin/groff -S -man -dlang=ja_JP.eucJP を使い、stdout に出力します。 /usr/local/bin/groff -S -man -dlang=ja_JP.eucJP の出力は表示する前に何らかのフィルターを通す必要があるでしょう。

-w  マニュアルページの表示は行わず、フォーマットや表示を行なうべきファイルの場所を表示します。

環境変数
MANPATH
    MANPATH がセットされていれば、その値はマニュアルページを検索するパスとして使われます。
LC_ALL, LC_CTYPE
    オリジナルのマニュアルページに優先して検索するマニュアルページの言語を 変更します。有効なロケール名で指定する必要があります。 LC_ALL は LC_CTYPE よりも優先されます。
LANG
    オリジナルのマニュアルページに優先して検索するマニュアルページの言語を 変更します。有効なロケール名で指定する必要があります。 LC_ALL, LC_CTYPE が設定されていない場合に有効です。
MACHINE
    特定のアーキテクチャ向けのマニュアルページを提供するために、 jman は検索する各ディレクトリの下にある、現在のアーキテクチャ名と同じ名前のディレクトリ以下も検索します。 このアーキテクチャ依存マニュアルの置かれている場所は、アーキテクチャに依存しないマニュアルの置き場所より先に検索されます。 環境変数 MACHINE に特定のアーキテクチャ名がセットされている場合には、 現在のマシン種別よりこちらを優先します。
MANROFFSEQ
    MANROFFSEQ がセットされていれば、その値は nroff や troff を行う前に実行されるプリプロセッサの順序を示すのに使われます。 デフォルトでは、nroff の前に tbl プリプロセッサが実行されます。
MANSECT
    MANSECT がセットされていれば、その値はどのマニュアルセクションを検索するのかを決定するのに使われます。
PAGER
    PAGER がセットされていれば、その値はマニュアルページを表示するのに使われるプログラムの名前を指定するのに使われます。 セットされていなければ、 jless -s が使われます。

使用例

通常、getopt に関連するマニュアルページの情報を見るためには、次のようにします。
    man getopt

一方、特定のセクションのマニュアル、例えば getopt(3) を参照したいときには、以下のようにします。
    man 3 getopt

関連項目
groff(1), japropos(1), jmanpath(1), jwhatis(1), jless(1), man(7), mdoc(7)

バグ
-t オプションは troff ライクなプログラムがインストールされている場合のみ有効です。