Les diagrammes de syntaxe décrivent la façon de saisir les commandes et les options disponibles.
Les rubriques de syntaxe utilisent différentes conventions pour indiquer les variables, les paramètres, les éléments obligatoires et les éléments facultatifs. Saisissez toutes les commandes sur une seule ligne, même si la commande ou l'exemple de syntaxe déborde sur la ligne suivante.
nom_de_commande -option_1 variable_1 [-option_2 variable_2]
[-option_3 variable_3 | -option_4]
où :
- nom_de_commande
- Le nom_de_commande ne peut être omis.
- -option_1
- Le paramètre -option_1 ne peut être omis.
- variable_1
- La valeur de variable_1 du paramètre -option_1 ne peut être omise.
- [-option_2 variable_2]
- Les crochets [] indiquent les éléments facultatifs. Le paramètre -option_2 et sa valeur sont facultatifs.
- -option_3 variable_3 |
-option_4
- Une barre verticale indique un choix entre plusieurs paramètres. Utilisez le paramètre -option_3 avec sa valeur, ou le paramètre -option_4.
Dans cet exemple, les deux paramètres sont facultatifs. Vous pouvez utiliser soit l'un, soit l'autre.