The parameters for a command might include mandatory values, optional values, or keyword choices. Parameters are order-dependent. Parameter Conventions describes the conventions this document uses to distinguish between value types.
Parameter Conventions
| Symbol | Example | Description |
|---|---|---|
| [] square brackets | [value] | Indicates an optional parameter. |
| italic font in a parameter . | value or [value] | Indicates a variable value. You must replace the italicized text and brackets with an appropriate value, which might be a name or number. |
| {} curly braces | {choice1 | choice2} | Indicates that you must select a parameter from the list of choices. |
| | Vertical bars | choice1 | choice2 | Separates the mutually exclusive choices. |
| [{}] Braces within square brackets | [{choice1 | choice2}] | Indicates a choice within an optional element. |
Print
this page
Email this topic
Feedback