Syntax conventions
Helix documentation uses the following syntax conventions to describe command line syntax.
| Notation | Meaning |
|---|---|
|
|
Monospace font indicates a word or other notation that must be used in the command exactly as shown. |
|
italics |
Italics indicate a parameter for which you must supply specific information. For example, for a serverid parameter, you must supply the id of the server. |
|
[ |
Square brackets indicate that the enclosed elements are optional. Omit the brackets when you compose the command. Elements that are not bracketed are required. |
|
… |
Ellipses (…) indicate that the preceding element can be repeated as often as needed. |
|
element1 | element2 |
A vertical bar ( | ) indicates that either element1 or element2 is required. |