Command description format

How to specify commands

The commands are specified using the following format:

Here, (1) is called an option, and (2) is called an argument.

The following describes the rules for specifying arguments:

• Specify an option first, and then specify an arbitrary name such as a unit name. If you specify any name before the option, the system assumes the entire specification as a name.

• Multiple options can be specified in any order.

• To specify more than one value for one option, use a comma (,) to separate each value.

• Options without a value can be specified in succession.

  Example:

  -a-b-c can be specified as -abc.

• Two-byte options without a value cannot be specified in succession.

  Example:

  -a-ab cannot be specified as -aab, or -cd -cf cannot be specified as -cdcf.

• When specifying options in succession, you can specify a value of the last option.

  Example:

  In -abc xyz, xyz is a value of the c option.

• If you specify a value for an option that does not have a value, the system assumes anything that follows the value to be a name.

• An error occurs if you specify an invalid option.

• To specify a character string beginning with a hyphen (-) for the first name, such as arbitrary-name-X in the above example of command specification, specify --Δ₁ before arbitrary-name-X. (The system assumes anything that follows --Δ₁ to be a name.)

  You do not need to specify --Δ₁ for the second and subsequent names.

  Example:

  To specify two names -jobA and -jobB, specify -- -jobA -jobB.

• You can use regular expressions for names.

• An error occurs if the number of specified names exceeds the limit.

• Character strings specified in arguments are case-sensitive. Be careful to use a correct combination of uppercase and lowercase letters.

To Page Top

Symbols used for command syntax explanations

The following table lists the conventions used in command syntax explanations:

Table 8‒1: Symbols used for command syntax explanations

Symbol	Convention and example
|	Only one of the options separated by a vertical bar can be used at one time. Example: A|B|C A, B, or C
{ }	One of the items enclosed in braces and separated by a vertical bar must be specified. Example: {A|B|C} Specify A, B, or C.
[ ]	The item or items enclosed in brackets are optional. When multiple items are listed, choose one or omit all. Example: [A] Specify A or nothing. [B|C] Specify B, C, or nothing.
...	The item or items preceding the ellipsis (...) can be repeated. Example: A, B, ... After A, specify B as many times as necessary.
_ (underline)	The underlined characters are the system default when you omit all the items enclosed in brackets. If there is no default, only the specified item will take effect. Example: [A|B] A is assumed if you do not specify either item.

To Page Top