1.4 Command description format
This section explains the format of command descriptions.
Each command description has the following information. However, some commands do not have all of the information.
- Description
Describes the functionality of the command.
- Syntax
Describes the command syntax as follows:
command-name[[/option[value]]...]
The combination of option and value is referred to as an option. The term arguments is also used as a generic term for options.
- Arguments
Describes the arguments of the command.
If the JP1/AO server OS is Linux, replace / with - when you read the description.
- Located in
Shows the directory where the command is located.
If the JP1/AO server OS is Linux, replace \ with / when you read the description.
- Execute permission
Describes user permission required to execute the command.
- Remarks
Contains what you have to be aware of when you use the command.
- Return code
Lists the return codes from the command.
For details about the messages shown when the command is executed, see the manual JP1/Automatic Operation Messages.
Some commands output audit logs. For details about the commands that output audit logs, actions to be audited, and IDs of the messages to be output, see the topic Event types for which audit log data is output in the manual JP1/Automatic Operation Administration Guide.
- Example
Shows sample usage of the command.