Documentation Conventions
In general, the following definitions are used throughout this documentation:
| Convention | Definition | Example |
|---|---|---|
| argument | A command consists of an array of arguments. | redcli config update {config_name} |
| flag | A flag is a type of argument used to enable or disable a specific feature or behavior of a command. Typically, flags are boolean. | redcli cluster show -s |
| option | An option is a type of argument modifying the behavior of a command. Typically, options require a value specified in its parameter. | redcli user login realm_admin -p <password> |
| parameter | A parameter is an argument that provides information to an option. | redcli user login realm_admin -p <password> |
The following conventions are used for command usage throughout this documentation:
| Convention | Description | Example |
|---|---|---|
| {} | Curly-brackets around arguments, options, or flags denote that they are required. | redcli config update {config_name} |
| [] | Square-brackets around an argument, an option, or a flag denote that it is optional. | redcli cluster create [cluster_name] |
| <> | Angle brackets are used for the parameter of an option or to indicate placeholder content. | redcli user login realm_admin -p <password> redcli config init <your_new_cfg> |
| | | Arguments separated by a pipe character are mutually exclusive. | redcli events { admin | cluster | hardware | system } |
| [flags] | The term “flags” in square-brackets denote optional flags and options are available. | redcli user info [flags] |
