noble (5) manpath.5.gz

Provided by: man-db_2.12.0-4build2_amd64 bug

NOM

       manpath - Format du fichier /etc/manpath.config

DESCRIPTION

       Le fichier de configuration de manpath est exploité par divers utilitaires dédiés aux pages de manuel. Il
       sert à déterminer, lors de l'exécution, les chemins d'accès personnels aux pages de manuel.  Cela  permet
       d'indiquer  les  structures hiérarchiques de pages de manuel (« manpaths ») devant être considérées comme
       des structures hiérarchiques « système » ainsi qu'à leur assigner les  répertoires  à  employer  pour  le
       stockage des fichiers « cat ».

       Si  la  variable d'environnement $MANPATH est définie, l'information contenue dans /etc/manpath.config ne
       la remplacera pas.

       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  commençant  par  un # seront considérées comme des commentaires et
              ignorées.

       MANDATORY_MANPATH structure_hiérarchique
              Les lignes de ce type précisent les structures  hiérarchiques  de  pages  de  manuel  que  doivent
              contenir tous les $MANPATH produits automatiquement. En général, cela inclut /usr/man.

       MANPATH_MAP élément_de_chemin  structure_hiérarchique
              Les  lignes  de ce type établissent la correspondance entre un des éléments du chemin de recherche
              $PATH et la structure hiérarchique qui contient les pages de manuel correspondantes $MANPATH. Pour
              chaque  élément_de_chemin  trouvé  dans  le $PATH de l'utilisateur, la structure_hiérarchique sera
              ajoutée au $MANPATH.

       MANDB_MAP structure_hiérarchique [ élément_de_chemin_cat ]
              Les lignes de ce type indiquent quelles sont les structures hiérarchiques de pages de  manuel  qui
              doivent  être  traitées  comme  « système ».  Éventuellement, elles précisent également le lieu de
              stockage des fichiers « cat » correspondant. Ce type de ligne est particulièrement important  dans
              le  cas  où man s'exécute avec les droits du superutilisateur (setuid). En effet, quand le fichier
              de configuration système /etc/manpath.config existe  au  lieu  du  fichier  de  configuration  par
              utilisateur  .manpath,  il  indique les structures hiérarchiques de pages de manuel auxquelles man
              accède en tant qu'utilisateur setuid et celles auxquelles il accède en tant qu'utilisateur normal.

              Les structures hiérarchiques de pages de manuel « système » sont  celles  habituellement  stockées
              dans /usr ainsi que dans /usr/man, /usr/local/man et /usr/X11R6/man.

              Si  les  pages  « cat »  d'une structure_hiérarchique ne doivent pas être stockées ou doivent être
              stockées à l'emplacement habituel, élément_de_chemin_cat peut être omis.

              L'emplacement habituel des pages « cat » serait inutilisable pour des structures hiérarchiques  de
              pages de manuel montées en lecture seule. C'est pourquoi il est possible d'indiquer n'importe quel
              répertoire valide pour leur stockage. Pour respecter le Linux FSSTND le mot-clé FSSTND  peut  être
              employé à la place d'un répertoire réel.

              Malheureusement,  il  est  nécessaire  d'indiquer  tous  les  chemins  vers  les  pages  de manuel
              « système », y compris les chemins d'accès aux pages des autres systèmes  d'exploitation  tel  que
              /usr/man/sun, ainsi que tous les chemins de localisation NLS locale comme /usr/man/de_DE.88591.

              Étant  donné  que  l'information  est  analysée  ligne  par ligne, dans l'ordre d'écriture, il est
              nécessaire que chaque chemin d'accès aux pages de manuel  forme  une  sous-structure  hiérarchique
              indiquée  préalablement  à  la structure hiérarchique qui la contient, sinon un résultat incorrect
              surviendra. Par exemple /usr/man/de_DE.88591 doit être indiqué avant /usr/man.

       DEFINE clé valeur
              Les lignes de ce type définissent diverses variables de configuration.  Consultez  le  fichier  de
              configuration  par  défaut  pour connaître les variables employées par les utilitaires de pages de
              manuel. Ces variables incluent les chemins d'accès par défaut à divers programmes (tels  que  grep
              et tbl), et fixent les valeurs par défaut des arguments de ces programmes.

       SECTION section ...
              Les  lignes  de  ce  type  définissent  l'ordre  dans  lequel  les  sections  de  manuel devraient
              recherchées. S'il n'y a pas de directives SECTION dans le fichier de  configuration,  l'ordre  par
              défaut est :

                     SECTION 1 n l 8 3 0 2 3type 5 4 9 6 7

              Si plusieurs directives SECTION sont données, leurs listes de sections seront concaténées.

              Si  une extension spécifique n'est pas dans cette liste (par exemple 1mh), elle sera affichée avec
              le reste de la section à laquelle elle appartient. Par conséquent, il vous suffit d'expliciter  la
              liste  des  extensions  si vous voulez forcer un ordre en particulier. Les sections avec extension
              devrait habituellement être à côté de leur section principale (par exemple « 1 1mh 8 ... »).

              SECTIONS est un nom équivalent pour cette directive.

       MINCATWIDTH largeur
              Si la largeur du terminal est inférieure à largeur, les pages  « cat »  ne  seront  ni  créées  ni
              affichées. La valeur par défaut est 80.

       MAXCATWIDTH largeur
              Si  la  largeur  du  terminal  est  supérieure à largeur, les pages « cat » ne seront ni créées ni
              affichées. La valeur par défaut 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 empêche man(1) de créer automatiquement les pages « cat ».

BOGUES

       Si les règles précédentes ne sont pas suivies et observées avec rigueur, les utilitaires  d'affichage  de
       pages de manuel ne fonctionneront pas comme prévu. Ces règles sont excessivement compliquées.

       https://gitlab.com/man-db/man-db/-/issues
       https://savannah.nongnu.org/bugs/?group=man-db

TRADUCTION

       Cette  traduction est maintenue à l'aide de l'outil po4a <URL:https://po4a.org/> par l'équipe francophone
       de traduction de Debian.

       Valéry Perrin <valery.perrin.debian@free.fr> le 2  janvier  2006.  David  Prévot  <david@tilapin.org>  et
       l'équipe francophone de traduction de Debian (2010).

       Veuillez  signaler  toute erreur de traduction en écrivant à <debian-l10n-french@lists.debian.org> ou par
       un rapport de bogue sur le paquet man-db.

       Vous pouvez toujours avoir accès à la version anglaise de ce document en utilisant la commande « man -L C
       <section> <page_de_man> ».