man.conf - fichier de configuration de man(1)

Les commandes man(1), apropos(1) et whatis(1) recherchent des pages de manuel ou leurs fichiers de bases de données, en se basant sur ce qui est spécifié dans le fichier man.conf. Les pages de manuel sont normalement sensées être préformatées et nommées avec un “.0” à la fin.

Le fichier man.conf contient deux types de lignes.

Le premier type de lignes est une ligne “section”, qui contient un nom de section suivi d'un ou plusieurs chemin(s) de répertoire. Les chemins de répertoires peuvent contenir les caractères de globbing normaux du shell, y compris les accolades (“{}”) ; pour protéger un caractère de globbing du shell, faites-le précéder d'un antislash (“\”). Les lignes de ce format spécifient quelles pages de manuel de cette section peuvent être trouvées dans les répertoires suivants.

Les répertoires portant un caractère slash (“/”) à la fin de leur nom sont sensés contenir des sous-répertoires de pages de manuel, (voir le mot-clef “_subdir” ci-dessous), et non des pages de manuel. La recherche s'effectue alors dans ces sous-répertoires, et non dans le répertoire lui-même.

Avant de rechercher une page de manuel dans un quelconque répertoire, la commande man(1) recherche toujours dans le sous-répertoire portant le nom du type de machine actuel, s'il existe. Il n'est pas nécessaire de spécifier ces sous-répertoires dans le fichier man.conf.

Les noms de sections ne sont pas limités, sauf pour les mots réservés spécifiés ci-dessous ; en général, vous devriez éviter d'utiliser des mots préfixés par un underscore (“_”) afin d'éviter de futures incompatibilités.

La section nommée “_default” est la liste des répertoires dans lesquels s'effectuera la recherche si aucune section n'est spécifiée par l'utilisateur.

Le second type de ligne est précédé d'un “mot-clef”. Les mots-clefs possibles et leur signification sont les suivants :

• _build

Les noms de fichier man, quelque soit leur format, sont sensés se terminer selon le modèle “.*”, c'est-à-dire un “.” suivi d'un suffixe quelconque. Le premier champ d'une ligne _build indique un suffixe qui indique quel fichier doit être reformaté ou manipulé d'une manière ou d'une autre avant d'être affiché à l'utilisateur. Le suffixe peut contenir les caractères de globbing normaux du shell (mais PAS les accolades (“{}”). Le reste de la ligne doit être une ligne de commande shell, dont la sortie standard est la page de manuel dans un format pouvant être directement affiché à l'utilisateur. Toute occurrence de la chaîne “%s” dans la ligne de commande shell sera remplacée par le nom du fichier qui est reformaté.

• _subdir

La liste (dans l'ordre de recherche) des sous-répertoires dans lesquels s'effectuera la recherche pour tout répertoire dont le nom se termine par un caractère slash (“/”). Cette liste est également utilisée lorsqu'un chemin est spécifié par l'utilisateur à l'utilitaire man(1), que ce soit en utilisant la variable d'environnement MANPATH ou en utilisant les options -M et -m.

• _suffix

Les noms de fichier man, quelque soit leur format, sont sensés se terminer selon le modèle “.*”, c'est-à-dire un “.” suivi d'un suffixe quelconque. Chaque champ d'une ligne _suffix est un suffixe indiquant les fichiers qui n'ont pas besoin d'être reformatés ou manipulés, mais qui peuvent être directement affichés à l'utilisateur. Chaque suffixe peut contenir les caractères de globbing normaux du shell (mais PAS les accolades (“{}”).

• _version

La version du fichier de configuration

• _whatdb

Le chemin d'accès complet (pas simplement un chemin de répertoire) menant à une base de donnée qu'utiliseront les commandes apropos(1) et whatis(1).

Pour tous les types de ligne, les spécifications multiples se cumulent et les entrées sont utilisées dans l'ordre où elles sont présentées dans le fichier ; on peut également donner plusieurs entrées par ligne.

Les lignes vides et les lignes dont le premier caractère non-espace est un dièse (“#”) sont ignorées.

/etc/man.conf répertoire standard de recherche du manuel

Étant donné le fichier man.conf suivant :

         _version        BSD.2
         _subdir         cat[123]
         _suffix         .0
         _build          .[1-9]  nroff -man %s
         _build          .tbl    tbl %s | nroff -man
         _default        /usr/share/man/
         sect3           /usr/share/man/{old/,}cat3

Par défaut, la commande “man mktemp” chercherait après “mktemp.<caractère_alphanumérique>” et “mktemp.tbl” dans les répertoires /usr/share/man/cat1, /usr/share/man/cat2, et /usr/share/man/cat3. Si on se trouvait sur une machine de type “vax”, la recherche s'effectuerait alors également dans le sous-répertoire “vax” de chaque répertoire, avant la recherche dans le répertoire.

Si “mktemp.tbl” était trouvé en premier, la commande “tbl mktemp.tbl | nroff -man” serait lancée afin de construire une page man à afficher à l'utilisateur.

La commande “man sect3 mktemp” lancerait la recherche dans les répertoires /usr/share/man/old/cat3 et /usr/share/man/cat3, dans cet ordre, pour trouver la page de manuel mktemp(1). Si un sous-répertoire du même nom que le type de la machine utilisée existe dans l'un d'entre eux, alors la recherche s'effectuerait également dedans, avant les autres répertoires.

apropos(1), machine(1), man(1), whatis(1), whereis(1), fnmatch(3), glob(3)

OpenBSD 4.4 31 Mai 2007 2