NAME¶
dh_installdocs - installiert Dokumentation in Paketbauverzeichnisse
ÜBERSICHT¶
dh_installdocs [
Debhelper-Optionen] [
-A]
[
-XElement] [
Datei …]
BESCHREIBUNG¶
dh_installdocs ist ein Debhelper-Programm, das für die
Installation von Dokumentation in
usr/share/doc/Paket im
Paketbauverzeichniszuständig ist.
DATEIEN¶
- debian/Paket.docs
- listet Dokumentationsdateien auf, die in Paket installiert werden
sollen.
Im Kompatibilitätsmodus 11 werden diese in
/usr/share/doc/mainpackage installiert. Vorher wäre dies
/usr/share/doc/package gewesen.
- debian/copyright
- Die Copyright-Datei ist in allen Paketen installiert, außer wenn
eine speziellere Copyright-Datei verfügbar ist.
- debian/Paket.copyright
- debian/Paket.README.Debian
- debian/Paket.TODO
- Jede dieser Dateien wird automatisch installiert, falls sie für ein
Paket vorhanden ist.
- debian/README.Debian
- debian/TODO
- Diese Dateien werden in das erste Binärpaket installiert, das in
»debian/control« aufgeführt ist.
Beachten Sie, dass README.debian-Dateien auch als
README.Debian und TODO-Dateien in nicht nativen Paketen auch
als TODO.Debian installiert werden.
- debian/Paket.doc-base
- sind als doc-base-Steuerdateien installiert. Beachten Sie, dass die Doc-ID
vom Eintrag Document: in der bestreffenden Doc-base-Steuerdatei
bestimmt wird. Im Fall, dass mehrere Doc-base-Dateien in einem einzelnen
Quellpaket die gleiche Doc-ID gemeinsam benutzen, werden sie nach
usr/share/doc-base/package statt nach usr/share/doc-base/doc-id
installiert.
- debian/Paket.doc-base.*
- Falls es nötig ist, dass Ihr Paket mehr als ein Dokument
registriert, benötigen Sie mehrere Doc-base-Dateien und
können sie so wie diese benennen. Im Fall, dass mehrere
Doc-base-Dateien in diesem Stil in einem einzelnen Quellpaket die gleiche
Doc-ID gemeinsam benutzen, werden sie nach usr/share/doc-base/package-*
statt nach usr/share/doc-base/doc-id installiert.
OPTIONEN¶
- -A, --all
- installiert alle Dateien, die durch Befehlszeilenparameter in ALLEN
Paketen angegeben werden, auf die es sich auswirkt.
- -XElement, --exclude=Element
- schließt Dateien von der Installation aus, die Element in
ihrem Dateinamen enthalten. Beachten Sie, dass dies doc-base-Dateien
einschließt.
- --link-doc=Paket
- veranlasst, dass das Dokumentationsverzeichnis aller Pakete, auf die es
sich auswirkt, ein symbolischer Link auf das Dokumentationsverzeichnis von
Paket ist. Dies hat keine Auswirkungen, wenn auf das Paket
selbst eingewirkt wird oder falls das Dokumentationsverzeichnis, das
erstellt werden soll, bereits bei der Ausführung von
dh_installdocs existiert. Um der Richtlinie zu entsprechen, muss
Paket ein Binärpaket sein, das vom selben Quellpaket stammt.
Debhelper wird versuchen, die Installation von Dateien in verknüpfte
Dokumentationsverzeichnisse zu verhindern, die Konflikte mit dem
verknüpften Paket verursachen würden. Die Option -A
wird keine Auswirkungen auf Pakete mit verknüpften
Dokumentationsverzeichnissen haben und die Dateien copyright,
changelog, README.Debian und TODO werden nicht
installiert.
(Eine ältere Methode, um dasselbe zu erreichen, die immer noch
unterstützt wird, besteht darin, das Dokumentationsverzeichnis
eines Pakets als defekten symbolischen Link zu erstellen, bevor
dh_installdocs aufgerufen wird.)
WARNUNG: Falls eine vorhergehende Version des Pakets ohne diese
Option gebaut wurde und nun mit ihr gebaut wird (oder umgekehrt),
erfordert es eine »Verzeichnis-zu-symbolischer-Link-Migration (oder
»symbolischer-Link-zu-Verzeichnis«). Da Debhelper nichts von
vorhergehenden Versionen weiß, müssen Sie diese Migration
selbst anstoßen.
Dies kann durch Bereitstellen einer »debian/
Paket.maintscript«-Datei und mittels dh_installdeb(1)
erledigt werden. Dadurch werden die passenden Betreuerskriptschnipsel zur
Verfügung gestellt.
- <Datei …
- installiert diese Dateien als Dokumentation in das erste Paket, auf die es
sich auswirkt (oder in allen Paketen, falls -A angegeben
wurde).
BEISPIELE¶
Dies ist ein Beispiel einer
debian/Paket.docs-Datei:
README
TODO
debian/notes-for-maintainers.txt
docs/manual.txt
docs/manual.pdf
docs/manual-html/
ANMERKUNGEN¶
Beachten Sie, dass
dh_installdocs klaglos ganze Verzeichnishierarchien
kopiert, falls Sie es verlangen (ähnlich
cp -a). Falls verlangt
wurde, ein Verzeichnis zu installieren, wird es den kompletten Inhalt des
Verzeichnisses installieren.
SIEHE AUCH¶
debhelper(7)
Dieses Programm ist Teil von Debhelper.
ÜBERSETZUNG¶
Diese Übersetzung wurde mit dem Werkzeug
po4a
<
http://po4a.alioth.debian.org/> durch Chris Leick
c.leick@vollbio.de und das deutsche Debian-Übersetzer-Team im
Dezember 2011 erstellt.
Bitte melden Sie alle Fehler in der Übersetzung an
debian-l10n-german@lists.debian.org oder als Fehlerbericht an das Paket
debhelper.
Sie können mit dem folgenden Befehl das englische Original anzeigen
man -L en Abschnitt Handbuchseite
AUTOR¶
Joey Hess <joeyh@debian.org>