MANPATH(5) /etc/man_db.conf MANPATH(5)
NOM
manpath - Format du fichier /etc/man_db.conf
DESCRIPTION
Le fichier de configuration de manpath est exploite par divers
utilitaires dedies aux pages de manuel. Il sert a determiner, lors de
l'execution, les chemins d'acces personnels aux pages de manuel. Cela
permet d'indiquer les structures hierarchiques de pages de manuel
(<< manpaths >>) devant etre considerees comme des structures
hierarchiques << systeme >> ainsi qu'a leur assigner les repertoires a
employer pour le stockage des fichiers << cat >>.
Si la variable d'environnement $MANPATH est definie, l'information
contenue dans /etc/man_db.conf ne la remplacera pas.
SEARCH PATH
By default, man-db examines the user's $PATH. For each path_element
found there, it adds manpath_element to the search path.
If there is no MANPATH_MAP line in the configuration file for a given
path_element, then it adds all of path_element/../man,
path_element/man, path_element/../share/man, and path_element/share/man
that exist as directories to the search path.
It then adds any MANDATORY_MANPATH entries from the configuration file
to the search path.
Finally, if the --systems option is used or the $SYSTEM environment
variable is set, then that should consist of a sequence of operating
system names separated by commas or colons. This acts as a template,
expanding the search path once more to allow access to other operating
systems' manual pages: for each system name, man-db looks for that name
as a subdirectory of each entry in the search path, and adds it to the
final search path if it exists. A system name of man inserts the
normal search path without subdirectories. For example, if the search
path would otherwise have been /usr/share/man:/usr/local/man, and
$SYSTEM is set to newOS:man, then the final search path will be
/usr/share/man/newOS:/usr/share/man:/usr/local/man/newOS:/usr/local/man.
The $MANPATH environment variable overrides man-db's default manual
page search paths. Most users should not need to set it. Its syntax
is similar to the $PATH environment variable: it consists of a sequence
of directory names separated by colons. It overrides the default
search path described above.
If the value of $MANPATH starts with a colon, then the default search
path is added at its start. If the value of $MANPATH ends with a
colon, then the default search path is added at its end. If the value
of $MANPATH contains a double colon (::), then the default search path
is inserted in the middle of the value, between the two colons.
FORMAT
Les types de champs suivants sont actuellement reconnus :
# commentaire
Les lignes vides ou celles commencant par un # seront
considerees comme des commentaires et ignorees.
MANDATORY_MANPATH structure_hierarchique
Les lignes de ce type precisent les structures hierarchiques de
pages de manuel que doivent contenir tous les $MANPATH produits
automatiquement. En general, cela inclut /usr/man.
MANPATH_MAP element_de_chemin structure_hierarchique
Les lignes de ce type etablissent la correspondance entre un des
elements du chemin de recherche $PATH et la structure
hierarchique qui contient les pages de manuel correspondantes
$MANPATH. Pour chaque element_de_chemin trouve dans le $PATH de
l'utilisateur, la structure_hierarchique sera ajoutee au
$MANPATH.
MANDB_MAP structure_hierarchique [ element_de_chemin_cat ]
Les lignes de ce type indiquent quelles sont les structures
hierarchiques de pages de manuel qui doivent etre traitees comme
<< systeme >>. Eventuellement, elles precisent egalement le lieu
de stockage des fichiers << cat >> correspondant. Ce type de
ligne est particulierement important dans le cas ou man
s'execute avec les droits du superutilisateur (setuid). En
effet, quand le fichier de configuration systeme
/etc/man_db.conf existe au lieu du fichier de configuration par
utilisateur .manpath, il indique les structures hierarchiques de
pages de manuel auxquelles man accede en tant qu'utilisateur
setuid et celles auxquelles il accede en tant qu'utilisateur
normal.
Les structures hierarchiques de pages de manuel << systeme >>
sont celles habituellement stockees dans /usr ainsi que dans
/usr/man, /usr/local/man et /usr/X11R6/man.
Si les pages << cat >> d'une structure_hierarchique ne doivent
pas etre stockees ou doivent etre stockees a l'emplacement
habituel, element_de_chemin_cat peut etre omis.
L'emplacement habituel des pages << cat >> serait inutilisable
pour des structures hierarchiques de pages de manuel montees en
lecture seule. C'est pourquoi il est possible d'indiquer
n'importe quel repertoire valide pour leur stockage. Pour
respecter le Linux FSSTND le mot-cle FSSTND peut etre employe a
la place d'un repertoire reel.
Malheureusement, il est necessaire d'indiquer tous les chemins
vers les pages de manuel << systeme >>, y compris les chemins
d'acces aux pages des autres systemes d'exploitation tel que
/usr/man/sun, ainsi que tous les chemins de localisation NLS
locale comme /usr/man/de_DE.88591.
Etant donne que l'information est analysee ligne par ligne, dans
l'ordre d'ecriture, il est necessaire que chaque chemin d'acces
aux pages de manuel forme une sous-structure hierarchique
indiquee prealablement a la structure hierarchique qui la
contient, sinon un resultat incorrect surviendra. Par exemple
/usr/man/de_DE.88591 doit etre indique avant /usr/man.
DEFINE cle valeur
Les lignes de ce type definissent diverses variables de
configuration. Consultez le fichier de configuration par defaut
pour connaitre les variables employees par les utilitaires de
pages de manuel. Ces variables incluent les chemins d'acces par
defaut a divers programmes (tels que grep et tbl), et fixent les
valeurs par defaut des arguments de ces programmes.
SECTION section ...
Les lignes de ce type definissent l'ordre dans lequel les
sections de manuel devraient recherchees. S'il n'y a pas de
directives SECTION dans le fichier de configuration, l'ordre par
defaut est :
SECTION 1 n l 8 3 0 2 3type 5 4 9 6 7
Si plusieurs directives SECTION sont donnees, leurs listes de
sections seront concatenees.
Si une extension specifique n'est pas dans cette liste (par
exemple 1mh), elle sera affichee avec le reste de la section a
laquelle elle appartient. Par consequent, il vous suffit
d'expliciter la liste des extensions si vous voulez forcer un
ordre en particulier. Les sections avec extension devrait
habituellement etre a cote de leur section principale (par
exemple << 1 1mh 8 ... >>).
SECTIONS est un nom equivalent pour cette directive.
MINCATWIDTH largeur
Si la largeur du terminal est inferieure a largeur, les pages
<< cat >> ne seront ni creees ni affichees. La valeur par defaut
est 80.
MAXCATWIDTH largeur
Si la largeur du terminal est superieure a largeur, les pages
<< cat >> ne seront ni creees ni affichees. La valeur par defaut
est 80.
CATWIDTH largeur
If width is non-zero, cat pages will always be formatted for a
terminal of the given width, regardless of the width of the
terminal actually being used. This overrides MINCATWIDTH and
MAXCATWIDTH.
NOCACHE
Cet indicateur empeche man(1) de creer automatiquement les pages
<< cat >>.
BOGUES
Si les regles precedentes ne sont pas suivies et observees avec
rigueur, les utilitaires d'affichage de pages de manuel ne
fonctionneront pas comme prevu. Ces regles sont excessivement
compliquees.
https://gitlab.com/man-db/man-db/-/issues
https://savannah.nongnu.org/bugs/?group=man-db
TRADUCTION
Cette traduction est maintenue a l'aide de l'outil po4a
par l'equipe francophone de traduction de
Debian.
Valery Perrin le 2 janvier 2006. David
Prevot et l'equipe francophone de traduction de
Debian (2010).
Veuillez signaler toute erreur de traduction en ecrivant a
ou par un rapport de bogue sur le
paquet man-db.
Vous pouvez toujours avoir acces a la version anglaise de ce document
en utilisant la commande << man -L C >>.
2.13.0 2024-08-29 MANPATH(5)