Lecture de diagrammes de syntaxe

Pour lire le diagramme de syntaxe d'entrée d'une commande, suivez le chemin de la ligne. Lisez de gauche à droite et de haut en bas.

  • Le symbole > > --- indique le début d'un diagramme de syntaxe.
  • Le symbole --- > à la fin d'une ligne indique que le diagramme de syntaxe se poursuit sur la ligne suivante.
  • Le symbole > --- au début d'une ligne indique qu'un diagramme de syntaxe se poursuit à partir de la ligne précédente.
  • Le symbole --- > < indique la fin d'un diagramme de syntaxe.

Noms de commande

Le nom de la commande peut être constitué d'un seul terme d'action, tel que HALT, ou d'un terme d'action et de l'objet correspondant à l'action, tel que DEFINE DOMAIN. Vous pouvez entrer la commande dans n'importe quelle colonne de la ligne de saisie.

Entrez le nom de commande complet ou l'abréviation spécifiée dans le diagramme de syntaxe pour la commande. Les lettres majuscules désignent l'abréviation la plus courte qui soit acceptable. Si une commande apparaît entièrement en majuscules, elle ne peut pas être abrégée. Vous pouvez entrer la commande en majuscules, en minuscules ou les deux. Dans l'exemple qui suit, vous pouvez saisir CMDNA, CMDNAM ou CMDNAME indifféremment en majuscules ou minuscules.
Lire le diagramme de syntaxeIgnorer le diagramme de syntaxe graphiqueCMDNAme
Remarque: les noms de commande dans le texte descriptif sont toujours en majuscules.

Paramètres obligatoires

Lorsqu'un paramètre est sur la même ligne que le nom de commande, il est obligatoire. Lorsqu'au moins deux valeurs de paramètre sont disposées en pile et que l'une d'elles est placée sur la ligne, vous devez impérativement en choisir une.

Dans cet exemple, vous devez entrer PARMNAME=A, PARMNAME=B ou PARMNAME=C. N'insérez aucun espace immédiatement avant ou après le signe égal (=).
Lire le diagramme de syntaxeIgnorer le diagramme de syntaxe graphiquePARMName= ABC

Paramètres facultatifs

Lorsqu'un paramètre est placé sous la ligne, il est facultatif. Dans cet exemple, vous pouvez entrer PARMNAME=A ou rien du tout. N'insérez aucun espace immédiatement avant ou après le signe égal (=).

Lire le diagramme de syntaxeIgnorer le diagramme de syntaxe graphiquePARMName=A
Lorsqu'au moins deux valeurs de paramètre sont disposées en pile sous la ligne, elles sont toutes facultatives. Dans cet exemple, vous pouvez entrer PARMNAME=A, PARMNAME=B, PARMNAME=C ou rien du tout. N'insérez aucun espace immédiatement avant ou après le signe égal (=).
Lire le diagramme de syntaxeIgnorer le diagramme de syntaxe graphiquePARMNAme=ABC

Valeurs par défaut

Les valeurs par défaut sont situées au-dessus de la ligne. Le système utilise la valeur par défaut, sauf si vous en indiquez une autre. Pour ce faire, vous pouvez entrer une option choisie dans la pile au-dessus de la ligne.

Dans cet exemple, PARMNAME=A est la valeur par défaut. Vous pouvez également entrer PARMNAME=A, PARMNAME=B ou PARMNAME=C. N'insérez aucun espace avant ou après le signe égal (=).
Lire le diagramme de syntaxeIgnorer le diagramme de syntaxe graphiquePARMNAme=APARMName=ABC

Variables

Les éléments en minuscules mises en évidence (comme ceci) désignent des variables. Dans ces exemples, nom_var représente les variables suivantes :
Lire le diagramme de syntaxeIgnorer le diagramme de syntaxe graphiqueCMDNAmenom_variable
Lire le diagramme de syntaxeIgnorer le diagramme de syntaxe graphiquePARMname=nom_variable

Caractères spéciaux

Vous devez entrer les symboles tels qu'ils apparaissent dans le diagramme de syntaxe.

*
Astérisque
:
Deux-points
,
Virgule
=
Signe égal
-
trait d'union
( )
Parenthèses
.
Période

Valeurs de répétition

Une flèche orientée vers la gauche signifie que l'élément peut être répété. Lorsqu'un signe est placé sur la flèche, vous devez l'utiliser pour séparer les différentes occurrences de cet élément.

Lire le diagramme de syntaxeIgnorer le diagramme de syntaxe graphique,file_name

Options réitérables

Une pile de valeurs suivie d'une flèche orientée vers la gauche signifie que vous pouvez sélectionner plusieurs valeurs, ou le cas échéant, répéter un seul et même élément. Dans l'exemple qui suit, vous pouvez choisir plusieurs valeurs, en séparant leurs noms par une virgule. N'insérez aucun espace avant ou après le signe égal (=).
Lire le diagramme de syntaxeIgnorer le diagramme de syntaxe graphiquePARMNAme= ,value1value2value3

Pied de page

Les pieds de page sont placés entre parenthèses.

Lire le diagramme de syntaxeIgnorer le diagramme de syntaxe graphique,1file_name
Remarques :
  • 1 Vous pouvez spécifier jusqu'à cinq noms de fichier.

Saisie des paramètres

L'ordre dans lequel les paramètres doivent être saisis peut être important. L'exemple suivant affiche une partie de la commande permettant de définir un pool de stockage de copie :

Lire le diagramme de syntaxeIgnorer le diagramme de syntaxe graphiqueDEFine STGpoolPool_Namenom_classe_unité POoltype=COpyDESCription=descriptionREClaim=100REClaim=pourcentage

Les deux premiers paramètres de cette commande (nom_pool et nom_classe_unité sont obligatoires. pool_name et device_class_name sont également positionnelles. En d'autres termes, ils doivent être entrés dans l'ordre indiqué, juste après le nom de la commande. Le paramètre POOLTYPE est un paramètre à mot clé obligatoire. DESCRIPTION et RECLAIMsont des paramètres de mot clé facultatifs. Les paramètres à mot clé sont ceux qui comportent un signe égal correspondant à une valeur ou à une variable spécifique. Ils doivent être placés après n'importe quel paramètre positionnel dans une commande.

Les entrées de commande suivantes dans lequel les paramètres à mot clé sont ordonnés différemment sont admises :

define stgpool mycopypool mydeviceclass pooltype=copy description=engineering
   reclaim=50
define stgpool mycopypool mydeviceclass description=engineering pooltype=copy
   reclaim=50

L'exemple suivant, dans lequel l'un des paramètres positionnels est placé après un paramètre à mot clé, n'est pas admis :

define stgpool mycopypool pooltype=copy mydeviceclass description=engineering  
   reclaim=50

Fragments de syntaxe

En raison de leur longueur, certains diagrammes doivent afficher leur syntaxe par fragment. Le nom du fragment est indiqué entre deux barres verticales.

Le fragment développé figure après tous les autres paramètres ou au bas du diagramme. Il est identifié par un en-tête indiquant son nom. Les commandes qui figurent directement sur la ligne sont obligatoires.

Dans cet exemple, le fragment est appelé Fragment.
Lire le diagramme de syntaxeIgnorer le diagramme de syntaxe graphiqueFragment
Fragment
Lire le diagramme de syntaxeIgnorer le diagramme de syntaxe graphiqueABC