Convention | Description |
|---|---|
--x or -x | An option placed before an argument. The option designates the parameter that you enter. For example, to enter the user name for tdwcmd, type --UserName or -un followed by the user name. |
<x> | Required option. If you omit a required option, the command line program returns an error message. |
<x | y> | Select between required options. If you omit a required option, the command line program returns an error message. If a pipe symbol (|) separates options, specify one option. If there are no pipe symbols to separate the options, specify all the options. |
[x] | Optional option. The command runs whether or not you enter these options. |
[x | y] | Select between optional options. For example, you can display help for all tdwcmd commands by using the --Help or -h option. [--Help|-h] The command runs whether or not you enter the optional parameter. |
< <x | y> | <a | b> > | When a set contains subsets, indicate the supersets with bold brackets (< >). Separate the subsets with the bold pipe symbol (|). |