Metasyntax
The table below lists the metasyntax and notational conventions used throughout this manual:
Representation |
Meaning |
Example |
UPPERCASE |
Uppercase letters denote constants (names of calls, statements, field names, commands and operands etc.) that are to be entered in this format. |
|
lowercase letters |
In syntax diagrams and operand descriptions, lowercase letters are used to denote place-holders for the operand values. |
|
lowercase letters in |
In running text, variables and the names of data structures and fields are indicated by lowercase letters in italics. |
utm-installationpath is the UTM installation directory |
|
Typewriter font (Courier) is used in running text to identify commands, file names, messages and examples that must be entered in exactly this form or which always have exactly this name or form. |
The call |
{ } and | |
Curly brackets contain alternative entries, of which you must choose one. The individual alternatives are separated within the curly brackets by pipe characters. |
|
[ ] |
Square brackets contain optional entries that can also be omitted. |
|
( ) |
Where a list of parameters can be specified for an operand, the individual parameters are to be listed in parentheses and separated by commas. If only one parameter is actually specified, you can omit the parentheses. |
|
Underscoring |
Underscoring denotes the default value. |
|
abbreviated form |
The standard abbreviated form of statements, operands and operand values is emphasized in boldface type. The abbreviated form can be entered in place of the full designation. |
|
. . . |
An ellipsis indicates that a syntactical unit can be repeated. It can also be used to indicate sections of a program or syntax description etc. |
|
Symbols
Indicates references to comprehensive, detailed information on the relevant topic.
Indicates notes that are of particular importance.
Indicates warnings.
Other
utmpath |
On Unix, Linux and Windows systems, designates the directory under which openUTM was installed. |
filebase |
On Unix, Linux and Windows systems, designates the directory of the UTM application. This is the base name generated in the KDCDEF statement MAX KDCFILE=. |
$userid |
On BS2000 systems, designates the user ID under which openUTM was installed. |
upic_dir |
The directory under which UPIC Client for UPIC Carrier System is installed on Unix, Linux, or Windows system. |