MAN(1)

NOM
man - formate et affiche les pages du manuel en ligne
manpath - détermine le chemin de recherche des pages pour l'utilisateur

SYNOPSIS
man [-acdfhktwW] [-m système] [-p chaîne] [-C fichier_config] [-M chemin] [-P visualiseur] [-S liste_sections] [section] nom ...

DESCRIPTION
man formate et affiche les pages du manuel en ligne. Cette version reconnaît les variables d'environnement MANPATH et (MAN)PAGER, de sorte que vous pouvez avoir vos propres jeux de manuels personnels et employer le programme de votre choix pour les visualiser. Si section est spécifiée, man ne recherchera que dans cette section particulière. Vous pouvez également indiquer l'ordre de recherche des sections désirées ainsi que les préprocesseurs à utiliser pour traiter les fichiers sources, par des options de la ligne de commandes ou des variables d'environnement. Si nom contient le caractère /, il sera d'abord considéré en tant que nom de fichier, vous pouvez donc faire : man ./toto.5 ou même man /truc/machin/bidule.1.gz.

OPTIONS

-C  fichier_config
    Spécifie le fichier man.conf à utiliser; par défaut il s'agit de /etc/man.conf. (voir man.conf(5).)

-M  path
    Indique la liste des répertoires dans lesquels la recherche des pages sera effectuée. Si rien n'est spécifié, c'est la variable d'environnement MANPATH qui sera utilisée. Si cette variable n'existe pas, la liste par défaut sera déterminée en consultant le fichier /etc/man.conf. Si MANPATH contient une chaîne vide, celle-ci sera remplacée par la liste par défaut.

-P  visualiseur
    Indique le programme de visualisation des pages à employer. Par défaut, man utilisera /usr/bin/less -is. Cette option a priorité sur la variable d'environnement PAGER.

-S  liste_sections
    Il s'agit d'une liste de sections, séparées par des deux points, dans lesquelles les pages seront recherchées. Elle a priorité sur la variable d'environnement MANSECT.

-a  Par défaut, man s'arrête après avoir affiché la première page de manuel trouvée. Cette option permet de lui faire afficher toutes les pages correspondant à la requête « nom » de l'utilisateur, s'il y en a plusieurs.

-c  Reformate la page de manuel, même si une version préformatée à jour existe. Cela peut être utile si cette dernière a été prévue pour un écran de taille différente, par exemple.

-d  N'affiche pas les pages de manuel, mais fournit une grande quantité d'informations de déboguage.

-D  Affiche à la fois les pages de manuel et les informations de déboguage.

-f  Équivalent à whatis.

-h  Affiche un court message d'aide.

-k  Équivalent à apropos.

-m  système
    Demande l'utilisation d'un autre jeu de pages de manuel, en fonction du nom de système indiqué.

-p  chaîne
    Spécifie la séquence de préprocesseurs à exécuter avant nroff ou troff. Selon votre installation de Linux, vous ne disposerez pas forcément de tous les programmes possibles. Voici les plus courants et les lettres qui les désignent: eqn (e), grap (g), pic (p), tbl (t), vgrind (v), refer (r). Cette option a priorité sur la variable d'environnement MANROFFSEQ.

-t  Emploie /usr/bin/groff -Tps -mandoc pour formater la page de manuel, la sortie se faisant sur stdout. La sortie de /usr/bin/groff -Tps -mandoc peut nécessiter un passage par certains filtres avant de pouvoir être affichée ou imprimée.

-w ou --path
    N'affiche pas les pages de manuel, mais les emplacements des fichiers qui auraient été formatés ou affichés. Si aucun argument n'est précisé, indique sur la sortie standard la liste des répertoires dans lesquels man recherche les pages. Si manpath est un lien sur le programme man, alors « manpath » est équivalent à la commande « man --path ».

-W  Comme -w, mais affiche les noms de fichiers, un par ligne, sans aucune autre information. Très utile dans des commandes shell du genre: man -aW man | xargs ls -l

PAGES FORMATÉES
Afin de gagner du temps, man tente de sauvegarder les pages formatées au lieu de les interpréter chaque fois qu'elles sont demandées. Traditionnellement, les versions formatées des pages de REP/manX sont enregistrées dans REP/catX, mais d'autres correspondances entre les répertoires man et les répertoires cat peuvent être indiquées dans le fichier /etc/man.conf. Si le répertoire « cat » correspondant n'existe pas, les pages formatées ne seront pas enregistrées.

Il est possible de rendre man suid utilisateur man. Dans ce cas, si un répertoire cat appartient à man et a le mode 0755 (seul man peut l'écrire), et que les fichiers cat appartiennent eux aussi à man et ont le mode 0644 ou 0444 (seul man peut les écrire, voire personne), aucun utilisateur normal ne pourra changer de pages formatées ou mettre d'autre fichiers dans le répertoire correspondant. Si man n'est pas suid, les répertoires cat devront avoir le mode 0777 afin que tout utilisateur puisse y laisser le résultat des formatages lors des consultations du manuel.

L'option -c force le reformatage d'une page, même si un fichier cat plus récent que le fichier source existe.

ENVIRONNEMENT

MANPATH
    Si la variable MANPATH est positionnée, sa valeur sera utilisée comme chemin de recherche des pages de manuel.

MANROFFSEQ
    Si MANROFFSEQ est positionnée, sa valeur servira à déterminer le jeu de préprocesseurs à exécuter avant de lancer nroff ou troff. Par défaut, les pages sont passées dans le processeur de tableaux avant nroff.

MANSECT
    Si MANSECT est positionnée, sa valeur déterminera les sections du manuel dans lesquelles les pages seront recherchées.

PAGER
    Si PAGER est positionnée, sa valeur sera considérée comme le nom du programme à utiliser pour afficher la page de manuel. Par défaut, il s'agira de /usr/bin/less -is.

LANG
    Si LANG est positionnée, sa valeur définira le nom du sous-répertoire où man commencera la recherche des pages de manuel. Ainsi, la commande « LANG=fr man 1 toto » aura pour effet de faire rechercher la page toto dans .../fr/man1/toto.1, et si ce fichier n'existe pas, dans .../man1/toto.1, où ... est un répertoire du chemin de recherche.

NLSPATH, LC_MESSAGES, LANG
    Les variables d'environnement NLSPATH et LC_MESSAGES (ou LANG lorsque la dernière n'existe pas) jouent un rôle dans la localisation du catalogue de messages. (Mais les messages anglais sont inclus dans le programme à la compilation, aucun catalogue n'est donc nécessaire pour un affichage dans la langue de Shakespeare.) Notez que les programmes comme col(1) qui sont appelés par man, utilisent également LC_CTYPE.

PATH
    PATH est utilisée pour la construction du chemin de recherche par défaut.

SYSTEM
    SYSTEM employée pour obtenir les systèmes alternatifs par défaut (en vue de l'utilisation de l'option -m ).

VOIR AUSSI
apropos(1), whatis(1), less(1), groff(1).

BUGS
L'option -t ne fonctionne que si un programme « troff-like » est installé.

TRADUCTION
René Cougnenc, 1995.