344 lines
11 KiB
HTML
344 lines
11 KiB
HTML
|
||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
||
<HTML><HEAD><TITLE>Man page of DH_INSTALLDOCS</TITLE>
|
||
</HEAD><BODY>
|
||
<H1>DH_INSTALLDOCS</H1>
|
||
Section: Debhelper (1)<BR>Updated: 2020-03-27<BR><A HREF="#index">Index</A>
|
||
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<A NAME="lbAB"> </A>
|
||
<H2>NOM</H2>
|
||
|
||
|
||
|
||
dh_installdocs - Installer la documentation dans le répertoire de
|
||
construction du paquet
|
||
<A NAME="lbAC"> </A>
|
||
<H2>SYNOPSIS</H2>
|
||
|
||
|
||
|
||
<B>dh_installdocs</B> [<I>options_de_debhelper</I>] [<B>-A</B>] [<B>-X</B><I>élément</I>]
|
||
[<I>fichier</I> ...]
|
||
<A NAME="lbAD"> </A>
|
||
<H2>DESCRIPTION</H2>
|
||
|
||
|
||
|
||
<B>dh_installdocs</B> est le programme de la suite debhelper chargé de
|
||
l'installation de la documentation dans le répertoire
|
||
<I>usr/share/doc/paquet</I> du répertoire de construction du paquet.
|
||
<P>
|
||
|
||
Dans les niveaux de compatibilité 10 et inférieurs, <B><A HREF="/cgi-bin/man/man2html?1+dh_install">dh_install</A></B>(1) est
|
||
mieux adapté à la gestion de la documentation si le système de construction
|
||
amont installe la documentation voulue correctement. Dans ce cas,
|
||
<B>dh_installdocs</B> est toujours utile pour installer la documentation de
|
||
l'empaquetage (par exemple le fichier <I>debian/copyright</I>).
|
||
<P>
|
||
|
||
Depuis la version 11 de debhelper, <B>dh_install</B> cherchera dans
|
||
l'arborescence <I>debian/tmp</I> pour trouver les fichiers s'il ne les trouve
|
||
pas dans le répertoire courant (ou dans celui indiqué par l'utilisation de
|
||
<B>--sourcedir</B>).
|
||
<P>
|
||
|
||
Dans les niveaux de compatibilité 11 et au delà, <B>dh_installdocs</B> offre la
|
||
plupart des fonctionnalités de <B><A HREF="/cgi-bin/man/man2html?1+dh_install">dh_install</A></B>(1). De plus, <B>dh_installdocs</B>
|
||
prend aussi en charge le profil de construction <B>nodoc</B> pour exclure la
|
||
documentation (quel que soit le niveau de compatibilité).
|
||
<A NAME="lbAE"> </A>
|
||
<H2>FICHIERS</H2>
|
||
|
||
|
||
|
||
<DL COMPACT>
|
||
<DT id="1">debian/<I>paquet</I>.docs<DD>
|
||
|
||
|
||
Liste les fichiers de documentation à installer dans <I>paquet</I>.
|
||
|
||
|
||
<P>
|
||
|
||
|
||
Supports substitution variables in compat 13 and later as documented in
|
||
<B><A HREF="/cgi-bin/man/man2html?7+debhelper">debhelper</A></B>(7).
|
||
<DT id="2"><I>debian/copyright</I><DD>
|
||
|
||
|
||
Le fichier de copyright est installé dans tous les paquets sauf si un
|
||
fichier de copyright plus spécifique est disponible.
|
||
<DT id="3">debian/<I>paquet</I>.copyright<DD>
|
||
|
||
|
||
|
||
<DT id="4">debian/<I>paquet</I>.README.Debian<DD>
|
||
|
||
|
||
<DT id="5">debian/<I>paquet</I>.TODO<DD>
|
||
|
||
|
||
|
||
Chacun de ces fichiers est automatiquement installé s'il existe pour un
|
||
<I>paquet</I>.
|
||
<DT id="6"><I>debian/README.Debian</I><DD>
|
||
|
||
|
||
|
||
<DT id="7"><I>debian/TODO</I><DD>
|
||
|
||
|
||
|
||
Ces fichiers sont installés dans le premier paquet binaire listé dans
|
||
<I>debian/control</I>.
|
||
|
||
|
||
<P>
|
||
|
||
|
||
Nota : les fichiers <I></I><FONT SIZE="-1"><I>README</I></FONT><I>.debian</I> sont également installés en tant que
|
||
<I></I><FONT SIZE="-1"><I>README</I></FONT><I>.Debian</I> et les fichiers <I></I><FONT SIZE="-1"><I>TODO</I></FONT><I></I> seront installés en tant que
|
||
<I></I><FONT SIZE="-1"><I>TODO</I></FONT><I>.Debian</I> dans les paquets non natifs.
|
||
<DT id="8">debian/<I>paquet</I>.doc-base<DD>
|
||
|
||
|
||
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 <B>Document:</B> 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/<I>paquet</I> au lieu de usr/share/doc-base/<I>doc-id</I>.
|
||
<DT id="9">debian/<I>paquet</I>.doc-base.*<DD>
|
||
|
||
|
||
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/<I>paquet-*</I> au lieu de usr/share/doc-base/<I>doc-id</I>.
|
||
</DL>
|
||
<A NAME="lbAF"> </A>
|
||
<H2>OPTIONS</H2>
|
||
|
||
|
||
|
||
<DL COMPACT>
|
||
<DT id="10"><B>-A</B>, <B>--all</B><DD>
|
||
|
||
|
||
Installe l'ensemble des fichiers indiqués sur la ligne de commande dans
|
||
<B>tous</B> les paquets construits.
|
||
<DT id="11"><B>-X</B><I>élément</I>, <B>--exclude=</B><I>élément</I><DD>
|
||
|
||
|
||
Exclut les fichiers qui comportent <I>élément</I>, n'importe où dans leur nom,
|
||
de l'installation. Il est à noter que cela inclut les fichiers doc-base.
|
||
<DT id="12"><B>--sourcedir=</B><I>répertoire</I><DD>
|
||
|
||
|
||
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).
|
||
|
||
|
||
<P>
|
||
|
||
|
||
Nota : cette option ne fait pas la même chose que <B>--sourcedirectory</B>
|
||
utilisée par <B>dh_auto_</B><I>*</I>. Il est rare d'avoir besoin d'utiliser cette
|
||
option puisque <B>dh_installman</B> cherche automatiquement les fichiers dans
|
||
<I>debian/tmp</I> depuis le niveau de compatibilité 11 de debhelper.
|
||
<DT id="13"><B>--doc-main-package=</B><I>paquet-principal</I><DD>
|
||
|
||
|
||
Définit le paquet principal pour un paquet de documentation. Cela est
|
||
utilisé pour installer la documentation du paquet de documentation dans <I>/usr/share/doc/paquet-principal</I> comme recommandé par la Charte
|
||
Debian 3.9.7 au paragraphe 12.3.
|
||
|
||
|
||
<P>
|
||
|
||
|
||
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.
|
||
|
||
|
||
<P>
|
||
|
||
|
||
Cette option ne peut pas être utilisée lorsque <B>dh_installdocs</B> doit agir
|
||
sur plusieurs paquets. Si vous avez besoin de cette option, vous devrez
|
||
généralement l'associer à <B>-p</B> pour vous assurer de n'agir que sur un
|
||
paquet.
|
||
|
||
|
||
<P>
|
||
|
||
|
||
Veuillez garder à l'esprit que certains documents (les fichiers copyright,
|
||
<FONT SIZE="-1">README</FONT>.Debian, etc.) ne seront pas affectés par cette option.
|
||
<DT id="14"><B>--link-doc=</B><I>paquet</I><DD>
|
||
|
||
|
||
Transforme le répertoire de documentation de chacun des paquets traités en
|
||
lien symbolique vers le répertoire de documentation de <I>paquet</I>. Cette
|
||
option est sans effet pour la construction du <I>paquet</I> lui-même ou si le
|
||
répertoire de documentation à créer existe déjà lorsque <B>dh_installdocs</B>
|
||
est lancé. Pour être conforme à la charte, <I>paquet</I> doit être un paquet
|
||
binaire provenant du même paquet source.
|
||
|
||
|
||
<P>
|
||
|
||
|
||
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</B> n'aura aucun effet sur les paquets avec des répertoires
|
||
de documentation liés et les fichiers <I>copyright</I>, <I>changelog</I>,
|
||
<I></I><FONT SIZE="-1"><I>README</I></FONT><I>.Debian</I> et <I></I><FONT SIZE="-1"><I>TODO</I></FONT><I></I> ne seront pas installés.
|
||
|
||
|
||
<P>
|
||
|
||
|
||
(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 à <B>dh_installdocs</B>.)
|
||
|
||
|
||
<P>
|
||
|
||
|
||
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 <B>--doc-main-package</B>), il
|
||
n'utilisera pas de lien symbolique pour la documentation de l'autre paquet.
|
||
|
||
|
||
<P>
|
||
|
||
|
||
<B></B><FONT SIZE="-1"><B>AVERTISSEMENT 1</B></FONT><B></B> : 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.
|
||
|
||
|
||
<P>
|
||
|
||
|
||
Cela peut être effectué en fournissant un fichier
|
||
« debian/<I>paquet</I>.maintscript » et en utilisant <B><A HREF="/cgi-bin/man/man2html?1+dh_installdeb">dh_installdeb</A></B>(1) pour
|
||
fournir les extraits des scripts de maintenance correspondants.
|
||
|
||
|
||
<P>
|
||
|
||
|
||
<B></B><FONT SIZE="-1"><B>AVERTISSEMENT 2</B></FONT><B></B> : <B>--link-doc</B> 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.
|
||
<DT id="15"><I>fichier</I> ...<DD>
|
||
|
||
|
||
Installe les fichiers indiqués en tant que documentation du premier paquet
|
||
traité (ou de tous les paquets traités si <B>-A</B> est indiqué).
|
||
</DL>
|
||
<A NAME="lbAG"> </A>
|
||
<H2>EXEMPLES</H2>
|
||
|
||
|
||
|
||
Voici un exemple de fichier <I>debian/paquet.docs</I> :
|
||
<P>
|
||
|
||
|
||
|
||
<PRE>
|
||
README
|
||
TODO
|
||
debian/notes-for-maintainers.txt
|
||
docs/manual.txt
|
||
docs/manual.pdf
|
||
docs/manual-html/
|
||
|
||
</PRE>
|
||
|
||
|
||
<A NAME="lbAH"> </A>
|
||
<H2>REMARQUES</H2>
|
||
|
||
|
||
|
||
Nota : Heureusement, <B>dh_installdocs</B> sait copier des hiérarchies entières
|
||
de répertoire (comme un <B>cp -a</B>). Si on lui demande d'installer un
|
||
répertoire, il installera le contenu complet du répertoire.
|
||
<A NAME="lbAI"> </A>
|
||
<H2>VOIR AUSSI</H2>
|
||
|
||
|
||
|
||
<B><A HREF="/cgi-bin/man/man2html?7+debhelper">debhelper</A></B>(7)
|
||
<P>
|
||
|
||
Ce programme fait partie de debhelper.
|
||
<A NAME="lbAJ"> </A>
|
||
<H2>AUTEUR</H2>
|
||
|
||
|
||
|
||
Joey Hess <<A HREF="mailto:joeyh@debian.org">joeyh@debian.org</A>>
|
||
<A NAME="lbAK"> </A>
|
||
<H2>TRADUCTION</H2>
|
||
|
||
|
||
|
||
Cette traduction est maintenue à l'aide de l'outil po4a
|
||
<URL:<A HREF="http://po4a.alioth.debian.org/">http://po4a.alioth.debian.org/</A>> par l'équipe francophone de traduction
|
||
de Debian.
|
||
<P>
|
||
|
||
Veuillez signaler toute erreur de traduction en écrivant à
|
||
<<A HREF="mailto:debian-l10n-french@lists.debian.org">debian-l10n-french@lists.debian.org</A>> ou par un rapport de bogue sur le paquet
|
||
debhelper.
|
||
<P>
|
||
|
||
Vous pouvez toujours avoir accès à la version anglaise de ce document en
|
||
utilisant la commande « man -L C <section> <page_de_man> ».
|
||
<P>
|
||
|
||
<HR>
|
||
<A NAME="index"> </A><H2>Index</H2>
|
||
<DL>
|
||
<DT id="16"><A HREF="#lbAB">NOM</A><DD>
|
||
<DT id="17"><A HREF="#lbAC">SYNOPSIS</A><DD>
|
||
<DT id="18"><A HREF="#lbAD">DESCRIPTION</A><DD>
|
||
<DT id="19"><A HREF="#lbAE">FICHIERS</A><DD>
|
||
<DT id="20"><A HREF="#lbAF">OPTIONS</A><DD>
|
||
<DT id="21"><A HREF="#lbAG">EXEMPLES</A><DD>
|
||
<DT id="22"><A HREF="#lbAH">REMARQUES</A><DD>
|
||
<DT id="23"><A HREF="#lbAI">VOIR AUSSI</A><DD>
|
||
<DT id="24"><A HREF="#lbAJ">AUTEUR</A><DD>
|
||
<DT id="25"><A HREF="#lbAK">TRADUCTION</A><DD>
|
||
</DL>
|
||
<HR>
|
||
This document was created by
|
||
<A HREF="/cgi-bin/man/man2html">man2html</A>,
|
||
using the manual pages.<BR>
|
||
Time: 00:05:01 GMT, March 31, 2021
|
||
</BODY>
|
||
</HTML>
|