man

Autres langues

Langue: fr

Version: 19 septembre 2005 (www.delafond.org - 07/08/07)

Autres sections - même nom

Section: 1 (Commandes utilisateur)

NOM

man - formate et affiche les pages du manuel en ligne

SYNOPSIS

man [-acdfFhkKtwW] [--path] [-m syst�me] [-p cha�ne] [-C fichier_config] [-M chemin] [-P visualiseur] [-B navigateur] [-H visualiseur_html] [-S liste_sections] [section] nom ...

DESCRIPTION

man formate et affiche les pages du manuel en ligne. Si section est sp�cifi�e, man ne recherchera que dans cette section du manuel. nom est le nom de la page qui est g�n�ralement le nom d'une commande, d'une fonction ou d'un fichier. Toutefois, si nom contient une barre oblique � / �, 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.

Voir plus loin pour une description sur la fa�on dont man cherche les fichiers pages de manuel.

OPTIONS

-C fichier_config
Sp�cifie le fichier de configuration � utiliser ; par d�faut il s'agit de @man_config_file@. (Voir man.conf(5).)
-M chemin
Indique la liste des r�pertoires dans lesquels la recherche des pages sera effectu�e. Veuillez s�parer les r�pertoires par le symbole deux points � : �. Une liste vide est �quivalent � ne pas sp�cifier l'option -M. Voir CHEMIN DE RECHERCHE POUR LES PAGES DE MANUEL.
-P visualiseur
Indique le programme de visualisation des pages � employer. Cette option a priorit� sur la variable d'environnement MANPAGER, qui, � son tour, a priorit� sur la variable d'environnement PAGER. Par d�faut, man utilisera @pager@.
-B
Sp�cifie quel navigateur utiliser pour les fichiers HTML. Cette option supplante la variable d'environnement BROWSER Par d�faut, man utilise @browser@.
-H
Sp�cifie une commande qui produit un fichier texte � partir du fichier HTML. Cette option supplante la variable d'environnement HTMLPAGER Par d�faut, man utilise @htmlpager@.
-S liste_sections
Il s'agit d'une liste de sections, s�par�es par le symbole 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 l'obliger � afficher toutes les pages correspondant � la requ�te � nom � de l'utilisateur, s'il y en a plusieurs, et pas seulement la premi�re trouv�e.
-c
Reformater 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 ou bien si elle est ab�m�e.
-d
Ne pas afficher les pages de manuel, mais fournir une grande quantit� d'informations de d�bogage.
-D
Afficher � la fois les pages de manuel et les informations de d�bogage.
-f
�quivalent � whatis.
-h
Afficher un court message d'aide et quitter.
-k
�quivalent � apropos.
-K
Chercher la cha�ne sp�cifi�e dans *toutes* les pages de manuel. Attention : cela peut �tre tr�s long ! Et il peut �tre utile de sp�cifier une section. (Pour donner une vague id�e, sur ma machine, il faut environ une minute pour 500 pages de manuel.)
-m syst�me
Demander 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
Utiliser @troff@ pour formater la page de manuel, la sortie se faisant sur stdout. La sortie de @troff@ peut n�cessiter un passage par certains filtres avant de pouvoir �tre affich�e ou imprim�e.
-w ou --path
Ne pas afficher 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 @man_config_file@. Aucune page format�e n'est enregistr�e si le r�pertoire � cat � correspondant n'existe pas. Aucune page format�e n'est enregistr�e si elle est format�e avec une longueur de ligne diff�rente de 80. Aucune page format�e n'est enregistr�e si le fichier @man_config_file@ contient la ligne NOCACHE.

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 format�s appartiennent eux aussi � man et ont le mode 0644 ou 0444 (seul man peut les �crire, voire personne), aucun utilisateur normal ne pourra modifier les 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.

CHEMIN DE RECHERCHE POUR LES PAGES DE MANUEL

man utilise une m�thode sophistiqu�e pour chercher les pages de manuels, bas�e sur l'invocation d'options et de variables d'environnement, le fichier de configuration @man_config_file@, des heuristiques et conventions pr�d�finies.

En premier lieu, lorsque l'argument nom de man contient une barre oblique � / �, man suppose qu'il s'agit d'un fichier et aucune recherche complexe n'est lanc�e.

Mais dans la plupart des cas o� nom ne contient pas de barre oblique, man recherche dans plusieurs r�pertoires un fichier qui pourrait �tre 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 le symbole deux points � : �, dans lesquels man effectuera sa recherche.

Si vous ne sp�cifiez pas -M mais que vous positionniez la variable d'environnement MANPATH, la valeur de cette variable est la liste des r�pertoires dans lesquels man effectuera sa recherche.

Si vous ne sp�cifiez pas une liste de chemins explicite avec -M ou MANPATH, man d�veloppe sa propre liste de chemins bas�e sur le contenu du fichier de configuration @man_config_file@. Les d�clarations MANPATH dans le fichier de configuration identifient des r�pertoires particuliers � inclure dans le chemin de recherche.

Qui plus est, les d�clarations MANPATH_MAP compl�tent le chemin de recherche en fonction du chemin de recherche de vos commandes (autrement dit, de votre variable d'environnement PATH). La d�claration MANPATH_MAP indique, pour chacun des r�pertoires pouvant se trouver dans le chemin de recherche des commandes, un r�pertoire qui devrait �tre ajout� au chemin de recherche des pages de manuel. man scrute la variable PATH et ajoute au chemin de recherche des pages de manuel les r�pertoires correspondants. Ainsi, avec une utilisation correcte de MANPATH_MAP, lorsque vous tapez la commande man xyz, vous obtenez la page de manuel du programme que vous lanceriez si vous tapiez la commande xyz.

De plus, pour chacun des r�pertoires situ�s dans le chemin de recherche des commandes (nous l'appellerons � r�pertoire commandes �) pour lequel vous n'avez pas d'instruction MANPATH_MAP, man cherchera automatiquement un r�pertoire de pages de manuel � proximit�, � savoir un sous-r�pertoire du � r�pertoire commandes � lui-m�me ou dans le r�pertoire parent du � r�pertoire commandes �.

Vous pouvez d�sactiver la recherche automatique de proximit� en incluant l'instruction NOAUTOPATH dans le fichier de configuration @man_config_file@.

Dans chaque r�pertoire du chemin de recherche d�crit plus haut, man cherche un fichier nomm� sujet.section, avec un suffixe optionnel sur le num�ro de section et un possible suffixe de compression. S'il ne peut trouver un tel fichier, il regarde alors dans tous les sous-r�pertoires nomm�s manN ou catN o� N est le num�ro de la section du manuel. Si le fichier se trouve dans le sous-r�pertoire cat N, man suppose qu'il s'agit d'une page de manuel format�e (page cat). Autrement, man suppose qu'elle n'est pas format�e. Dans tous les cas, si le nom de fichier comporte une extension indiquant une compression connue (comme .gz), man suppose que le fichier est gzipp�.

Si vous vouloir savoir o� (ou si) man peut trouver une page de manuel sur un sujet particulier, utilisez l'option --path (-w).

ENVIRONNEMENT

MANPATH
Si la variable MANPATH est positionn�e, man utilisera sa valeur comme chemin de recherche des pages de manuel. Cette variable est prioritaire sur le fichier de configuration et le chemin de recherche automatique, mais c�de cette priorit� si l'option -M est utilis�e. Voir CHEMIN DE RECHERCHE POUR LES PAGES DE MANUEL.
MANPL
Si la variable MANPL est positionn�e, sa valeur servira � d�finir la longueur de l'affichage de la page. Autrement, la page enti�re est affich�e sur une seule et longue page.
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.
MANWIDTH
Si MANWIDTH est positionn�e, sa valeur servira � d�finir la largeur de l'affichage de la page. Autrement, la page sera affich�e sur toute la largeur de l'�cran.
MANPAGER
Si MANPAGER est positionn�e, sa valeur sera consid�r�e comme le nom du programme � utiliser pour visualiser la page de manuel. Dans le cas contraire, PAGER sera utilis�e. Si aucune des deux variables n'est positionn�e, @pager@ sera utilis�.
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. Voir CHEMIN DE RECHERCHE POUR LES PAGES DE MANUEL.
SYSTEM
SYSTEM est employ�e pour obtenir le nom du syst�me alternatif par d�faut (en vue de l'utilisation de l'option -m ).

BOGUES

L'option -t ne fonctionne que si un programme � troff-like � est install�.
Si vous voyez clignoter \255 ou <AD> au lieu de traits d'union, mettez � LESSCHARSET=latin1 � dans votre environnement.

ASTUCES

Si vous ajoutez la ligne


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

� votre fichier .emacs, vous obtiendrez la page de manuel de l'appel de la biblioth�que situ� � la position courante du curseur lorsque vous presserez la touche F1.

Pour obtenir une version texte seul d'une page de manuel, sans retour arri�re ni caract�re de soulignement, essayez


  # man foo | col -b > foo.mantxt

AUTEUR

John W. Eaton est l'auteur historique de man. Federico Lucifredi <flucifredi@acm.org> en assure aujourd'hui la maintenance.

VOIR AUSSI

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

TRADUCTION

Ce document est une traduction r�alis�e par Ren� Cougnenc en mai 1995 et mise � jour par Alain Portal <aportal@univ-montp2.fr> le 2 novembre 2005.

L'�quipe de traduction a fait le maximum pour r�aliser une adaptation fran�aise de qualit�. La version anglaise la plus � jour de ce document est toujours consultable via la commande : � LANG=en man 1 man �. N'h�sitez pas � signaler � l'auteur ou au traducteur, selon le cas, toute erreur dans cette page de manuel.