MANPATH

Section: /etc/man_db.conf (5)
Updated: 2019-10-23
Index Return to Main Contents
 

名前

manpath - /etc/man_db.conf ファイルのフォーマット  

説明

manpath 設定ファイルは、マニュアルページのユーティリティによって用いられる。 ユーザーの manpath を実行時に評価したり、どのマニュアルページ系列 (hierarchy) すなわち manpath をシステムの系列として扱うかを判断したり、 どのディレクトリを cat ファイルを保管するディレクトリとして用いるかを 決定するために用いられる。

環境変数 $MANPATH がすでに設定されている場合には、/etc/man_db.conf に含まれている 情報はそれを上書きしない。  

フォーマット

現在のところ、以下のフィールドタイプが認識される。
# comment
空行や # で始まる行はコメントとみなされ、無視される。
MANDATORY_MANPATH manpath_element
この形式の行は、自動的に生成される $MANPATH には必ず含まれているべき manpath を示す。 /usr/man などが典型である。
MANPATH_MAP path_element manpath_element
この形式の行は PATH から $MANPATH へのマッピングを設定する。 それぞれの path_element がユーザーの $PATH に含まれていると、 manpath_element が $MANPATH に追加される。
MANDB_MAP manpath_element [ catpath_element ]
この形式の行は、どの manpath をシステムの manpath として扱い、またそれらの cat ページをどこに保存するかを指定する (後半は省略可)。 この形式のフィールドは、 man が setuid されたプログラムである場合に特に重要である。 なぜなら、(ユーザー毎の設定ファイル .manpath ではなく、 システムの設定ファイル /etc/man_db.conf において) これはどの系列を setuid されたユーザー権限でアクセスし、 どれを起動ユーザーの権限でアクセスするかを指定することになるから である。

システムのマニュアルページの系列は、通常 /usr 以下に保管されている。例えば /usr/man, /usr/local/man, /usr/X11R6/man などがこれにあたる。

特定の manpath_element からの cat ページは保管したくない場合や、伝統的な位置に保管したい場合には、 catpath_element は省略する。

伝統的な cat の場所は、リードオンリーでマウントされているマニュアルページの 系列下にすることはできない。この理由から、これらの保管場所としては、 任意のディレクトリ系列を指定することが可能になっている (もちろん指定した ディレクトリは有効なものでなければならない)。 Linux FSSTND に従う場合には、 キーワード FSSTND を実際のディレクトリ名の代わりに用いることができる。

残念ながら、システムの man のツリーパスはすべて指定しなければならない。 他のシステムパス (/usr/man/sun のようなもの) やすべての NLS ロケール パス (/usr/man/de_DE.88591 のようなもの) も、それぞれすべて指定する必要がある。

情報は書かれた順に一行ずつ評価されるので、他の系列のサブツリーと なっているような manpath は先に書かなければならない。 さもないと、マッチが正しく行われない可能性がある。 例えば /usr/man/de_DE.88591/usr/man より先に来なければならない。

DEFINE key value
この形式の行では、様々な設定値を定義する。 マニュアルページャーユーティリティで使われるこれらの値については、 デフォルトの設定ファイルを参照すること。 これらの設定値には、 (greptbl のような) 様々なプログラムのデフォルトのパスや、 そのプログラムのデフォルトの引き数のセットが含まれる。
SECTION section ...
この形式の行では、マニュアルセクションを検索する順番を定義する。 設定ファイルに SECTION の指定がない場合、デフォルトは以下の通りである:

SECTION 1 n l 8 3 0 2 5 4 9 6 7

複数の SECTION が指定されている場合、セクションのリストが連結される。

特定の拡張子 (たとえば 1mh) がリストにない場合、 残りの部分が属するセクションで表示される。 この機能により、ユーザーは特定の順番を強制したい場合にのみ、 明示的に拡張子をリストに定義すればよくなる。 拡張付きのセクションは、通常はメインのセクションに隣接して定義 すべきである (たとえば "1 1mh 8 ...")。

SECTIONS は、この指定の別名として受け付けられる。

MINCATWIDTH width
端末の幅が width より小さい場合、cat ページは (存在しない場合) 生成されず、表示もされない。 デフォルトは 80 である。
MAXCATWIDTH width
端末の幅が width より大きい場合、cat ページは (存在しない場合) 生成されず、表示もされない。 デフォルトは 80 である。
CATWIDTH width
width が 0 以外の場合、端末の幅が自動的に使われるのではなく、 指定された端末の幅で cat ページが常にフォーマットされる。 この値は一般に MINCATWIDTH から MAXCATWIDTH の範囲でなければならない。
NOCACHE
このフラグを指定すると man(1) は cat ページを自動的に生成しない。
 

バグ

上記のルールが正しく守られない場合には、マニュアルページャーの機能は 正しく動作しない。 これらのルールは不必要に難しい。


 

Index

名前
説明
フォーマット
バグ

This document was created by man2html, using the manual pages.
Time: 06:31:53 GMT, July 02, 2020