Command and parameter formats and conventions
For each command that is described, the following items of information are provided, if applicable:
- Command
- Identifies the name of the command and lists the command parameters.
- Description
- Briefly explains what the command does when it is invoked.
- Input Parameters
- Describes each parameter in the command and identifies the values that can be specified.
- Result
- Specifies the information, if any, which is displayed on the screen as a result of running the command.
- Examples
- Provides one or more examples of invoking the command.
- Use
- Identifies limitations and recommendations that determine where and when the command can be invoked.
- Related Topics
- Identifies other commands that may be related in some way to the current command.
Note the following conventions in the definition of the command parameters:
- Underline ( ___ ) indicates mandatory parameters.
- Square brackets ( [ ] ) indicate an optional parameter sequence. If a parameter sequence is omitted, one or more default values may be used.
- Braces ( { } ) group multiple parameters together.
- A vertical bar ( | ) indicates that only one of the parameters in the list can be selected. When one or more vertical bars appear in a list of parameters that is enclosed by square brackets ( [ ] ), the choices are limited to the parameters in the list, but you have the option to not specify any of the parameter sequences.
- Ellipsis ( ... ) mean that a parameter or option can be repeated more than once.