Format for describing command syntax

In this chapter, command syntax is described in the following format. Note that the commands are listed and explained in alphabetical order.

Format
Describes the command input format.
Function
Describes the functionality of commands.
Argument
Describes the arguments and the options of commands.
Output format
Describes the command output format.
Example of input
Gives an example of command input.
Display format
Describes the command output format.
Example of display
Gives an example of command display.
Return value
Describes the return value of commands.
Notes
Provides general notes on executing commands.
Note
All the above-mentioned items are not provided for each command. In addition to the above-mentioned items, the information specific to individual commands might be provided.

The following table lists the symbols used in syntax explanations in this chapter.

SymbolMeaning
|In syntax explanations, a vertical bar separates multiple items, and has the meaning of OR.
For example: A|B means A or B.
{ }In syntax explanations, curly brackets indicate that only one of the enclosed items is to be selected. If the items are arranged horizontally and separated by a vertical bar (|), select one of the items.
For example: {A|B|C} means only one of A, or B, or C.
[ ]In syntax explanations, square brackets indicate that the enclosed item or items are optional.
For example: [A] means that you can specify A or nothing.
ItalicsIn syntax explanations, italics indicate that the corresponding element must be specified.
For example: property means that you must specify a property.
...In coding, an ellipsis (...) indicates that one or more lines of coding have been omitted.
For example: ABC... means that the coding after ABC has been omitted.
~In syntax explanations, a swung dash (~) indicates that the items preceding the swung dash comply with the rules mentioned in < >, (( )), and << >> following the swung dash.
< >In syntax explanations, angle brackets indicate the syntax elements that must be complied with when items are coded. For details on syntax elements, see the following table.
(( ))In syntax explanations, double-parentheses indicate the range of values that you can specify for an item.
<< >>In syntax explanations, double-angle brackets indicate the default value that the system assumes when an item is omitted.

The following table lists the types and definitions of the syntax elements used in this chapter.

TypeDefinition
Alphabetic charactersA to Z, a to z
Lowercase alphabetic charactersa to z
Uppercase alphabetic charactersA to Z
Numeric characters0 to 9
Alphanumeric charactersA to Z, a to z, 0 to 9
Symbols_, ., -
Character stringAn array of strings