Scroll to navigation

DH_INSTALLDOCS(1) Debhelper DH_INSTALLDOCS(1)

名前

dh_installdocs - パッケージビルドディレクトリ以下にドキュメントをインストールする

書式

dh_installdocs [debhelper options] [-A] [-Xitem] [file ...]

説明

dh_installdocs はパッケージビルドディレクトリ以下にある usr/share/doc/package ディレクトリへドキュメントをインストールする役割を持つ debhelper プログラムです。

ファイル

package にインストールすべきドキュメントファイルの一覧を列挙します。

In compat 11 (or later), these will be installed into /usr/share/doc/mainpackage. Previously it would be /usr/share/doc/package.

The copyright file is installed into all packages, unless a more specific copyright file is available.
Each of these files is automatically installed if present for a package.
これらのファイルは debian/control に最初に記載されているバイナリパッケージへインストールされます。

非 native パッケージの元では、README.debian ファイルは README.Debian としてインストールされ、TODO ファイルは TODO.Debian としてインストールされます。

Installed as doc-base control files. Note that the doc-id will be determined from the Document: 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.
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.

オプション

全パッケージに対して、コマンドラインパラメータに指定されたファイルを全てインストールします。
インストール対象のファイルから、item をファイル名に含むものを除外します。これには doc-base のファイルも含む点に注意ください。
処理対象の全パッケージのドキュメンテーションディレクトリを、package のドキュメンテーションディレクトリへのシンボリックリンクを張ることにより作成します。この動作は package そのものには行われず、また、dh_installdocs が動作する時に既に存在しているディレクトリに対しては行われません。ポリシーに準拠する為、package は同じソースパッケージからビルドされるバイナリパッケージである必要があります。

debhelper はファイルをインストール時にシンボリックリンク先のパッケージとの競合を避ける為、シンボリックリンクで作成されているドキュメンテーションディレクトリにはファイルをインストールしません。-A オプションはシンボリックリンクで作成されたディレクトリには作用しません。さらに、この場合、copyright, changelog, README.Debian, TODO ファイルはインストールされません。

(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 dh_installdocs.)

CAVEAT: If a previous version of the package was built without this option and is now built with it (or vice-versa), it requires a "dir to symlink" (or "symlink to dir") migration. Since debhelper has no knowledge of previous versions, you have to enable this migration itself.

This can be done by providing a "debian/package.maintscript" file and using dh_installdeb(1) to provide the relevant maintainer script snippets.

作業予定の最初のパッケージに、これらのファイルをドキュメントファイルとしてインストールします (あるいは -A が指定されている場合は、ビルド予定の全てのパッケージに対してインストールします)

使用例

以下が debian/package.docs ファイルの例です:

  README
  TODO
  debian/notes-for-maintainers.txt
  docs/manual.txt
  docs/manual.pdf
  docs/manual-html/

付記

Note that dh_installdocs will happily copy entire directory hierarchies if you ask it to (similar to cp -a). If it is asked to install a directory, it will install the complete contents of the directory.

参照

debhelper(7)

このプログラムは debhelper の一部です。

作者

Joey Hess <joeyh@debian.org>

2017-01-25 10.2.5