dh installdocs(1)

dh_installdocs(1)

dh_installdocs(1) — Linux manualsida

NAMN

dh_installdocs – installera dokumentation i paketens byggkataloger

SYNOPSIS

dh_installdocs [debhelper-flaggor] [-A] [-Xobjekt] [fil ...]

BESKRIVNING

dh_installdocs är ett debhelper-program som ansvarar för att installera dokumentation i usr/share/doc/paket i paketens byggkataloger.

I kompatibilitetsnivå 10 och tidigare kan dh_install(1) vara ett bättre verktyg för att hantera uppströmsdokumentation, när uppströmsprojektets eget byggsystem installerar all önskad dokumentation korrekt. I detta fall är dh_installdocs fortfarande användbart för att installera dokumentation som hör till paketeringen, till exempel filen debian/copyright.

Från debhelpers kompatibilitetsnivå 11 och framåt kommer dh_install att falla tillbaka till att leta i debian/tmp efter filer om det inte hittar dem i den aktuella katalogen, eller på den plats där du har sagt åt det att leta med --sourcedir.

I kompatibilitetsnivå 11 och senare erbjuder dh_installdocs många av de funktioner som dh_install(1) också har. Dessutom stöder dh_installdocs även byggprofilen nodoc för att utesluta dokumentation, oavsett kompatibilitetsnivå.

FILER

debian/paket.docs

Lista över dokumentationsfiler som ska installeras i paket.

Stöder substitutionsvariabler i kompatibilitetsnivå 13 och senare enligt dokumentationen i debhelper(7).

debian/copyright

Copyright-filen installeras i alla paket, såvida inte en mer specifik copyright-fil finns tillgänglig.

debian/paket.copyright

debian/paket.README.Debian

debian/paket.TODO

Var och en av dessa filer installeras automatiskt om den finns för ett paket.

debian/README.Debian

debian/TODO

Dessa filer installeras i det första binärpaketet som listas i debian/control.

Observera att README.debian-filer också installeras som README.Debian, och att TODO-filer installeras som TODO.Debian i icke-inhemska paket.

debian/paket.doc-base

Installeras som doc-base-kontrollfiler. Observera att doc-id bestäms från posten Document: i den aktuella doc-base-kontrollfilen. Om flera doc-base-filer i ett enda källpaket delar samma doc-id installeras de i usr/share/doc-base/package i stället för usr/share/doc-base/doc-id.

debian/paket.doc-base.*

Om ditt paket behöver registrera mer än ett dokument behöver du flera doc-base-filer, och du kan namnge dem på detta sätt. Om flera doc-base-filer av denna typ i ett enda källpaket delar samma doc-id installeras de i usr/share/doc-base/package-* i stället för usr/share/doc-base/doc-id.

Var medveten om att denna deduplicering för närvarande endast görs i minnet. Därför kräver den tills vidare att dh_installdocs anropas högst en gång under paketbygget. Att anropa dh_installdocs -ppaket i kombination med användning av filer av typen debian/package.doc-base.* kan leda till paket som inte går att installera. Se [1](https://bugs.debian.org/980903) för detaljer.

FLAGGOR

-A, --all

Installera alla filer som anges som kommandoradsparametrar i ALLA paket som bearbetas.

-Xobjekt, --exclude=objekt

Uteslut filer som innehåller objekt någonstans i filnamnet från att installeras. Observera att detta även omfattar doc-base-filer.

--sourcedir=katalog

Leta i den angivna katalogen efter filer som ska installeras. Denna flagga kräver kompatibilitetsnivå 11 eller senare. Den ignoreras tyst i kompatibilitetsnivå 10 eller tidigare.

Observera att detta inte är samma sak som flaggan --sourcedirectory som används av kommandona dh_auto_*. Du behöver sällan använda denna flagga, eftersom dh_installman automatiskt letar efter filer i debian/tmp i debhelpers kompatibilitetsnivå 11 och senare.

--doc-main-package=huvudpaket

Sätt huvudpaketet för ett dokumentationspaket. Detta används för att installera dokumentationen för dokumentationspaketet i /usr/share/doc/huvudpaket, enligt rekommendationen i Debians policymanual 3.9.7 i §12.3.

I kompatibilitetsnivå 11 eller senare är denna flagga endast användbar om debhelpers automatiska identifiering av huvudpaketet är fel. Flaggan kan också användas för att tysta en varning från debhelper när den automatiska identifieringen misslyckas men standardvärdet råkar vara korrekt.

Denna flagga kan inte användas när dh_installdocs instrueras att arbeta på flera paket. Om du behöver denna flagga måste du i allmänhet kombinera den med -p för att säkerställa att exakt ett paket bearbetas.

Fältet X-Doc-Main-Package kan användas i stället sedan debhelper/13.28. Det har liknande semantik men kräver inte kommandoradsflaggor.

Kom ihåg att viss dokumentation, exempelvis copyright-filen, README.Debian och liknande, inte påverkas av denna flagga eller av fältet X-Doc-Main-Package.

--link-doc=paket

Gör dokumentationskatalogen för alla paket som bearbetas till en symbolisk länk till dokumentationskatalogen för paket. Detta har ingen effekt när programmet arbetar på paket självt, eller om dokumentationskatalogen som ska skapas redan finns när dh_installdocs körs. För att följa policyn måste paket vara ett binärpaket som kommer från samma källpaket.

debhelper försöker undvika att installera filer i länkade dokumentationskataloger som skulle orsaka konflikter med det länkade paketet. Flaggan -A har ingen effekt på paket med länkade dokumentationskataloger, och filer som copyright, changelog, README.Debian och TODO installeras inte.

En äldre metod för att uppnå samma sak, som fortfarande stöds, är att göra dokumentationskatalogen för ett paket till en bruten symbolisk länk innan dh_installdocs anropas.

Observera att denna flagga endast gäller dokumentationskatalogen för själva paketet. När paketet levererar dokumentation för ett annat paket, se till exempel --doc-main-package, använder det inte en symbolisk länk för dokumentationen till det andra paketet.

VARNING 1: Om en tidigare version av paketet byggdes utan denna flagga och nu byggs med den, eller tvärtom, krävs en migrering från katalog till symbolisk länk, eller från symbolisk länk till katalog. Eftersom debhelper inte har någon kunskap om tidigare versioner måste du själv aktivera denna migrering.

Detta kan göras genom att tillhandahålla en fil med namnet "debian/paket.maintscript" och använda dh_installdeb(1) för att tillhandahålla de relevanta kodsnuttarna för paketskript.

VARNING 2: Användning av --link-doc bör endast göras när paketen har samma typ av "architecture". En länk från ett arkitekturoberoende paket till ett arkitekturberoende paket, eller tvärtom, fungerar inte. Sedan kompatibilitetsnivå 10 avvisar debhelper aktivt kombinationer som inte stöds.

fil ...

Installera dessa filer som dokumentation i det första paketet som bearbetas, eller i alla paket om -A anges.

EXEMPEL

Detta är ett exempel på en fil av typen debian/package.docs:

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

ANMÄRKNINGAR

Observera att dh_installdocs utan problem kopierar hela kataloghierarkier om du ber det göra det, ungefär som cp -a. Om det instrueras att installera en katalog installerar det hela innehållet i katalogen.

SE ÄVEN

debhelper(7)

Detta program är en del av debhelper.

FÖRFATTARE

Joey Hess [joeyh@debian.org](mailto:joeyh@debian.org)

KOLOFON

Denna sida är en del av projektet debhelper, hjälpprogram för debian/rules. Information om projektet kan hittas på [okänd -- om du känner till den, kontakta [man-pages@man7.org](mailto:man-pages@man7.org)].

Om du har en felrapport för denna manualsida, skicka den till:

[submit@bugs.debian.org](mailto:submit@bugs.debian.org)

Denna sida hämtades från projektets uppströms Git-arkiv:

[2](https://salsa.debian.org/debian/debhelper.git)

Om du upptäcker renderingsproblem i denna HTML-version av sidan, eller tror att det finns en bättre eller mer uppdaterad källa för sidan, eller har rättelser eller förbättringar till informationen i denna COLOPHON, som inte är en del av den ursprungliga manualsidan, skicka e-post till:

[man-pages@man7.org](mailto:man-pages@man7.org)

Sidor som hänvisar till denna sida

• dh_assistant(1)
• debhelper(7)

HTML-rendering

HTML-renderingen skapades 2026-01-16 av Michael Kerrisk, författare till The Linux Programming Interface.

För information om fördjupade utbildningar i Linux/UNIX-systemprogrammering, se:

[3](https://man7.org/training/)

Webbhotellet tillhandahålls av jambit GmbH.