Lecture d'un diagramme de syntaxe

Le diagramme de syntaxe montre comment spécifier une commande afin que le système d'exploitation puisse interpréter correctement les informations que vous saisissez. Lisez le diagramme de syntaxe de gauche à droite et de haut en bas, en suivant la ligne horizontale (chemin principal).

Symboles

Les symboles suivants sont utilisés dans les diagrammes de syntaxe :
Symbole
Description
>>
Marque le début du diagramme de syntaxe.
>
Indique que le diagramme de syntaxe continue.
|
Marque le début et la fin d'un fragment ou d'une partie du diagramme de syntaxe.
><
Marque la fin du diagramme de syntaxe.

Opérandes

Les types d'opérande suivants sont utilisés dans les diagrammes de syntaxe :
Les opérandes sont classés sous forme de mots clés ou de variables :
  • Les mots clés sont des constantes qui doivent être fournies. Si le mot clé apparaît dans le diagramme de syntaxe à la fois en minuscules et en majuscules, la partie en majuscules représente son abréviation (par exemple, KEYword). Les mots clés ne sont pas sensibles à la casse. Vous pouvez les coder en majuscules ou en minuscules.
  • Les variables apparaissent en minuscules et en italiques, et représentent les noms ou les valeurs que vous indiquez. Par exemple, un nom de fichier est une variable. Les variables peuvent être sensibles à la casse.

Exemple de syntaxe

Dans l'exemple suivant, la commande USER est un mot clé. Le paramètre de variable requis est user_id et le paramètre de variable facultatif est password. Remplacez les paramètres de variable par vos propres valeurs :
Lire le diagrammeSauter le diagramme
>>-USER--user_id -+----------+---------------------------------><
                  '-password-'   

Caractères non alphanumériques et espaces

Si un diagramme contient un caractère non alphanumérique (tel que des parenthèses, des points, des virgules, des signes égal et des espaces), vous devez coder le caractère dans le cadre de la syntaxe. Dans cet exemple, vous devez coder OPERAND=(001 0.001) :
Lire le diagrammeSauter le diagramme
>>-OPERANDE--=--(--001 0.001--)--------------------------------><

Sélection de plusieurs opérandes

Une flèche vers la gauche dans un groupe d'opérandes signifie que plusieurs opérandes peuvent être sélectionnés ou qu'un seul opérande peut être répété :
Lire le diagrammeSauter le diagramme
>>-+--------------------------+--------------------------------><
   +-OPERANDE_REPRODUCTIBLE_1-+   
   +-OPERANDE_REPRODUCTIBLE_2-+   
   '-<------------------------'   

Longueur supérieure à une ligne

Si un diagramme contient plusieurs lignes, la première ligne se termine par une tête de flèche simple et la deuxième commence par une tête de flèche simple :
Lire le diagrammeSauter le diagramme
>>-| La longueur de la première ligne d'un diagramme de syntaxe dépasse la ligne |-->

>--| Continuation des sous-commandes et/ou paramètres |--------><

Fragments de syntaxe

Certains diagrammes peuvent contenir des fragments de syntaxe, qui servent à faire passer à la ligne les diagrammes trop longs, trop complexes ou trop répétitifs. Les noms de fragments de syntaxe apparaissent en casse mixte et s'affichent dans le diagramme et le titre du fragment. Le fragment est placé au-dessous du diagramme principal :
Lire le diagrammeSauter le diagramme
>>-| Fragment de syntaxe |-------------------------------------><

Fragment de syntaxe

|--1ER_OPERANDE--,--2E_OPERANDE--,--3E_OPERANDE-----------------|


Commentaires