1.2 How to read command reference information
This section provides important information required for reading the Command Reference Guide.
Description format
This section describes the format used to explain commands. The explanation of a command contains only required items from among the following items. Additionally, there are cases in which a command explanation contains information that is specific to the command and which is not described below.
- Synopsis
-
Indicates the syntax for inputting the command.
- Storage location
-
Indicates the path where the commands are stored.
- Function
-
Describes the functionality of the command.
- Execution permission
-
Indicates the execution permissions required to run the command.
- Precondition
-
Indicates the requirements to run the command.
- Arguments
-
Describes the command arguments and their options.
Specification of a value might be required, depending on the option.
For commands used in the Java EE server, "Default Value" indicates the value for when the entire option is omitted, and not for when only the option value is omitted.
- Output format
-
Indicates the format of output from the command.
- Examples
-
Provides an example of command input and output.
- Exit Status
-
Describes the return values of the command.
- Notes
-
Describes important points to note when executing the command.
Symbols used
The following table describes the various symbols used in command syntax explanations:
|
Symbols |
Meaning |
|---|---|
|
| |
Indicates that items are separate, when multiple items are arranged side-by-side. This symbol means OR. Example: A|B This example indicates that you need to specify either A or B. |
|
{ } |
Indicates that you need to select one of the items from among the multiple items enclosed within these symbols. If the items are listed side-by-side and separated by the symbol |, you can select one of the listed items. Example: {A|B|C} This example indicates that you need to specify A or B or C. |
|
[ ] |
Indicates that the items enclosed in the symbols can be omitted. If multiple items enclosed within these symbols are written horizontally, you can ignore all the items or select one of them (the same as with the symbols { }). Example 1: [A] This example indicates that you do not need to specify anything, or you can specify A. Example 2: [B|C] This example indicates that you do not need to specify anything, or you can specify B or C. |
|
... |
Indicates that the item specified before "..." can be specified multiple times. Example: [property]... This example indicates that you can specify multiple properties repeatedly. |
|
item |
Items that are in italics indicate corresponding files or elements that are specified in the command or the corresponding elements that might be displayed. Example 1: property This example indicates that a property is to be written here, or a property is displayed here. Example 2: file_name This example indicates that a file name here is specified here. |
Syntax elements used
The following table defines the syntax elements used in command explanations:
|
Syntax element |
Definition |
|---|---|
|
Alphabetical characters |
A to Z a to z |
|
Lowercase letters |
a to z |
|
Uppercase letters |
A to Z |
|
Numbers |
0 to 9 |
|
Alphanumeric characters |
A to Z a to z 0 to 9 |
|
Symbols |
! " # $ % & ' ( ) + , _ . / : ; < = > @ [ ] ^ - { } ~ Tab space |
- Note:
-
In all the syntax elements, use half-width characters.