Command syntax notation conventions
Convention | Usage |
---|---|
|
Identifies commands and their options and operands, code examples, filenames, pathnames, and output displayed in a command window. Items that appear like the example text in the previous column are to be entered exactly as shown and are required unless enclosed in brackets ( |
example-text |
In code and screen examples, indicates text entered by a user. |
Any of the following:
|
Identifies a placeholder—such as a parameter or a variable—that you must substitute with an actual value in a command or in code:
|
|
Vertical bar. A logical
Any spaces that are on either side of the vertical bar are included for readability and are not a required part of the command syntax. |
|
Braces. Indicates that at least one of the enclosed items is required. |
|
Brackets. Indicates that the enclosed item or items are optional. |
|
Ellipsis:
|