RÉSUMÉ

 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

DESCRIPTION

install-docs 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 dhelp, dwww, doc-central, et scrollkeeper.

Cette page de manuel fournit un court résumé de l'utilisation d'install-docs. 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.

OPTIONS

-v, --verbose

Fonctionnement bavard

-d, --debug

Afficher certaines informations de débogage.

--no-update-menus

Interdire le lancement de dwww-build-menu(8), dhelp_parse(8), et scrollkeeper-update(8).

--rootdir répertoire

Définir le répertoire racine à répertoire au lieu de « / ». Utile et valable uniquement avec l'action --check.

ACTIONS

Vous trouverez ci-dessous la liste des actions possibles que peut prendre en charge install-docs. 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.

Chaque paramètre fichier 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 id_doc 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).

Si fichier ou id_doc est égal à « - » (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).

-i fichier [fichier ...], --install fichier [fichier ...]

Installer la documentation décrite par le fichier de contrôle fichier.

-r fichier [fichier ...], --remove fichier [fichier ...]

Supprimer la documentation identifiée par le fichier de contrôle fichier.

-c fichier [fichier ...], --check fichier [fichier ...]

Vérifier le fichier de contrôle fichier et afficher le nombre de problèmes potentiels trouvés. Utilisé avec --verbose, il permet de trouver la position réelle des erreurs et des avertissements. Si --rootdir est aussi indiqué, son paramètre sera ajouté en tête des noms de fichiers indiqués dans les champs « Files » et « Index » de fichier.

-R, --remove-all

Désenregistrer tous les documents enregistrés.

-I, --install-all

Réenregistrer tous les documents de /usr/share/doc-base et /etc/doc-base/documents.

-C, --install-changed

Comparer le contenu des répertoires /usr/share/doc-base et /etc/doc-base/documents 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.

-s id_doc [id_doc ...], --status id_doc [id_doc ...]

Afficher l'état de l'identifiant de document id_doc.

-L id_doc [id_doc ...], --listfiles id_doc [id_doc ...]

Option obsolète. N'effectue rien.

--dump-db nom_base_de_données

Vider le contenu des bases de données internes pour des besoins de débogage. nom_base_de_données peut être soit files.db ou status.db.

-h, --help

Afficher un court message d'aide.

-V, --version

Afficher les informations de version.

PROBLÈMES DE COMPATIBILITÉ

Les fonctions suivantes ont été ajoutées dans la version 0.8.4, veuillez vous assurer d'avoir ajouté les lignes « Conflicts » ou « Depends » si vous voulez les utiliser dans les scripts de vos paquets :

• prise en compte du passage de plus d'un seul paramètre aux actions -i et -r,
• lecture des paramètres depuis l'entrée standard.
• actions -I, --install-all, -R, ---remove-all, -c, --check,
• option -d, --debug, -h, --help.

Les options -C, --install-changed, --dump-db, -V, --version ont été ajoutées dans la version 0.8.12.

FICHIERS

/usr/share/doc-base/

Emplacement des fichiers de contrôle de documentation fournis par différents paquets.

/etc/doc-base/documents/

Emplacement des fichiers de contrôle de documentation fournis par l'administrateur local.

/var/lib/doc-base/info/documents/

Emplacement des fichiers de contrôle enregistrés.

/var/lib/doc-base/info/status.db

État des documents enregistrés.

/var/lib/doc-base/info/files.db

Horodatage et identifiants des documents des fichiers de documentation enregistrés.

/var/lib/doc-base/omf/

Emplacement des fichiers OMF créés par scrollkeeper. Note : /usr/share/omf/doc-base doit être un lien symbolique pointant vers le répertoire.

AUTEUR

Ce programme a été initialement écrit par Christian Schwarz <[email protected]>, pour le système Debian GNU/Linux, il a ensuite été maintenu par Adam Di Carlo <[email protected]>. Il est actuellement maintenu et développé par Robert Luberda <[email protected]>.

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 <[email protected]>.