man

Section: Manuel de l'utilisateur Linux (1)
Updated: 2 septembre 1995
Index Retour au Menu Principal

 

NOM

man - formater et afficher les pages de manuel en ligne
manpath - déterminer le chemin de recherche des pages de manuel pour un utilisateur  

SYNOPSIS

man [-acdfFhkKtwW] [--path] [-m système] [-p chaîne] [-C fichier_config] [-M liste_chemins] [-P paginateur] [-S liste_sections] [section] nom ...

 

DESCRIPTION

man formate et affiche les pages de manuel en ligne. Si vous spécifiez une section, man ne recherche que dans cette section du manuel. nom est normalement le nom de la page de manuel, qui est typiquement celui d'une commande, d'une fonction ou d'un fichier. Néanmoins, si nom contient un slash (/) alors man l'interprète comme une spécification de fichier, afin que vous puissiez utiliser man ./foo.5 ou même man /cd/foo/bar.1.gz.

Voyez en dessous pour une description de l'endroit où man recherche les fichiers des pages de manuel.

 

OPTIONS

-C fichier_config
Spécifier le fichier de configuration à utiliser (/etc/man.config par défaut ; voyez man.config(5))
-M chemin
Spécifier la liste de répertoires où rechercher les pages de manuel. Séparez les répertoires par des deux-points. Une liste vide revient à ne pas spécifier -M du tout. Voyez CHEMIN DE RECHERCHE DES PAGES DE MANUEL.
-P paginateur
Spécifier quel paginateur utiliser. Cette option surcharge la variable d'environnement MANPAGER, qui surcharge à son tour la variable PAGER. Par défaut, man utilise /usr/bin/less -isr.
-S liste_sections
La liste est une liste de sections de manuel séparées par des deux-points où il faut chercher. Cette option surcharge la variable d'environnement MANSECT.
-a
Par défaut, man se termine après avoir affiché la première page de manuel trouvée. L'utilisation de cette option force man à afficher toutes les pages de manuel correspondant à nom, et pas seulement la première.
-c
Reformater la page de manuel source, même si une page cat à jour existe. Cela peut servir quand la page cat a été formatée pour un écran utilisant un nombre de colonnes différent, ou lorsque la page préformatée est corrompue.
-d
Ne pas réellement afficher les pages de manuel, mais afficher des tas d'informations de débogage.
-D
Afficher la ou les pages de manuel ET les informations de débogage.
-f
Équivalent à whatis.
-F ou --preformat
Formater uniquement - ne pas afficher.
-h
Afficher un message d'aide d'une ligne et se terminer.
-k
Équivalent à apropos.
-K
Rechercher la chaîne spécifiée dans toutes les pages de manuel. Attention : c'est potentiellement très lent ! Cela aide à spécifier une section. (Pour vous donner une petite idée, cela prend à peu près une minute par 500 pages de manuel sur ma machine.)
-m système
Spécifier un groupe de pages de manuel alternatif où rechercher.
-p chaîne
Spécifier la séquence de préprocesseurs à exécuter avant nroff ou troff. Toutes les installations ne disposent pas de l'ensemble complet de préprocesseurs. Certains des préprocesseurs et les lettres utilisées pour les désigner sont : eqn (e), grap (g), pic (p), tbl (t), vgrind (v), refer (r). Cette option surcharge la variable d'environnement MANROFFSEQ.
-t
Utiliser /usr/bin/groff -Tps -mandoc pour formater la page de manuel, en plaçant la sortie sur stdout. La sortie provenant de /usr/bin/groff -Tps -mandoc pourrait devoir être filtrée avant d'être imprimée.
-w ou --path
Ne pas réellement afficher les pages de manuel, mais afficher le ou les emplacements des fichiers qui doivent être formatés ou affichés. Si aucun argument n'est donné, afficher (sur stdout) la liste des répertoires parcourus par man lors de la recherche de pages de manuel. Si manpath est un lien vers man, alors « manpath » est équivalent à « man --path ».
-W
Comme -w, mais afficher les noms de fichiers (un par ligne), sans informations additionnelles. C'est utile dans les commandes shell comme man -aW man | xargs ls -l.

 

PAGES CAT

man essaie de sauver les pages de manuel formatées, afin d'économiser le temps de formatage la prochaine fois où elles seront requises. Traditionnellement, les versions formatées des pages de RÉP/manX sont sauvées dans RÉP/catX, mais d'autres correspondances entre répertoires man et cat peuvent être spécifiées dans /etc/man.config. Aucune page cat n'est sauvée quand le répertoire cat requis n'existe pas, quand elle est formatée pour une ligne de longueur différente de 80, ou quand man.config contient la ligne NOCACHE.

Il est possible de rendre man suid vers l'utilisateur man (NdT : c.-à-d. qu'il prend l'identité de l'utilisateur man à l'exécution). Par la suite, si un répertoire cat a pour propriétaire man et pour mode 0755 (accessible en écriture uniquement pour man), et si les fichiers cat ont pour propriétaire man et pour mode 0644 ou 0444 (accessible en écriture uniquement pour man, ou pas du tout), aucun utilisateur ordinaire ne peut modifier les pages cat ou placer d'autres fichiers dans le répertoire cat. Si man n'utilise pas le bit Set-UID, alors un répertoire cat devrait avoir pour mode 0777 si tous les utilisateurs doivent avoir la possibilité d'y laisser des pages cat.

L'option -c force le reformatage d'une page, même si une page cat plus récente existe.

 

CHEMIN DE RECHERCHE DES PAGES DE MANUEL

man utilise une méthode sophistiquée de localisation des fichiers des pages de manuel, basée sur les options d'invocation et les variables d'environnement, le fichier de configuration /etc/man.config, et certaines conventions et heuristiques intégrées.

Tout d'abord, quand l'argument nom de man contient un slash (/), man suppose qu'il s'agit d'une spécification de fichier, et aucune recherche n'est effectuée.

Mais dans le cas normal où nom ne contient pas de slash, man recherche dans divers répertoires un fichier pouvant représenter une page de manuel pour le sujet nommé.

Si vous spécifiez l'option -M liste_chemins, liste_chemins est une liste de répertoires séparés par des deux-points où man va effectuer sa recherche.

Si vous ne spécifiez pas -M mais définissez la variable d'environnement MANPATH, la valeur de cette variable est la liste des répertoires parcourus par man.

Si vous ne spécifiez pas de liste de chemins explicite avec -M ou MANPATH, man développe sa propre liste de chemins qui est basée sur le contenu du fichier de configuration /etc/man.config. Les instructions MANPATH qui y sont présentes identifient les répertoires particuliers à inclure dans le chemin de recherche.

En outre, les instructions MANPATH_MAP en ajoutent au chemin de recherche en fonction de votre chemin de recherche des commandes (c.-à-d. votre variable d'environnement PATH). Pour chaque répertoire pouvant se trouver dans le chemin de recherche des commandes, une instruction MANPATH_MAP spécifie un répertoire devant être ajouté au chemin de recherche des fichiers des pages de manuel. man examine la variable PATH et ajoute les répertoires correspondant au chemin de recherche des fichiers de pages de manuel. Ainsi, en utilisant correctement MANPATH_MAP, quand vous lancerez la commande man xyz, vous obtiendrez la page de manuel du programme qui s'exécuterait si vous aviez tapé la commande xyz.

En outre, pour chaque répertoire du chemin de recherche des commandes (nous l'appellerons un « répertoire de commandes ») auquel ne correspond pas d'instruction MANPATH_MAP, man recherche automatiquement un répertoire de pages de manuel « proche », à savoir un sous-répertoire du répertoire de commandes lui-même ou du répertoire père du répertoire de commandes.

Vous pouvez désactiver les recherches « proches » automatiques en incluant une instruction NOAUTOPATH dans /etc/man.config.

Dans chaque répertoire du chemin de recherche comme décrit plus haut, man recherche un fichier nommé sujet.section (où le suffixe de numéro de section est optionnel) qui est éventuellement complété par un suffixe de compression. S'il ne trouve pas un tel fichier, il recherche alors dans tous les sous-répertoires nommés manN ou cat N, où N est le numéro de la section du manuel. Si le fichier est dans un sous-répertoire cat N, man suppose que c'est une page de manuel formatée (page cat). Sinon, man suppose qu'elle n'est pas formatée. Dans tous les cas, si le nom de fichier a un suffixe de compression connu (comme .gz), man suppose qu'il est gzippé.

Si vous voulez voir où (ou si) man trouverait la page de manuel pour un sujet particulier, utilisez l'option --path (-w).

 

ENVIRONNEMENT

MANPATH
Si MANPATH est définie, man l'utilise comme chemin de recherche des fichiers des pages de manuel. Il surcharge le fichier de configuration et le chemin de recherche automatique, mais est surchargé par l'option d'invocation -M. Voyez CHEMIN DE RECHERCHE DES PAGES DE MANUEL.
MANPL
Si MANPL est définie, sa valeur est utilisée comme longueur de la page d'affichage. Sinon, la page de manuel entière occupera une seule (longue) page.
MANROFFSEQ
Si MANROFFSEQ est définie, sa valeur est utilisée pour déterminer l'ensemble de processeurs exécutés avant d'exécuter nroff ou troff. Par défaut, les pages passent dans le préprocesseur tbl avant nroff.
MANSECT
Si MANSECT est définie, sa valeur est utilisée pour déterminer dans quelles sections du manuel il faut chercher.
MANWIDTH
Si MANWIDTH est définie, sa valeur est utilisée comme largeur d'affichage des pages de manuel. Sinon, les pages seront affichées sur la largeur complète de votre écran.
MANPAGER
Si MANPAGER est définie, sa valeur est utilisée comme nom du programme à utiliser pour afficher la page de manuel. Si ce n'est pas le cas, alors PAGER est utilisé. Si c'est variable n'est pas non plus définie, /usr/bin/less -isr est utilisé.
LANG
Si LANG est définie, elle définit le nom du sous-répertoire où man recherche en premier lieu les pages de manuel. Ainsi, la commande « LANG=dk man 1 foo » lui fera rechercher la page de manuel de foo dans .../dk/man1/foo.1 ou, s'il ne la trouve pas, dans .../man1/foo.1, où ... est un répertoire du chemin de recherche.
NLSPATH, LC_MESSAGES, LANG
Les variables d'environnement NLSPATH et LC_MESSAGES (ou LANG quand cette dernière n'existe pas) jouent un rôle dans la localisation du catalogue de messages. (Mais les messages anglais sont déjà intégrés, et aucun catalogue n'est requis pour l'anglais.) Notez que des programmes comme col(1) appelés par man peuvent également utiliser LC_CTYPE.
PATH
PATH aide à déterminer le chemin de recherche des pages de manuel. Voyez CHEMIN DE RECHERCHE DES PAGES DE MANUEL.
SYSTEM
SYSTEM est utilisée pour obtenir le nom du système alternatif par défaut (pour utilisation avec l'option -m).
 

VOIR AUSSI

apropos(1), whatis(1), less(1), groff(1), man.config(5).  

BOGUES

L'option -t ne fonctionne que si un programme de type troff est installé.
Si vous voyez des \255 ou <AD> clignotants au lieu de traits d'union, placez « LESSCHARSET=latin1 » dans votre environnement.  

TRUCS

Si vous ajoutez la ligne


  (global-set-key [(f1)] (lambda () (interactive) (manual-entry (current-word))))

dans votre fichier .emacs, alors l'appui sur F1 vous donnera la page de manuel pour l'appel de bibliothèque situé à l'emplacement actuel du curseur.

Pour obtenir une version texte pur d'une page de manuel, sans backspaces ni caractères de soulignement (« _ »), essayez


  # man foo | col -b > foo.mantxt  

TRADUCTION

Frédéric Delanoy <delanoy_f at yahoo.com>, 2002.


 

Index

NOM
SYNOPSIS
DESCRIPTION
OPTIONS
PAGES CAT
CHEMIN DE RECHERCHE DES PAGES DE MANUEL
ENVIRONNEMENT
VOIR AUSSI
BOGUES
TRUCS
TRADUCTION

Time: 18:57:03 GMT, December 19, 2004