help
The help command displays a list of commands available in a command-line interface and optionally displays the syntax or brief description of each command. If you specify this command with no parameters, this command displays only a list of available commands.
>>-help--+--------+--+-----+--+---------------+-----------------> +- -? ---+ +- -l-+ | .- off . | +- -h ---+ '- -s-' '- -p -+- on -+-' '- -help ' >--+---------------+--+----------------+--+-----------------+-->< '- -r - number -' '- command_name -' '- -match -string-'
Parameters
- -? | -h | -help
- Displays a detailed description of this command, including syntax, parameter descriptions, and examples. If you specify a help option, all other command options are ignored.
- -l
- Displays a list of available commands with the syntax diagrams for each. If you specify a command name with this parameter, this command displays the syntax for only the specified command.
- -s
- Displays a list of available commands with a brief description of each. If you specify a command name with this parameter, this command displays a brief description for only the specified command.
- -p off | on
- Specifies whether to display one page of text at a time or all text at once.
- off Displays all text at one time. This value is the default.
- on Displays one page of text at a time. Pressing any key displays the next page.
- -r number
- Specifies the number of rows per page to display when the -p parameter is on. The default is 24 rows. You can specify a value from 1 to 100.
- command_name
- Displays help information for the specified command, including the syntax diagram, parameter descriptions, return codes and errors, descriptions, examples, and miscellaneous remarks.
- -match string
- Displays a list of commands that contain the specified string. This parameter cannot be used with any other parameters.
Example
Invoke help
#dscli> help -s exit
The resulting output
Ends a command-line interface session.