'\" t
.\" Man page for mandb
.\"
.\" 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.
.\" 
.\" Tue Apr 26 12:56:44 BST 1994  Wilf. (G.Wilford@ee.surrey.ac.uk) 
.\"
.\" Japanese Version Copyright (c) 1998 NAKANO Takeo all rights reserved.
.\" Translated Fri 25 Sep 1998 by NAKANO Takeo <nakano@apm.seikei.ac.jp>
.\" Modified Sun 6 Dec 1998 by NAKANO Takeo <nakano@apm.seikei.ac.jp>
.\"
.\"WORD:	hierarchy	階層
.\"
.TH mandb 8 "July 12th, 1995" "2.3.10" "Manual pager utils"
.SH 名前
mandb \- マニュアルページのインデックスキャッシュを作成・更新する。
.SH 書式
.B mandb  
.RB [\| \-dqsuc \||\| \-h \||\| \-V\c
.RI "\|] [\|" manpath \|] 
.SH 説明
.B mandb
はデータベースのキャッシュ
.B index
を初期化したり、手動で更新するときに用いる。通常はこのキャッシュは
.B man
によって管理されている。
キャッシュには、現在のマニュアルページシステムに関する情報が含まれている。
この情報は man_db ユーティリティ群によって用いられ、速度と機能の向上に
貢献している。

.B index
が生成・更新されるとき、
.B mandb
は ROFF の .so 命令の間違いや、マニュアルページのファイル名の重複、
.B whatis
によって情報を抽出できないマニュアルページなどにたいして警告を発する。

.B mandb
に、コロンで区切ったパスのリストを与えることもできる。
これは man_db 設定ファイルの情報から決定された、プログラム
内部の `global' なマニュアルページ階層検索パスを上書きする。

.SS データベースキャッシュ
.B mandb
は以下のデータベース形式のいずれか一つをサポートするように
コンパイルすることができる。

.TS
tab (@);
l l l l.
名前@形式@非同期@ファイル名
_
Berkeley db@二分木@可@\fIindex.bt\fR
GNU gdbm v >= 1.6@ハッシュ@可@\fIindex.db\fR
GNU gdbm v <  1.6@ハッシュ@不可@\fIindex.db\fR
UNIX ndbm@ハッシュ@不可@\fIindex.(dir|pag)\fR
.TE

これらのデータベース形式のうち非同期な更新ができるものでは、
速度は向上するが、予期しない中断が起こったときにデータが壊れるかもしれない。
このような破壊が起こったときには、
.B mandb
を
.B \-c
オプションをつけて実行し、データベースを再構成しなおす必要が
あるだろう。
.SH オプション
.TP
.B \-d, \-\-debug
デバッグ情報を生成する。
.TP
.B \-q, \-\-quiet
警告を発しない。
.TP
.B \-s, \-\-no-straycats
stray cat (訳注: おそらく対応する roff ソースのない cat ページのこと
でしょう) を探したり、それに関する情報をデータに追加しようとは試みない。
.\"??? stray cats?
.TP
.B \-c, \-\-create
デフォルトでは、
.B mandb
は以前に生成されたデータベースを更新しようとする。データベースが
存在しない場合には、始めから生成する。
このオプションを指定すると、
.B mandb
は以前のデータベースを消去し、データベースをゼロから再構成する。
これはデータベースが壊れた場合や、将来データベースの管理方法が
新しいものに変わったときなどに必要となろう。
.TP
.B \-u, \-\-user-db
ユーザーのデータベースしか生成しない。 `global' なデータベースを作成す
る権限があっても、こちらは生成しない。
.TP
.B \-h, \-\-help
使用法に関するメッセージを表示して終了する。
.TP
.B \-V, \-\-version
バージョンを表示して終了する。
.SH 診断メッセージ
データベースの構築中に、以下のような警告メッセージが出力されることがあ
る。
.TP 
.B <filename>: whatis parse for page(sec) failed
<filename> から whatis に必要な行を取り出すのに失敗した。これは通常マ
ニュアルページの書き方が悪いからであることが多いが、このようなメッセー
ジが多く出るようであれば、そのシステムには man_db の whatis パーザーと
互換性のない、非標準的なマニュアルページが含まれている可能性が高い。
.TP
.B <filename>: is a dangling symlink
<filename> がシンボリックリンクによって参照されているが、存在していな
い。通常、 <filename> を間違ってリンク対象としてしまっているリンク元に
関する診断メッセージが同時に表示される。
.TP
.B <filename>: bad symlink or ROFF `.so' request
<filename> はシンボリックリンクであるか、 ROFF のインクルー
ド命令を含んでいるが、リンク先・読み込み先のファイルが存在していない。
.TP
.B <filename>: ignoring bogus filename
<filename> は正しい (あるいは正しくない) マニュアルページであるが、
名前が正しくない。通常これは、セクション拡張子 <x> のファイルが、
マニュアルページのセクション <y> に置かれている場合に起こる。
.TP
.B <filename_mask>: competing extensions
ワイルドカード <filename_mask> がユニークな名前でない。これは通常、同
じマニュアルページに対して、圧縮されたバージョンとされていないバージョ
ンが共存している場合に起こる。最新のもの以外は無視される。
.SH ファイル
.TP
.I /etc/manpath.config
man_db の設定ファイル。
.TP
.I /usr/man/index.(bt|db|dir|pag)
従来形式の、 global なデータベースキャッシュの
インデックス。
.TP
.I /var/catman/index.(bt|db|dir|pag)
新しい (FSSTND 準拠の)、 global なデータベースキャッシュの
インデックス。
.SH 関連項目
.BR man (1), 
.BR manpath (5),
.BR catman (8)
.SH 著者
Wilf. (G.Wilford@ee.surrey.ac.uk)