Lecture d'un schéma de syntaxe

Le schéma de syntaxe explique comment indiquer une commande de sorte que le système d'exploitation puisse interpréter correctement les données que vous entrez. Lisez le schéma de syntaxe de gauche à droite et de haut en bas, suivant la ligne horizontale (chemin principal).

Symboles et ponctuation

Les symboles suivants sont utilisés dans les schémas de syntaxe :

Symbole
Description
>>
Marque le début de la syntaxe de la commande.
><
Marque la fin de la syntaxe de la commande.

Vous devez inclure tous les signes de ponctuation tels que le deux-points, le point d'interrogation et le signe moins, qui sont indiqués dans le schéma de syntaxe.

Paramètres

Les types de paramètres suivants sont utilisés dans les schémas de syntaxe :

Paramètre
Description
Obligatoire
Les paramètres obligatoires s'affichent dans le chemin principal.
Facultatif
Les paramètres facultatifs s'affichent sous le chemin principal.

Les paramètres sont classés par mots clés ou par variables. Les mots clés s'affichent en minuscules et peuvent être entrés en minuscules. Par exemple, un nom de commande est un mot clé. Les variables apparaissent en italique et représentent des noms ou des valeurs que vous indiquez.

Exemples de syntaxe

Dans l'exemple suivant, la commande de l'utilisateur correspond à un mot clé. La variable obligatoire est id_util et la variable facultative mot_de_passe. Remplacez les variables par vos propres valeurs.

Lire le diagrammeSauter le diagramme>>-user--id_util--+--------------+-----------------------------><
                  '-Mot de passe-'
 

Mots clés obligatoires : Les mots clés et les variables obligatoires apparaissent sur la ligne du chemin principal.

Lire le diagrammeSauter le diagramme>>-mot clé nécessaire------------------------------------------><
 

Vous devez codifier les mots clés et les valeurs obligatoires.

Choisissez un élément obligatoire dans une pile : Si vous devez effectuer votre choix parmi plusieurs mots clés ou variables obligatoires qui s'excluent, ceux-ci sont empilés verticalement dans l'ordre alphanumérique.

Lire le diagrammeSauter le diagramme>>-+-paramètre 1 nécessaire-+----------------------------------><
   '-paramètre 2 nécessaire-'
 

Valeurs facultatives : Les mots clés et les variables facultatifs apparaissent sous la ligne du chemin principal.

Lire le diagrammeSauter le diagramme>>-+---------+-------------------------------------------------><
   '-mot clé-'
 

Vous pouvez choisir de ne pas codifier les mots clés et les variables facultatifs.

Choisissez un mot clé facultatif dans une pile : Si vous devez effectuer votre choix parmi plusieurs mots clés ou variables facultatifs qui s'excluent, ceux-ci sont empilés verticalement dans l'ordre alphanumérique sous la ligne du chemin principal.

Lire le diagrammeSauter le diagramme>>-+-------------+---------------------------------------------><
   +-paramètre 1-+
   '-paramètre 2-'
 

PVariables : Un mot apparaissant intégralement en italique correspond à une variable. Lorsque la syntaxe comporte une variable, celle-ci doit être remplacée par un nom ou une valeur admise, comme cela est défini dans le texte.

Lire le diagrammeSauter le diagramme>>-variable----------------------------------------------------><
 

Caractères non alphanumériques : Si un schéma indique un caractère non alphanumérique (par exemple, deux-point, des guillemets ou le signe moins), ce dernier doit être codifié dans le cadre de la syntaxe. Dans cet exemple, vous devez codifier cluster:port.

Lire le diagrammeSauter le diagramme>>-cluster:port------------------------------------------------><