DH_INSTALLDOCS(1) Debhelper DH_INSTALLDOCS(1)
NOM
dh_installdocs - Installer la documentation dans le répertoire de
construction du paquet
SYNOPSIS
dh_installdocs [options_de_debhelper] [-A] [-Xélément] [fichier ...]
DESCRIPTION
dh_installdocs est le programme de la suite debhelper chargé de
l'installation de la documentation dans le répertoire
usr/share/doc/paquet du répertoire de construction du paquet.
Dans les niveaux de compatibilité 10 et inférieurs, dh_install(1) est
mieux adapté à la gestion de la documentation si le système de
construction amont installe la documentation voulue correctement. Dans
ce cas, dh_installdocs est toujours utile pour installer la
documentation de l'empaquetage (par exemple le fichier
debian/copyright).
Depuis la version 11 de debhelper, dh_install cherchera dans
l'arborescence debian/tmp pour trouver les fichiers s'il ne les trouve
pas dans le répertoire courant (ou dans celui indiqué par l'utilisation
de --sourcedir).
Dans les niveaux de compatibilité 11 et au delà, dh_installdocs offre
la plupart des fonctionnalités de dh_install(1). De plus,
dh_installdocs prend aussi en charge le profil de construction nodoc
pour exclure la documentation (quel que soit le niveau de
compatibilité).
FICHIERS
debian/paquet.docs
Liste les fichiers de documentation à installer dans paquet.
Les variables de substitution sont prises en charge dans les
niveaux de compatibilité 13 et ultérieurs comme documenté dans
debhelper(7).
debian/copyright
Le fichier de copyright est installé dans tous les paquets sauf si
un fichier de copyright plus spécifique est disponible.
debian/paquet.copyright
debian/paquet.README.Debian
debian/paquet.TODO
Chacun de ces fichiers est automatiquement installé s'il existe
pour un paquet.
debian/README.Debian
debian/TODO
Ces fichiers sont installés dans le premier paquet binaire listé
dans debian/control.
Nota : les fichiers README.debian sont également installés en tant
que README.Debian et les fichiers TODO seront installés en tant que
TODO.Debian dans les paquets non natifs.
debian/paquet.doc-base
Installés en tant que fichiers de contrôle doc-base. Remarque :
l'identifiant de documentation (doc-id) sera défini d'après
l'indication du champ Document: du fichier de contrôle doc-base en
question. Au cas où plusieurs fichiers doc-base d'un seul paquet
source partagent le même identifiant de documentation, ils seront
installés dans usr/share/doc-base/paquet au lieu de
usr/share/doc-base/doc-id.
debian/paquet.doc-base.*
Si le paquet doit enregistrer plus d'un document, plusieurs
fichiers doc-base sont nécessaires, et peuvent être nommés comme
cela. Au cas où plusieurs fichiers doc-base de ce genre dans un
seul paquet source partagent le même identifiant de documentation,
ils seront installés dans usr/share/doc-base/paquet-* au lieu de
usr/share/doc-base/doc-id.
Soyez conscient que cette déduplication est uniquement réalisée en
mémoire actuellement, ce qui fait que pour l'instant il ne faut pas
que dh_installdocs soit appelé plus d'une fois pendant la
construction du paquet. L'appel de dh_installdocs -ppaquet en
combinaison avec l'utilisation de debian/paquet.doc-base.* peut
mener à des paquets non installables. Voir
<https://bugs.debian.org/980903> pour plus de détails.
OPTIONS
-A, --all
Installe l'ensemble des fichiers indiqués sur la ligne de commande
dans tous les paquets construits.
-Xélément, --exclude=élément
Exclut les fichiers qui comportent élément, n'importe où dans leur
nom, de l'installation. Il est à noter que cela inclut les fichiers
doc-base.
--sourcedir=répertoire
Cherche dans le répertoire indiqué les fichiers à installer. Cette
option nécessite le niveau de compatibilité 11 ou supérieur (et
sera silencieusement ignorée en version 10 et avant).
Nota : cette option ne fait pas la même chose que --sourcedirectory
utilisée par dh_auto_*. Il est rare d'avoir besoin d'utiliser cette
option puisque dh_installman cherche automatiquement les fichiers
dans debian/tmp depuis le niveau de compatibilité 11 de debhelper.
--doc-main-package=paquet-principal
Définit le paquet principal pour un paquet de documentation. Cela
est utilisé pour installer la documentation du paquet de
documentation dans /usr/share/doc/paquet-principal comme recommandé
par la Charte Debian 3.9.7 au paragraphe 12.3.
Dans les niveaux de compatibilité 11 ou suivants, cette option
n'est utile que si l'auto-détection du paquet principal de
debhelper est erronée. Cette option peut aussi être utilisée pour
masquer un avertissement de debhelper lorsque l'auto-détection
échoue mais que le comportement par défaut est correct.
Cette option ne peut pas être utilisée lorsque dh_installdocs doit
agir sur plusieurs paquets. Si vous avez besoin de cette option,
vous devrez généralement l'associer à -p pour vous assurer de
n'agir que sur un paquet.
Veuillez garder à l'esprit que certains documents (les fichiers
copyright, README.Debian, etc.) ne seront pas affectés par cette
option.
--link-doc=paquet
Transforme le répertoire de documentation de chacun des paquets
traités en lien symbolique vers le répertoire de documentation de
paquet. Cette option est sans effet pour la construction du paquet
lui-même ou si le répertoire de documentation à créer existe déjà
lorsque dh_installdocs est lancé. Pour être conforme à la charte,
paquet doit être un paquet binaire provenant du même paquet source.
debhelper essayera d'éviter l'installation de fichiers, dans les
répertoires de la documentation liée, qui causerait des conflits
avec le paquet lié. L'option -A n'aura aucun effet sur les paquets
avec des répertoires de documentation liés et les fichiers
copyright, changelog, README.Debian et TODO ne seront pas
installés.
(Une autre méthode, pour réaliser la même chose, qui reste toujours
possible, est de faire du répertoire de documentation un lien
symbolique « en l'air » avant l'appel à dh_installdocs.)
Veuillez noter que cette option ne s'applique qu'au répertoire de
documentation du paquet lui-même. Lorsque le paquet fournit de la
documentation pour un autre (voir par exemple --doc-main-package),
il n'utilisera pas de lien symbolique pour la documentation de
l'autre paquet.
AVERTISSEMENT 1 : si une version précédente du paquet était
construite sans cette option et qu'elle est maintenant construite
avec (ou vice-versa), une migration est nécessaire, « répertoire
vers lien symbolique » (« dir to symlink ») ou « lien symbolique
vers répertoire » (« symlink to dir »). Puisque debhelper n'a
aucune connaissance des versions précédentes, vous devez activer
cette migration vous-même.
Cela peut être effectué en fournissant un fichier
« debian/paquet.maintscript » et en utilisant dh_installdeb(1) pour
fournir les extraits des scripts de maintenance correspondants.
AVERTISSEMENT 2 : --link-doc ne doit être utilisé que lorsque les
paquets ont la même « architecture ». Un lien depuis un paquet
indépendant de l'architecture vers un paquet dépendant de
l'architecture (ou vice-versa) ne fonctionnera pas. Depuis la
version 10, debhelper rejette activement les combinaisons non
prises en charge.
fichier ...
Installe les fichiers indiqués en tant que documentation du premier
paquet traité (ou de tous les paquets traités si -A est indiqué).
EXEMPLES
Voici un exemple de fichier debian/paquet.docs :
README
TODO
debian/notes-for-maintainers.txt
docs/manual.txt
docs/manual.pdf
docs/manual-html/
REMARQUES
Nota : Heureusement, dh_installdocs sait copier des hiérarchies
entières de répertoire (comme un cp -a). Si on lui demande d'installer
un répertoire, il installera le contenu complet du répertoire.
VOIR AUSSI
debhelper(7)
Ce programme fait partie de debhelper.
AUTEUR
Joey Hess <joeyh@debian.org>
TRADUCTION
Cette traduction est maintenue à l'aide de l'outil po4a
<URL:http://po4a.alioth.debian.org/> par l'équipe francophone de
traduction de Debian.
Veuillez signaler toute erreur de traduction en écrivant à
<debian-l10n-french@lists.debian.org> ou par un rapport de bogue sur le
paquet debhelper.
Vous pouvez toujours avoir accès à la version anglaise de ce document
en utilisant la commande « man -L C <section> <page_de_man> ».
13.11.4 2023-01-02 DH_INSTALLDOCS(1)
Generated by dwww version 1.15 on Sat Jun 29 01:42:15 CEST 2024.