Manpages

名 前

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

書 式

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

説 明

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

フ ァ イ ル

debian/package.docs

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

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

debian/copyright

The copyright file is installed into all packages, unless a more specific copyright file is available.

debian/package.copyright
debian/package.README.Debian
debian/package.TODO

Each of these files is automatically installed if present for a package.

debian/README.Debian
debian/TODO こ れ ら の フ ァ イ ル は debian/control に 最 初 に 記 載 さ れ て い る バ イ ナ リ パ ッ ケ ー ジ へ イ ン ス ト ー ル さ れ ま す 。 非 native パ ッ ケ ー ジ の 元 で は 、 README .debian フ ァ イ ル は README .Debian と し て イ ン ス ト ー ル さ れ 、 TODO フ ァ イ ル は TODO .Debian と し て イ ン ス ト ー ル さ れ ま す 。
debian/package.doc−base

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.

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.

オ プ シ ョ ン

−A, −−all 全 パ ッ ケ ー ジ に 対 し て 、 コ マ ン ド ラ イ ン パ ラ メ ー タ に 指 定 さ れ た フ ァ イ ル を 全 て イ ン ス ト ー ル し ま す 。
−Xitem, −−exclude=item イ ン ス ト ー ル 対 象 の フ ァ イ ル か ら 、 item を フ ァ イ ル 名 に 含 む も の を 除 外 し ま す 。 こ れ に は doc-base の フ ァ イ ル も 含 む 点 に 注 意 く だ さ い 。
−−link−doc=package 処 理 対 象 の 全 パ ッ ケ ー ジ の ド キ ュ メ ン テ ー シ ョ ン デ ィ レ ク ト リ を 、 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.

file ... 作 業 予 定 の 最 初 の パ ッ ケ ー ジ に 、 こ れ ら の フ ァ イ ル を ド キ ュ メ ン ト フ ァ イ ル と し て イ ン ス ト ー ル し ま す (あ る い は −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 [AT] debian.org>