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.
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 :

>>-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) :

>>-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é :

>>-+--------------------------+--------------------------------><
+-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 :

>>-| 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 :

>>-| Fragment de syntaxe |-------------------------------------><
Fragment de syntaxe
|--1ER_OPERANDE--,--2E_OPERANDE--,--3E_OPERANDE-----------------|