.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" 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 .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . 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 .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "DH_INSTALLDOCS 1" .TH DH_INSTALLDOCS 1 2024-03-27 13.15.3 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 NAME dh_installdocs \- installiert Dokumentation in Paketbauverzeichnisse .SH ÜBERSICHT .IX Header "ÜBERSICHT" \&\fBdh_installdocs\fR [\fIDebhelper-Optionen\fR] [\fB\-A\fR] [\fB\-X\fR\fIElement\fR] [\fIDatei\fR\ …] .SH BESCHREIBUNG .IX Header "BESCHREIBUNG" \&\fBdh_installdocs\fR ist ein Debhelper-Programm, das für die Installation von Dokumentation in \fIusr/share/doc/Paket\fR im Paketbauverzeichnis zuständig ist. .PP In Kompatibilitätsstufe 10 und älter war \fBdh_install\fR\|(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 \fBdh_installdocs\fR immer noch paketierungsbezogene Dokumentation (z.B. die Datei \fIdebian/copyright\fR) installieren. .PP Ab Debhelper\-Kompatibilitätsstufe 11 wird \fBdh_install\fR in \fIdebian/tmp\fR nach Dateien suchen, wenn es sie nicht im aktuellen Verzeichnis findet (oder wo auch immer Sie ihm mit \fB\-\-sourcedir\fR aufgetragen haben zu suchen). .PP In Kompatibilitätsstufe 11 und neuer bietet \fBdh_installdocs\fR viele der Funktionalitäten, die auch \fBdh_install\fR\|(1) hat. Desweiteren unterstützt \fBdh_installdocs\fR außerdem das Bauprofil \fBnodoc\fR, um Dokumentation (unabhängig von der Kompatibilitätsstufe) auszuschließen. .SH DATEIEN .IX Header "DATEIEN" .IP debian/\fIPaket\fR.docs 4 .IX Item "debian/Paket.docs" listet Dokumentationsdateien auf, die in \fIPaket\fR installiert werden sollen. .Sp unterstützt Ersetzungsvariablen in Kompatibilitätsstufe 13 oder neuer, wie in \fBdebhelper\fR\|(7) beschrieben. .IP \fIdebian/copyright\fR 4 .IX Item "debian/copyright" Die Copyright-Datei ist in allen Paketen installiert, außer wenn eine speziellere Copyright-Datei verfügbar ist. .IP debian/\fIPaket\fR.copyright 4 .IX Item "debian/Paket.copyright" .PD 0 .IP debian/\fIPaket\fR.README.Debian 4 .IX Item "debian/Paket.README.Debian" .IP debian/\fIPaket\fR.TODO 4 .IX Item "debian/Paket.TODO" .PD Jede dieser Dateien wird automatisch installiert, falls sie für ein \fIPaket\fR vorhanden ist. .IP \fIdebian/README.Debian\fR 4 .IX Item "debian/README.Debian" .PD 0 .IP \fIdebian/TODO\fR 4 .IX Item "debian/TODO" .PD Diese Dateien werden in das erste Binärpaket installiert, das in »debian/control« aufgeführt ist. .Sp Beachten Sie, dass \fIREADME.debian\fR\-Dateien auch als \fIREADME.Debian\fR und \fITODO\fR\-Dateien in nicht-nativen Paketen auch als \fITODO.Debian\fR installiert werden. .IP debian/\fIPaket\fR.doc\-base 4 .IX Item "debian/Paket.doc-base" sind als doc-base-Steuerdateien installiert. Beachten Sie, dass die Doc-ID vom Eintrag \fBDocument:\fR in der bestreffenden Doc-base-Steuerdatei bestimmt wird. In dem 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. .IP debian/\fIPaket\fR.doc\-base.* 4 .IX Item "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 auf diese Weise benennen. In dem Fall, dass mehrere solche 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. .Sp Bitte behalten Sie im Hinterkopf dass diese Deduplikation derzeit nur im Speicher stattfindet, daher darf \fBdh_installdocs\fR nur ein einziges Mal während des Bauvorgangs aufgerufen werden. Wenn Sie \fBdh_installdocs \-p\fR\fIPaket\fR aufrufen und gleichzeitig \fIdebian/\fR\fIPaket\fR\fI.doc\-base.*\fR\-Dateien verwenden, können dabei uninstallierbare Pakete herauskommen. Siehe für Details. .SH OPTIONEN .IX Header "OPTIONEN" .IP "\fB\-A\fR, \fB\-\-all\fR" 4 .IX Item "-A, --all" installiert alle durch Befehlszeilenparameter angegebenen Dateien in ALLEN Paketen, auf die es sich auswirkt. .IP "\fB\-X\fR\fIElement\fR, \fB\-\-exclude=\fR\fIElement\fR" 4 .IX Item "-XElement, --exclude=Element" schließt Dateien von der Installation aus, die \fIElement\fR in ihrem Dateinamen enthalten. Beachten Sie, dass dies doc-base-Dateien einschließt. .IP \fB\-\-sourcedir=\fR\fIVerz\fR 4 .IX Item "--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). .Sp Beachten Sie, dass dies nicht das Gleiche wie die Option \fB\-\-sourcedirectory\fR ist, die von \fBdh_auto_\fR\fI*\fR\-Befehlen benutzt wird. Sie benötigen diese Option selten, da \fBdh_installman\fR in Debhelper\-Kompatibilitätsstufe 11 und darüber automatisch in \fIdebian/tmp\fR nach Dateien sucht. .IP \fB\-\-doc\-main\-package=\fR\fIHauptpaket\fR 4 .IX Item "--doc-main-package=Hauptpaket" setzt das Hauptpaket für ein Dokumentationspaket. Dies wird zur Installation der Dokumentation des Dokumentationspakets in \fI/usr/share/doc/Hauptpaket\fR benutzt, wie es das Debian-Richlinienhandbuch 3.9.7 in §12.3 empfiehlt. .Sp 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. .Sp Diese Option kann nicht verwendet werden, wenn \fBdh_installdocs\fR angewiesen wurde, auf mehrere Pakete einzuwirken. Falls Sie diese Option benötigen, werden Sie sie üblicherweise mit \fB\-p\fR kombinieren müssen, um sicherzustellen, dass nur auf exakt ein Paket eingewirkt wird. .Sp Bitte denken Sie daran, dass manche Dokumentation (die Copyright-Datei, README.Debian, etc.) nicht von dieser Option beeinflusst wird. .IP \fB\-\-link\-doc=\fR\fIPaket\fR 4 .IX Item "--link-doc=Paket" veranlasst, dass das Dokumentationsverzeichnis aller Pakete, auf die es sich auswirkt, ein symbolischer Link auf das Dokumentationsverzeichnis von \fIPaket\fR ist. Dies hat keine Auswirkungen, wenn auf das \fIPaket\fR selbst eingewirkt wird oder falls das Dokumentationsverzeichnis, das erstellt werden soll, bereits bei der Ausführung von \fBdh_installdocs\fR existiert. Um der Richtlinie zu entsprechen, muss \fIPaket\fR ein Binärpaket sein, das vom selben Quellpaket stammt. .Sp Debhelper wird versuchen, die Installation von Dateien in verlinkte Dokumentationsverzeichnisse zu verhindern, die Konflikte mit dem verlinkten Paket verursachen würden. Die Option \fB\-A\fR wird keine Auswirkungen auf Pakete mit verlinkten Dokumentationsverzeichnissen haben und die Dateien \fIcopyright\fR, \fIchangelog\fR, \fIREADME.Debian\fR und \fITODO\fR werden nicht installiert. .Sp (Eine ältere Methode, die dasselbe errecht und die immer noch unterstützt wird, besteht darin, das Dokumentationsverzeichnis eines Pakets als defekten symbolischen Link zu erstellen, bevor \fBdh_installdocs\fR aufgerufen wird.) .Sp 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. \fB\-\-doc\-main\-package\fR), wird kein symbolischer Link für die Dokumentation des anderen Pakets verwendet. .Sp \&\fBWARNUNG 1\fR: 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. .Sp Dies kann durch Bereitstellen einer »debian/\fIPaket\fR.maintscript«\-Datei und mittels \fBdh_installdeb\fR\|(1) erledigt werden. Dadurch werden die passenden Betreuerskriptschnipsel zur Verfügung gestellt. .Sp \&\fBWARNUNG 2\fR: \fB\-\-link\-doc\fR 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. .IP "<\fIDatei\fR …" 4 .IX Item " durch Chris Leick \&\fIc.leick@vollbio.de\fR und das deutsche Debian\-Übersetzer\-Team im Dezember 2011 erstellt. .PP Bitte melden Sie alle Fehler in der Übersetzung an \&\fIdebian\-l10n\-german@lists.debian.org\fR oder als Fehlerbericht an das Paket \&\fIdebhelper\fR. .PP Sie können mit dem folgenden Befehl das englische Original anzeigen man\ \-L\ en\ Abschnitt\ Handbuchseite .SH AUTOR .IX Header "AUTOR" Joey Hess