man(1)

名前
man - オンラインマニュアルページを整形し表示する。
manpath - ユーザー個々のマニュアルページの検索パスを決める。

書式
man [-adfhktwW] [-m system] [-p string] [-C config_file] [-M path] [-P pager] [-S section_list] [section] name ...

説明
man はオンライン・マニュアル・ページを整形し表示する。このバージョン の man コマンドでは環境変数 MANPATH と (MAN)PAGER を設定できる。 これにより、個人的なマニュアルページを設定したり、整形したページを 表示するプログラムを好きに選べる。 section を指定すると、 man はマニュアルのそのセクションのみ探す。またコマンドライン・オプションや 環境変数で、それぞれのセクションを検索する順序や、ソース・ファイルに 対してどんなプリプロセッサを用いるかを指定したりすることができる。 name に / が含まれているとき man コマンドはまずファイル名として扱う。 したがって man ./foo.5 または man /cd/foo/bar.1.gz とさえできる。

オプション

-C  config_file
    使用する man.conf ファイルを指定する。デフォルトは @man_config_file@ (参照： man.conf(5))

-M  path
    マニュアル・ページを探すディレクトリのリストを指定する。 このオプションを指定しない場合、環境変数 MANPATH を使う。この環境変数も指定しないと、 @man_config_file@ に指定されたデフォルトのリストを使う。 MANPATH 中の空の文字列はデフォルトのリストを意味する。

-P  pager
    使用するページャーを指定する。デフォルトでは man は @pager@ を使う。このオプションは環境変数 MANPAGER より優先する。この環境変数は PAGER よりも優先する。デフォルトでは man は @pager@ を使用する。

-S  section_list
    コロンで分けられたリストで、マニュアルを探すセクションを 指定する。このオプションは環境変数 MANSECT より優先される。

-a  デフォルトでは、man は見つかった最初のマニュアルページを表示 したあと終了する。このオプションを使うと、man は最初にみつかった ものだけでなく name にマッチしたすべてのページを表示する。

-c  最新の cat 形式のページがあってもマニュアルページのソースを 整形しなおす。このオプションは cat ページが端末と違った幅で 整形されているときや壊れている場合などに有用である。

-d  マニュアル・ページを表示せず、大量のデバッグ情報を出力する。

-D  デバッグ情報とマニュアル・ページの両方を表示する。

-f  whatis コマンドと同じ。

-h  1行ヘルプ・メッセージを表示して終了する。

-k  apropos コマンドと同じ。 -K 「全ての」マニュアル・ページより指定した文字列を探す。警告: これは 非常に遅いので セクションを指定した方が良い。(私のマシンでは、 だいたいの目安として、500 ページを検索するのに 1分間かかる。)

-m  system
    別のシステムのマニュアル・ページを検索するように指定する。

-p  string
    nroff や troff のまえに実行するプリプロセッサの順番を指定する。 インストールの状態によってはフルセットの プリプロセッサが用意されてないかもしない。いくつ かのプリプロセッサとそれを指し示す文字は次のとおり： eqn (e), grap (g), pic (p), tbl (t), vgrind (v), refer (r)。 このオプションは環境変数 MANROFFSEQ より優先される。

-t  マニュアル・ページの整形に @troff@ を使い、 stdout に出力する。 @troff@ からの出力は印刷するまえになんらかのフィルターなどを通す必要 があるかもしれない。

-w or --path
    マニュア・ルページを表示せず、すでにフォーマットまたは表示に使用する ソース・ファイルの位置を表示する。引数を与えないと man がマニュア・ルページを検索するディレクトリのリストを(標準出力に)表示する。 manpath が man にリンクされているときは "manpath" は "man --path" と 同じになる。

-W  -w に似ているが、ファイル名を追加情報なしに１行１つずつ表示する。 これはシェル上で ,B "man -aW man | xargs ls -l" などと使うのに便利である。

CAT ページ
man コマンドはすでに整形されたマニュアルページを、次にその ページが必要になったときの整形時間の節約のために、保存しよう とする。伝統的に、DIR/manX の整形済みマニュアルは DIR/catX に セーブされるが、man ディレクトリから cat ディレクトリへの 他のマッピング方法を @man_config_file@ に指定できる。 cat ディレクトリが用意されてなかった場合、cat ページはセーブされない。

man コマンドをユーザー man に suid することができる。そのすると
 cat ディレクトリのオーナーが man かつモードが 0755 (ユーザー man だけが 書き込み可)で、cat ファイルのオーナーが man かつモードが 0644 または 0444 (ユーザー man だけが書き込み可、またはユーザーすべてが書き込み不可) のとき、普通のユーザーは cat ページを変更したり他のファイルを cat ディレ クトリ置いたりすることができなくなる。 man コマンドが suid されていなければ、 すべてのユーザーが cat ページを cat ディレクトリに置けるように、 cat ディレクトリのモードを 0777 にする必要がある。

cat ページがあったとしても、オプション -c をつけると強制的にマニュアルページを再整形する。

環境変数

MANPATH
    MANPATH を設定すると、マニュアル・ページを探すときそのパスを使う。

MANROFFSEQ
    MANROFFSEQ を設定すると、nroff や troff の前に実行するプリプロセッサ を決定するのにその値を使う。デフォルトではマニュアルページは nroff のまえにテーブル用のプリプロセッサに通される。

MANSECT
    MANSECT を設定すると、その値を元にどのマニュアル・セクションを探すかを決める。

MANWIDTH
    MANWIDTH を設定すると、その値を表示するマニュアル・ページの幅として使用する。 指定しなかった場合には画面の幅一杯まで使用する。

MANPAGER
    MANPAGER を設定すると、マニュアル・ページを表示するプログラムとして使用する。 指定しなかった場合には、 PAGER が使用される。どちらも設定されていない場合には @pager@ が使われる。

LANG
    LANG を設定すると、man コマンドその名前のサブディレクトリから最初に マニュアル・ぺージを探す。それゆえ、'LANG=dk man 1 foo' とコマンドラインから打つと、man コマンドはまず .../dk/man1/foo.1 を探し、 見つからなければ .../man1/foo.1 を探す。この ... はサーチパス のディレクトリである。

NLSPATH, LC_MESSAGES, LANG
    環境変数 NLSPATH と LC_MESSAGES (また後者がないときは LANG )はメッセージ・カタログの位置を指定する。 (英語のメッセージはコンパイル時に組み込まれているので、英語の場合は
     カタログは必要ない) man に呼び出される col(1) のような moプログラムは 、たとえば LC_CTYPE 使うことに注意すること。

PATH
    PATH はマニュアル・ページのデフォルトの検索パスの構築に使われる。

SYSTEM
    SYSTEM はデフォルトのシステム名を得るのに使われる。 ( -m オプションとともに使う)

関連項目
apropos(1), whatis(1), less(1), groff(1).

バグ
-t オプションは troff ライクなプログラムがインストールされている 場合のみ有効である。
もしハイフンのかわりに、点滅する \255 や <AD> が表示された場合には 環境変数に 'LESSCHARSET=latin1' を設定すると良い。 (訳注: 日本語を使用する場合には を使用するために、この方法では対応できない。groff のオプションで -Tnippon また -Tascii を使用すること。)