MANDB
Section: Manual pager utils (8)
Updated: 2019-10-23
Index
Return to Main Contents
名前
mandb - マニュアルページのインデックスキャッシュを作成・更新する
書式
mandb
[-dqsucpt?V]
[-C
file]
[manpath]
mandb
[-dqsut]
[-C
file]
-f
filename ...
説明
mandb
はデータベースのキャッシュ
index
を初期化したり、手動で更新するときに用いる。
キャッシュには、現在のマニュアルページシステムに関する情報が含まれている。
この情報は man-db ユーティリティ群によって用いられ、速度と機能の向上に
貢献している。
index
が生成・更新されるとき、
mandb
は ROFF の .so 命令の間違いや、マニュアルページのファイル名の重複、
whatis
によって情報を抽出できないマニュアルページなどに対して警告を発する。
mandb
に、コロンで区切ったパスのリストを与えることもできる。
これは man-db 設定ファイルの情報から決定された、
内部のシステムのマニュアルページ階層検索パスを上書きする。
データベースキャッシュ
mandb
は以下のデータベース形式のいずれか一つをサポートするように
コンパイルすることができる。
名前 | 形式 | 非同期 | ファイル名
|
|
Berkeley db |
二分木
| 可 | index.bt
|
GNU gdbm |
ハッシュ
| 可 | index.db
|
UNIX ndbm |
ハッシュ
| 不可 | index.(dir|pag)
|
これらのデータベース形式のうち非同期な更新ができるものでは、
速度は向上するが、予期しない中断が起こったときにデータが壊れるかも
しれない。
このような破壊が起こったときには、
mandb
を
-c
オプションをつけて実行し、データベースを再構成しなおす必要があるだろう。
オプション
- -d, --debug
-
デバッグ情報を表示する。
- -q, --quiet
-
警告を発しない。
- -s, --no-straycats
-
stray cat (訳注: おそらく対応する roff ソースのない cat ページのこと
でしょう) を探したり、それに関する情報をデータに追加しようとは試みない。
- -p, --no-purge
-
削除されたマニュアルページのチェックと、データベースからの削除に
時間を使わない。
- -c, --create
-
デフォルトでは、
mandb
は以前に生成されたデータベースを更新しようとする。
データベースが存在しない場合には、始めから生成する。
このオプションを指定すると、
mandb
は以前のデータベースを消去し、データベースをゼロから再構成する。
これは暗黙のうちに
--no-purge
を指定する。
これはデータベースが壊れた場合や、将来データベースの管理方法が
新しいものに変わったときなどに必要となろう。
- -u, --user-db
-
ユーザーのデータベースしか生成しない。
システムのデータベースを作成する権限があっても、生成しない。
- -t, --test
-
階層の検索パスにあるマニュアルページの整合性チェックを行う。
このオプションを指定すると、
mandb
は既存のデータベースを変更しない。
- -f, --filename
-
指定されたファイル名のエントリのみを更新する。
このオプションは一般的には使用されない。
このオプションは、
man
が
MAN_DB_UPDATES
オプションを付けてコンパイルされていて、ページの有効期限が切れて
いるのを見つけた場合、
man
が内部的に使う。
このオプションは
-p
を暗黙のうちに指定し、
-c
と
-s
を無効にする。
- -C file, --config-file=file
-
デフォルトの
~/.manpath
ではなく、ユーザーの設定ファイルを使う。
- -?, --help
-
使用法のメッセージを表示して、終了する。
- --usage
-
簡単な使用法のメッセージを表示して、終了する。
- -V, --version
-
バージョン情報を表示して、終了する。
返り値
- 0
-
プログラムの実行に成功した。
- 1
-
使用法、文法、設定ファイルのいずれかにエラーがある。
- 2
-
実行時エラー。
- 3
-
子プロセスが失敗した。
診断メッセージ
データベースの構築中に、以下のような警告メッセージが出力されることがある。
- <filename>: whatis parse for page(sec) failed
-
<filename> から whatis に必要な行を取り出すのに失敗した。
これは通常マニュアルページの書き方が悪いからであることが多いが、
このようなメッセージが多く出るようであれば、そのシステムには man-db の
whatis パーサーと互換性のない、非標準的なマニュアルページが含まれている
可能性が高い。
詳しい情報は
lexgrog(1)
の
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/man_db.conf
-
man-db の設定ファイル。
- /var/cache/man/index.(bt|db|dir|pag)
-
FHS 準拠のグローバルな
index
データベースキャッシュ。
データベースキャッシュの昔の場所としては以下がある:
- /usr/man/index.(bt|db|dir|pag)
-
従来形式のグローバルな
index
データベースキャッシュ。
- /var/catman/index.(bt|db|dir|pag)
-
別の FSSTND 準拠のグローバルな
index
データベースキャッシュ。
関連項目
lexgrog(1),
man(1),
manpath(5),
catman(8)
以前このマニュアルページにあった
WHATIS の解析
のセクションは、現在は
lexgrog(1)
の一部である。
著者
Wilf. (G.Wilford@ee.surrey.ac.uk).
Fabrizio Polacco (fpolacco@debian.org).
Colin Watson (cjwatson@debian.org).
Index
- 名前
-
- 書式
-
- 説明
-
- データベースキャッシュ
-
- オプション
-
- 返り値
-
- 診断メッセージ
-
- ファイル
-
- 関連項目
-
- 著者
-
This document was created by
man2html,
using the manual pages.
Time: 14:24:29 GMT, July 02, 2020