IBM Tivoli NetView for z/OS Programming: Pipes - IBM notice

xvi Programming: Pipes
Symbols
The following symbols are used in syntax diagrams:
►► Marks the beginning of the command syntax.
► Indicates that the command syntax is continued.
| Marks the beginning and end of a fragment or part of the command
syntax.
►◄ Marks the end of the command syntax.
Parameters
The following types of parameters are used in syntax diagrams:
Required Required parameters are shown on the main path.
Optional Optional parameters are shown below the main path.
Default Default parameters are shown above the main path. In parameter
descriptions, default parameters are underlined.
Syntax diagrams do not rely on highlighting, brackets, or braces. In syntax
diagrams, the position of the elements relative to the main syntax line indicates
whether an element is required, optional, or the default value.
Parameters are classified as keywords or variables. Keywords are shown in
uppercase letters. Variables, which represent names or values that you supply, are
shown in lowercase letters and are either italicized or, in NetView help and
BookManager publications, displayed in a differentiating color.
In the following example, the USER command is a keyword, the user_id parameter
is a required variable, and the password parameter is an optional variable.
►► USER user_id
password
Punctuation and parentheses
You must include all punctuation that is shown in the syntax diagram, such as
colons, semicolons, commas, minus signs, and both single and double quotation
marks.
When an operand can have more than one value, the values are typically enclosed
in parentheses and separated by commas. For a single value, the parentheses
typically can be omitted. For more information, see “Multiple operands or values”
on page xviii.
If a command requires positional commas to separate keywords and variables, the
commas are shown before the keywords or variables.
When examples of commands are shown, commas are also used to indicate the
absence of a positional operand. For example, the second comma indicates that an
optional operand is not being used:
COMMAND_NAME opt_variable_1,,opt_variable_3
►◄