Format d'une page du manuel

Une page de manuel contient en général les 11 parties suivantes :

• NAME
• SYNOPSYS (Syntaxe)
• HARDWARE DEPENDENCIES
• EXAMPLES
• FILES
• RETURN VALUE
• SEE ALSO
• DIAGNOSTICS
• BUGS
• WARNINGS
• AUTHOR

Chacun de ces paragraphes décrit les points suivants :

NAME

Contient le nom de la commande ainsi qu'une description succincte. Le texte de cette section est utilisé pour générer l'index général.

SYNOPSYS

Indique comment la commande est libellée. Affiche en gras les caractères tels qu'ils doivent être exactement frappés au terminal. Les termes entre crochets (« [] ») sont optionnels. Les champs réguliers peuvent être remplis par des textes appropriés. Les parenthèses sont utilisées pour montrer que l'argument précédent peut être répété. S'il y a doute sur la description de SYNOPSYS, lisez DESCRIPTION.

DESCRIPTION

Contient une description détaillée de ce que fait la commande.

HARDWARE DEPENDENCIES

Signale les variantes d'exploitation selon le matériel.

EXAMPLES

Certaines pages du manuel ont des exemples pas toujours limpides mais qui peuvent aider à mieux comprendre la commande.

FILES

Tous les fichiers spéciaux que la commande utilise.

RETURN VALUE

Décrit les valeurs en retour d'un appel programme.

SEE ALSO

Renvoie à d'autres pages du manuel ou à une autre documentation pour de plus amples renseignements.

DIAGNOSTICS

Si la commande fait ressortir des messages d'erreurs, ils sont explicités ici (en général !!!).

BUGS

Décrit les bugs (eh oui). Souvent utilisé pour vous prévenir des problèmes potentiels dans l'utilisation de cette commande.

WARNINGS

idem que BUGS.