Skip to main content

Syntax diagram conventions

To understand the command descriptions, Review the conventions used in syntax diagrams.

The syntax diagram consists of options and arguments. Options consist of a dash and single letter (for example, -v) or two dashes and multiple letters (for example, --view). Options can be followed by one or more arguments (for example, as illustrated in [-v <filter>]).

Consider these conventions when reading syntax diagrams:

  • Options that are preceded by one dash (-) are case-sensitive.

  • Options that are preceded by two dashes (--) must be specified in their entirety. These options are not case-sensitive.

  • The names of arguments that require substitution by actual values are italicized and enclosed in greater-than and less-than symbols (< >).

  • Options that are enclosed in brackets ([]) are optional. Do not include these brackets in the command.

  • Options that are enclosed in braces ({}) are required. Do not include these braces in the command.

  • Options that are not enclosed in either brackets or braces are required.

  • The pipe (|) character signifies that you choose one option or the other. For example, [a | b] indicates that you can choose either a or b, but not both. Similarly, {a | b} indicates that you must choose either a or b.

  • An ellipsis (...) signifies that you can repeat the operand and option argument on the command line.