Scroll to navigation

INSTALL-DOCS(8) Debian INSTALL-DOCS(8)

名前

install-docs - オンライン Debian ドキュメントの管理

書式

 install-docs [options] -i,--install | -r,--remove | -c,--check file [ file ... ]

 install-docs [options] -I,--install-all | -C,--install-changed | -R,--remove-all

 install-docs [options] -s,--status docid [ docid ... ]

 install-docs [options] --dump-db dbname

 install-docs -h,--help | -V,--version

説明

install-docs は、Debian のパッケージメンテナがさまざまなドキュメンテーションシステムに、ドキュメントを登録できるようにするツールです。現在、dhelp, dwww, doc-central, scrollkeeper といったブラウザをサポートしています。

このマニュアルページでは、install-docs を使う上での、簡単な書式を提供しています。コントロールファイルの構文や文法に説明といった、完全な文書はドキュメントにあります。

オプション

-v, --verbose
饒舌に動作します。
-d, --debug
デバッグ情報を表示します。
--no-update-menus
dwww-build-menu(8), dhelp_parse(8), scrollkeeper-update(8) の実行を抑制します。
--rootdir dir
ルートディレクトリを、`/' ではなく dir に設定します。--check アクションと共に使用したときのみ、有効で意味があります。

アクション

以下に install-docs が扱える、有効なアクションを列挙します。install-docs へはアクションオプションをひとつしか渡せません。さらに、引数のあるアクションは、最後のオプションとして渡さなければなりません。

file は、doc-base コントロールファイルのフルパス (つまり `/usr/share/doc-base/some_file' や `/etc/doc-base/documents/some_file') にしてください。また、各 docid は、ドキュメント識別子 (ドキュメント識別子は、コントロールファイルの `Document' フィールド設定されており、通常パッケージ名と同じ) にしてください。

filedocid が `-' (マイナス記号) の場合、引数のリストを標準入力 (ファイル名やドキュメント ID は改行で区切る) から読み込みます。

-i file [file ...], --install file [file ...]
コントロールファイル file に記述したドキュメントをインストールします。
-r file [file ...], --remove file [file ...]
コントロールファイル file で識別したドキュメントを削除します。
-c file [file ...], --check file [file ...]
コントロールファイル file をチェックし、発見した問題の数を表示します。エラーや警告の実際の場所を得るには、--verbose と合わせて使用してください。--rootdir が与えられた場合、file の `Files' フィールドや `Index' フィールドがあると、そのファイル名の前に付与します。
-R, --remove-all
登録したすべてのドキュメントを、登録解除します。
-I, --install-all
/usr/share/doc-base/etc/doc-base/documents から、すべてのドキュメントを (再) 登録します。
-C, --install-changed
/usr/share/doc-base の内容や /etc/doc-base/documents ディレクトリと、登録ドキュメントデータベースとを比較し、見つからないファイルを登録解除したり、変更されただけのファイルや新しいファイルを (再) 登録します。
-s docid [docid ...], --status docid [docid ...]
ドキュメント識別子 docid の状態を表示します。
-L docid [docid ...], --listfiles docid [docid ...]
廃止予定のオプションです。何もしません。
--dump-db dbname
デバッグ用に、内部データベースをダンプします。dbnamefiles.dbstatus.db のいずれかです。
-h, --help
短いヘルプメッセージを表示します。
-V, --version
バージョン情報を表示します。

互換性問題

以下の機能は、バージョン 0.8.4 で追加されました。パッケージスクリプトで使用する場合は、適切な `Conflicts' 行や `Depends' 行を、確実に追加してください。
  • -i-r アクションに対する複数の引数サポート
  • 標準入力からの引数読み込み
  • -I,--install-all, -R, ---remove-all, -c, --check の各アクション
  • -d, --debug, -h, --help の各オプション

-C, --install-changed, --dump-db, -V, --version の各オプションは 0.8.12 で追加されました。

ファイル

/usr/share/doc-base/
さまざまなパッケージが提供する、doc-base 制御ファイルの場所。
/etc/doc-base/documents/
ローカル管理者が提供する、doc-base 制御ファイルの場所。
/var/lib/doc-base/info/documents/
登録された制御ファイルの場所。
/var/lib/doc-base/info/status.db
登録されたドキュメントの状態。
/var/lib/doc-base/info/files.db
登録された doc-base ファイルの、タイムスタンプとドキュメント ID。
/var/lib/doc-base/omf/
生成された scrollkeeper OMF ファイルの場所。注意: /usr/share/omf/doc-base は、このディレクトリへのシンボリックリンクであるべきです。

バグ

<http://bugs.debian.org/doc-base> をご覧ください。

関連項目

dhelp(1), doccentral(1), dwww(7), scrollkeeper(7), Debian doc-base マニュアル /usr/share/doc/doc-base/doc-base.html/index.html

著者

このプログラムは、元々 Debian GNU/Linux システム向けに Christian Schwarz <schwarz@debian.org> と、2代目メンテナである Adam Di Carlo <aph@debian.org> によって書かれました。現在 Robert Luberda <robert@debian.org> が、保守と拡張を行っています。

このソフトウェアは、Debian のユーザ・開発者コミュニティ全体のためになるように作られました。このソフトウェアに興味がある方は、<debian-doc@lists.debian.org> メーリングリストに参加してください。

06 August 2019 doc-base v0.10.9