Vous devez conna�tre avec pr�cision le m�canisme d'acc�s aux pages de manuel afin de savoir donner un nom correct � vos documents, et d'�tre capable de les installer au bon endroit. Chaque page de manuel appartient � une section sp�cifique, d�not�e par un simple chiffre. Les sections les plus courantes rencontr�es sous Linux sont :
/dev ;/etc/passwd ;Quelquefois, une lettre est ajout�e au num�ro de section comme
par exemple "xterm.1x" ou "wish.1tk". Le but
de cette notation est d'indiquer qu'il s'agit respectivement
d'une documentation d'un programme X Window ou d'une
application Tk. Certains programmes d'affichage du manuel
peuvent exploiter cette particularit� ; xman, par
exemple affichera "xterm(x)" et "wish(tk)"
dans la liste des documents disponibles.
S'il vous pla�t, n'utilisez pas les sections n, o et l : selon le standard du syst�me de fichiers (File System Standard), ces sections sont d�conseill�es, utilisez plut�t les sections num�riques.
Attention aux �ventuels conflits de noms avec des programmes, fonctions ou fichiers d�j� existants. Ce serait certainement une mauvaise id�e d'�crire un autre �diteur de texte et de le nommer ed, sed (pour super ed) ou red (pour Roger edition). En vous assurant que le nom de votre programme est unique, vous �viterez que quelqu'un ex�cute votre programme et qu'il lise la page de manuel d'un autre ou vice verca. Vous pouvez �ventuellement vous aider de la base de donn�es "lsm" qui recense beaucoup de programmes disponibles pour Linux.
Maintenant que nous savons quel nom donner � notre fichier, la
prochaine d�cision est de choisir le r�pertoire dans lequel nous
l'installerons (quand l'utilisateur lancera la commande "make
install"). Sous Linux, toutes les pages de manuel sont dans des
sous-r�pertoires � partir d'une racine m�moris�e dans la variable
d'environnement MANPATH. Les outils de traitement de la
documentation l'utilisent de la m�me mani�re que le shell utilise
la variable PATH pour trouver les ex�cutables. En fait, MANPATH a
le m�me format que PATH : toutes les deux sont une liste de
r�pertoires s�par�s par des ":" (mais MANPATH n'autorise pas de
champs vides ou des chemins relatifs, seulement des chemins
absolus). Si MANPATH n'existe pas ou si elle n'est pas export�e,
/usr/man est utilis�e comme valeur par d�faut. Dans le but
d'acc�lerer la recherche et pour garder les r�pertoires de taille
raisonable, les r�pertoires point�s dans MANPATH (aussi appel�s
r�pertoires de base) contiennent une multitude de sous-r�pertoires
nomm�s "man<s>" o� <s> d�signe le caract�re
correspondant � la section pr�sent� plus haut. Toutes les sections
ne sont pas repr�sent�es, il n'y a pas, par exemple de raison de
garder une entr�e "mano". Vous pourrez y trouver �galement
des sous-r�pertoires appel�s "cat<s>",
"dvi<s>" et "ps<s>", qui contiennent
toute la documentation format�e, pr�te � �tre affich�e ou
imprim�e : nous reviendrons sur ce sujet plus loin. Le
seul fichier � �tre pr�sent � c�t� de ces sous-r�pertoires du
r�pertoire de base s'appelle "whatis". Le but et la
cr�ation de ce fichier sera d�crit dans la section 11. La
m�thode la plus s�re pour installer au bon endroit une page de
manuel de la section "s" est de mettre le fichier dans le r�pertoire
"/usr/man/man<s>". Toutefois, un bon
Makefile devra autoriser l'utilisateur de choisir un autre
r�pertoire de base, disons par exemple par le biais d'une variable
d'environnement que l'on pourrait nommer MANDIR. La plupart des
distributions GNU peuvent �tre configur�es � l'aide de l'option
--prefix=/nom/option. Les pages de manuels correspondantes
seront alors install�es � partir du r�pertoire de base
/mon/option/man. Je vous sugg�re d'utiliser une m�thode
similaire pour vos r�alisations personnelles.
Depuis l'av�nement du "Syst�me de fichiers standard" pour Linux (FS-STnd), les choses se sont compliqu�es. Le FS-STnd 1.2 stipule que :
des am�nagements doivent �tre faits dans la structure de /usr/man pour supporter des pages de manuel �crites dans diff�rentes (ou mutiples) langues.
Ceci est fait en introduisant un niveau de r�pertoires suppl�mentaire qui distingue les diff�rentes langues. Citant encore le FS-Stnd 1.2 :
Le nommage des sous-r�pertoires correspondants aux langues de /usr/man est bas� sur l'appendice E du standard POSIX 1003.1 qui d�crit la cha�ne de caract�res d'authentification locale (qui est la m�thode la mieux accept�e pour d�crire un environement culturel). La cha�ne locale se pr�sente sous la forme(Reportez vous au FS-Stnd pour voir quelques cha�nes localecourantes.) D'apr�s ces recommandations, nous avons nos pages de manuel dans /usr/man/<locale>/man[1-9lno]. Les versions format�es se trouveraient alors bien entendu dans /usr/man/<locale>/cat[1-9lno] : nous pourrions ne les fournir que pour une seule langue.<langage>[_<pays>][.<jeu-de-caracteres>][,<version>]
TOUTEFOIS, je (l'auteur du document, pas le traducteur) ne peut pas recommander de passer a cette structure en l'�tat actuel des choses. Le FS-Stnd 1.2 autorise aussi que
les syst�mes qui n'utilisent qu'une seule langue et jeu de caract�res pour toutes les pages de manuel peuvent omettre la sous-cha�ne <locale> et stocker toutes ces pages dans le r�pertoire mandir. Par exemple, les machines �quip�es seulement de pages de manuel en anglais cod�es en ASCII peuvent mettre les pages de manuel (les r�pertoires man[1-9]) directement dans /usr/man/. Il s'agit en fait de l'arrangement habituel.
Je (l'auteur du document, pas le traducteur) ne changerai pas
ma configuration tant que tous les outils (comme
xman, info, tkman et beaucoup
d'autres) ne seront pas tous adapt�s � cette nouvelle
structure.
Hosting by: Hurra Communications GmbH
Generated: 2007-01-26 18:01:31