Le système d'exploitation GNU-Linux/L'aide en ligne man



Chaque commande dispose d'une page de manuel en ligne (appelée manpages).

Cette aide en ligne est très utile pour savoir comment utiliser les commandes et connaître la liste exhaustive de toutes les options disponibles.

Pour accéder à cette aide en ligne, il suffit de taper man <le_sujet>. Le sujet peut être le nom d'une commande (section 1) :

 $ man ls

Il peut être un nom de fonction C (section 2 ou section 3) :

 $ man 3 printf

L'exemple précédent donne explicitement le numéro de section où chercher le sujet pour éviter la confusion avec la commande shell printf (section 1).

Les pages de manuel sont réparties en section. Pour connaître l'ensemble des sections, il suffit de consulter la page de manuel de la commande man :

 $ man man
 ...
 1  Programmes exécutables ou commandes de l’interpréteur de  commandes (shell)
 2  Appels système (Fonctions fournies par le noyau)
 3  Appels  de  bibliothèque  (fonctions  fournies  par  les  bibliothèques des programmes)
 4  Fichiers spéciaux (situés généralement dans /dev)
 5  Formats des fichiers et conventions. Par exemple /etc/passwd
 6  Jeux
 7  Divers (y compris les macropaquets et les conventions). Par exemple, man(7), groff(7)
 8  Commandes  de  gestion  du  système (généralement réservées au  superutilisateur) 
 9  Sous-programmes du noyau [hors standard]

Certaines commandes sont à la fois des commandes systèmes, des appels systèmes ou des fichiers de configuration (exemple : passwd). Il est possible d'indiquer la section que l'on désire consulter :

 $ man passwd             # la page de man de la commande passwd
 $ man 5 passwd           # la page de man du fichier de configuration /etc/passwd

Les pages de man sont découpées en différents chapitres (extrait de man 7 man) :

Les chapitres des pages de man
Chapitre Descriptif
SYNOPSIS Indique brièvement l'interface de la commande ou de la fonction. Pour les commandes, ce paragraphe montre sa syntaxe et ses arguments. Les caractères gras marquent le texte invariable et l'italique indique les arguments remplaçables. Les crochets encadrent les arguments optionnels, les barres verticales (caractère pipe) séparent les alternatives, et les ellipses ... signalent les répétitions. Pour les fonctions, on trouve toutes les déclarations et directives #include, suivies de la déclaration de fonction.
DESCRIPTION Fournit une explication sur ce que la commande, la fonction ou le format représente. Décrit les interactions avec les fichiers et l'entrée standard, ou ce qui est produit sur la sortie standard ou d'erreur. Ne contient pas les détails d'implémentation internes, sauf s'ils sont critique pour comprendre l'interface. Décrit le cas principal, pour les détails sur les options, on utilise le paragraphe OPTIONS. S'il y a une sorte de grammaire d'entrée, ou un jeu de sous-commandes, on peut les placer dans une section UTILISATION supplémentaire (et placer un bref aperçu dans la section DESCRIPTION).
RETURN VALUE (VALEUR RENVOYÉE) Donne une liste des valeurs qu'une routine de bibliothèque renverra à l'appelant et les conditions qui provoquent ces retours.
EXIT STATUS (CODE DE RETOUR) Indique les codes de retour d'un programme et les conditions associées.
OPTIONS Décrit les options acceptées par le programme et leur influence sur son son comportement.
USAGE (UITILISATION) Décrit la grammaire de tout sous-langage implémenté.
EXAMPLES (EXEMPLES) Donne un ou plusieurs exemples d'utilisation de la fonction, du fichier ou de la commande.
FILES (FICHIERS) Liste les fichiers utilisés par le programme ou la fonction, tels que fichiers de configuration, de démarrage, et les fichiers manipulés directement par le programme. Il faut donner le chemin d'accès complet des fichiers et utiliser le mécanisme d'installation pour modifier le préfixe. Pour la plupart des programmes, l'installation par défaut se fait dans /usr/local, aussi, votre page de manuel de base devrait utiliser /usr/local comme base.
ENVIRONMENT (ENVIRONNEMENT) Décrit toutes les variables d'environnement qui affectent le programme ou la fonction, ainsi que leurs effets.
DIAGNOSTICS (DIAGNOSTIQUE) Fournit un survol des messages d'erreurs usuels et comment les considérer. Il n'est pas nécessaire d'indiquer les messages d'erreur système ou les signaux fatals qui peuvent apparaître durant l'exécution du programme, sauf s'ils sont traités spécialement.
SECURITY (SECURITÉ) Décrit les problèmes de sécurité et leurs implications. Doit contenir les avertissements à propos des configurations ou des environnements à éviter, les commandes ayant des répercussions au niveau sécurité, etc. surtout s'ils ne sont pas évidents. Il n'est pas obligatoire de faire un paragraphe spécifique sur la sécurité. Si l'intelligibilité est améliorée, on peut placer ces informations dans les autres sections (telles que DESCRIPTION ou USAGE (UTILISATION)). Néanmoins, il est important de placer les informations de sécurité quelque part.
CONFORMING TO (CONFORMITÉ) Décrit les standards ou les conventions suivis par l'implémentation.
NOTES Contient des notes diverses.
BUGS (BOGUES) Liste les limitations ou les défauts recensés, ainsi que les sujets à débat.
AUTHOR (AUTEUR) Liste les auteurs de la documentation ou du programme afin de pouvoir leur envoyer les rapports de bogue.
SEE ALSO (VOIR AUSSI) Fournit une liste des pages de manuel ayant un rapport, dans l'ordre alphabétique, suivies des autres documents éventuels. Il s'agit d'habitude de la dernière section.

Recherche par mot-cléModifier

Si le sujet exact n'est pas déterminé, l'option -k permet une recherche par mot-clé :

man -k <mot_cle>

Commandes interactivesModifier

Une fois la commande man entrée, si le sujet est trouvé, la console présente la documentation page par page avec une interface similaire à la commande less ou more : l'appui d'une touche déclenche une commande immédiate.

NavigationModifier

Les terminaux récents permettent l'utilisation des touches de navigation : flèches, page suivante, page précédente...

  • Défilement par lignes :
Ligne suivante : ou
Ligne précédente :
  • Défilement par pages :
Page suivante :   ou
Page précédente : B (back) ou
  • Début / fin du document :
Début du document G
Fin du document g

Recherche dans le texteModifier

/ puis entrez le terme rechercher

L'écran défile directement sur la première occurrence trouvée ou bien affiche un message d'erreur. La commande met en valeur toutes les occurrences du terme.

Pour passer à l'occurrence suivante, il s'agit de la même commande mais sans entrer de terme à chercher : /

QuitterModifier

Pour quitter, appuyez la touche Q (quit). Le contenu de l'écran du terminal est restauré.