OpenTP1 Version 7 TP1/Client User's Guide TP1/Client/W, TP1/Client/P

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

7.1.2 Definition conventions

This subsection describes the symbols that are used for describing definitions.

The syntax symbols, attribute symbols, and syntax element symbols are not included in the actual definitions.

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

(1) Syntax symbols

The following table lists the symbols that describe the syntax.

Syntax symbol Meaning
[ ] The item between brackets can be omitted.

Example:
CLTRESDN [/U]
Specify CLTRESDN or CLTRESDN /U.
| One of the items separated by vertical bars can be selected.

Example:
DCCLTTREXPSP=Y|N
Specify DCCLTTREXPSP=Y or DCCLTTREXPSP=N.
... This symbol indicates a description is omitted. The item immediately before this symbol can be specified more than once consecutively.

Example:
host-name [:port-number][,host-name [:port-number],...]
"host-name[:port-name]" can be specified more than once consecutively.

(2) Attribute symbols

The following table lists the symbols that describe the range of user-specified values.

Attribute symbol Meaning
~ Attributes of the user-specified value are inserted after this symbol.
<< >> Default for the user-specified value
< > Syntax element symbol for the user-specified value
(( )) Specification range of the user-specified value

(3) Syntax element symbols

The following table lists the symbols that describe the contents of user-specified values.

Syntax element symbol Meaning
<alphabetic character> Alphabetic character (A to Z, a to z) and underscore (_)
<alphanumeric> Alphabetic characters and numbers (0 to 9)
<alphabetic character and symbol> Alphabetic characters (A to Z, a to z), #, @, and \
<unsigned integer> Numbers 0 to 9
<unsigned hexadecimal number> Numbers 0 to 9, A to F, a to f
<symbolic name> Alphabetic character or symbol and a number (the beginning character must be an alphabetic character or symbol)
<character string> Any character(s)
<path name> Symbolic name, /, and period (.)
(The path name depends on the operating system used.)