0 | B – Command Line Interface |
| |
| Help Command |
|
|
|
|
Help Command
Displays a brief description of the specified command, its keywords, and usage.
Authority None
Syntax help [command] [keyword]
Keywords [command]
Displays a summary of the command given by [command] and its keywords. If you omit [command], the system displays all available commands.
[keyword]
Displays a summary of the keyword given by [keyword] belonging to the command given by [command]. If you omit [keyword], the system displays the available keywords for the specified command.
all
Displays a list of all available commands (including command variations). Examples The following is an example of the Help Config command:
SANbox2 #> | help | config |
|
|
|
|
|
|
|
config CONFIG_OPTIONS |
|
|
|
|
|
|
| ||
The config | command operates on | configurations. |
|
|
| ||||
Usage: config | { activate | backup | cancel | copy | delete | ||||
|
| edit | list | restore | save | } |
| ||
The following is an example of the Help Config Edit command:
SANbox2 #> help config edit config edit [CONFIG_NAME]
This command initiates a configuration session and places the current session into config edit mode.
If CONFIG_NAME is given and it exists, it gets edited; otherwise, it gets created. If it is not given, the currently active configuration is edited.
Admin mode is required for this command.
Usage: config edit [CONFIG_NAME]
