コマンドラインのマニュアル

Man » mandb マニュアルオンライン - mandb man ページに関する詳細なオンラインドキュメント

🌍
mandb - マニュアルページインデックスキャッシュを作成または更新します

概要

mandb [-dqsucpt?V] [-C ファイル] [manpath]
mandb [-dqsut] [-C ファイル] -f ファイル名 ...

説明

mandb は、インデックスデータベースキャッシュを初期化または手動で更新するために使用されます。キャッシュには、現在のマニュアルページシステムの状態に関する情報と、その中に格納されている情報が含まれており、man-db ユーティリティによって、その速度と機能が向上します。

インデックスを作成または更新する場合、mandb は、ROFF .so リクエスト、不正なマニュアルページファイル名、および whatis を解析できないマニュアルページに関する警告を発します。

オプションのコロン区切りパスを mandb に渡すと、内部システムマニュアルページ階層検索パスがオーバーライドされます。この内部パスは、man-db 構成ファイル内の情報から決定されます。

データベースキャッシュ

mandb は、以下のいずれかのデータベースタイプをサポートするようにコンパイルできます。

名前          非同期   ファイル名

Berkeley db   はい     index.bt
GNU gdbm      はい     index.db
UNIX ndbm     いいえ   index.(dir|pag)

非同期更新をサポートするデータベースタイプは、パフォーマンスを向上させますが、異常な終了の場合には、データが破損する可能性があります。まれなケースですが、この場合、-c オプションを使用して mandb を再実行し、データベースを最初から再作成する必要がある場合があります。

オプション

-d, --debug

デバッグ情報を出力します。

-q, --quiet

警告を出力しません。

-s, --no-straycats

迷子の猫に関する情報をデータベースに追加したり、検索したりするのに時間をかけません。

-p, --no-purge

削除されたマニュアルページをデータベースから削除して検証するのに時間をかけません。

-c, --create

デフォルトでは、mandb は以前に作成されたデータベースを更新しようとします。データベースが存在しない場合は、作成します。このオプションは、mandb に対して、以前のデータベースを削除し、最初から再作成するように強制します。-p と --no-purge を含みます。これは、データベースが破損した場合、または将来、新しいデータベースストレージスキームが導入された場合に必要になる場合があります。

-u, --user-db

システムデータベースを作成するために必要な書き込み権限があっても、ユーザーデータベースのみを作成します。

-t, --test

階層検索パス内のマニュアルページの整合性を検証します。このオプションを使用すると、mandb は既存のデータベースを変更しません。

-f, --filename

指定されたファイル名のエントリのみを更新します。このオプションは、一般的な使用を目的としていません。これは、man が MAN_DB_UPDATES オプションでコンパイルされ、ページが最新ではないことが判明した場合に、内部で使用されます。-p を含み、-c と -s を無効にします。

-C ファイル, --config-file=ファイル

デフォルトの \~/.manpath ではなく、このユーザー構成ファイルを使用します。

-?, --help

使用法メッセージを表示して終了します。

--usage

短い使用法メッセージを出力して終了します。

-V, --version

バージョンを表示して終了します。

終了ステータス

0     プログラムは正常に実行されました。

1     使用法、構文、または構成ファイルの誤り。

2     操作上のエラー。

3     子プロセスが失敗しました。

診断

データベース構築中に、次の警告メッセージが出力されることがあります。

<filename>: whatis 解析に失敗しました
指定された <filename> から whatis 行を抽出する試行が失敗しました。通常、これは書き方が悪いマニュアルページが原因ですが、このようなメッセージが多数出力される場合は、システムに man-db whatis パーサーと互換性がない非標準のマニュアルページが含まれている可能性があります。lexgrog(1) の WHATIS PARSING セクションを参照してください。

<filename>: ダングリングシンボリックリンクです
<filename> は存在しませんが、シンボリックリンクによって参照されています。通常、<filename> の問題のあるリンクに関する詳細な診断情報が出力されます。

<filename>: 不正なシンボリックリンクまたは ROFF `.so` リクエスト
<filename> はシンボリックリンクであるか、存在しないファイルへの ROFF include リクエストを含んでいます。

<filename>: 不正なファイル名を無視しています
<filename> は有効なマニュアルページである場合とそうでない場合がありますが、その名前は無効です。通常、これは、セクション拡張子 <x> を持つマニュアルページが、マニュアルページセクション <y> に配置された場合に発生します。

<filename_mask>: 競合する拡張子
ワイルドカード <filename_mask> は一意ではありません。通常、これは、圧縮バージョンと非圧縮バージョンの同じマニュアルページが存在する場合に発生します。最新のもの以外のすべてが無視されます。

ファイル

/etc/manpath.config

man-db 構成ファイル。

/var/cache/man/index.(bt|db|dir|pag)

FHS 準拠のグローバルインデックスデータベースキャッシュ。

データベースキャッシュの古い場所には、次のようなものがあります。

/usr/man/index.(bt|db|dir|pag)

従来のグローバルインデックスデータベースキャッシュ。

/var/catman/index.(bt|db|dir|pag)

代替または FSSTND 準拠のグローバルインデックスデータベースキャッシュ。

関連項目

lexgrog(1), man(1), manpath(5), catman(8)

このマニュアルページに以前は含まれていた WHATIS PARSING セクションは、現在は lexgrog(1) の一部になっています。

著者

Wilf. (_). Fabrizio Polacco (_). Colin Watson (_).

バグ

https://gitlab.com/man-db/man-db/-/issues
https://savannah.nongnu.org/bugs/?group=man-db