Installation et mise en œuvre du module Eclair

L'ensemble du man est organisé en sections numérotées de 1 à 9 pour les plus courantes :

1. commandes utilisateurs pouvant être exécutées quelque soit l'utilisateur

2. appels systèmes, c'est-à-dire les fonctions fournies par le noyau

3. fonctions des bibliothèques

4. périphériques, c'est-à-dire les fichiers spéciaux que l'on trouve dans le répertoire /dev

5. descriptions des formats de fichiers de configuration (comme par exemple /etc/passwd)

6. jeux

7. divers (macros, conventions particulières, ...)

8. outils d'administration exécutables uniquement par le super utilisateur (root)

9. autre section (spécifique à GNU/Linux) destinée à la documentation des services offerts par le noyau

Lorsque la documentation est interrogée à propos d'un terme présent dans plusieurs sections (ex : passwd, à la fois commande et fichier de configuration), si le numéro de section n'est pas précisé, c'est toujours la section de numérotation la moins élevée qui sera affichée.

Chaque page de man est structurée en paragraphes contenant des éléments particuliers.

Vérifier qu'il s'agit de la documentation attendue.

Exemple :

• CP(1)      Manuel de l'utilisateur Linux      CP(1)

documentation pour la commande cp, section 1

• PASSWD(5)      Manuel de l'administrateur Linux      PASSWD(5)

documentation pour le fichier passwd, section 5

comme son nom l'indique, il s'agit du nom de la commande ou du fichier ainsi que d'une description synthétique.

Exemple :

• NOM

        cp - Copier des fichiers.

Dans ce paragraphe, on retrouve la syntaxe d'une commande, c'est-à-dire l'ensemble des options et arguments disponibles.

Quelques précisions pour bien lire cette syntaxe : si à première vue elle peut paraître rébarbative, elle dit tout au sujet de la manipulation d'une commande.

Exemple :

• cp [options] fichier chemin

   Options GNU (forme courte) : [-abdfilprsuvxPR]

la commande cp accepte des options (introduites par un "-") et des arguments (sans "-").

Les éléments spécifiés entre crochets sont facultatifs pour le fonctionnement de la commande.

Au contraire, les éléments indiqués sans crochets sont obligatoires et, s'ils sont omis, provoqueront une erreur.

Lorsque les options sont indiquées dans les mêmes crochets, elles peuvent être combinées. Dans le cas contraire, elles sont incompatibles et devront être utilisées séparément.

Enfin les options peuvent être abrégées (ex : -f) ou complètes (ex : --force), la signification est la même et elle est développée dans le paragraphe description.

Cette section du man détaille la totalité des options et arguments d'une commande, ou les éléments d'un fichiers de configuration.

Dans ce paragraphe, vous trouverez une liste de fichiers intéressants à consulter, en complément d'information pour une commande ou un fichier de configuration.

(ou "See also")

Comme son nom l'indique, il s'agit d'une liste de commandes, fichiers, appels système... auquel on renvoie le lecteur pour compléter son information

Exemple :

• VOIR AUSSI

        passwd(1), login(1), group(5), shadow(5).

Cette page propose ici de consulter les commandes passwd et login dans la section 1 et les fichiers group et shadow dans la section 5 de la documentation.

ici sont spécifiées les variables d'environnement qu'il est possible de configurer pour le fonctionnement de la commande ou du fichier.