Conventions typographiques

Ce document utilise les conventions typographiques suivantes :

%, $ ou #: Un signe de pourcentage représente l'invite système de shell C. Un signe dollar représente l'invite système des shells Bourne, Korn et POSIX. Un signe dièse représente l'invite de superutilisateur.
audit(5): Page de manuel. Le nom de la page de manuel est audit, et elle se trouve dans la Section 5.
Commande: Un nom de commande ou une phrase de commande qualifiée.
Sortie d'ordinateur: Texte affiché par l’ordinateur.
Ctrl+x: Séquence de touches. Une séquence telle que Ctrl+x indique que vous devez maintenir enfoncée la touche Ctrl tout en appuyant sur une autre touche ou un bouton de la souris.
Titre de document: Le titre d'un document. Sur le Web et sur le support Instant Information, il peut s’agir d’un lien vers le document proprement dit.
VARIABLE ENVIRONNEMENT: Nom d'une variable d'environnement, par exemple PATH.
NOM ERREUR: Nom d'une erreur, généralement retournée dans la variable errno.
Touche: Nom d'une touche du clavier. Retour et Entrée désignent la même touche.
Terme: Utilisation définie d'un mot ou d'une phrase important.
Entrée utilisateur: Commandes et texte que vous saisissez.
Variable: Nom d'un espace réservé dans une commande, fonction ou autre affichage de syntaxe que vous devez remplacer par une valeur réelle.
[]: Le contenu est facultatif dans la syntaxe. Si le contenu apparaît sous la forme d’une liste comportant des séparateurs |, vous devez choisir un des éléments.
{}: Le contenu est obligatoire dans la syntaxe. Si le contenu apparaît sous la forme d'une liste comportant des séparateurs |, vous devez choisir un des éléments.
...: L’élément précédent peut être répété à un nombre arbitraire de reprises.
|: Sépare les éléments d’une liste de choix.
AVERTISSEMENT: Un avertissement indique des informations importantes qui, si elles ne sont pas comprises ou respectées, provoqueront des blessures personnelles ou des problèmes système irrécupérables.
ATTENTION: Une attention indique des informations importantes qui, si elles ne sont pas comprises ou respectées, provoqueront des pertes de données, un endommagement des données ou des dommages matériels ou logiciels.
IMPORTANT: Cette alerte fournit des informations essentielles expliquant un concept ou l'exécution d'une tâche.
REMARQUE: Une remarque contient des informations supplémentaires destinées à souligner ou compléter des points importants du texte principal.

Exemples et shells

Ce document décrit les pratiques utilisées par l'administrateur système. L'utilisateur root (superutilisateur) devant utiliser le shell POSIX /sbin/sh, tous les exemples de commande utilisent ce shell. Le shell POSIX est défini dans sh-posix(1). Pour plus d'informations sur d'autres shells, consultez le document Shells User’s Guide et sh(1).

Syntaxe de commande

Littéral: Mot ou caractère que vous entrez littéralement.
Élément remplaçable: Mot ou phrase que vous remplacez par une valeur appropriée.
-caracs: Une ou plusieurs options de commandes groupées, telles que -ikx. Les caracs sont souvent une chaîne de caractères littéraux représentant chacun une option spécifique. Par exemple, l'entrée -ikx équivaut aux options -i, -k et -x. Le caractère plus (+) est parfois utilisé comme préfixe d'option.
-mot: Option de commande unique, telle que -help. Le mot est un mot clé littéral. La différence par rapport à -caracs est en général évidente et clarifiée dans une description d'option. Le caractère plus (+) et le double tiret (--) sont parfois utilisés comme préfixes d'option.
[ ]: Les métacaractères entre crochets indiquent du contenu optionnel dans les descriptions de formats et de commandes.
{ }: Les métacaractères entre accolades indiquent du contenu obligatoire dans les descriptions de formats et de commandes.
|: La barre verticale sépare des alternatives dans une liste de choix, généralement entre crochets ou accolades.
. . .: Le métacaractère ellipse après un jeton (abc...) ou un crochet droit ([ ]...) ou une accolage droite ({ }...) indique que l'élément précédent et son espace précédent, le cas échéant, peuvent être répétés à un nombre arbitraire de reprises.
. . .: L'ellipse est parfois utilisée pour indiquer des éléments omis dans une plage.

Conventions typographiques

Documentation technique

» Table des matières

» Glossaire

» Index

Exemples et shells

Syntaxe de commande