Ceci est une ancienne révision du document !
Le manuel
man1) est une commande UNIX permettant d'accéder aux pages de manuel installées sur le système.
La plupart des programmes fournissent une page de manuel les documentant, lisible donc avec la commande man
.
Installation
Aucune installation n'est nécessaire, man est installé par défaut sous Ubuntu (toutes versions). Vous pouvez cependant ajouter des pages de manuel supplémentaires.
Pages de manuel supplémentaires
- manpages-fr : Version française des pages de manuel sur l'utilisation de GNU/Linux
- manpages-fr-extra : Version française des pages de manuel des programmes
- manpages : Pages de manuel (en anglais) sur l'utilisation de GNU/Linux
- manpages-posix : Pages de manuel (en anglais) sur l'utilisation des systèmes POSIX
Pour le développeur
- manpages-fr-dev : Version française des pages de manuel pour les développeurs
- manpages-dev : Pages de manuel (en anglais) pour les développeurs
- manpages-posix-dev : Pages de manuel (en anglais) sur l'utilisation des systèmes POSIX pour les développeurs
Autres
- funny-manpages : Pages de manuel humoristiques (en anglais)
Utilisation
man
s'utilise dans un terminal de la façon suivante :
man nom-de-la-page
Par exemple, pour obtenir le manuel de la commande man
, l'on fera :
man man
Les sections
Les pages de manuel sont réparties dans des sections distinctes :
- Programmes exécutables ou commandes de l'interpréteur de commandes (shell) ;
- Appels système (Fonctions fournies par le noyau) ;
- Appels de bibliothèque (fonctions fournies par des bibliothèques) ;
- Fichiers spéciaux (situés généralement dans /dev) ;
- Formats des fichiers et conventions (Par exemple
/etc/passwd
) ; - Jeux ;
- Divers (y compris les macropaquets et les conventions). Par exemple, man(7), groff(7) ;
- Commandes de gestion du système (généralement réservées au superutilisateur) ;
- Interface du noyau Linux.
Les numéros de sections sont souvent spécifiés entre parenthèses après le nom de la page, comme ci-dessus.
Il arrive (rarement) que deux pages de manuel aient le même nom mais soient dans des sections différentes ; c'est le cas de man(1) et man(7) ou de printf(1) et printf(3) par exemple. Il est donc possible de spécifier dans quelle section chercher la page de manuel, en indiquant son numéro juste avant le nom de la page ou en spécifiant le paramètre -s
(voir ci-dessous). Par exemple, pour obtenir la page de manuel de man(7) (qui parle de la syntaxe des pages de manuel), l'on fera :
man 7 man
Chaque section possède de plus une page appelée intro
qui présente la section, accessible comme les autres pages de manuel. Pour lire l'introduction de la section 3, il suffit donc de saisir :
man 3 intro
Options utiles
- -s SECTION : permet de spécifier la ou les sections où chercher, dans l'ordre, les pages de manuel. SECTION est un numéro de section ou une liste de numéros de sections séparées par des virgules.
Exemple :man -s 3 printf
Consulter les pages de manuel dans une interface graphique
Sous GNOME (Ubuntu)
L'aide de GNOME permet de parcourir la documentation du système, dont les pages de manuel. Pour ce faire, ouvrez l'aide via Système → Aide de cliquez sur « Pages de manuel » dans la colonne de gauche.
Vous pouvez aussi simplement effectuer une recherche dans toute la documentation en allant dans le menu Édition → Rechercher.
Sous KDE (Kubuntu)
Consulter les pages de manuel sur internet
La plupart des pages de manuel sont aussi disponibles en ligne, sur divers sites dont voici une liste non exhaustive :