How to read syntax statements

Syntax diagrams pictorially display the order and parameters for the command utility. The reference documentation uses the following special characters to define syntax:

[ ]

Identifies optional options. Options that are not enclosed in brackets are required.

...

Indicates that we can specify multiple values for the previous option.

|

Indicates mutually exclusive information. We can use the option to the left of the separator or the option to the right of the separator. We cannot use both options in a single use of the command.

{ }

Delimits a set of mutually exclusive options when one of the options is required. If the options are optional, they are enclosed in brackets ([ ]).

\

That the command line wraps to the next line. It is a continuation character.

The options for each command are listed alphabetically in the Options section. The options for each utility are listed alphabetically in the Parameters section. When the order of the options or parameters must be used in a specific order, this order is shown in the syntax statements.

Parent topic: pdadmin commands