There is a syntax convention for how parameters and values
are represented in the command syntax diagrams in the Teracloud®
Streams documentation.
Read the syntax diagrams from left to right and top to
bottom, following the path of the line.
Right chevrons and a
hyphen (>>-) indicate the beginning of a syntax diagram.
Hyphens
and a right chevron (-->) indicate that the syntax
is continued on the next line.
A right chevron and hyphens (>--)
indicate that the syntax is continued from the previous line.
Hyphens
followed by a right chevron and left chevron (--><)
indicate the end of a syntax diagram.
Syntax fragments start
with a vertical bar and hyphens (|--) and end with
hyphens and a vertical bar (--|).
Required
items appear on the horizontal line (the main path). For example:
Optional items appear below the main path.
For example:
If you can choose from two or more items,
they appear in a stack. If you must choose one of the items, one item
of the stack appears on the main path. For example:
If you can optionally choose one of the items, the
entire stack appears below the main path. For example:
If one of the items is the default value, it
appears above the main path. The other choices are shown below the
main path. For example:
An arrow that returns to the left, above the
main line, indicates that an item can be repeated. In the following
example, repeated items must be separated by one or more blanks:
If the repeat arrow contains a comma, you must
separate repeated items with a comma. For example:
A repeat arrow above a stack indicates that
you can make more than one choice from the stacked items, or repeat
a single choice.
Variables appear in italics (for example: iid).
They represent user-supplied names or values in the syntax.
If
punctuation marks, parentheses, arithmetic operators, or other such
symbols are included in the syntax diagram, you must enter them as
part of the syntax.
Sometimes a single variable represents a
larger fragment of the syntax. For example, in the following diagram,
the variable fragment-block represents the whole
syntax fragment that is labeled fragment-block:
