man - affiche les pages de manuel en ligne

man [-achw] [-C fichier] [-M chemin] [-m chemin] [-S sous-section] [-s section] [section] nom …
man -f commande …
man -k mot-clef …

L'utilitaire man affiche les pages de manuel dont le titre correspond au nom spécifié. Les pages peuvent être sélectionnées selon une catégorie (section) spécifique ou une architecture matérielle (sous-section).

Les options sont les suivantes :

• -a Affiche toutes les pages de manuel correspondant à une combinaison de section et de nom spécifiée. Normalement, seule la première page trouvée est affichée.

• -C fichier Utilise le fichier spécifié en lieu et place du fichier de configuration par défaut. Cela permet aux utilisateurs de configurer leur propre environnement de manuel. Voir man.conf(5) pour une description du contenu de ce fichier.

• -c Copie la page de manuel vers la sortie standard au lieu d'utiliser more(1) pour la paginer. C'est le comportement par défaut si la sortie standard n'est pas un périphérique de terminal.

• -f commande Synonyme de whatis(1). Recherche une commande donnée et renvoie la ligne d'en-tête de la page de manuel.

• -h N'affiche que les lignes “SYNOPSIS” de la page de manuel demandée.

• -k mot-clef Synonyme de apropos(1). Montre quelles pages de manuel contiennent n'importe lequel des mots-clefs donnés dans leur ligne de titre. Le mot-clef est insensible à la casse.

Par exemple, pour dresser la liste de toutes les pages man contenant le mot “mount” dans la ligne “NOM” de la page man :

                 $ man -k mount

Cela produirait une liste un peu comme celle-ci :

           amd (8) - automatically mount file systems
           amq (8) - automounter query tool
           domountroothooks (9) - run all mountroot hooks
           exports (5) - define remote mount points for NFS mount requests
           getfsstat (2) - get list of all mounted file systems
           getmntinfo (3) - get information about mounted file systems
           mount (8) - mount file systems
           mount, unmount (2) - mount or dismount a filesystem
           mount_cd9660 (8) - mount an ISO-9660 filesystem
           mount_ext2fs (8) - mount an ext2fs file system
           mount_ffs (8) - mount a Berkeley Fast File System
           mount_msdos (8) - mount an MS-DOS file system
           mount_nfs (8) - mount NFS file systems
           mount_ntfs (8) - mount an NTFS file system
           mount_portal (8) - mount the portal daemon
           mount_procfs (8) - mount the process file system
           mount_udf (8) - mount a UDF filesystem
           mount_xfs (8) - mount the xfs filesystem
           mountd (8) - service remote NFS mount requests
           ...

• -M chemin Écrase la liste des répertoires standards dans lesquels man cherche des pages de manuel. Le chemin fournit doit être une liste de répertoires séparés par des symboles deux-points (“:”). Ce chemin de recherche peut également être réglé en utilisant la variable d'environnement MANPATH. Les sous-répertoires dans lesquels chercher et l'ordre de recherche sont spécifiés dans la ligne “_subdir” du fichier de configuration de man.

• -m chemin Ajoute chemin à la liste des répertoires standards dans lesquels man recherche des pages de manuel. Le chemin spécifié doit être une liste de répertoires séparés par des symboles deux-points (“:”). Ces répertoires seront fouillés avant les répertoires standards ou les répertoires spécifiés en utilisant l'option -M ou la variable d'environnement MANPATH. Les sous-répertoires dans lesquels chercher et l'ordre de recherche sont spécifiés par la ligne “_subdir” du fichier de configuration de man.

• -S sous-section Restreint les répertoires dans lesquels man cherchera à ceux qui concernent une architecture matérielle spécifique. Par défaut, les pages de manuel de toutes les architectures sont installées, et cette options peut donc être utilisée pour voir les pages d'une architecture autre que celle utilisée.

Écrase la variable d'environnement MACHINE ; voir également la section ENVIRONNEMENT ci-dessous.

• [-s] section Restreint les répertoires dans lesquels man cherchera ceux qui concernent une section spécifique. Les sections actuellement disponibles sont :

                 1         Les commandes générales (outils et utilitaires).
                 2         Les appels système et les numéros d'erreur.
                 3         Les bibliothèques.
                 3f        Guide de référence du programmeur Fortran.
                 3p        Guide de référence du programmeur perl(1).
                 4         Les pilotes de périphérique.
                 5         Les formats de fichier.
                 6         Les jeux.
                 7         Divers.
                 8         Les commandes de maintenance du système.
                 9         Les documentations relatives au noyau.
                 X11       Alias de X11R6.
                 X11R6     Le système de gestion de fenêtres X Window System.
                 local     Les pages situées dans /usr/local.
                 n         Les commandes Tcl/Tk.

Le fichier de configuration de man, man.conf(5), spécifie les valeurs possibles pour les sections, et leur ordre de recherche. Des sections supplémentaires peuvent être spécifiées.

• -w Dresse la liste des chemins d'accès des pages de manuel que man afficherait pour la combinaison de section et de nom spécifiée.

Les directives des pages man d'OpenBSD peuvent être trouvées dans mdoc(7). Un tutoriel complet sur l'écriture de pages man figure dans mdoc.samples(7).

Comme certaines pages de manuel ne concernent que des architectures spécifiques, man cherche tout sous-répertoire portant le nom de l'architecture courante dans tous les répertoires où il recherche. Les zones spécifiques à une machine sont vérifiées avant les zones générales. Le type de machine courant peut être écrasé en fixant la variable d'environnement MACHINE au nom d'une architecture spécifique, ou en utilisant l'option -S.

Toute valeur différente de null dans la variable d'environnement MANPAGER sera utilisée en lieu et place du programme de pagination standard, more(1).

Le chemin de recherche standard utilisé par man peut être écrasé en spécifiant un chemin dans la variable d'environnement MANPATH. Le format du chemin est une liste de répertoires séparés par des symboles deux points (“:”). Les sous-répertoires dans lesquels chercher et l'ordre de recherche sont spécifiés par la ligne “_subdir” du fichier de configuration de man.

Spécifie le programme de pagination à utiliser lorsque la variable d'environnement MANPAGER n'est pas spécifiée.

/etc/man.conf fichier de configuration par défaut de man

apropos(1), intro(1), whatis(1), whereis(1), intro(2), intro(3), intro(4), intro(5), man.conf(5), intro(6), intro(7), mdoc(7), mdoc.samples(7), intro(8), intro(9)

L'utilitaire man se conforme à la spécification du standard IEEE Std 1003.1-2004 (“POSIX”).

Les drapeaux [-aCcfhMmSsw] sont des extensions de cette spécification.

Une commande man est apparue dans AT&T UNIX Version 3.

Les pages de manuel en ligne sont, par nécessité, obligées de passer par de stupides périphériques d'affichage, ce qui fait qu'un petit nombre d'entre elles ne sont pas aussi bien formatées que leurs homologues typographiées.

OpenBSD 4.4 27 Avril 2008 3