246 lines
9.1 KiB
HTML
246 lines
9.1 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of INSTALL-DOCS</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>INSTALL-DOCS</H1>
|
|
Section: Debian (8)<BR>Updated: 06 August 2019<BR><A HREF="#index">Index</A>
|
|
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<A NAME="lbAB"> </A>
|
|
<H2>名前</H2>
|
|
|
|
|
|
|
|
install-docs - オンライン Debian ドキュメントの管理
|
|
<A NAME="lbAC"> </A>
|
|
<H2>書式</H2>
|
|
|
|
|
|
|
|
|
|
|
|
<PRE>
|
|
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
|
|
|
|
</PRE>
|
|
|
|
|
|
<A NAME="lbAD"> </A>
|
|
<H2>説明</H2>
|
|
|
|
|
|
|
|
<B>install-docs</B> は、Debian
|
|
のパッケージメンテナがさまざまなドキュメンテーションシステムに、ドキュメントを登録できるようにするツールです。現在、<B>dhelp</B>, <B>dwww</B>,
|
|
<B>doc-central</B>, <B>scrollkeeper</B> といったブラウザをサポートしています。
|
|
<P>
|
|
|
|
このマニュアルページでは、<B>install-docs</B>
|
|
を使う上での、簡単な書式を提供しています。コントロールファイルの構文や文法に説明といった、完全な文書はドキュメントにあります。
|
|
<A NAME="lbAE"> </A>
|
|
<H2>オプション</H2>
|
|
|
|
|
|
|
|
<DL COMPACT>
|
|
<DT id="1"><B>-v</B>, <B>--verbose</B><DD>
|
|
|
|
|
|
饒舌に動作します。
|
|
<DT id="2"><B>-d</B>, <B>--debug</B><DD>
|
|
|
|
|
|
デバッグ情報を表示します。
|
|
<DT id="3"><B>--no-update-menus</B><DD>
|
|
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?8+dwww-build-menu">dwww-build-menu</A></B>(8), <B><A HREF="/cgi-bin/man/man2html?8+dhelp_parse">dhelp_parse</A></B>(8), <B><A HREF="/cgi-bin/man/man2html?8+scrollkeeper-update">scrollkeeper-update</A></B>(8)
|
|
の実行を抑制します。
|
|
<DT id="4"><B>--rootdir</B> <I>dir</I><DD>
|
|
|
|
|
|
ルートディレクトリを、`<I>/</I>' ではなく <I>dir</I> に設定します。<B>--check</B> アクションと共に使用したときのみ、有効で意味があります。
|
|
</DL>
|
|
<A NAME="lbAF"> </A>
|
|
<H2>アクション</H2>
|
|
|
|
|
|
|
|
以下に <B>install-docs</B> が扱える、有効なアクションを列挙します。install-docs
|
|
へはアクションオプションをひとつしか渡せません。さらに、引数のあるアクションは、最後のオプションとして渡さなければなりません。
|
|
<P>
|
|
|
|
各 <I>file</I> は、doc-base コントロールファイルのフルパス (つまり `/usr/share/doc-base/some_file' や
|
|
`/etc/doc-base/documents/some_file') にしてください。また、各 <I>docid</I> は、ドキュメント識別子
|
|
(ドキュメント識別子は、コントロールファイルの `Document' フィールド設定されており、通常パッケージ名と同じ) にしてください。
|
|
<P>
|
|
|
|
<I>file</I> や <I>docid</I> が `<B>-</B>' (マイナス記号) の場合、引数のリストを標準入力 (ファイル名やドキュメント <FONT SIZE="-1">ID</FONT>
|
|
は改行で区切る) から読み込みます。
|
|
<DL COMPACT>
|
|
<DT id="5"><B>-i</B> <I>file</I> [<I>file</I> ...], <B>--install</B> <I>file</I> [<I>file</I> ...]<DD>
|
|
|
|
|
|
コントロールファイル <I>file</I> に記述したドキュメントをインストールします。
|
|
<DT id="6"><B>-r</B> <I>file</I> [<I>file</I> ...], <B>--remove</B> <I>file</I> [<I>file</I> ...]<DD>
|
|
|
|
|
|
コントロールファイル <I>file</I> で識別したドキュメントを削除します。
|
|
<DT id="7"><B>-c</B> <I>file</I> [<I>file</I> ...], <B>--check</B> <I>file</I> [<I>file</I> ...]<DD>
|
|
|
|
|
|
コントロールファイル <I>file</I> をチェックし、発見した問題の数を表示します。エラーや警告の実際の場所を得るには、<I>--verbose</I>
|
|
と合わせて使用してください。<I>--rootdir</I> が与えられた場合、<I>file</I> の `Files' フィールドや `Index'
|
|
フィールドがあると、そのファイル名の前に付与します。
|
|
<DT id="8"><B>-R</B>, <B>--remove-all</B><DD>
|
|
|
|
|
|
登録したすべてのドキュメントを、登録解除します。
|
|
<DT id="9"><B>-I</B>, <B>--install-all</B><DD>
|
|
|
|
|
|
<I>/usr/share/doc-base</I> や <I>/etc/doc-base/documents</I> から、すべてのドキュメントを (再)
|
|
登録します。
|
|
<DT id="10"><B>-C</B>, <B>--install-changed</B><DD>
|
|
|
|
|
|
<I>/usr/share/doc-base</I> の内容や <I>/etc/doc-base/documents</I>
|
|
ディレクトリと、登録ドキュメントデータベースとを比較し、見つからないファイルを登録解除したり、変更されただけのファイルや新しいファイルを (再)
|
|
登録します。
|
|
<DT id="11"><B>-s</B> <I>docid</I> [<I>docid</I> ...], <B>--status</B> <I>docid</I> [<I>docid</I> ...]<DD>
|
|
|
|
|
|
ドキュメント識別子 <I>docid</I> の状態を表示します。
|
|
<DT id="12"><B>-L</B> <I>docid</I> [<I>docid</I> ...], <B>--listfiles</B> <I>docid</I> [<I>docid</I> ...]<DD>
|
|
|
|
|
|
廃止予定のオプションです。何もしません。
|
|
<DT id="13"><B>--dump-db</B> <I>dbname</I><DD>
|
|
|
|
|
|
デバッグ用に、内部データベースをダンプします。<I>dbname</I> は <B>files.db</B> と <B>status.db</B> のいずれかです。
|
|
<DT id="14"><B>-h</B>, <B>--help</B><DD>
|
|
|
|
|
|
短いヘルプメッセージを表示します。
|
|
<DT id="15"><B>-V</B>, <B>--version</B><DD>
|
|
|
|
|
|
バージョン情報を表示します。
|
|
</DL>
|
|
<A NAME="lbAG"> </A>
|
|
<H2>互換性問題</H2>
|
|
|
|
|
|
|
|
以下の機能は、バージョン 0.8.4 で追加されました。パッケージスクリプトで使用する場合は、適切な `<I>Conflicts</I>' 行や
|
|
`<I>Depends</I>' 行を、確実に追加してください。
|
|
<DL COMPACT>
|
|
<DT id="16">•<DD>
|
|
<B>-i</B> や <B>-r</B> アクションに対する複数の引数サポート
|
|
<DT id="17">•<DD>
|
|
標準入力からの引数読み込み
|
|
<DT id="18">•<DD>
|
|
<B>-I</B>,<B>--install-all</B>, <B>-R</B>, <B>---remove-all</B>, <B>-c</B>, <B>--check</B> の各アクション
|
|
<DT id="19">•<DD>
|
|
<B>-d</B>, <B>--debug</B>, <B>-h</B>, <B>--help</B> の各オプション
|
|
</DL>
|
|
<P>
|
|
|
|
<B>-C</B>, <B>--install-changed</B>, <B>--dump-db</B>, <B>-V</B>, <B>--version</B> の各オプションは
|
|
0.8.12 で追加されました。
|
|
<A NAME="lbAH"> </A>
|
|
<H2>ファイル</H2>
|
|
|
|
|
|
|
|
<DL COMPACT>
|
|
<DT id="20"><I>/usr/share/doc-base/</I><DD>
|
|
|
|
|
|
さまざまなパッケージが提供する、doc-base 制御ファイルの場所。
|
|
<DT id="21"><I>/etc/doc-base/documents/</I><DD>
|
|
|
|
|
|
ローカル管理者が提供する、doc-base 制御ファイルの場所。
|
|
<DT id="22"><I>/var/lib/doc-base/info/documents/</I><DD>
|
|
|
|
|
|
登録された制御ファイルの場所。
|
|
<DT id="23"><I>/var/lib/doc-base/info/status.db</I><DD>
|
|
|
|
|
|
登録されたドキュメントの状態。
|
|
<DT id="24"><I>/var/lib/doc-base/info/files.db</I><DD>
|
|
|
|
|
|
登録された doc-base ファイルの、タイムスタンプとドキュメント ID。
|
|
<DT id="25"><I>/var/lib/doc-base/omf/</I><DD>
|
|
|
|
|
|
生成された scrollkeeper <FONT SIZE="-1">OMF</FONT> ファイルの場所。注意: <I>/usr/share/omf/doc-base</I>
|
|
は、このディレクトリへのシンボリックリンクであるべきです。
|
|
</DL>
|
|
<A NAME="lbAI"> </A>
|
|
<H2>バグ</H2>
|
|
|
|
|
|
|
|
<<A HREF="http://bugs.debian.org/doc-base">http://bugs.debian.org/doc-base</A>> をご覧ください。
|
|
<A NAME="lbAJ"> </A>
|
|
<H2>関連項目</H2>
|
|
|
|
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?1+dhelp">dhelp</A></B>(1), <B><A HREF="/cgi-bin/man/man2html?1+doccentral">doccentral</A></B>(1), <B><A HREF="/cgi-bin/man/man2html?7+dwww">dwww</A></B>(7), <B><A HREF="/cgi-bin/man/man2html?7+scrollkeeper">scrollkeeper</A></B>(7), Debian doc-base マニュアル
|
|
<I>/usr/share/doc/doc-base/doc-base.html/index.html</I>
|
|
<A NAME="lbAK"> </A>
|
|
<H2>著者</H2>
|
|
|
|
|
|
|
|
このプログラムは、元々 Debian GNU/Linux システム向けに Christian Schwarz <<A HREF="mailto:schwarz@debian.org">schwarz@debian.org</A>>
|
|
と、2代目メンテナである Adam Di Carlo <<A HREF="mailto:aph@debian.org">aph@debian.org</A>> によって書かれました。現在 Robert Luberda
|
|
<<A HREF="mailto:robert@debian.org">robert@debian.org</A>> が、保守と拡張を行っています。
|
|
<P>
|
|
|
|
このソフトウェアは、Debian
|
|
のユーザ・開発者コミュニティ全体のためになるように作られました。このソフトウェアに興味がある方は、<<A HREF="mailto:debian-doc@lists.debian.org">debian-doc@lists.debian.org</A>>
|
|
メーリングリストに参加してください。
|
|
<P>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="26"><A HREF="#lbAB">名前</A><DD>
|
|
<DT id="27"><A HREF="#lbAC">書式</A><DD>
|
|
<DT id="28"><A HREF="#lbAD">説明</A><DD>
|
|
<DT id="29"><A HREF="#lbAE">オプション</A><DD>
|
|
<DT id="30"><A HREF="#lbAF">アクション</A><DD>
|
|
<DT id="31"><A HREF="#lbAG">互換性問題</A><DD>
|
|
<DT id="32"><A HREF="#lbAH">ファイル</A><DD>
|
|
<DT id="33"><A HREF="#lbAI">バグ</A><DD>
|
|
<DT id="34"><A HREF="#lbAJ">関連項目</A><DD>
|
|
<DT id="35"><A HREF="#lbAK">著者</A><DD>
|
|
</DL>
|
|
<HR>
|
|
This document was created by
|
|
<A HREF="/cgi-bin/man/man2html">man2html</A>,
|
|
using the manual pages.<BR>
|
|
Time: 00:05:06 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|