[ précédent ] [ Table des matières ] [ 1 ] [ 2 ] [ 3 ] [ 4 ] [ 5 ] [ 6 ] [ 7 ] [ 8 ] [ 9 ] [ 10 ] [ suivant ]

Guide du nouveau responsable Debian
Chapitre 5 - Autres fichiers dans le répertoire debian/


Vous verrez qu'il y a plusieurs autres fichiers dans le sous-répertoire debian, la plupart d'entre eux avec le suffixe « .ex  », ce qui signifie qu'ils sont des exemples. Jetez un coup d'oeil à chacun d'entre eux. Si vous souhaitez ou devez utiliser une de ces options :

Certains de ces fichiers, les plus utilisés, sont décrits dans les sections suivantes.


5.1 README.Debian

Tous les détails ou différences entre le paquet original et votre version debianisée devraient être documentés ici.

dh_make en crée un par défaut, voici ce à quoi il ressemble :

       gentoo for Debian
       -----------------
     
       <possible notes regarding this package - if none, delete this file>
     
        -- Josip Rodin <joy-mg@debian.org>, Wed, 11 Nov 1998 21:02:14 +0100

Puisque nous n'avons rien en particulier à mettre ici, nous effaçons le fichier.


5.2 conffiles.ex

L'une des choses les plus irritantes à propos des logiciels est de consacrer beaucoup de temps et d'efforts pour configurer un programme, et de voir une seule mise à jour détruire tous vos changements. Debian résout ce problème en marquant les fichiers de configuration de sorte que quand vous mettez à jour un paquet, il vous sera demandé si vous voulez gardez votre vieille configuration ou pas.

La façon de procéder pour un paquet est d'entrer le chemin complet de chaque fichier de configuration (en général sous /etc), un par ligne dans un fichier nommé conffiles. Gentoo a un fichier de configuration, /etc/gentoorc, et nous le mettons dans conffiles.

Si votre programme utilise des fichiers de configuration, mais les réécrit aussi de son côté, il vaut mieux ne pas les marquer comme conffiles, parce que dpkg va alors interroger les utilisateurs pour vérifier les modifications tout le temps.

Si le programme que vous paquetez requiert que chaque utilisateur modifie le fichier de configuration pour fonctionner tout court, envisagez de ne pas le marquer non plus comme conffile.

Vous pouvez gérer des fichiers d'exemple de configuration à partir des « scripts du responsable ». Lisez postinst.ex, preinst.ex, postrm.ex, prerm.ex, Section 5.12 pour plus d'information.

Si votre programme n'a pas de conffiles, vous pouvez tranquillement effacer le fichier conffiles du répertoire debian.


5.3 cron.d.ex

Si votre paquet requiert des tâches programmées régulièrement pour fonctionner correctement, vous pouvez utiliser ce fichier pour le configurer.

Notez que ceci n'inclut pas la rotation des journaux; pour cela, voyez dh_installlogrotate(1) et logrotate(8).

Sinon, supprimez-le.


5.4 dirs

Ce fichier spécifie les répertoires dont nous avons besoin mais que la procédure d'installation normale (make install) ne crée pas.

Par défaut, il ressemble à ceci :

       usr/bin
       usr/sbin

Remarquez que le préfixe slash n'est pas inclus. Nous devrions normalement le changer comme ceci :

       usr/bin
       usr/man/man1

mais ces répertoires sont déjà créés dans Makefile, donc nous n'avons pas besoin de ce fichier, et allons plutôt l'effacer.


5.5 docs

Ce fichier spécifie les noms des fichiers de documentation que dh_installdocs peut installer pour nous dans le répertoire temporaire.

Par défaut, il inclut tous les fichiers, existant dans le répertoire racine des sources, qui sont nommés « BUGS », « README* », « TODO », etc.

Pour gentoo, j'ai aussi inclus d'autres choses :

       BUGS
       CONFIG-CHANGES
       CREDITS
       ONEWS
       README
       README.gtkrc
       TODO

Nous pouvons aussi retirer ce fichier et à la place lister ces fichiers directement dans la ligne de commande dh_installdocs dans le fichier rules, comme ceci :

           dh_installdocs BUGS CONFIG-CHANGES CREDITS ONEWS README \
                            README.gtkrc TODO

Aussi incroyable que cela puisse être, vous pouvez ne pas avoir de tels fichiers dans les sources de votre paquet. Dans ce cas, vous pouvez tranquillement effacer ce fichier. Mais ne retirez l'appel dh_installdocs du fichier rules parce qu'il est utilisé pour installer le fichier copyright et d'autres choses.


5.6 emacsen-*.ex

Si votre paquet fournit des fichiers Emacs qui peuvent être byte-compilés au moment de l'installation, vous pouvez utiliser ces fichiers pour les configurer.

Ils sont installés dans le répertoire temporaire par dh_installemacsen(1), donc n'oubliez pas de décommenter cette ligne dans le fichier rules si vous l'utilisez.

Si vous n'en avez pas besoin, effacez-les.


5.7 init.d.ex

Si votre paquet est un démon qui doit être lancé au démarrage du système, vous avez de toute évidence ignoré mes recommandations initiales, n'est-ce-pas ? :-)

Ceci est un squelette de fichier générique pour un fichier script /etc/init.d/, donc vous aurez à l'éditer, beaucoup. Il est installé dans le répertoire temporaire par dh_installinit(1).

Si vous n'en avez pas besoin, effacez-le.


5.8 manpage.1.ex, manpage.sgml.ex

Votre programme devrait avoir une page de manuel. S'il n'en a pas, chacun de ces fichiers est un squelette que vous pouvez remplir.

Les pages de manuel sont normalement écrites en nroff(1). L'exemple manpage.1.ex est aussi écrit en nroff. Lisez la page de manuel man(7) pour une description brève de la façon d'éditer ce genre de fichier.

D'un autre côté, si vous préférez écrire du SGML à la place de nroff, vous pouvez utiliser le patron manpage.sgml.ex. Si vous le faites, vous devez :

Et souvenez-vous de renommer le fichier en quelque chose comme gentoo.sgml !

Le nom du fichier de la page de manuel finale devrait inclure le nom du programme qu'elle documente, donc nous le renommons de « manpage » en « gentoo ». Le nom du fichier inclut aussi « .1 » comme premier suffixe, ce qui signifie que c'est une page de manuel pour une commande utilisateur. Assurez-vous de vérifier que cette section est bien la bonne. Voici une courte liste des sections de pages de manuel :

       Section |     Description      |     Notes
          1     Commandes utilisateur   Commandes ou scripts exécutables.
          2     Appel système           Fonctions fournies par le noyau.
          3     Appel bibliothèque      Fonctions des bibliothèques système.
          4     Fichiers spéciaux       D'ordinaire trouvés dans /dev.
          5     Formats de fichiers     Par ex. le format /etc/password.
          6     Jeux                    Ou d'autres programmes frivoles.
          7     Paquets de macros       Comme les macros de man.
          8     Administration système  Des programmes d'habitude exécutés par root.
          9     Routines noyau          Appels non standards et routines internes.

Donc, la page de manuel de gentoo devrait être appelée gentoo.1, ou gentoo.1x parce que c'est un programme X11. Il n'y avait pas de page de manuel gentoo.1 dans les sources originales, donc j'en ai écrit un à partir de l'exemple et de la documentation amont.


5.9 menu.ex

Les utilisateurs de X Window ont un gestionnaire de fenêtres avec un menu qui peut être configuré. S'ils ont installé le paquet menu de Debian, un ensemble de menu pour chaque programme sur le système sera créé pour eux.

Voici le fichier menu.ex créé par défaut par dh_make :

       ?package(gentoo):needs=X11|text|vc|wm section=Apps/see-menu-manual\
         title="gentoo" command="/usr/bin/gentoo"

Le premier champ après le caractère deux-points est « needs », et il indique le genre d'interface dont a besoin le programme. Changez ceci en une des alternatives listées, par exemple « text » ou « X11 ».

Le suivant est « section », avec le menu et le sous-menu dans lesquels l'entrée devrait apparaître. La liste courante des sections est dans : /usr/share/doc/debian-policy/menu-policy.html/ch2.html#s2.1.

le champ « title » est le nom du programme. Vous pouvez le commencer par une majuscule si vous le souhaitez. Mais gardez-le court.

Enfin, le champ « command » est la commande qui lance le programme.

Maintenant nous changeons l'entrée menu en ceci :

       ?package(gentoo): needs=X11 section=Apps/Tools title="Gentoo" command="gentoo"

Vous pouvez aussi ajouter d'autres champs comme « longtitle  », « icon », « hint », etc. Voir menufile(5), update-menus(1) et /usr/share/doc/debian-policy/menu-policy.html/ pour plus d'information.


5.10 watch.ex

Ce fichier est utilisé pour configurer les programmes uscan(1) et de uupdate(1) (dans le paquet devscripts). Ils sont utilisés pour surveiller le site sur lequel vous avez obtenu les sources.

Voici ce que j'y ai mis :

       # watch control file for uscan
       # Site                  Directory       Pattern                Version Script
       ftp.obsession.se        /gentoo         gentoo-(.*)\.tar\.gz   debian  uupdate

Astuce : connectez-vous à Internet, et essayez d'exécuter « uscan » dans le répertoire du programme une fois que vous avez créé ce fichier. Et lisez les manuels. :-)


5.11 ex.package.doc-base

Si votre paquet a de la documentation autre que des pages de manuel et des documents info, vous devriez utiliser le fichier doc-base pour l'enregistrer, de sorte que l'utilisateur puisse le trouver avec par exemple dhelp(1), dwww(1) ou doccentral(1).

Cela inclut normalement les fichiers HTML, PS et PDF, délivrés dans /usr/share/doc/nom_du_paquet/.

Voici ce à quoi le fichier doc-base de gentoo ressemble :

       Document: gentoo
       Title: Gentoo Manual
       Author: Emil Brink
       Abstract: This manual describes what Gentoo is, and how it can be used.
       Section: Apps/Tools
     
       Format: HTML
       Index: /usr/share/doc/gentoo/html/index.html
       Files: /usr/share/doc/gentoo/html/*.html

Pour plus d'information sur le format de ce fichier, voir install-docs(8) et le manuel de doc-base, dans /usr/doc/doc-base/doc-base.html/index.html.


5.12 postinst.ex, preinst.ex, postrm.ex, prerm.ex

Ces fichiers sont nommés scripts de responsable. Ce sont des scripts placés dans la zone de contrôle du paquet et sont exécutés par dpkg lorsque votre paquet est installé, mis à jour ou supprimé.

Pour l'instant, vous devriez éviter les scripts de responsable si vous le pouvez parce qu'ils ont tendance à être complexes. Pour plus d'information regardez dans le chapitre 6 du manuel des Normes, et examinez les fichiers d'exemples fournis par dh_make.


[ précédent ] [ Table des matières ] [ 1 ] [ 2 ] [ 3 ] [ 4 ] [ 5 ] [ 6 ] [ 7 ] [ 8 ] [ 9 ] [ 10 ] [ suivant ]

Guide du nouveau responsable Debian

version 1.2, 6 avril 2002.

Josip Rodin joy-mg@debian.org
Traducteur : Frédéric Dumont frederic.dumont@easynet.be