Command description format
The description of each command consists of eight items, including the functionality, format (syntax), and arguments. The following table shows how the commands are described.
- Organization of this page
Command description format
|
No. |
Item |
Description |
|---|---|---|
|
1 |
Functionality |
This subsection describes the command functionality. |
|
2 |
Format |
This subsection describes the format of the command. |
|
3 |
Arguments |
This subsection describes the arguments for the command. |
|
4 |
Storage location |
This subsection describes the storage location for the command. |
|
5 |
Execution permissions |
This subsection describes the permissions required to execute the command. |
|
6 |
Notes |
This subsection provides notes on execution of the command. |
|
7 |
Return values |
This subsection describes the return values of the command. |
|
8 |
Example |
This subsection provides an example of usage of the command. |