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 に設定しておく必要があります。

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

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

−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 がセットされていれば、その値はマニュアルページを検索 するパスとして使われます。
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 ライクなプログラムがインストールされている場合のみ 有効です。

FreeBSD 10.0 June 11, 2001 FreeBSD 10.0