mandb

Section: Manual pager utils (8)
Updated: July 12th, 1995
Index JM Home Page

名前

mandb - マニュアルページのインデックスキャッシュを作成・更新する。

書式

mandb [-dqsuc|-h|-V] [manpath]

説明

mandb はデータベースのキャッシュ index を初期化したり、手動で更新するときに用いる。通常はこのキャッシュは man によって管理されている。キャッシュには、現在のマニュアルページシステムに関する情報が含まれている。この情報は man_db ユーティリティ群によって用いられ、速度と機能の向上に貢献している。

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

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

データベースキャッシュ

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

名前	形式	非同期	ファイル名

Berkeley db	二分木	可	index.bt
GNU gdbm v >= 1.6	ハッシュ	可	index.db
GNU gdbm v < 1.6	ハッシュ	不可	index.db
UNIX ndbm	ハッシュ	不可	index.(dir\|pag)

これらのデータベース形式のうち非同期な更新ができるものでは、速度は向上するが、予期しない中断が起こったときにデータが壊れるかもしれない。このような破壊が起こったときには、 mandb を -c オプションをつけて実行し、データベースを再構成しなおす必要があるだろう。

オプション

-d, --debug: デバッグ情報を生成する。
-q, --quiet: 警告を発しない。
-s, --no-straycats: stray cat (訳注: おそらく対応する roff ソースのない cat ページのことでしょう) を探したり、それに関する情報をデータに追加しようとは試みない。
-c, --create: デフォルトでは、 mandb は以前に生成されたデータベースを更新しようとする。データベースが存在しない場合には、始めから生成する。このオプションを指定すると、 mandb は以前のデータベースを消去し、データベースをゼロから再構成する。これはデータベースが壊れた場合や、将来データベースの管理方法が新しいものに変わったときなどに必要となろう。
-u, --user-db: ユーザーのデータベースしか生成しない。 `global' なデータベースを作成する権限があっても、こちらは生成しない。
-h, --help: 使用法に関するメッセージを表示して終了する。
-V, --version: バージョンを表示して終了する。

診断メッセージ

データベースの構築中に、以下のような警告メッセージが出力されることがある。

<filename>: whatis parse for page(sec) failed: <filename> から whatis に必要な行を取り出すのに失敗した。これは通常マニュアルページの書き方が悪いからであることが多いが、このようなメッセージが多く出るようであれば、そのシステムには man_db の whatis パーザーと互換性のない、非標準的なマニュアルページが含まれている可能性が高い。
<filename>: is a dangling symlink: <filename> がシンボリックリンクによって参照されているが、存在していない。通常、 <filename> を間違ってリンク対象としてしまっているリンク元に関する診断メッセージが同時に表示される。
<filename>: bad symlink or ROFF `.so' request: <filename> はシンボリックリンクであるか、 ROFF のインクルード命令を含んでいるが、リンク先・読み込み先のファイルが存在していない。
<filename>: ignoring bogus filename: <filename> は正しい (あるいは正しくない) マニュアルページであるが、名前が正しくない。通常これは、セクション拡張子 <x> のファイルが、マニュアルページのセクション <y> に置かれている場合に起こる。
<filename_mask>: competing extensions: ワイルドカード <filename_mask> がユニークな名前でない。これは通常、同じマニュアルページに対して、圧縮されたバージョンとされていないバージョンが共存している場合に起こる。最新のもの以外は無視される。

ファイル

/etc/manpath.config: man_db の設定ファイル。
/usr/man/index.(bt|db|dir|pag): 従来形式の、 global なデータベースキャッシュのインデックス。
/var/catman/index.(bt|db|dir|pag): 新しい (FSSTND 準拠の)、 global なデータベースキャッシュのインデックス。