OpenTP1 Version 7 TP1/Client User's Guide TP1/Client/J

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

5.1.2 Rules for definitions

This section explains the conventions used to explain the definitions.

The syntax, attribute, and element symbols explained here are not actually specified in the definitions.

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

(1) Syntax symbols

The syntax symbols are used to explain the syntax.

Symbol Convention
[ ] Square brackets enclose an item or set of items whose specification is optional.

Example: host-name[:port-number]
Either host-name or host-name:port-number must be specified.
| Only one of the options separated by a vertical bar can be specified at the same time.

Example: dcnamuse=Y|N
Either dcnamuse=Y or dcnamuse=N can be specified.
... An ellipsis (...) indicates that the item or items immediately preceding the ellipsis may be specified as many times as necessary.

Example: host-name[:port-number][,host-name[:port-number],...]
host-name[:port-number] can be specified as many times as necessary.

(2) Attribute symbols

The attribute symbols are used to explain the attributes of user-specified values, such as a value range.

Attribute symbol Convention
~ This symbol is followed by the attribute of a user-specified value.
<< >> Double diamond brackets enclose the default value.
< > Single diamond brackets enclose the element symbol for a user-specified value.
(( )) Double parentheses enclose the permitted range of a user-specified value.

(3) Element symbols

The element symbols are used to explain the type of a user-specified value.

Element symbol Convention
<alphabetic> Alphabetic characters (A-Z, a-z) and underscore (_)
<alphanumeric> Alphabetic and numeric characters (0-9)
<alphabetic symbol> Alphabetic characters (A-Z, a-z), #, @, and \
<unsigned integer> Numeric characters (0-9)
<unsigned hexadecimal integer> Numeric characters (0-9), A-F, a-f
<symbolic name> String of alphabetic symbols and numeric characters (beginning with an alphabetic symbol)
<character string> String of any characters
<path name> Symbolic name, /, and . (period)
(The path name depends on the operating system being used.)