help

Displays a list of commands available in an administrative command-line interface (CLI) and optionally displays the syntax or brief description of each command.

Read syntax diagramSkip visual syntax diagram
>>-help--+--------+--+-----+--+--------------+--+-------------+--+--------------+-><
         +- -?----+  +- -l-+  |      .-off-. |  '- -r--number-'  '-command_name-'
         +- -h----+  '- -s-'  '- -p--+-on--+-'
         '- -help-'

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
Specifies whether to display one page of text at a time or all text at once.
off
Displays all text at one time. This is the default value.
on
Displays one page of text at 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.

Description

If you specify this command with no parameters, this command displays only a list of available commands.

Example

Display a description of a command The following example displays the description of the mkimage command:
admin_cli_utility>help -s lspool
lspool    Displays a list of existing storage pools and their attributes.

Parent topic: Common commands

Terms of use | Feedback
(C) Copyright IBM Corporation 2003, 2004. All Rights Reserved.