Le manuel de programmation de dpkg - chapitre 7
Description des paquets - le champ Description

Le champ Description du fichier de contrôle est utilisé par dselect quand l'utilisateur est en train de sélectionner les paquets à installer et par dpkg quand il affiche les informations sur les statuts des paquets et ainsi de suite. Il est inclus sur les sites FTP dans les fichiers Packages, et peut être aussi utilisé sur les pages Web Debian.

La description permet de décrire le programme à l'utilisateur qui n'en avait jamais entendu parler auparavant, afin de savoir s'il veut l'installer. Elle doit donner des informations sur les conflits et dépendances significatives entre ce paquet et les autres, afin que l'utilisateur sache pourquoi ces conflits et dépendances ont été déclarés.

Le champ a le format suivant:

    Description: Une seule ligne de résumé
     description étendue sur plusieurs lignes
Le résumé est souvent affiché dans les listes de paquets et autres, et doit être aussi instructif que possible. Chaque paquet doit aussi avoir une description détaillée (étendue).


7.1 Types de lignes formatées dans la description étendue


7.2 Remarques sur l'écriture des descriptions

Commencer toujours les lignes de description étendue par au moins un espace. Les champs dans les fichiers de contrôle et les fichiers Packages sont séparés par des noms de champ qui commencent sur la première colonne, comme le sont les champs d'en-tête de message dans la RFC 822. Oublier les espaces provoquera de la part de dpkg-deb [21] une erreur de syntaxe quand il essayera de construire le paquet. Si tu forces la construction, dpkg refusera d'installer le désordre.

Ne pas inclure de lignes complètement vides. Elles servent à séparer les différents enregistrements dans le fichiers Packages et différents paquets dans le fichier debian/control et sont interdites dans les fichiers de contrôle de paquets. Voir le paragraphe précédent pour connaître les effets sur dpkg.

La ligne de résumé doit être brève, moins de 80 caractères. dselect affiche entre 25 et 49 caractères sans déborder, si tu utilises un terminal de 80 colonnes, dépendant des options d'affichage.

Ne pas inclure le nom du paquet dans la ligne de résumé. Le logiciel sait déjà l'afficher, et ce n'est pas nécessaire de s'en occuper. Ne pas oublier que dans beaucoup de cas, l'utilisateur ne regarde seulement que la ligne de résumé, il faut donc la rendre aussi instructive que possible.

La description étendue doit décrire ce que fait le paquet, et comment il est relié au reste du système (en termes, par exemple, de sous-système, de partie de ...).

Le commentaire, qui est fourni avec un programme dans ses fichiers d'annonces et/ou README, est rarement approprié pour une utilisation dans une description. Il est habituellement conçu pour les gens qui connaissent déjà le paquet. Le champ de description doit être compris par n'importe qui, même pour les gens qui n'ont aucune idée sur ce que fait le paquet.

Mettre les informations importantes d'abord, dans le résumé et dans la description étendue. Quelques fois, seulement, la première partie du résumé ou de la description sera affichée. On peut supposer qu'il y a d'habitude une manière de voir l'ensemble de la description étendue.

Tu dois inclure les informations sur les dépendances et autres, dans la description étendue, si tu le souhaites.

Ne pas utiliser le caractère de tabulation, son effet est imprévisible.

Ne pas essayer de couper la ligne du résumé (la partie sur la même ligne que le champ description) dans la description étendue. Cela ne fonctionnera pas correctement quand la description complète sera affichée et n'aura aucun sens aux endroits où seul le résumé est disponible.


7.3 Exemple de description dans le fichier de contrôle de Smail

Package: smail
Version: 3.1.29.1-13
Maintener: Ian Jackson <iwj10@cus.cam.ac.uk>
Recommends: pine | mailx | elm | emacs | mail-user-agent
Suggests: metamail
Depends: cron, libc5
Conflicts: sendmail
Provides: mail-transport-agent
Description: Electronic mail transport system.
 Smail is the recommended mail transport agent (MTA) for Debian.
 .
 An MTA is the innards of the mail system - it takes messages from
 user-friendly mail programs and arranges for them to be delivred
 locally or passed on to other systems as required.
 .
 In ordre to make use of it you must have one or more user level
 mailreader programs such as elm, pine, mailx, or Emacs (which has Rmail
 and VM as mailreaders) installed. If you wish to send messages other
 than just to other users of your system you must also have appropriate
 networking support, in the form of IP or UUCP.

Le manuel de programmation de dpkg - Copyright ©1996 Ian Jackson Copyright ©1997 David Curé et Christian Jacolot pour la version française.
Table des matières; résumé; suivant; précédent.
15 octobre 1998
D. Cure cure@cnam.fr
C. Jacolot jacolot@ubolib.univ-brest.fr