manpath.5

[UCHIDA Norihiro <KY4N-UCD@xxxxxxxxxxxxxxx>]

manpath.5です。


.\" Man page for format of the manpath.config data file
.\"
.\" Copyright (C), 1994, 1995, Graeme W. Wilford. (Wilf.)
.\"
.\" You may distribute under the terms of the GNU General Public
.\" License as specified in the file COPYING that comes with the
.\" man_db distribution.
.\"
.\" Sat Oct 29 13:09:31 GMT 1994  Wilf. (G.Wilford@xxxxxxxxxxxxxxx) 
.\" 
.\" Japanese Version Copyright (c) 1998 NAKANO Takeo all rights reserved.
.\" Translated Fri 25 Sep 1998 by NAKANO Takeo <nakano@xxxxxxxxxxxxxxxx>
.\" Modified Sun 6 Dec 1998 by NAKANO Takeo <nakano@xxxxxxxxxxxxxxxx>
.\" Updated Mon 2 Oct 2000 by UCHIDA Norihiro <KY4N-UCD@xxxxxxxxxxxxxxx>
.\"
.\"WORD:	hierarchy	階層
.\"

.\"O .TH manpath 5 "Wed Feb 23 00:00:00 EET 2000" "" "/etc/manpath.config"
.\"O .SH NAME
.\"O manpath \- format of the /etc/manpath.config file


.TH manpath 5 "Wed Feb 23 00:00:00 EET 2000" "" "/etc/manpath.config"
.SH 名前
manpath \- /etc/manpath.config ファイルのフォーマット

.\"O .SH DESCRIPTION
.\"O The manpath configuration file is used by the manual page utilities
.\"O to assess users' manpaths at run time, to indicate which manual page
.\"O hierarchies (manpaths) are to be
.\"O treated as `global' and to assign them directories to be used for storing 
.\"O cat files.

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

.\"O If the environment variable
.\"O .RB $ MANPATH
.\"O is already set, the information contained within /etc/manpath.config will
.\"O not override it.


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

.\"O .SH FORMAT
.\"O The following field types are currently recognised:
.\"O .TP
.\"O .BI # \ comment
.\"O Blank lines or those beginning with a 
.\"O .B #
.\"O will be treated as comments and ignored. 

.SH フォーマット
現在のところ、以下のフィールドタイプが認識される。
.TP
.BI # \ comment
空行や
.B #
で始まる行はコメントとみなされ、無視される。

.\"O .TP
.\"O .BI MANDATORY_MANPATH \ manpath_element
.\"O Lines of this form indicate manpaths that every automatically generated 
.\"O .RB $ MANPATH
.\"O should contain. This will typically include 
.\"O .IR /usr/man .

.TP
.BI MANDATORY_MANPATH \ manpath_element
この形式の行は、自動的に生成される
.RB $ MANPATH
には必ず含まれているべき manpath を示す。
.I /usr/man
などが典型である。

.\"O .TP
.\"O .BI MANPATH_MAP \ path_element\ manpath_element
.\"O Lines of this form set up 
.\"O .RB $ PATH 
.\"O to 
.\"O .RB $ MANPATH 
.\"O mappings. For each 
.\"O .I path_element
.\"O found in the user's 
.\"O .RB $ PATH , 
.\"O .I manpath_element 
.\"O will be added to the 
.\"O .RB $ MANPATH . 

.TP
.BI MANPATH_MAP \ path_element\ manpath_element
この形式の行は
.RB $ PATH
から
.RB $ MANPATH
へのマッピングを設定する。それぞれの
.I path_element
がユーザの
.RB $ PATH
に含まれていると、
.I manpath_element
が
.RB $ MANPATH
に追加される。

.\"O .TP
.\"O \fBMANDB_MAP \fImanpath_element \fR\|[\| \fIcatpath_element\fR \|]
.\"O Lines of this form indicate which manpaths are to be treated as `global'
.\"O and optionally, where their cat files should be stored.
.\"O This field type is particularly important if 
.\"O .B man 
.\"O is a setuid program, as it indicates
.\"O which manual page hierarchies to access as the setuid user and which as the
.\"O invoking user. 

.TP
\fBMANDB_MAP \fImanpath_element \fR\|[\| \fIcatpath_element\fR \|]
この形式の行は、どの manpath を `global' として扱い、またそれらの cat 
ページをどこに保存するかを指定する (後半は省略可)。この形式のフィール
ドは、
.B man
が setuid されたプログラムである場合に特に重要である。なぜなら、これは
どの階層を setuid されたユーザー権限でアクセスし、どれを起動ユーザーの
権限でアクセスするかを指定することになるからである。

.\"O The `global' manual page hierarchies are usually those stored under 
.\"O .I /usr
.\"O such as
.\"O .IR /usr/man , 
.\"O .I /usr/local/man
.\"O and
.\"O .IR /usr/X11R6/man .

`global' なマニュアルページの階層は、通常
.I /usr
以下に保管されている。例えば
.IR /usr/man ,
.IR /usr/local/man ,
.I /usr/X11R6/man
などがこれにあたる。

.\"O If cat pages from a particular
.\"O .I manpath_element
.\"O are not to be stored or are to be stored in the traditional location, 
.\"O .I catpath_element
.\"O may be omitted.

特定の
.I manpath_element
からの cat ページを保管したくない場合や、従来の位置に保管したい場合には、
.I catpath_element
は省略する。

.\"O Traditional cat placement would be impossible for read only mounted manual
.\"O page hierarchies and because of this it is possible to specify any valid
.\"O directory hierarchy for their storage. To observe the 
.\"O .B Linux FSSTND
.\"O the keyword 
.\"O .RB ` FSSTND ' 
.\"O can be used in place of an actual directory. 

従来用いられていた cat ファイルの保管場所 (/usr/man/cat?/ など) は、
リードオンリーでマウントされているマニュアルページの階層下に
置くことはできなかった。この理由から、保管場所として
任意のディレクトリ階層を指定することが可能になっている (もちろん指定した
ディレクトリは有効なものでなければならない)。
.B Linux FSSTND
に従う場合には、
キーワード
.RB ` FSSTND '
を実際のディレクトリ名の代わりに用いることができる。

.\"O Unfortunately, it is necessary to specify
.\"O .B all
.\"O `global' man tree paths, including alternate system paths such as
.\"O .I /usr/man/sun
.\"O and any 
.\"O .B NLS locale
.\"O paths such as
.\"O .IR /usr/man/de_DE.88591 . 

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

.\"O As the information is parsed line by line in the order written, it is 
.\"O necessary for any 
.\"O manpath that is a sub-hierarchy of another hierarchy to be listed 
.\"O first, otherwise an incorrect match will be made.
.\"O An example is that
.\"O .I /usr/man/de_DE.88591
.\"O must come before
.\"O .IR /usr/man .

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

.\"O .SH BUGS
.\"O Unless the rules above are followed and observed precisely, the manual pager
.\"O utilities will not function as desired. The rules are overly complicated.

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


-----
内田憲宏 (UCHIDA Norihiro)
KY4N-UCD@xxxxxxxxxxxxxxx