Syntax diagrams describe how you must enter commands and
what options are available.
The syntax topics uses several conventions to indicate
variable, parameters, required items, and optional items. Enter all
commands on a single line, even if the command or syntax examples
wrap to the next line.
command_name -option_1 variable_1 [-option_2 variable_2]
[-option_3 variable_3 | -option_4]
Where:
- command_name
- The command_name is required.
- -option_1
- The -option_1 parameter is a required parameter.
- variable_1
- The variable_1 value is a required variable
for the -option_1 parameter.
- [-option_2 variable_2]
- Square braces [] indicate optional items. The -option_2 parameter
with its value is optional.
- -option_3 variable_3 | -option_4
- A vertical bar indicates a choice of parameters. Use the -option_3 parameter
with its value, or use the -option_4 parameter.
In this example, both items are optional, and you can use only one
or the other.