Syntax of commands
The following table describes the symbols used to explain the commands.
|
Symbol |
Convention |
|---|---|
|
| |
In syntax explanations, a vertical bar separates multiple items, and has the meaning of OR. For example: A|B|C means A, or B, or C. |
|
{ } |
In syntax explanations, curly brackets indicate that only one of the enclosed items is to be selected. 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. [B|C] means that you can specify B, or C, or nothing. |
|
... |
In coding, an ellipsis (...) indicates that one or more lines of coding have been omitted. In syntax explanations, an ellipsis indicates that the immediately preceding item can be repeated as many times as necessary. For example: A, B, B, ... means that, after you specify A, B, you can specify B as many times as necessary. |
|
perm |
In syntax explanations, underlined characters indicate the value that the system will use if none of the values enclosed in square brackets is specified. For example: [A|B] means that if neither A nor B is specified, the system assumes that A is specified. |
The basic format of command explanations is as follows.
- Description
-
Describes the function of a command.
- Format
-
Describes the input format of the command.
- Required execution permission
-
Indicates the permission that is required to execute the command.
- Storage folder
-
Indicates the folder storing the command.
- Arguments
-
Describes the arguments of the command.
- Return values
-
Describes the return values of the command.
- Prerequisites for executing the command
-
Describes the prerequisites for executing the command.
- Remarks
-
Provides remarks about executing the command.
- Example
-
Provides an example of using the command.