Format des sections des pages de manuel

Les informations de référence suivantes décrivent le contenu de chaque section de page de manuel, les informations figurant dans chaque section ainsi que la mise en page standard utilisée pour l'ensemble des pages de manuel Oracle Solaris.

Description des sections des pages de manuel

Le tableau ci-dessous décrit chaque section de page de manuel ainsi que les informations référencées par chaque page de manuel.

Tableau 1-1 Description des sections des pages de manuel

Format des pages de manuel

Les pages de manuel utilisent un format standard comprenant toutes ou certaines des sous-sections suivantes. L'ordre des sous-sections indiqué ici correspond à l'ordre dans lequel les informations s'affichent dans chaque section des pages de manuel.

NAME

Fournit le nom de la commande, de la fonction de bibliothèque, du fichier ou du pilote de périphérique ainsi qu'une brève description des actions de l'élément concerné.

SYNOPSIS

Affiche la syntaxe de la commande, de la fonction de bibliothèque, du fichier ou du lecteur de périphérique.

DESCRIPTION

Définit la fonctionnalité et le comportement du service.

IOCTL

Utilisé pour une classe de périphériques donnée dont tous les périphériques se terminent par io, tels que mtio(7I). Cette section s'affiche sur les pages de la section 7 uniquement.

OPTIONS

Répertorie les options de commande et contient un résumé succinct de ce que fait chaque option.

OPERANDS

Répertorie les opérandes de commande et décrit la manière dont celles-ci influent sur les actions de la commande.

OUTPUT

Décrit la sortie, la sortie standard, l'erreur standard ou les fichiers de sortie qui sont générés par la commande, la fonction de bibliothèque, le fichier ou le pilote de périphérique.

RETURN VALUES

Répertorie les valeurs et décrit les conditions dans lesquelles elles sont renvoyées (s'applique uniquement aux pages de manuel décrivant des fonctions qui renvoient des valeurs).

ERRORS

Répertorie par ordre alphabétique tous les codes d'erreur qu'une bibliothèque de fonction peut générer et décrit les conditions ayant donné lieu à chaque erreur.

USAGE

Répertorie les règles spéciales, fonctionnalités et commandes qui nécessitent des explications détaillées.

EXAMPLES

Fournit des exemples de syntaxe ou d'utilisation d'une commande, d'une fonction de bibliothèque, d'un fichier ou d'un pilote de périphérique.

ENVIRONMENT VARIABLES

Répertorie toutes les variables d'environnement affectées par la commande, la fonction de bibliothèque, le fichier ou le pilote de périphérique, suivies d'une brève description de l'effet.

EXIT STATUS

Répertorie les valeurs que la commande renvoie au programme ou shell appelant et les conditions qui causent le retour de ces valeurs.

FILES

Répertorie les noms de tous les fichiers auxquels la page de manuel fait référence : fichiers intéressants et fichiers créés ou requis par les commandes.

ATTRIBUTES

Répertorie les caractéristiques de commandes, utilitaires et pilotes de périphériques en définissant le type d'attribut et la valeur correspondante. Reportez-vous à la page de manuel attributes(5).

SEE ALSO

Liste toute commande ou fonction de bibliothèque connexe.

DIAGNOSTICS

Répertorie les messages de diagnostic avec une explication succincte des conditions ayant entraîné l'erreur.

WARNINGS

Répertorie des avertissements à propos de conditions spéciales pouvant sérieusement affecter les conditions de travail. Il ne s'agit pas d'une liste de diagnostics.

NOTES

Répertorie les informations supplémentaires qui ne figurent nulle part ailleurs sur la page.

BUGS

Décrit les bogues connus et, dans la mesure du possible, propose une solution de contournement.