MAN

名前

書式

説明

以下の表にマニュアルの section 番号を示す。それぞれの section に、どのようなページが含まれるかもあわせて示す。

1	実行プログラムまたはシェルのコマンド
2	システムコール (カーネルが提供する関数)
3	ライブラリコール (プログラムライブラリに含まれる関数)
4	特殊なファイル (通常 /dev に置かれているもの)
5	ファイルのフォーマットと約束事。例えば /etc/passwd など
6	ゲーム
7	その他 (マクロのパッケージとその約束事)。 例えば man(7), groff(7) など
8	システム管理用のコマンド (通常は root 用)
9	カーネルルーチン [非標準]

それぞれのマニュアルページ page は、いくつかのセクションからなる。

一般的なセクション名としては、以下がある。 名前 (NAME), 書式 (SYNOPSIS), 設定 (CONFIGURATION), 説明 (DESCRIPTION), オプション (OPTIONS), 終了ステータス (EXIT STATUS), 返り値 (RETURN VALUE), エラー (ERRORS), 環境変数 (ENVIRONMENT), ファイル (FILES), バージョン (VERSIONS), 準拠 (CONFORMING TO), 注意 (NOTES), バグ (BUGS), 例 (EXAMPLE), 著者 (AUTHORS), 関連項目 (SEE ALSO).

書式 のセクションには以下のような形式が用いられている。 他のセクションでも同様のルールを用いると良い。

ボールド体 (bold)	そのままタイプする。
イタリック体 (italic)	適切な引き数に置き代える。
[-abc]	[ ] 内部の引き数はすべて省略できる。
-a|-b	| で区切られたオプションは同時には指定できない。
argument ...	argument は繰り返し指定できる。
[expression] ...	[ ] 内部の expression 全体を繰り返し指定できる。

厳密なレンダリングは出力デバイスによって変わる。 例えば、man を端末で実行した場合、通常はイタリック体をレンダリングできないため、 下線または色付きのテキストを代わりに使用する。

コマンドや関数は、これらのパターンの組みあわせによって、起動可能な書式の すべてを網羅しているべきである。 複数ある起動方法のうちの排他的なものは、 場合によっては別々に示した方が良いかもしれない (このページの 書式 セクションではそのようにしている)。  

例

man ls

アイテム (プログラム) ls に関するマニュアルページを表示する。

man man.7

セクション 7 からマクロパッケージ man のマニュアルページを表示する。 (これは "man 7 man" の別の表現である。)

man 'man(7)'

セクション 7 からマクロパッケージ man のマニュアルページを表示する。 (これは "man 7 man" のまた別の表現である。 マニュアルページの相互参照をコピー・ペーストする際に、便利である。 シェルでの解釈を防ぐため、括弧は通常はクォートしなければならない点に 注意すること。)

man -a intro

マニュアルにある intro のページをすべて、順番に表示する。 次のページに移るときに、以降の表示を中止したり、見たくないものを スキップすることもできる。

man -t bash | lpr -Pps

bash のマニュアルページを、 troff または nroff のデフォルト出力フォーマットに整形して、 ps という名前のプリンターにパイプしている。 groff のデフォルト出力は通常 PostScript である。 man --help とすれば、 -t オプションによって起動される整形コマンドに関する情報が得られる。

man -l -Tdvi ./foo.1x.gz > ./foo.1x.dvi

このコマンドは nroff ソースのマニュアルページ ./foo.1x.gz を展開して、 デバイス非依存 (dvi) なファイルにフォーマットする。 -T オプションによって、フォーマットの結果は stdout にページャーなしで出力されているので、この場合リダイレクションが 必要である。 この出力結果は xdvi のようなプログラムで見ることができる。また dvips のようなプログラムを用いれば、さらに PostScript に変換することもできる。

man -k printf

キーワード printf を正規表現として、マニュアルページの要約文とページ名を検索し、 マッチした結果を表示する。 マッチしたすべてを表示する。 apropos printf と同等である。

man -f smail

smail と言う名前のマニュアルページを探し、 見つかったものそれぞれに対して要約文を表示する。 whatis smail と同等である。

概要

また man の動作に影響を及ぼす環境変数も数多く存在する。 「万能」な環境変数である $MANOPT を用いれば、コマンドラインと同じ形式の文字列を設定することもできる。 ただしオプションの引き数の一部として用いられるスペースは、 すべてエスケープする (バックスラッシュを前置する) 必要がある。 man は、 $MANOPT をコマンドラインの前に解釈する。 引き数を必要とするオプションに関しては、同じものがコマンドラインにも 存在すれば、コマンドラインの方が優先される。 $MANOPT に設定されたオプションをすべてリセットするには、コマンドラインオプション の最初に -D を指定すればよい。 これによって man は一時的に $MANOPT の内容を「忘れる」が、環境変数の内容自体は有効なまま残る。

マニュアルページは通常は nroff(1) 形式で /usr/share/man といったディレクトリに格納される。 インストール状態によっては、性能を改善するため整形済み cat ページが存在することもある。 これらのファイルがどこに格納されるかの詳細は、 manpath(5) を参照すること。

このパッケージでは、多言語のマニュアルページをサポートしており、 locale で制御できる。 使っているシステムがロケールを自動で設定しない場合、この機能を 有効にするには、 $LC_MESSAGES, $LANG のいずれかか、他のシステム依存の環境変数を、使用している言語のロケールに 設定する必要がある。 通常言語ロケールは POSIX に基づいたフォーマットで指定する:

<language>[_<territory>[.<character-set>[,<version>]]]

要求したページに対して、使用している locale のものが存在すれば、そのページが標準のページ (通常はアメリカ英語) の 代わりに表示される。

このパッケージに、あなたのネイティブな言語に対応したマニュアルページが なく、これを追加したいと思う人は、メンテナーに連絡して欲しい。 このような努力をまとめたいと思っている。

各マニュアルページは、通常はプログラム、関数、その他のドキュメント化した トピックのメンテナーによって書かれて保守されており、このパッケージには 含まれていない。 マニュアルページが見つからなかったり、不十分であると思った場合には、 疑問を持ったパッケージのメンテナーに報告して欲しい。

このマニュアルページャーで用いることのできる、その他の機能や拡張に ついては、このパッケージに付属しているドキュメントを読んで欲しい。  

デフォルト

1 1p 8 2 3 3p 3pm 4 5 6 7 9 0p n l p o 1x 2x 3x 4x 5x 6x 7x 8x

整形されたマニュアルページは pager を使って表示される。 これは複数の方法で指定することができて、指定されない場合はデフォルトに なる。 (詳細はオプション -P を参照すること)。

フィルタは複数の手段で読み込まれる。 最初にコマンドラインオプション -p または環境変数 $MANROFFSEQ を調べる。 -p が使用されておらず、環境変数が設定されていない場合、 nroff ファイルの最初の行を、プリプロセッサ文字列として解釈する。 プリプロセッサ文字列として有効なものであるためには、先頭行は以下のような ものでなければならない。

'\ <string>

ここで string は、以下の -p オプションの部分で記述されている文字の任意の組み合わせである。

上記のいずれの手法も用いられず、フィルタの情報が与えられなかった場合は、 デフォルトのセットが用いられる。

整形プロセスのパイプラインは、フィルタ群と基本整形プログラム (nroff または [tg]roff + オプション -t) によって構成され、これが実行される。 あるいは、実行可能なプログラム mandb_nfmt (または mandb_tfmt と -t オプション) が man 階層ツリーのルートにある場合は、これが代わりに実行される。 このプログラムはマニュアルのソースファイルとプリプロセッサ文字列とを 引き数に取る。省略可能であるが -T によるデバイス指定を行うこともできる。  

オプション

一般的なオプション

-C file, --config-file=file

デフォルトの ~/.manpath ではなく、ユーザー設定ファイルを使用する。

-d, --debug

デバッグ情報を表示する。

-D, --default

このオプションは、通常先頭に指定して、 man の振る舞いをデフォルトにリセットする。 このオプションの目的は、 $MANOPT で指定されているかもしれないオプションをリセットすることである。 この -D 以降に指定されたオプションは、通常通りの効果を持つ。

--warnings[=warnings/]

groff からの警告を有効にする。 このオプションはマニュアルページのソースコードの整合性チェックを 行うために使用される。 warnings はコンマ区切りの警告名のリストである。 指定されてない場合、デフォルトは "mac" である。 使用可能な警告名は info groff の "Warnings" ノードを参照すること。

操作のメインモード

-f, --whatis

whatis と等価。 可能であれば、マニュアルページの要約を表示する。 詳細は whatis(1) を見よ。

-k, --apropos

apropos と等価。 マニュアルページの要約文からキーワードを検索し、 マッチしたものをすべて表示する。 詳細は apropos(1) を見よ。

-K, --global-apropos

すべてのマニュアルページのテキストを検索する。 全数検索を行うため、長い時間がかかる。 検索するページ数を減らすために、可能であればセクションを指定する べきである。 検索する語はデフォルトでは単純な文字列である。 --regex オプションを指定した場合は正規表現になる。

検索はレンダリングされた文字列ではなく、 マニュアルページの ソースファイル に対して行われるので、ソースファイル中のコメントなどにより 誤りを含む可能性がある点に注意すること。 レンダリングされた文字列を検索すると、とても遅くなるだろう。

-l, --local-file

"local" モードを有効にする。 システムのマニュアルを検索する代わりに、ローカルなマニュアル ファイルを整形して表示する。 マニュアルページの引き数は、正しいフォーマットを持った nroff のソースファイルであるとみなされる。 cat ファイルは生成されない。 `-' が引き数に指定された場合は、標準入力から入力が与えられると みなされる。 このオプションが指定されず、man が要求されたページを見つけるのに失敗した場合、 エラーメッセージを表示する前に、このオプションが指定されて、 名前をファイル名として厳密にマッチングして検索するように動作する。

-w, --where, --path, --location

実際にはマニュアルページを表示せず、整形・表示されることになる ファイルの位置を表示する。 -a オプションも指定された場合、検索条件にマッチするすべてのソース ファイルの位置を表示する。

-W, --where-cat, --location-cat

実際にはマニュアルページを表示せず、表示されることになる 整形済み cat ファイルの位置を表示する。 -a オプションも指定された場合、検索条件にマッチするすべての整形済み cat ファイルの位置を表示する。

-w と -W の両方が指定された場合、ソースファイルと cat ファイルの両方を コンマで区切って表示する。 -w, -W, -a のすべてが指定された場合、それぞれにマッチするものが表示される。

-c, --catman

このオプションは一般的な用途のためのものではなく、 catman プログラムを通してのみ用いるべきである。

-R encoding, --recode=encoding

マニュアルページを通常の方法で整形する代わりに、 encoding で指定したエンコーディングに変換して出力する。 ソースファイルのエンコーディングを知っている場合は、 manconv(1) を直接使用することもできる。 しかし、このオプションにより、マニュアルページ階層と同様の構造で インストールされた形で提供されている、複数のマニュアルページの エンコーディングを明示的に意識することなく単一のエンコーディングに 変換して出力できる。

複数のマニュアルページを個別に変換するのではなく、 man-recode(1) を使うのを考慮すること。 man-recode(1) には一括変換のために設計されたインターフェースがあり、とても速い。

マニュアルページの検索方法

-L locale, --locale=locale

man は通常、カレント・ロケールを C 関数 setlocale(3) を呼ぶことによって決定しようとする。 この関数は、 $LC_MESSAGES や $LANG などを含む様々な環境変数を調べる。 この値を一時的に上書きするには、このオプションを使って man に直接 locale 文字列を渡せば良い。 このオプションが効力を持つのは、実際のページの検索が始まってから であることに注意すること。 ヘルプメッセージなどの出力は、起動前に定まっていたロケールで 出力される。

-m system[,...], --systems=system[,...]

現在のシステムから、他のオペレーティングシステムについての マニュアルにアクセスできる場合には、このオプションをつけると それらのマニュアルが検索される。 NewOS のマニュアルページを検索する場合には、 -m NewOS のようなオプションを指定する。

system には複数のオペレーティングシステムをコンマで区切った形式で 指定できる。 ネイティブのオペレーティングシステムの whatis 記述を検索の対象に含めるためには、システム名 man を引き数文字列に加える。 このオプションは $SYSTEM 環境変数を上書きする。

-M path, --manpath=path

通常の代わりに用いる manpath を指定する。 デフォルトでは、 man は検索パスの決定に manpath 由来のコードを用いている。 このオプションは、 $MANPATH 環境変数を上書きする。またこのオプションを指定すると、 -m オプションは無視される。

manpath に指定されるパスは、マニュアルページ階層のルートの必要がある。 この階層は man-db のマニュアル (の「マニュアルページの体系」) で説明されている セクションに構造化される。 この階層構造の外にあるマニュアルページを見る場合は、 -l オプションを参照すること。

-S list/, -s list/, --sections=list/

引き数 list には、検索対象とするセクションをコロンかコンマ区切りで指定する。 検索は指定した順序でなされる。 このオプションは $MANSECT 環境変数を上書きする。 (-s の綴りは、System V との互換性を表す。)

-e sub-extension, --extension=sub-extension

(例えば Tcl などがそうだが) システムによっては、大きなマニュアルページのパッケージを、 メインのマニュアルページ階層にインストールするようなものがある。 同じ名前のページ (例えば exit(3) など) が二つ存在してしまうことを避けるために、通常 Tcl のページは l というセクションに割り当てられえいた。 これは望ましくないので、ページを正しいセクションに入れ、それらに 特定の「拡張」を追加することができるようになった。 例えばこの場合なら exit(3tcl) のようになる。 通常の動作では、 man は exit(3) を exit(3tcl) より優先して表示する。 この状況を調整し、目的とするページがどのセクションにあるのかを いちいち記憶しておかなくてもすむように、 man に sub-extension 文字列を与えることができるようになった。 この文字列は、ページが 所属するパッケージを指定するものである。上記の例なら、オプション として -e tcl を man に与えれば、検索対象とするページは拡張子が *tcl のものに限られるようになる。

-i, --ignore-case

マニュアルページを検索する時に大文字と小文字の区別をしない。 これはデフォルトの動作である。

-I, --match-case

マニュアルページを検索する時に大文字と小文字の区別する。

--regex

apropos(1) と同じように、各 page 引き数を正規表現として、名前または説明の一部にマッチするすべての ページを表示する。 正規表現で検索する際に、「最適な」ページを見つける一般的に適切な 方法はないため、このオプションでは -a が暗黙のうちに指定される。

--wildcard

apropos(1) --wildcard と同じように、各 page 引き数をシェル形式のワイルドカードとして、名前または説明の一部に マッチするすべてのページを表示する。 page 引き数は、名前または説明の全体にマッチするか、 説明の単語の区切りにマッチしなければならない。 ワイルドカードで検索する際に、「最適な」ページを見つける一般的に 適切な方法はないため、このオプションでは -a が暗黙のうちに指定される。

--names-only

--regex または --wildcard オプションと併せて使用した場合、一致処理を要約文に対して行わず、 ページ名のみに一致処理を行う。 whatis(1) で使用した時も同様である。 その他の場合は何も効果を及ぼさない。

-a, --all

デフォルトでは man は検索で見つかったページのうち、もっとも適切と判断したものを 一つだけ表示して終了する。 このオプションを用いると、 man は検索でマッチしたすべてのファイルを表示する。

-u, --update

このオプションを用いると、 man はインストールされているマニュアルページのデータベースキャッシュを 更新する。 これが必要なのは稀な状況であり、一般的には mandb(8) を代わりに実行する方がよい。

--no-subpages

デフォルトでは、 man は、コマンドラインで指定されたマニュアルページ名のペアを、 ハイフンまたはアンダースコアを含む 1 つのマニュアルページ名と等しいと解釈する。 これにより、複数のサブコマンドを実装しているプログラムでの一般的な パターンをサポートし、サブコマンド自体を呼び出しに使われるのと 同様の書式で、各サブコマンドのマニュアルページにアクセス可能にして いる。 例えば:

  $ man -aw git diff
  /usr/share/man/man1/git-diff.1.gz

この振る舞いを無効化するには、 --no-subpages オプションを使うこと。

  $ man -aw --no-subpages git diff
  /usr/share/man/man1/git.1.gz
  /usr/share/man/man3/Git.3pm.gz
  /usr/share/man/man1/diff.1.gz

整形済み出力の制御

-P pager, --pager=pager

出力に用いるページャーを指定する。 デフォルトでは、 man は less を使い、 less が見つからない、または実行不能の場合には、 cat を使う。 このオプションは、環境変数 $MANPAGER を上書きする。 また、 $MANPAGER は環境変数 $PAGER を上書きする。 このオプションは -f や -k と同時に用いることはできない。

この値は、単純なコマンド名か引き数付きのコマンドで、シェルの エスケープ文字 (バックスラッシュ、シングルクォート、ダブルクォート) を使用している場合がある。 パイプを使用して複数のコマンドをつなげることはできない。 そのような必要性がある場合、表示するファイルを、単一の引き数 または標準入力として受け取るラッパースクリプトを使用する。

-r prompt, --prompt=prompt

最新版の less がページャーに用いられている場合には、 man は less のプロンプトやオプションを設定しようとする。 デフォルトは以下のようなものである。

 Manual page name(sec) line x

ここで name はマニュアルページの名前、 sec はセクション、 x は現在の行番号である。 これは環境変数 $LESS を通して設定される。

-r を文字列とともに指定すると、デフォルトを上書きできる。 文字列に $MAN_PN というテキストを入れると、現在のマニュアル名と、セクションを "(" と ")" で括ったものとに展開される。 デフォルトの出力となるような文字列は、以下のように表現できる。

\ Manual\ page\ \$MAN_PN\ ?ltline\ %lt?L/%L.:
byte\ %bB?s/%s..?\ (END):?pB\ %pB\\%..
(press h for help or q to quit)

ここで二行に分割されているのは、単に可読性のためである。 これらの意味に 関しては less(1) のマニュアルページを見ること。 このプロンプト文字列は、まずシェルによって解釈される。 プロンプト中に存在するダブルクォート、バッククォート、 バックスラッシュは、すべてバックスラッシュを前置して エスケープしなければならない。 プロンプト文字列はエスケープされた $ で終わり、これ以降は less に与える追加オプションになる。 デフォルトでは、 man は -ix8 をオプションとして指定する。

上記で説明されている環境変数 $MANLESS は、コマンドラインで何も指定されていないときに、 デフォルトのプロンプト文字列を設定するために使われる。

-7, --ascii

純粋な ascii(7) コードで記述されたマニュアルページを 7 ビット端末 (や端末エミュレータ) で読む場合、 GNU nroff の latin1(7) デバイス表示を用いると、文字によっては正しく表示されない可能性が ある。 このオプションを用いると、純粋な ascii のマニュアルページを、 latin1 デバイスでも ascii で表示することができるようになる。 ただしこれは latin1 テキストを変換するわけではない。 以下の表は、行われる変換の様子を示すものである。 これらのうちいくつかは、 GNU nroff の latin1(7) デバイスを使った場合にのみ正しく表示される。

Description	Octal	latin1	ascii
continuation hyphen	255		-
bullet (middle dot)	267	•	o
acute accent	264	´	'
multiplication sign	327	×	x

latin1 カラムの表示が正しい場合は、あなたが現在使っている端末は latin1 文字向けに設定されているので、このオプションは必要ない。 latin1 と ascii カラムが同一である場合は、あなたは現在このページをこのオプションで 見ているか、あるいは man がこのページの整形に latin1 デバイスの指定を用いていないことになる。 latin1 カラムが空であるか、変な表示になっている場合は、マニュアルページを 見るためにこのオプションを指定する必要がある。

このオプションは -t, -H, -T, -Z オプションを用いている場合は無視される。 また GNU 以外の nroff を用いている場合も、おそらく指定する意味はない。

-E encoding, --encoding=encoding

デフォルト以外の文字エンコーディングで出力を生成する。 過去の互換性のために、 encoding には、 UTF-8 のような実際のエンコーディングに加えて ascii, latin1, utf8 のような nroff デバイス設定も使用できる。

--no-hyphenation, --nh

通常、 nroff は、単語内にハイフンが無かったとしても、改行部分でテキストに 自動的にハイフンを付加する。 これにより、行内の単語間に過剰なスペースが配置されることを防ぐ。 このオプションは自動的なハイフン付加を無効にする。 よって、ハイフンが含まれている単語のみハイフン区切りが行われる。

マニュアルページを書いていて、 nroff が単語内の誤った場所にハイフンを付加するのを防止したい場合、 このオプションを使用してはいけない。 代わりに nroff の文書を参照すること。 例えば、"\%" を単語内に含めると、その場所にハイフンを付加することが可能である ことを示す。 また、"\%" を単語の最初に付加すると、その単語にはハイフンは付加されない。

--no-justification, --nj

通常、 nroff は自動的に左右余白に対してテキストを均等に割り付ける。 このオプションは左右余白の均等割り付けを抑止し、左側余白のみ 整列する。 これは "ragged-right" text と呼ばれる。

マニュアルページを書いていて、 nroff がある段落に対して均等割り付けを行うのを防止したい場合、 このオプションを使用してはいけない。 代わりに nroff の文書を参照すること。 例えば ".na", ".nf", ".fi", ".ad" を使用すると、 一時的に字間調整や字詰めを無効にするように要求できる。

-p string, --preprocessor=string

nroff または troff/groff の前に実行するプリプロセッサのシーケンスを指定する。 すべてのインストール環境で、以下すべてのプリプロセッサが使える わけではない。 プリプロセッサと、それを指定する文字のいくつかを以下に挙げる。 eqn (e), grap (g), pic (p), tbl (t), vgrind (v), refer (r). このオプションは $MANROFFSEQ 環境変数を上書きする。 zsoelim は、常に他のプリプロセッサすべてに先立って実行される。

-t, --troff

マニュアルページの整形と、標準出力への表示に groff -mandoc を用いる。 -H, -T, -Z オプションの指定時に、このオプションを指定する必要はない。

-T[device/], --troff-device[=device/]

このオプションは groff (あるいは他の troff) の出力を、デフォルトから用いるデバイスにあわせて変更するために 用いられる。 -t が暗黙のうちに指定される。 例としては (Groff-1.17 でのもの)、 dvi, latin1, ps, utf8, X75, X100 などが挙げられる。

-H[browser/], --html[=browser/]

このオプションを指定した場合、 groff は HTML 出力を生成し、その出力をウェブブラウザーで表示する。 ブラウザーはオプション引き数の browser (指定されている場合)、 $BROWSER 環境変数が使用される。 それらが設定されていない場合はコンパイル時のデフォルト (通常は lynx) が使用される。 -t が暗黙のうちに指定される。 そして、 GNU troff を使用している時のみ有効である。

-X[dpi/], --gxditview[=dpi/]

このオプションを指定した場合、 gxditview プログラムを使用して、 groff の出力をグラフィカルウィンドウに表示する。 (ドット/インチ) は 75, 75-12, 100, 100-12 であり、 デフォルトは 75 である。 -12 では 12 ポイントのフォントを使用する。 dpi このオプションにより -T オプションと、その引き数としてそれぞれ X75, X75-12, X100, X100-12 デバイス設定が暗黙のうちに指定される。

-Z, --ditroff

groff は troff を実行し、その後適切なポストプロセッサを用いて選択したデバイスに 応じた出力を生成する。 もし groff -mandoc が groff であるならば、このオプションは groff に渡されて、ポストプロセッサの利用を抑制する。 -t が暗黙のうちに指定される。

ヘルプの取得

-?, --help

ヘルプメッセージを表示して、終了する。

--usage

簡単な使用法のメッセージを表示して、終了する。

-V, --version

バージョン情報を表示する。

返り値

0

プログラムの実行に成功した。

1

使用法、文法、設定ファイルのいずれかにエラーがある。

2

実行時エラー。

3

子プロセスの返り値が非ゼロだった。

16

少なくとも、ページ、ファイル、キーワードのどれか一つが 存在しないか、マッチしなかった。

環境変数

MANPATH

$MANPATH が設定されている場合には、その値がマニュアルページの検索パスとして 用いられる。

MANROFFOPT

man がフォーマッタ (nroff, troff, groff) を呼び出す度に、 $MANROFFOPT の内容をフォーマッタのコマンドラインに追加する。

MANROFFSEQ

$MANROFFSEQ が設定されている場合には、その値は各々のマニュアルページを処理する プリプロセッサのセットを定義する。 デフォルトのプリプロセッサのセットはシステムによって異なる。

MANSECT

$MANSECT が設定されている場合には、その値はセクションのリスト (コロン区切り) として扱われ、マニュアルのどのセクションを検索するかを決定する際に 用いられる。 /etc/man_db.conf の SECTION 指定で上書きされない限り、デフォルトは "1 1p 8 2 3 3p 3pm 4 5 6 7 9 0p n l p o 1x 2x 3x 4x 5x 6x 7x 8x" である

MANPAGER, PAGER

$MANPAGER または $PAGER が設定されている場合には、その値がマニュアルページを表示する プログラムの名前として用いられる ($MANPAGER が優先して使用される)。 デフォルトでは less が使われ、 less が見つからない場合、または実行不能である場合、 cat が使われる。

この値は、単純なコマンド名か引き数付きのコマンドで、シェルの エスケープ文字 (バックスラッシュ、シングルクォート、ダブルクォート) を使用している場合がある。 パイプを使用して複数のコマンドをつなげることはできない。 そのような必要性がある場合、表示するファイルを、単一の引き数または 標準入力として受け取るラッパースクリプトを使用すること。

MANLESS

$MANLESS が設定されると、 -r オプションを使って渡されたのと同様に、 less ページャーのデフォルトのプロンプト文字列として使われる (よって、文字列 $MAN_PN が存在する場合は、同様に展開される)。 例えば、プロンプト文字列を無条件に "my prompt string" に設定したい場合、 $MANLESS を '-Psmy prompt string' に設定すること。 -r オプションを指定すると、この環境変数を上書きする。

BROWSER

$BROWSER が設定されている場合、この値はコロンで区切られたコマンドのリスト として、 man --html 用のウェブブラウザーとして順番に試す。 それぞれのコマンドでは、 %s は groff の出力を保存したファイル名に、 %% は単一のパーセント記号 (%) に、 %c はコロン (:) にそれぞれ置換される。

SYSTEM

$SYSTEM 環境変数が設定されている場合には、 -m オプションに指定された場合と同じ効果を持つ。

MANOPT

$MANOPT が設定されている場合には、その内容が man のコマンドラインに先立って解釈される。 形式はコマンドラインのものと同じである。 man に影響する他のすべての環境変数には、同じ効果を持つコマンドライン オプションが存在し、したがって $MANOPT に記述することができるので、これらの環境変数はいずれ使用されなく なるだろう。 オプションの引き数の一部として解釈させたいすべてのスペースは、 エスケープする必要があることに注意すること。

MANWIDTH

$MANWIDTH が設定されると、マニュアルページを整形する時の行の長さとして 使われる。 この環境変数が設定されない場合、マニュアルページは、現在の端末に 適した行の長さで整形される (利用可能であれば、 $COLUMNS と ioctl(2) を使い、利用可能でない場合は、80 文字にされる)。 cat ページはデフォルトの整形が使える場合、 つまり、端末の行の長さが 66 から 80 文字の場合にのみ保存される。

MAN_KEEP_FORMATTING

通常、端末以外 (ファイルやパイプなど) に出力する場合、 特別なツールが使用しなくても結果を読みやすくするために書式文字は 破棄される。 しかし、 $MAN_KEEP_FORMATTING を空以外に設定した場合、書式文字が残される。 これにより man と併せて使用するラッパーに書式文字を解釈させることができる。

MAN_KEEP_STDERR

通常、端末 (通常はページャー) に出力する時、ページャーの表示と 干渉するのを避けるため、マニュアルページを整形するコマンドのエラー 出力は破棄される。 groff のようなプログラムは、整列がうまくできないなどの、印字問題に関する 比較的軽微なエラーメッセージをしばしば出力する。 これは、マニュアルページと併せて表示すると、見苦しく、 混乱の原因となる。 しかし、エラーメッセージを見る必要がある場合、 $MAN_KEEP_STDERR を空以外に設定すると、エラー出力は通常通り表示される。

LANG, LC_MESSAGES

システムと実装に依存するが、 $LANG と $LC_MESSAGES のどちらか、あるいは両方が、カレントのメッセージロケールを調べる のに用いられる。 man は自分自身のメッセージを、そのロケールで出力する (可能な場合)。 正確な内容は setlocale(3) を見よ。

ファイル

/etc/man_db.conf

man-db の設定ファイル。

/usr/share/man

グローバルなマニュアルページの階層。

関連項目

パッケージによってはドキュメントが、 info(1) や HTML といった他の形式で入手可能である。  

履歴

1992年12月23日: Rik Faith (faith@cs.unc.edu) が Willem Kasdorp (wkasdo@nikhefk.nikef.nl) のバグフィックスを当てた。

1994年4月30日 - 2000年2月23日: Wilf. (G.Wilford@ee.surrey.ac.uk) が何人かの人々の助力のもと、このパッケージの開発とメンテナンスをしていた。

1996年10月30日 - 2001年3月30日: Fabrizio Polacco <fpolacco@debian.org> がコミュニティの助力のもと、Debian プロジェクトのために、このパッケージの保守と拡張を行った。

2001年3月31日 - 現在: Colin Watson <cjwatson@debian.org> が man-db の開発と保守を行っている。

Index

名前

書式

説明

例

概要

デフォルト

オプション

一般的なオプション

操作のメインモード

マニュアルページの検索方法

整形済み出力の制御

ヘルプの取得

返り値

環境変数

ファイル

関連項目

履歴