OpenTP1 Version 7 System Definition

[Contents][Index][Back][Next]

1.4.3 Explanation of symbols

The meaning of syntax description symbols, attribute symbols, and syntax symbols used to explain a definition are summarized in the following tables. Note that these symbols are not themselves used in the notation of a definition.

Organization of this subsection
(1) Syntax description symbols
(2) Attribute display symbols
(3) Syntax symbols

(1) Syntax description symbols

Syntax description symbols are symbols used to explain options and command arguments. The meaning of each symbol is shown in Table 1-5.

Table 1-5 Syntax description symbols

Syntax description symbol Meaning
[ ] An item enclosed by this symbol can be omitted.

Example: [prcsvpath path-name]
This indicates that prcsvpath path-name can be specified; or a specification can be omitted.

Example: [-c cid]
This indicates that cid becomes the value for the item specified as -c option; or a specification can be omitted.
... The item immediately preceding this symbol can be specified repeatedly.

Example: dcsvstart -u server-name [,server-name] ...
This indicates that several individual names can be notated as the service group name to be specified with dcsvstart command.

Example: -1 "1e1 1e2 . . . 1en"
This indicates that several character strings, each separated by a blank, can be specified as part of the -1 option.
{{ }} Multiple items enclosed within this symbol become one repeatable item.

Example: {{dcsvstart -u server-name [,server-name] ...}} can be specified as:
dcsvstart -u server-name [,server-name] ...
dcsvstart -u server-name [,server-name] ...
| One of the two values separated by the bar can be selected as the value for specification.

Example: set hold=Y | N
This indicates that Y or N can be specified.
_
(Underline)
The value underlined is the default if the said operand, option, or command argument is omitted.

Example: set type=other | MHP
This indicates that other is the assumed value if the type operand is omitted.

(2) Attribute display symbols

Attribute display symbols explain the range and other attributes which the user can specify for an operand. The meaning of each symbol is shown in Table 1-6.

Table 1-6 Attribute display symbols

Attribute display symbol Meaning
~ Specifiable attributes for the operand value follow this symbol.
<< >> Indicates the default if the operand is not specified.
< > Indicates the required syntax for the operand.
(( )) Indicates the specifiable range of operand values.

(3) Syntax symbols

Syntax symbols explain the nature of an operand value. The meaning of each symbol is explained in Table 1-7.

Table 1-7 Syntax symbols

Syntax symbol Meaning
Alphabetic Any letter of the alphabet from A-Z (uppercase) or a-z (lowercase) or the underscore '__'.
Alphabetic symbol Any letter of the alphabet (A-Z, a-z) and the following symbols: #, @, \, $, and %
Alphanumeric A combination of any alphabetic or any numeral from 0-9 inclusive.
Alphanumeric symbol A combination of any alphabetic symbol and numeral (0-9).
Unsigned integer A numeric (0-9) string.
Hexadecimal number A numeral (0-9) and (A-F, a-f)
Note that when lower case (a-f) and numeral (0-9) are used for hexadecimal numbers, upper case (A-F) cannot be included.
Identifier Alphanumeric string starting with an alphabetic.
Symbolic name Alphanumeric symbol string starting with an alphabetic symbol.
Character string A character array consisting of alphanumeric-symbol characters.
Path name '/' followed by symbolic name

Note
Path names depend on the operating system in use.