Syntax statements


The following example shows a sample syntax statement:

COMMAND KEYWORD1 [KEYWORD2 | KEYWORD3] KEYWORD4={YES | NO} fileName...

The following table explains conventions for syntax statements and provides examples:

Item

Example

Items in italic type represent variables that you must replace with a name or value. If a variable is represented by two or more words, initial capitals distinguish the second and subsequent words.

alias

databaseDirectory

serverHostName

Brackets indicate a group of optional items. Do not type the brackets when you enter the option. A comma means that you can choose one or more of the listed options. You must use a comma to separate the options if you choose more than one option.

[tableName, columnName, field]

[-full, -incremental, -level] (UNIX)

Braces indicate that at least one of the enclosed items is required. Do not type the braces when you enter the item.

{DBDName | tableName}

UNLOAD device={disk | tape,
fileName | deviceName}

{-a | -c} (UNIX)

A vertical bar means that you can choose only one of the listed items. In the example, you would choose either commit or cancel.

{commit | cancel}

{-commit | -cancel} (UNIX)

An ellipsis indicates that you can repeat the previous item or items as many times as necessary.

columnName . . .

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*