.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32) .\" .\" 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 .. .if !\nF .nr F 0 .if \nF>0 \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} .\} .\" ======================================================================== .\" .IX Title "DH_INSTALLDOCS 1" .TH DH_INSTALLDOCS 1 "2017-01-25" "10.2.5" "Debhelper" .\" 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 "名前" dh_installdocs \- パッケージビルドディレクトリ以下にドキュメントをインストールする .SH "書式" .IX Header "書式" \&\fBdh_installdocs\fR [\fIdebhelper options\fR] [\fB\-A\fR] [\fB\-X\fR\fIitem\fR] [\fIfile\fR ...] .SH "説明" .IX Header "説明" \&\fBdh_installdocs\fR はパッケージビルドディレクトリ以下にある \fIusr/share/doc/package\fR ディレクトリへドキュメントをインストールする役割を持つ debhelper プログラムです。 .SH "ファイル" .IX Header "ファイル" .IP "debian/\fIpackage\fR.docs" 4 .IX Item "debian/package.docs" \&\fIpackage\fR にインストールすべきドキュメントファイルの一覧を列挙します。 .Sp In compat 11 (or later), these will be installed into \&\fI/usr/share/doc/mainpackage\fR. Previously it would be \&\fI/usr/share/doc/package\fR. .IP "\fIdebian/copyright\fR" 4 .IX Item "debian/copyright" The copyright file is installed into all packages, unless a more specific copyright file is available. .IP "debian/\fIpackage\fR.copyright" 4 .IX Item "debian/package.copyright" .PD 0 .IP "debian/\fIpackage\fR.README.Debian" 4 .IX Item "debian/package.README.Debian" .IP "debian/\fIpackage\fR.TODO" 4 .IX Item "debian/package.TODO" .PD Each of these files is automatically installed if present for a \fIpackage\fR. .IP "\fIdebian/README.Debian\fR" 4 .IX Item "debian/README.Debian" .PD 0 .IP "\fIdebian/TODO\fR" 4 .IX Item "debian/TODO" .PD これらのファイルは debian/control に最初に記載されているバイナリパッケージへインストールされます。 .Sp 非 native パッケージの元では、\fI\s-1README\s0.debian\fR ファイルは \fI\s-1README\s0.Debian\fR としてインストールされ、\fI\s-1TODO\s0\fR ファイルは \fI\s-1TODO\s0.Debian\fR としてインストールされます。 .IP "debian/\fIpackage\fR.doc\-base" 4 .IX Item "debian/package.doc-base" Installed as doc-base control files. Note that the doc-id will be determined from the \fBDocument:\fR entry in the doc-base control file in question. In the event that multiple doc-base files in a single source package share the same doc-id, they will be installed to usr/share/doc\-base/package instead of usr/share/doc\-base/doc\-id. .IP "debian/\fIpackage\fR.doc\-base.*" 4 .IX Item "debian/package.doc-base.*" If your package needs to register more than one document, you need multiple doc-base files, and can name them like this. In the event that multiple doc-base files of this style in a single source package share the same doc-id, they will be installed to usr/share/doc\-base/package\-* instead of usr/share/doc\-base/doc\-id. .SH "オプション" .IX Header "オプション" .IP "\fB\-A\fR, \fB\-\-all\fR" 4 .IX Item "-A, --all" 全パッケージに対して、コマンドラインパラメータに指定されたファイルを全てインストールします。 .IP "\fB\-X\fR\fIitem\fR, \fB\-\-exclude=\fR\fIitem\fR" 4 .IX Item "-Xitem, --exclude=item" インストール対象のファイルから、\fIitem\fR をファイル名に含むものを除外します。これには doc-base のファイルも含む点に注意ください。 .IP "\fB\-\-link\-doc=\fR\fIpackage\fR" 4 .IX Item "--link-doc=package" 処理対象の全パッケージのドキュメンテーションディレクトリを、\fIpackage\fR のドキュメンテーションディレクトリへのシンボリックリンクを張ることにより作成します。この動作は \fIpackage\fR そのものには行われず、また、\fBdh_installdocs\fR が動作する時に既に存在しているディレクトリに対しては行われません。ポリシーに準拠する為、\fIpackage\fR は同じソースパッケージからビルドされるバイナリパッケージである必要があります。 .Sp debhelper はファイルをインストール時にシンボリックリンク先のパッケージとの競合を避ける為、シンボリックリンクで作成されているドキュメンテーションディレクトリにはファイルをインストールしません。\fB\-A\fR オプションはシンボリックリンクで作成されたディレクトリには作用しません。さらに、この場合、\fIcopyright\fR, \fIchangelog\fR, \&\fI\s-1README\s0.Debian\fR, \fI\s-1TODO\s0\fR ファイルはインストールされません。 .Sp (An older method to accomplish the same thing, which is still supported, is to make the documentation directory of a package be a dangling symlink, before calling \fBdh_installdocs\fR.) .Sp \&\fB\s-1CAVEAT\s0\fR: If a previous version of the package was built without this option and is now built with it (or vice-versa), it requires a \*(L"dir to symlink\*(R" (or \*(L"symlink to dir\*(R") migration. Since debhelper has no knowledge of previous versions, you have to enable this migration itself. .Sp This can be done by providing a "debian/\fIpackage\fR.maintscript" file and using \fIdh_installdeb\fR\|(1) to provide the relevant maintainer script snippets. .IP "\fIfile\fR ..." 4 .IX Item "file ..." 作業予定の最初のパッケージに、これらのファイルをドキュメントファイルとしてインストールします (あるいは \fB\-A\fR が指定されている場合は、ビルド予定の全てのパッケージに対してインストールします) .SH "使用例" .IX Header "使用例" 以下が \fIdebian/package.docs\fR ファイルの例です: .PP .Vb 6 \& README \& TODO \& debian/notes\-for\-maintainers.txt \& docs/manual.txt \& docs/manual.pdf \& docs/manual\-html/ .Ve .SH "付記" .IX Header "付記" Note that \fBdh_installdocs\fR will happily copy entire directory hierarchies if you ask it to (similar to \fBcp \-a\fR). If it is asked to install a directory, it will install the complete contents of the directory. .SH "参照" .IX Header "参照" \&\fIdebhelper\fR\|(7) .PP このプログラムは debhelper の一部です。 .SH "作者" .IX Header "作者" Joey Hess