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.
FICHIERS¶
- debian/paquet.docs
- Liste les fichiers de documentation à installer dans
paquet.
- 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. Nota : L'identifiant de documentation (doc-id) sera
fixé d'après l'indication du champ Document: du fichier
de contrôle doc-base en question.
- debian/paquet.doc-base.*
- Si le paquet nécessite l'inscription de plus d'un
document, il faudra utiliser plusieurs fichiers doc-base et les nommer de
cette façon.
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.
- --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 B <-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.)
- 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.
Nota : Ce programme n'est pas idempotent. Un
dh_prep(1) doit
être réalisé entre chaque exécution de ce programme.
Sinon, il risque d'y avoir plusieurs occurrences des mêmes lignes de code
dans les scripts de maintenance du paquet.
VOIR AUSSI¶
debhelper(7)
Ce programme fait partie de debhelper.
AUTEUR¶
Joey Hess <joeyh@debian.org>
TRADUCTION¶
Valéry Perrin <valery.perrin.debian@free.fr> le 17 septembre 2005.
Dernière mise à jour le 3 avril 2011.
L'équipe de traduction a fait le maximum pour réaliser une adaptation
française de qualité.
Cette traduction est gérée dynamiquement par po4a. Certains
paragraphes peuvent, éventuellement, apparaître en anglais. Ils
correspondent à des modifications ou des ajouts récents du
mainteneur, non encore incorporés dans la traduction française.
La version originale anglaise de ce document est toujours consultable via la
commande man -L en nom_du_man.
N'hésitez pas à signaler à l'auteur ou au traducteur, selon le
cas, toute erreur dans cette page de manuel.