Dans les distributions UNIX et Linux, les programmes de ligne de commande sont livrés avec leur propre documentation appelée pages de manuel ou pages de manuel.
Les pages de manuel sont généralement écrites par le développeur du programme correspondant. Généralement, les pages de manuel sont divisées en plusieurs sections.
Voici la liste de toutes les sections man disponibles. Chaque section a un numéro unique et ne contient qu'un type spécifique de pages de manuel. Par exemple, la section man numéro 3 ne contient que les pages de manuel des appels de bibliothèque.
- 1 - Programmes ou commandes exécutables
- 2 – Appels système (fonctions fournies par le noyau)
- 3 – Appels à la bibliothèque (fonctions fournies par la bibliothèque)
- 4 – Fichiers spéciaux
- 5 – Formats de fichiers et conventions (fichiers de configuration)
- 6 – Jeux
- 7 – Divers
- 8 - Commandes d'administration système
Syntaxe :
man <TOPICNAME>
1. Afficher la page de manuel d'une commande UNIX
Pour lire la page de manuel d'une commande UNIX, transmettez le nom de la commande comme argument à man. Ce qui suit affichera la page de manuel de la commande passwd.
$ man passwd
PASSWD(1) User Commands PASSWD(1)
NAME
passwd - change user password
... Certaines rubriques peuvent même avoir des pages de manuel dans plus d'une section. Dans un tel cas, la commande man affichera la page qui a le numéro de section le plus bas.
Dans cet exemple, la commande passwd comporte des pages de manuel dans plusieurs sections. Mais, par défaut, il affiche la page man de la section 1.
Le "PASSWD (1)" affiché dans la 1ère ligne de la sortie de la commande man indique qu'il affiche la page de manuel de la section 1. La sortie de la page de manuel affiche le nom de la commande, la syntaxe des commandes, la description de ce que fait la commande, options fournies par la commande, etc…
2. Afficher la page de manuel d'une section spécifique
Pour lire la page de manuel d'une section particulière, indiquez le numéro de section comme suit. La commande passwd a une page de manuel dans la section 1 et la section 5. Par défaut, si vous ne spécifiez pas le numéro de section, elle affichera la page de manuel de la section 1.
Pour afficher la page de manuel de la section 5, spécifiez le numéro de section comme indiqué ci-dessous.
$ man 5 passwd
Maintenant, il affichera la page de manuel du fichier de configuration /etc/passwd, puisque la section numéro 5 concerne les formats de fichiers et les conversions.
3. Lister les sections Man disponibles pour une commande
Vous pouvez également lister toutes les sections disponibles sur un sujet particulier en utilisant l'option -aw.
$ man -aw printf /usr/share/man/man1/printf.1.gz /usr/share/man/man3/printf.3.gz
D'après la sortie ci-dessus, nous pouvons savoir qu'il existe 2 manuels printf, un dans la section "Commandes" et un autre dans "Appels de bibliothèque". Ainsi, vous pouvez exécuter la commande man suivante pour afficher les deux pages de manuel.
$ man printf $ man 3 printf
4. Afficher toutes les pages de manuel d'une commande – Afficher toutes les sections
Pour afficher toutes les pages de manuel d'un sujet particulier, utilisez l'option "-a". Vous verrez d'abord la page de manuel portant le numéro le plus bas. Lorsque vous quittez cette page et appuyez sur "Entrée", la page de manuel suivante apparaît.
$ man -a printf
La commande ci-dessus affichera d'abord la page de manuel de la commande printf(1). Lorsque vous appuyez sur "q" et appuyez sur "Entrée", la page de manuel de la fonction de bibliothèque printf(3) s'affiche.
5. Afficher la page de manuel au format HTML dans un navigateur
Vous pouvez également afficher la page de manuel au format HTML en utilisant n'importe quel navigateur de votre choix en utilisant l'argument "-H". Cela ouvrira la page de manuel de la commande printf dans firefox en tant que page HTML.
$ export BROWSER=/usr/bin/firefox $ man -H printf
6. Modifier le téléavertisseur par défaut utilisé par Man Command
Par défaut, la commande man utilisera la variable d'environnement $PAGER pour identifier le pager à utiliser pour afficher la sortie. L'utilisateur peut changer le pager dans lequel il préfère voir la page de manuel en utilisant l'option "-P".
La commande suivante affichera la page de manuel en utilisant more command pager.
$ man -P more printf
7. Rechercher la page de manuel par rapport à la section NAME
Pour rechercher la page de manuel dans la section NAME, utilisez l'option "-f" comme indiqué ci-dessous.
$ man -f printf printf (3) - formatted output conversion printf (1) - format and print data
Cela équivaut à utiliser la commande whatis shell.
La commande ci-dessus recherche les noms de page de manuel et affiche la description du sujet donné si les noms de page de manuel correspondent au sujet donné. Vous pouvez également transmettre plusieurs sujets dans la même ligne de commande.
8. Rechercher la page de manuel par rapport à la section NAME et DESCRIPTION
Pour rechercher la page de manuel dans la section NAME &DESCRIPTION, utilisez l'option "-k". Cela équivaut à utiliser la commande shell "apropos".
$ man -k printf asprintf (3) - print to allocated string dprintf (3) - print to a file descriptor fprintf (3) - formatted output conversion fwprintf (3) - formatted wide-character output conversion printf (1) - format and print data printf (3) - formatted output conversion snprintf (3) - formatted output conversion sprintf (3) - formatted output conversion ... ...
La commande ci-dessus recherchera le mot-clé "printf" en tant qu'expression régulière et affichera toutes les pages de manuel correspondant au mot-clé.