Linux Certif

Toute la documentation sur la certification Linux LPI

dh_installdocs

NOM

dh_installdocs - installe la documentation dans le repertoire de construction du paquet

SYNOPSIS

dh_installdocs [options de debhelper] [-A] [-n] [-Xelement] [fichier ...]

DESCRIPTION

dh_installdocs est le programme de la suite debhelper charge de l'installation de la documentation dans le repertoire usr/share/doc/paquet du repertoire de construction du paquet.

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

Tous les fichiers indiques en parametres de la ligne de commande seront installes dans le premier paquet traite par dh_installdirs. Par defaut, il s'agit du premier paquet indique dans le fichier debian/control, mais, si les options -p, -i ou -a sont utilisees, il s'agira du premier paquet indique par ces options.

De la meme facon, s'ils existent, les fichiers debian/README.Debian (ou debian/README.debian) et debian/TODO seront installes dans le premier paquet binaire indique 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 installe sous le nom TODO.Debian. Pour des raisons de coherence, le fichier README.debian est installe sous le nom de README.Debian. Enfin, des fichiers debian/paquet.README.Debian et debian/paquet.TODO peuvent etre utilises pour fournir des fichiers TODO et README aux sous-paquets.

Des fichiers nommes debian/paquet.docs peuvent etre employes pour enumerer d'autres fichiers de documentation a installer.

Les fichiers nommes debian/paquet.doc-base, seront installes en tant que fichiers de controle doc-base et feront produire a dh_installdocs les lignes de code des scripts de maintenance postinst et prerm necessaires a l'interfacage avec le paquet doc-base. Nota : L'identificateur de documentation (doc-id) sera fixe d'apres l'indication du champ X Document: X du fichier de controle doc-base en question.

Si le paquet necessite l'inscription d'un ou de plusieurs documents, il faudra utiliser plusieurs fichiers. Pour obtenir ce resultat, il est possible d'utiliser des fichiers nommes debian/paquet.doc-base.*

OPTIONS

-A, --all

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

-n, --noscripts

Empeche la modification des scripts de maintenance postinst et prerm.

-Xelement, --exclude=element

Exclut les fichiers qui comportent X element X, n'importe ou dans leur nom, de l'installation. Il est a noter que cela inclut les fichiers doc-base.

fichier ...

Installe les fichiers indiques en tant que documentation du premier paquet traite (ou de tous les paquets traites si -A est indique).

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 hierarchies entieres de repertoire (comme un cp -a). Si on lui demande d'installer un repertoire, il installera le contenu complet du repertoire.

Note that this command is not idempotent. dh_prep(1) should be called between invocations of this command. Otherwise, it may cause multiple instances of the same text to be added to maintainer scripts.

VOIR AUSSI

debhelper(7)

Ce programme fait partie de debhelper.

AUTEUR

Joey Hess <joeyh@debian.org>

TRADUCTION

Valery Perrin <valery.perrin.debian@free.fr> le 17 septembre 2005. Derniere mise a jour le 19 novembre 2006.

L'equipe de traduction a fait le maximum pour realiser une adaptation francaise de qualite

La version anglaise la plus a jour de ce document est toujours consultable via la commande  man -L en nom_du_man .

N'hesitez pas a signaler a l'auteur ou au traducteur, selon le cas, toute erreur dans cette page de manuel.