next up previous contents Next: /usr/share/misc: données diverses indépendantes Up: /usr/share/man: Pages du manuel. Previous: Objectifs.   Table des matières  

Options spécifiques.

Les répertoires suivants, ou les liens symboliques vers ces répertoires, doivent se trouver dans /usr/share/<mandir>/<locale>, sauf s'ils sont vides: Par exemple, si /usr/local/man n'a pas de pages de manuel dans la section 4 (Périphériques), alors /usr/local/man/man4 peut être omis.

/<mandir>/<locale> ----- arborescence des pages de manuel
  \_ man1 programmes d'utilisateur (optionnel)
  \_ man2 appels système (optionnel)
  \_ man3 appels bibliothèque (optionnel)
  \_ man4 fichiers spéciaux (optionnel)
  \_ man5 formats de fichiers (optionnel)
  \_ man6 jeux (optionnel)
  \_ man7 divers (optionnel)
  \_ man8 administration système (optionnel)


La composante <section> décrit la section du manuel.

Des dispositions doivent être prises concernant la structure de /usr/share/man de manière à supporter les pages de manuel qui sont écrites dans différentes (ou de multiples) langues. Ces dispositions doivent prendre en considération le stockage et les références à ces pages de manuel. Les facteurs pertinents comprennent la langue (y compris les différences de nature géographique) et le jeu de code de caractères.

La dénomination des sous-répertoires de langues de /usr/share/man est basée sur l'appendice E de la norme POSIX 1003.1 qui décrit les chaînes d'identification locales; il s'agit de la méthode la plus largement acceptée pour décrire un environnement culturel linguistique. La chaîne <string> est:

<langue>[_<pays>] [.<jeu_de_caractère>] [,<version>]


Le champ <langue> doit être extrait de la norme ISO 639 (un code de représentation des noms de langues). Il doit être constitué de deux caractères et de lettres minuscules, exclusivement.

Le champ <pays> doit être constitué de deux lettres du code ISO 3166 (un code désignant les pays), si possible. (La plupart des personnes connaissent les codes à deux lettres désignant les pays dans les adresses de courriel). Le Royaume-Uni constitue une exception importante à cette règle, puisqu'on trouve GB dans ISO 3166 et UK dans la plupart des adresses de messages électroniques. Ce champ doit comprendre deux caractères et des lettres majuscules, exclusivement.

Le champ <jeu_de_caractère> doit être conforme à la norme décrivant le jeu de caractères. Si le champ <jeu_de_caractère> n'est constitué que de chiffres, le nombre qu'ils forment appartient au code international décrivant le jeu de caractères. Il est recommandé d'utiliser une représentation numérique autant que faire se peut (normes ISO, en particulier), sans inclure de symboles de ponctuation ni de lettres minuscules.

Un paramètre indiquant la <version> peut être placé après le champ <jeu_de_caractère>, le délimiteur étant une virgule. Ceci peut être employé pour faire une distinction linguistique; par exemple, dans le cas de dictionnaires. Cette norme recommande de ne pas utiliser le champ <version>, sauf si cela est réellement nécessaire.

Les systèmes qui utilisent une seule langue et un seul code pour toutes les pages du manuel peuvent ne pas avoir de sous-chaîne <locale> et stocker toutes les pages de manuel dans <mandir>. Ainsi, les systèmes qui ont seulement des pages de manuel en anglais, codées en ASCII peuvent stocker ces pages (répertoires man<section>) directement dans /usr/share/man. En fait, il s'agit là du cas et de l'arragnement classiques.

Dans les pays pour lesquels existe un code de caractères standard accepté, les systèmes peuvent ne pas utiliser le champ <jeu_de_caractère>, mais il est fortement recommandé de l'inclure, notamment dans le cas des pays avec plusieurs standards.

Divers exemples sont donné le tableau des langues.

Langue Pays Jeu de caractères Répertoire
anglais - ASCII /usr/share/man/en
anglais Royaume Uni ASCII /usr/share/man/en_GB
anglais Etats-Unis ASCII /usr/share/man/en_US
français Canada ISO 8859-1 /usr/share/man/fr_CA
français France ISO 8859-1 /usr/share/man/fr_FR
allemand Allemagne ISO 646 /usr/share/man/de_DE.646
allemand Allemagne ISO 6937 /usr/share/man/de_DE.6937
allemand Allemagne ISO 8859-1 /usr/share/man/de_DE.88591
allemand Suisse ISO 646 /usr/share/man/de_CH.646
japonais Japon JIS /usr/share/man/ja_JP.jis
japonais Japon SJIS /usr/share/man/ja_JP.sjis
japoanis Japon UJIS (ou EUC-J) /usr/share/man/ja_JP.ujis


De manière analogue, des dispositions doivent être prises pour les pages de manuel dépendantes de l'architecture, telle que la documentation à propos des pilotes de périphériques ou les commandes d'administration système de bas niveau. Elles doivent être placées sous le répertoire <arch> dans le répertoire approprié de man<section>; par exemple, une page de man pour la commande ctrlaltdel(8) sur i386 pourrait être placée dans /usr/share/man/<locale>/man8/i386/ctrlaltdel(8).

Les pages de manuel pour les commandes et données sous /usr/local sont stockées dans /usr/local/man. Les pages de manuel pour X11R6 sont conservées dans /usr/X11R6/man. Il s'en suit que tous les répertoires des pages du manuel doivent avoir la même structure que /usr/share/man.

Les sections des pages de catalogue (cat<section>) contenant des entrées de pages de manuel formatées sont aussi localisées dans les sous-répertoires de <mandir>/<locale>, mais ne sont pas nécessaires et peuvent ne pas être distribuées à la place des pages de man ``nroff''.

Les sections numérotées de 1 à 8 sont usuellement définies. En règle générale, le nom de fichier pour les pages de manuel localisées dans une section particulière se termine par .<section>.

Par ailleurs, des jeux de grande taille de pages du manuel présentent un suffixe additionnel au nom de fichier des pages. Par exemple, les pages de manuel relatives au système de gestion du courriel MH ont un suffixes mh (à toutes les pages). Toutes les pages du manuel relatives au système X Window doivent avoir un suffixe x.

La pratique consistant à placer des pages de manuel en diverses langues dans les sous-répertoires appropriés de /usr/share/man peut également être appliquée à d'autres arborescences telles que /usr/local.man et /usr/X11R6/man (cette partie de la norme s'applique également à la structure de la section /var/cache/man décrite ci-après).


next up previous contents Next: /usr/share/misc: données diverses indépendantes Up: /usr/share/man: Pages du manuel. Previous: Objectifs.   Table des matières  
1-01-2006