|
| Documentation Conventions |
Table 1. Symbols in Command Syntax | ||
|
|
|
| Symbol | Usage |
|
|
|
| [ ] | Denotes optional arguments. Those arguments not enclosed in |
|
| square brackets are required. Example: |
|
| APPLDEST DEST [ALTDEST] |
|
| In this example, DEST is a required argument and ALTDEST is |
|
| optional. |
|
|
|
| { } | Some documents use braces to denote required arguments, or to |
|
| group arguments for clarity. Example: |
|
| COMPARE {workload} - |
|
| REPORT={SUMMARY HISTOGRAM} |
|
| The workload variable is required. The REPORT keyword must be |
|
| specified with a value of SUMMARY or HISTOGRAM. |
|
|
|
| _ | Default values are underscored. Example: |
|
| COPY infile outfile - [COMPRESS={YES NO}] |
|
| In this example, the COMPRESS keyword is optional. If specified, |
|
| the only valid values are YES or NO. If omitted, the default is YES. |
|
|
|
11
