.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "INSTALL-DOCS 8"
.TH INSTALL-DOCS 8 "25 January 2021" "doc-base v0.11.1" "Debian"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "名前"
.IX Header "名前"
install-docs \- オンライン Debian ドキュメントの管理
.SH "書式"
.IX Header "書式"
.Vb 1
\& 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
.Ve
.SH "説明"
.IX Header "説明"
\&\fBinstall-docs\fR は、Debian
のパッケージメンテナがさまざまなドキュメンテーションシステムに、ドキュメントを登録できるようにするツールです。現在、\fBdhelp\fR, \fBdwww\fR,
\&\fBdochelp\fR, \fBdoc-central\fR といったブラウザをサポートしています。
.PP
このマニュアルページでは、\fBinstall-docs\fR
を使う上での、簡単な書式を提供しています。コントロールファイルの構文や文法に説明といった、完全な文書はドキュメントにあります。
.SH "オプション"
.IX Header "オプション"
.IP "\fB\-v\fR, \fB\-\-verbose\fR" 4
.IX Item "-v, --verbose"
饒舌に動作します。
.IP "\fB\-d\fR, \fB\-\-debug\fR" 4
.IX Item "-d, --debug"
デバッグ情報を表示します。
.IP "\fB\-\-no\-update\-menus\fR" 4
.IX Item "--no-update-menus"
\&\fBdwww\-build\-menu\fR\|(8), \fBdhelp_parse\fR\|(8) の実行を抑制します。
.IP "\fB\-\-rootdir\fR \fIdir\fR" 4
.IX Item "--rootdir dir"
ルートディレクトリを、`\fI/\fR' ではなく \fIdir\fR に設定します。\fB\-\-check\fR アクションと共に使用したときのみ、有効で意味があります。
.SH "アクション"
.IX Header "アクション"
以下に \fBinstall-docs\fR が扱える、有効なアクションを列挙します。install\-docs
へはアクションオプションをひとつしか渡せません。さらに、引数のあるアクションは、最後のオプションとして渡さなければなりません。
.PP
各 \fIfile\fR は、doc\-base コントロールファイルのフルパス (つまり `/usr/share/doc\-base/some_file' や
`/etc/doc\-base/documents/some_file') にしてください。また、各 \fIdocid\fR は、ドキュメント識別子
(ドキュメント識別子は、コントロールファイルの `Document' フィールド設定されており、通常パッケージ名と同じ) にしてください。
.PP
\&\fIfile\fR や \fIdocid\fR が `\fB\-\fR' (マイナス記号) の場合、引数のリストを標準入力 (ファイル名やドキュメント \s-1ID\s0
は改行で区切る) から読み込みます。
.IP "\fB\-i\fR \fIfile\fR [\fIfile\fR ...], \fB\-\-install\fR \fIfile\fR [\fIfile\fR ...]" 4
.IX Item "-i file [file ...], --install file [file ...]"
コントロールファイル \fIfile\fR に記述したドキュメントをインストールします。
.IP "\fB\-r\fR \fIfile\fR [\fIfile\fR ...], \fB\-\-remove\fR \fIfile\fR [\fIfile\fR ...]" 4
.IX Item "-r file [file ...], --remove file [file ...]"
コントロールファイル \fIfile\fR で識別したドキュメントを削除します。
.IP "\fB\-c\fR \fIfile\fR [\fIfile\fR ...], \fB\-\-check\fR \fIfile\fR [\fIfile\fR ...]" 4
.IX Item "-c file [file ...], --check file [file ...]"
コントロールファイル \fIfile\fR をチェックし、発見した問題の数を表示します。エラーや警告の実際の場所を得るには、\fI\-\-verbose\fR
と合わせて使用してください。\fI\-\-rootdir\fR が与えられた場合、\fIfile\fR の `Files' フィールドや `Index'
フィールドがあると、そのファイル名の前に付与します。
.IP "\fB\-R\fR, \fB\-\-remove\-all\fR" 4
.IX Item "-R, --remove-all"
登録したすべてのドキュメントを、登録解除します。
.IP "\fB\-I\fR, \fB\-\-install\-all\fR" 4
.IX Item "-I, --install-all"
\&\fI/usr/share/doc\-base\fR や \fI/etc/doc\-base/documents\fR から、すべてのドキュメントを (再)
登録します。
.IP "\fB\-C\fR, \fB\-\-install\-changed\fR" 4
.IX Item "-C, --install-changed"
\&\fI/usr/share/doc\-base\fR の内容や \fI/etc/doc\-base/documents\fR
ディレクトリと、登録ドキュメントデータベースとを比較し、見つからないファイルを登録解除したり、変更されただけのファイルや新しいファイルを (再)
登録します。
.IP "\fB\-s\fR \fIdocid\fR [\fIdocid\fR ...], \fB\-\-status\fR \fIdocid\fR [\fIdocid\fR ...]" 4
.IX Item "-s docid [docid ...], --status docid [docid ...]"
ドキュメント識別子 \fIdocid\fR の状態を表示します。
.IP "\fB\-L\fR \fIdocid\fR [\fIdocid\fR ...], \fB\-\-listfiles\fR \fIdocid\fR [\fIdocid\fR ...]" 4
.IX Item "-L docid [docid ...], --listfiles docid [docid ...]"
廃止予定のオプションです。何もしません。
.IP "\fB\-\-dump\-db\fR \fIdbname\fR" 4
.IX Item "--dump-db dbname"
デバッグ用に、内部データベースをダンプします。\fIdbname\fR は \fBfiles.db\fR と \fBstatus.db\fR のいずれかです。
.IP "\fB\-h\fR, \fB\-\-help\fR" 4
.IX Item "-h, --help"
短いヘルプメッセージを表示します。
.IP "\fB\-V\fR, \fB\-\-version\fR" 4
.IX Item "-V, --version"
バージョン情報を表示します。
.SH "互換性問題"
.IX Header "互換性問題"
以下の機能は、バージョン 0.8.4 で追加されました。パッケージスクリプトで使用する場合は、適切な `\fIConflicts\fR' 行や
`\fIDepends\fR' 行を、確実に追加してください。
.IP "\(bu" 4
\&\fB\-i\fR や \fB\-r\fR アクションに対する複数の引数サポート
.IP "\(bu" 4
標準入力からの引数読み込み
.IP "\(bu" 4
\&\fB\-I\fR,\fB\-\-install\-all\fR, \fB\-R\fR, \fB\-\-\-remove\-all\fR, \fB\-c\fR, \fB\-\-check\fR の各アクション
.IP "\(bu" 4
\&\fB\-d\fR, \fB\-\-debug\fR, \fB\-h\fR, \fB\-\-help\fR の各オプション
.PP
\&\fB\-C\fR, \fB\-\-install\-changed\fR, \fB\-\-dump\-db\fR, \fB\-V\fR, \fB\-\-version\fR の各オプションは
0.8.12 で追加されました。
.SH "ファイル"
.IX Header "ファイル"
.IP "\fI/usr/share/doc\-base/\fR" 4
.IX Item "/usr/share/doc-base/"
さまざまなパッケージが提供する、doc\-base 制御ファイルの場所。
.IP "\fI/etc/doc\-base/documents/\fR" 4
.IX Item "/etc/doc-base/documents/"
ローカル管理者が提供する、doc\-base 制御ファイルの場所。
.IP "\fI/var/lib/doc\-base/info/documents/\fR" 4
.IX Item "/var/lib/doc-base/info/documents/"
登録された制御ファイルの場所。
.IP "\fI/var/lib/doc\-base/info/status.db\fR" 4
.IX Item "/var/lib/doc-base/info/status.db"
登録されたドキュメントの状態。
.IP "\fI/var/lib/doc\-base/info/files.db\fR" 4
.IX Item "/var/lib/doc-base/info/files.db"
登録された doc-base ファイルの、タイムスタンプとドキュメント ID。
.SH "バグ"
.IX Header "バグ"
<http://bugs.debian.org/doc\-base> をご覧ください。
.SH "関連項目"
.IX Header "関連項目"
\&\fBdhelp\fR\|(1), \fBdoccentral\fR\|(1), \fBdochelp\fR\|(1), \fBdwww\fR\|(7), Debian doc-base マニュアル
\&\fI/usr/share/doc/doc\-base/doc\-base.html/index.html\fR
.SH "著者"
.IX Header "著者"
このプログラムは、元々 Debian GNU/Linux システム向けに Christian Schwarz <schwarz@debian.org>
と、2代目メンテナである Adam Di Carlo <aph@debian.org> によって書かれました。現在 Robert Luberda
<robert@debian.org> が、保守と拡張を行っています。
.PP
このソフトウェアは、Debian
のユーザ・開発者コミュニティ全体のためになるように作られました。このソフトウェアに興味がある方は、<debian\-doc@lists.debian.org>
メーリングリストに参加してください。