Syntax Legend

Whenever possible, this guide lists commands, parameters and options in the alphabetical order.

This guide uses this convention in the Command Line Interface (CLI) syntax:

Character

Description

TAB

Shows the available nested subcommands:

main command

→ nested subcommand 1

→ → nested subsubcommand 1-1

→ → nested subsubcommand 1-2

→ nested subcommand 2

Example:

cpwd_admin

    config

        -a <options>

        -d <options>

        -p

        -r

    del <options>

Meaning, you can run only one of these commands:

  • This command:

    cpwd_admin config -a <options>

  • Or this command:

    cpwd_admin config -d <options>

  • Or this command:

    cpwd_admin config -p

  • Or this command:

    cpwd_admin config -r

  • Or this command:

    cpwd_admin del <options>

Curly brackets or braces

{ }

Enclose a list of available commands or parameters, separated by the vertical bar |.

User can enter only one of the available commands or parameters.

Angle brackets

< >

Enclose a variable.

User must explicitly specify a supported value.

Square brackets or brackets

[ ]

Enclose an optional command or parameter, which user can also enter.