About This Manual : Conventions
 
Conventions
Unless otherwise noted, command syntax, code, and examples use the following conventions:
Case
Commands and reserved words typically appear in uppercase letters. Unless the manual states otherwise, you can enter these items using uppercase, lowercase, or both. For example, you can type MYPROG, myprog, or MYprog.
[ ]
Square brackets enclose optional information, as in [log_name]. If information is not enclosed in square brackets, it is required.
|
A vertical bar indicates a choice of information to enter, as in [file name | @file name].
< >
Angle brackets enclose multiple choices for a required item, as in /D=<5|6|7>.
variable
Words appearing in italics are variables that you must replace with appropriate values, as in file name.
. . .
An ellipsis following information indicates you can repeat the information more than one time, as in [parameter . . . ].
::=
The symbol ::= means one item is defined in terms of another. For example, a::=b means the item a is defined in terms of b.
*
An asterisk is used as a wildcard symbol to indicate a series of APIs with the same prefix.
Note Unless otherwise noted, all references in this book to the PSQL product refer to the current version.