DH_INSTALLDOCS(1)

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 Paketbauverzeichnis zuständig ist.

In Kompatibilitätsstufe 10 und älter war dh_install(1) möglicherweise ein besseres Werkzeug zur Handhabung von Dokumentation der Ursprungsautoren, wenn das eigene Bausystem der Ursprungsautoren sämtliche gewünschte Dokumentation korrekt installierte. In diesem Fall kann dh_installdocs immer noch paketierungsbezogene Dokumentation (z.B. die Datei debian/copyright) installieren.

Ab Debhelper-Kompatibilitätsstufe 11 wird dh_install in debian/tmp nach Dateien suchen, wenn es sie nicht im aktuellen Verzeichnis findet (oder wo auch immer Sie ihm mit --sourcedir aufgetragen haben zu suchen).

In Kompatibilitätsstufe 11 und neuer bietet dh_installdocs viele der Funktionalitäten, die auch dh_install(1) hat. Desweiteren unterstützt dh_installdocs außerdem das Bauprofil nodoc, um Dokumentation (unabhängig von der Kompatibilitätsstufe) auszuschließen.

DATEIEN

debian/Paket.docs
    listet Dokumentationsdateien auf, die in Paket installiert werden sollen.

    unterstützt Ersetzungsvariablen in Kompatibilitätsstufe 13 oder neuer, wie in debhelper(7) beschrieben.

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
    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.

debian/Paket.doc-base.*
    If your package needs to register more than one document, you need multiple doc-base files, and can name them like this.

    Please be aware that the files are deduplicated in memory based on their doc-id. To work correctly, it requires dh_installdocs to be called no more than once during the package build. Calling dh_installdocs -ppackage in combination with using debian/package.doc-base.* files can lead to uninstallable packages. See <https://bugs.debian.org/980903> for details.

OPTIONEN

-A, --all
    installiert alle durch Befehlszeilenparameter angegebenen Dateien in ALLEN Paketen, 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.

--sourcedir=Verz
    schaut im angegebenen Verzeichnis nach Dateien, die installiert werden sollen. Diese Option erfordert Kompatibilitätsstufe 11 oder höher (sie wird in Kompatibilitätsstufe 10 und darunter stillschweigend ignoriert).

    Beachten Sie, dass dies nicht das Gleiche wie die Option --sourcedirectory ist, die von dh_auto_*-Befehlen benutzt wird. Sie benötigen diese Option selten, da dh_installman in Debhelper-Kompatibilitätsstufe 11 und darüber automatisch in debian/tmp nach Dateien sucht.

--doc-main-package=Hauptpaket
    setzt das Hauptpaket für ein Dokumentationspaket. Dies wird zur Installation der Dokumentation des Dokumentationspakets in /usr/share/doc/Hauptpaket benutzt, wie es das Debian-Richtlinienhandbuch 3.9.7 in §12.3 empfiehlt.

    In Kompatibilitätsstufe 11 (oder höher) ist diese Option nur dann nützlich, wenn Debhelpers automatische Erkennung des Hauptpakets falsch ist. Die Option kann außerdem benutzt werden, um eine Warnung von Debhelper zu unterdrücken, wenn die automatische Erkennung fehlschlägt, die Voreinstellung aber korrekt funktioniert.

    Diese Option kann nicht verwendet werden, wenn dh_installdocs angewiesen wurde, auf mehrere Pakete einzuwirken. Falls Sie diese Option benötigen, werden Sie sie üblicherweise mit -p kombinieren müssen, um sicherzustellen, dass nur auf exakt ein Paket eingewirkt wird.

    The X-Doc-Main-Package field can be used instead since debhelper/13.28. It has similar semantics but does not require command line options.

    Please keep in mind that some documentation (the copyright file, README.Debian, etc.) will be unaffected by this option and the X-Doc-Main-Package field.

--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 verlinkte Dokumentationsverzeichnisse zu verhindern, die Konflikte mit dem verlinkten Paket verursachen würden. Die Option -A wird keine Auswirkungen auf Pakete mit verlinkten Dokumentationsverzeichnissen haben und die Dateien copyright, changelog, README.Debian und TODO werden nicht installiert.

    (Eine ältere Methode, die dasselbe erreicht und die immer noch unterstützt wird, besteht darin, das Dokumentationsverzeichnis eines Pakets als defekten symbolischen Link zu erstellen, bevor dh_installdocs aufgerufen wird.)

    Bitte beachten Sie, dass diese Option nur für das Dokumentationsverzeichnis des Pakets selbst gilt. Wenn das Paket Dokumentation für ein anderes Paket mitbringt (siehe z. B. --doc-main-package), wird kein symbolischer Link für die Dokumentation des anderen Pakets verwendet.

    WARNUNG 1: Falls eine vorhergehende Version des Pakets ohne diese Option gebaut wurde und nun mit ihr gebaut wird (oder umgekehrt), erfordert es eine »Verzeichnis-zu-Symlink«- (oder »Symlink-zu-Verzeichnis«)-Migration. Da Debhelper nichts über die 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.

    WARNUNG 2: --link-doc sollte nur benutzt werden, wenn die Pakete denselben »architecture«-Typ haben. Ein Link von einem architekturunabhängigen zu einem architekturabhängigen Paket (oder umgekehrt) wird nicht funktionieren. Seit Kompatibilitätsstufe 10 wird Debhelper nicht unterstützte Kombinationen aktiv zurückweisen.

<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, wenn Sie es verlangen (ähnlich cp -a). Wenn ein Verzeichnis installieren soll, übernimmt es den kompletten Verzeichnisinhalt.

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>