Syntax conventions
Helix Core documentation uses the following conventions for command-line syntax.
Notation | Meaning |
---|---|
literal
|
Must be used in the command exactly as shown. |
italics | A parameter for which you must supply specific information. For example, for a serverid parameter, supply the ID of the server. |
-a -b
|
Both a and b are required. |
[-a -b]
|
Any combination of the enclosed elements is optional. None is also optional. Omit the brackets when you compose the command. |
|
Any one of the enclosed elements is required. Do not combine them. Omit the curly braces when you compose the command. |
[-a | -b]
|
Any one of the enclosed elements is optional. Do not combine them. None is also optional. Omit the brackets when you compose the command. |
... |
Previous argument can be repeated.
Tip
... has a different meaning for directories. See Wildcards in the Helix Core Command-Line (P4) Reference. |