Message Conventions
Message specification syntax follows several conventions to convey what parameters are required or optional and how they and their values must be specified.
Table 5-1 Message Conventions
Symbol | Description |
---|---|
|
All code examples. |
monospace
|
Names of commands when provided outside of a code example. |
italics | Variable names when provided outside of a code example or value list. |
spaces | Spaces (for example, zero or more space characters, " ") may be inserted anywhere except within a single name or number. At least one space is required to separate adjacent names or numbers. |
… | Ellipses represent a variable number of repeated entries.
For example:
|
< > | Angle brackets are used to enclose parameter values that are
choices or names.
In the following example, the numbers represent specific value
choices.
In the following example,
ServerName represents the actual value.
In the following example, the numbers represent a choice in
the range from 0 to 3600.
|
[ ] | Square brackets are used to enclose an optional parameter
and its value.
A parameter and its value that are not enclosed in square brackets
are mandatory.
|
| | The pipe symbol is used in a parameter value list to
indicate a choice between available values.
|
, | A literal comma is used in the message to separate each parameter that is specified. |