Manuel
6. La documentation en ligne
- L'utilité des commandes
- La syntaxe et les options des commandes
- Le comment-faire, la prise en main des logiciels
On peut trouver cette documentation à plusieurs endroit, que ce soit par:
- Le manuel: la commande man
- Les fichiers info: la commande info
- Les HOWTO et documentation applicative: le répertoire /usr/share/doc/
Le manuel, la commande man
Pour accéder à une page du manuel:
man [commande]
man [option] [commande]
$ man ls
$ man man
$ man -S5 passwd
$ man -k mot-clef
Structure des documents de manuel (man)
| Section
|
Contenu
|
| 1
|
Commandes utilisateur
|
| 2
|
Appels système
|
| 3
|
Fonctions / librairies
|
| 4
|
Fichiers spéciaux et périphériques
|
| 5
|
Formats de fichiers et conventions
|
| 6
|
Jeux
|
| 7
|
Macros
|
| 8
|
Commandes d'administration système
|
| 9
|
Noyau (Kernel)
|
Présentation de l'information sur une page du manuel
Voici le schéma de présentation utilisé dans le manuel :
NAME
Nom de la commande.
SYNOPSIS
Sommaire de l'utilisation de la commande.
DESCRIPTION
Description détaillée de la commande.
OPTIONS
Explications de chacune des options de la commande.
ENVIRONMENT
Affiche les noms des variables d'environnement utilisées par la commande ainsi que les valeurs de celles-ci.
EXAMPLES
Présente des exemples.
FILES
Description des fichiers utilisés par la commande.
SEE ALSO
Propose des pages de référence sur des commandes connexes.
WARNINGS
Affiche des avertissements sur des utilisations pouvant causer des problèmes avec la commande.
DIAGNOSTICS
Explique la signification de messages de diagnostiques que la commande pourrait afficher.
BUGS
Cette partie de la page vous avertit des bogues connus de la commande.
