dh_installdocs - installe la documentation dans le répertoire de construction du paquet

dh_installdocs [options de debhelper] [-A] [-n] [-Xélément] [fichier ...]

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.

dh_installdocs installe automatiquement, s'il existe, le fichier debian/copyright. Si dh_installdocs traite plusieurs paquets, debian/copyright sera installé dans chacun des paquets. Toutefois, s'il est nécessaire d'avoir des licences distinctes pour chaque paquet, il est possible d'utiliser des fichiers nommés debian/paquet.copyright.

Tous les fichiers indiqués en paramètres de la ligne de commande seront installés dans le premier paquet traité par dh_installdirs. Par défaut, il s'agit du premier paquet indiqué dans le fichier debian/control, mais, si les options -p, -i ou -a sont utilisées, il s'agira du premier paquet indiqué par ces options.

De la même façon, s'ils existent, les fichiers debian/README.Debian (ou debian/README.debian) et debian/TODO seront installés dans le premier paquet binaire indiqué dans le fichier debian/control, si dh_installdocs traite ce paquet. Nota : Si le paquet n'est pas natif Debian, le fichier debian/TODO sera installé sous le nom TODO.Debian. Pour des raisons de cohérence, le fichier README.debian est installé sous le nom de README.Debian. Enfin, des fichiers debian/paquet/README.Debian et debian/paquet.TODO peuvent être utilisés pour fournir des fichiers TODO et README aux sous-paquets.

Des fichiers nommés debian/paquet.docs peuvent être employés pour énumérer d'autres fichiers de documentation à installer.

Les fichiers nommés debian/paquet.doc-base, seront installés en tant que fichiers de contrôle doc-base et feront produire à dh_installdocs les lignes de code des scripts de maintenance postinst et prerm nécessaires à l'interfaçage avec le paquet doc-base. Nota : L'identificateur de documentation (doc-id) sera fixé d'après l'indication du champ « Document: » du fichier de contrôle doc-base en question.

Si le paquet nécessite l'inscription d'un ou de plusieurs documents, il faudra utiliser plusieurs fichiers. Pour obtenir ce résultat, il est possible d'utiliser des fichiers nommés debian/paquet.doc-base.*

-A, --all

Installe l'ensemble des fichiers indiqués sur la ligne de commande dans TOUS les paquets construits.

-n, --noscripts

Empêche la modification des scripts de maintenance postinst et prerm.

-Xélément, --exclude=élément

Exclut du traitement les fichiers qui comportent « élément » n'importe où dans leur nom.

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

Voici un exemple de fichier debian/paquet.docs :

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

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_clean -k » doit être réalisé entre chaque exécution de ce programme. Sinon, cela pourrait causer l'ajout de plusieurs occurrences des mêmes lignes de code dans les scripts de maintenance du paquet.

debhelper(7)

Ce programme fait partie de debhelper.

Joey Hess <joeyh@debian.org>

Valéry Perrin <valery.perrin.debian@free.fr> le 17 septembre 2005. Dernière mise à jour le 10 novembre 2005.

L'équipe de traduction a fait le maximum pour réaliser une adaptation française de qualité.

La version anglaise la plus à jour 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.