Conventions Used in the Syntax Graphs
- Last UpdatedOct 28, 2024
- 2 minute read
The commands described in this chapter are presented in the form of syntax graphs.
Commands are shown in a combination of uppercase and lowercase letters, where the capital letters indicate the minimum abbreviation.
Note:
This convention does not mean that the second part of the command must be typed in
lowercase letters; commands may be entered in any combination of uppercase and lowercase
letters.
For example, the command
Query
can be input in any of the following forms:
Q
QU
QUE
QUER
QUERY
-
Commands shown in all uppercase letters cannot be abbreviated.
-
Command arguments are shown in lowercase italic letters. For example:
PASSWORD password
means that to set a password to secret, you enter:
PASSWORD /SECRET
Command arguments are just descriptions of what you need to enter, and the description shown should be replaced by the text or value required. The following table shows some examples:
|
Name |
Definition |
Example |
|
name |
An element name |
PIPE-A63 |
|
refno |
A reference number |
=23/1403 |
|
integer |
A positive integer |
3 |
|
value |
A positive or negative number |
3.142 |
|
word |
A sequence of up to 4 letters |
FLOW |
|
text |
An alphanumeric string |
‘Enclose in quotes’ |
|
filename |
The pathname of a file |
/c:\\testing |
|
Note: |
||
-
Syntax graphs are read from top left to bottom right. The start point is shown by >, and you can follow any path through the graph until the exit point, shown by >, is reached.
-
Points marked with a plus sign (+) are option junctions which allow you to input any one of the commands to the right of the junction. For example:
>----+--- ABC -----.
| |
|--- PQR -----|
| |
‘-------------+--->
means you can type in ABC or PQR or just press Enter to get the default option.
-
Points marked with an asterisk (*) are loop back junctions. Command options following these may be repeated as required.
For example:
.-----<-------.
/ |
>---*--- option1 ---|
| |
|--- option2 ---|
| |
‘--- option3 ---+--->
means that you can enter any combination of option1 and/or option2 and/or option3, where the options can be commands, other syntax diagrams, or command arguments.
-
The simplified format:
.----<------.
/ |
>---*--- name ----+--->
means that you may type in a list of names, separated by at least one space.