CA-GSS Statements and Commands › Notation Conventions

Notation Conventions

This section explains the general notation conventions used in syntax for the CA‑GSS services. Conventions specific to a service are explained in the section discussing that service.

These general conventions are used in syntax:

• When parameters are optional, they are enclosed in brackets:

  [parameter]
  

• When a parameter is required but may take one of several predefined values, your choices are enclosed in braces:

  {value1|value2}
  

• Multiple choices sometimes appear on one line and are separated by a vertical bar (as shown above). When your choices are more complex, they appear stacked on top of one another.
• When the entire command syntax will not fit on one line, the syntax is continued on a second line that is indented two spaces. Likewise, if the command syntax carries over onto a third line, the third line of syntax is indented an additional two spaces, and so on.

Example

Assume there is a batch maintenance command called GO, and this is its syntax diagram:

GO BY {CAR|TRAIN} {TO WORK AT time}             [WITH name]
                  {OUT FOR DINNER TO restaurant}
                  {OVER THE BRIDGE}
 [BECAUSE reason] BEFORE DOING action [AND THEN PHONE HOME]
                               [OR JUST STAY WHERE YOU ARE]

This syntax diagram indicates the following things about the GO command:

• You must specify the BY parameter, and you must give it a value of either CAR or TRAIN.
• You must specify one of the following: TO WORK AT time, OUT FOR DINNER TO restaurant, or OVER THE BRIDGE.
• You may include the WITH parameter and a value for name.
• You may include the BECAUSE parameter and a value for reason.
• You must include the BEFORE DOING parameter and a value for action.
• You may include one of the following: AND THEN PHONE HOME or OR JUST STAY WHERE YOU ARE.