man-pages/fr/man8/install-docs.8.html
2021-03-31 01:06:50 +01:00

268 lines
8.8 KiB
HTML
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of INSTALL-DOCS</TITLE>
</HEAD><BODY>
<H1>INSTALL-DOCS</H1>
Section: Debian (8)<BR>Updated: 06 August 2019<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NOM</H2>
install-docs - gestion de la documentation en ligne de Debian
<A NAME="lbAC">&nbsp;</A>
<H2>RÉSUMÉ</H2>
<PRE>
install-docs [options] -i, --install | -r, --remove | -c, --check fichier [ fichier... ]
install-docs [options] -I, --install-all | -C, --install-changed | -R, --remove-all
install-docs [options] -s, --status id_doc [id_doc ... ]
install-docs [options] --dump-db nom-base-données
install-docs -h, --help | -V,--version
</PRE>
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
<B>install-docs</B> est un outil qui permet aux responsables de paquets Debian
d'enregistrer de la documentation dans divers systèmes de documentation. Il
prend actuellement en charge les navigateurs <B>dhelp</B>, <B>dwww</B>,
<B>doc-central</B>, et <B>scrollkeeper</B>.
<P>
Cette page de manuel fournit un court résumé de l'utilisation
d'<B>install-docs</B>. Une documentation complète se trouve dans la
documentation, elle comprend une description de la syntaxe et de la
grammaire du fichier de contrôle.
<A NAME="lbAE">&nbsp;</A>
<H2>OPTIONS</H2>
<DL COMPACT>
<DT id="1"><B>-v</B>, <B>--verbose</B><DD>
Fonctionnement bavard
<DT id="2"><B>-d</B>, <B>--debug</B><DD>
Afficher certaines informations de débogage.
<DT id="3"><B>--no-update-menus</B><DD>
Interdire le lancement de <B><A HREF="/cgi-bin/man/man2html?8+dwww-build-menu">dwww-build-menu</A></B>(8), <B><A HREF="/cgi-bin/man/man2html?8+dhelp_parse">dhelp_parse</A></B>(8), et
<B><A HREF="/cgi-bin/man/man2html?8+scrollkeeper-update">scrollkeeper-update</A></B>(8).
<DT id="4"><B>--rootdir</B> <I>répertoire</I><DD>
Définir le répertoire racine à <I>répertoire</I> au lieu de « <I>/</I> ». Utile et
valable uniquement avec l'action <B>--check</B>.
</DL>
<A NAME="lbAF">&nbsp;</A>
<H2>ACTIONS</H2>
Vous trouverez ci-dessous la liste des actions possibles que peut prendre en
charge <B>install-docs</B>. Il ne peut y avoir qu'une seule option d'action
passée à install-docs. De plus, l'action, avec ses paramètres, doit être la
dernière option passée.
<P>
Chaque paramètre <I>fichier</I> doit être le chemin complet vers le fichier de
contrôle de doc-base (par ex. « /usr/share/doc-base/some_file » ou
« /etc/doc-base/documents/un_fichier »), et chaque <I>id_doc</I> doit être
l'identifiant du document (les identifiants de document sont définis dans le
champ « Document » du fichier de contrôle, ils correspondent habituellement
au nom du paquet).
<P>
Si <I>fichier</I> ou <I>id_doc</I> est égal à « <B>-</B> » (le signe moins), la liste
des paramètres sera lue depuis l'entrée standard (chaque nom de fichier ou
chaque identifiant de document se trouvant sur une ligne séparée).
<DL COMPACT>
<DT id="5"><B>-i</B> <I>fichier</I> [<I>fichier</I> ...], <B>--install</B> <I>fichier</I> [<I>fichier</I> ...]<DD>
Installer la documentation décrite par le fichier de contrôle <I>fichier</I>.
<DT id="6"><B>-r</B> <I>fichier</I> [<I>fichier</I> ...], <B>--remove</B> <I>fichier</I> [<I>fichier</I> ...]<DD>
Supprimer la documentation identifiée par le fichier de contrôle <I>fichier</I>.
<DT id="7"><B>-c</B> <I>fichier</I> [<I>fichier</I> ...], <B>--check</B> <I>fichier</I> [<I>fichier</I> ...]<DD>
Vérifier le fichier de contrôle <I>fichier</I> et afficher le nombre de
problèmes potentiels trouvés. Utilisé avec <I>--verbose</I>, il permet de
trouver la position réelle des erreurs et des avertissements. Si
<I>--rootdir</I> est aussi indiqué, son paramètre sera ajouté en tête des noms
de fichiers indiqués dans les champs « Files » et « Index » de <I>fichier</I>.
<DT id="8"><B>-R</B>, <B>--remove-all</B><DD>
Désenregistrer tous les documents enregistrés.
<DT id="9"><B>-I</B>, <B>--install-all</B><DD>
Réenregistrer tous les documents de <I>/usr/share/doc-base</I> et
<I>/etc/doc-base/documents</I>.
<DT id="10"><B>-C</B>, <B>--install-changed</B><DD>
Comparer le contenu des répertoires <I>/usr/share/doc-base</I> et
<I>/etc/doc-base/documents</I> avec la base de données des documents enregistrés
et désenregistrer tous les fichiers manquants et n'enregistrer ou ne
réenregistrer que les fichiers nouveaux ou ayant été modifiés.
<DT id="11"><B>-s</B> <I>id_doc</I> [<I>id_doc</I> ...], <B>--status</B> <I>id_doc</I> [<I>id_doc</I> ...]<DD>
Afficher l'état de l'identifiant de document <I>id_doc</I>.
<DT id="12"><B>-L</B> <I>id_doc</I> [<I>id_doc</I> ...], <B>--listfiles</B> <I>id_doc</I> [<I>id_doc</I> ...]<DD>
Option obsolète. N'effectue rien.
<DT id="13"><B>--dump-db</B> <I>nom_base_de_données</I><DD>
Vider le contenu des bases de données internes pour des besoins de
débogage. <I>nom_base_de_données</I> peut être soit <B>files.db</B> ou <B>status.db</B>.
<DT id="14"><B>-h</B>, <B>--help</B><DD>
Afficher un court message d'aide.
<DT id="15"><B>-V</B>, <B>--version</B><DD>
Afficher les informations de version.
</DL>
<A NAME="lbAG">&nbsp;</A>
<H2>PROBLÈMES DE COMPATIBILITÉ</H2>
Les fonctions suivantes ont été ajoutées dans la version 0.8.4, veuillez
vous assurer d'avoir ajouté les lignes « <I>Conflicts</I> » ou « <I>Depends</I> » si
vous voulez les utiliser dans les scripts de vos paquets :
<DL COMPACT>
<DT id="16">&bull;<DD>
prise en compte du passage de plus d'un seul paramètre aux actions <B>-i</B> et
<B>-r</B>,
<DT id="17">&bull;<DD>
lecture des paramètres depuis l'entrée standard.
<DT id="18">&bull;<DD>
actions <B>-I</B>, <B>--install-all</B>, <B>-R</B>, <B>---remove-all</B>, <B>-c</B>, <B>--check</B>,
<DT id="19">&bull;<DD>
option <B>-d</B>, <B>--debug</B>, <B>-h</B>, <B>--help</B>.
</DL>
<P>
Les options <B>-C</B>, <B>--install-changed</B>, <B>--dump-db</B>, <B>-V</B>, <B>--version</B>
ont été ajoutées dans la version 0.8.12.
<A NAME="lbAH">&nbsp;</A>
<H2>FICHIERS</H2>
<DL COMPACT>
<DT id="20"><I>/usr/share/doc-base/</I><DD>
Emplacement des fichiers de contrôle de documentation fournis par différents
paquets.
<DT id="21"><I>/etc/doc-base/documents/</I><DD>
Emplacement des fichiers de contrôle de documentation fournis par
l'administrateur local.
<DT id="22"><I>/var/lib/doc-base/info/documents/</I><DD>
Emplacement des fichiers de contrôle enregistrés.
<DT id="23"><I>/var/lib/doc-base/info/status.db</I><DD>
État des documents enregistrés.
<DT id="24"><I>/var/lib/doc-base/info/files.db</I><DD>
Horodatage et identifiants des documents des fichiers de documentation
enregistrés.
<DT id="25"><I>/var/lib/doc-base/omf/</I><DD>
Emplacement des fichiers <FONT SIZE="-1">OMF</FONT> créés par scrollkeeper. Note :
<I>/usr/share/omf/doc-base</I> doit être un lien symbolique pointant vers le
répertoire.
</DL>
<A NAME="lbAI">&nbsp;</A>
<H2>BOGUES</H2>
Voir &lt;<A HREF="http://bugs.debian.org/doc-base">http://bugs.debian.org/doc-base</A>&gt;.
<A NAME="lbAJ">&nbsp;</A>
<H2>VOIR AUSSI</H2>
<B><A HREF="/cgi-bin/man/man2html?1+dhelp">dhelp</A></B>(1), <B><A HREF="/cgi-bin/man/man2html?1+doccentral">doccentral</A></B>(1), <B><A HREF="/cgi-bin/man/man2html?7+dwww">dwww</A></B>(7), <B><A HREF="/cgi-bin/man/man2html?7+scrollkeeper">scrollkeeper</A></B>(7), Debian doc-base Manual
<I>/usr/share/doc/doc-base/doc-base.html/index.html</I>
<A NAME="lbAK">&nbsp;</A>
<H2>AUTEUR</H2>
Ce programme a été initialement écrit par Christian Schwarz
&lt;<A HREF="mailto:schwarz@debian.org">schwarz@debian.org</A>&gt;, pour le système Debian GNU/Linux, il a ensuite été
maintenu par Adam Di Carlo &lt;<A HREF="mailto:aph@debian.org">aph@debian.org</A>&gt;. Il est actuellement maintenu et
développé par Robert Luberda &lt;<A HREF="mailto:robert@debian.org">robert@debian.org</A>&gt;.
<P>
Ce logiciel a été développé au profit de la communauté toute entière des
utilisateurs et développeurs de Debian. Si vous désirez être tenu au courant
des évolutions de ce logiciel, veuillez nous rejoindre sur la liste de
diffusion &lt;<A HREF="mailto:debian-doc@lists.debian.org">debian-doc@lists.debian.org</A>&gt;.
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="26"><A HREF="#lbAB">NOM</A><DD>
<DT id="27"><A HREF="#lbAC">RÉSUMÉ</A><DD>
<DT id="28"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="29"><A HREF="#lbAE">OPTIONS</A><DD>
<DT id="30"><A HREF="#lbAF">ACTIONS</A><DD>
<DT id="31"><A HREF="#lbAG">PROBLÈMES DE COMPATIBILITÉ</A><DD>
<DT id="32"><A HREF="#lbAH">FICHIERS</A><DD>
<DT id="33"><A HREF="#lbAI">BOGUES</A><DD>
<DT id="34"><A HREF="#lbAJ">VOIR AUSSI</A><DD>
<DT id="35"><A HREF="#lbAK">AUTEUR</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:03 GMT, March 31, 2021
</BODY>
</HTML>