| Home Prev |  cOS Core 14.00.18 CLI Reference Guide
|
Next |
|---|
There are two ways of getting help about a command. A brief help is displayed if the
command name is typed followed by -? or -h. This
applies to all commands and is therefore not listed in the option list for each command
in this guide. Using the help
command gives a more detailed help corresponding to the information found in this guide.
In most cases it is possible to simply type help followed by the
command name to get the full help. See Section 2.4.3, help for a more detailed
description. To list the available commands, just type help
and press return.
Example 1.7. Displaying Help for Commands
Display brief help for the activate command:
Device:/>activate -?Device:/>activate -h
Display full help for activate:
Device:/> help activateHelp for the arp command. Arp is also the name of a configuration object type, so it is necessary to specify that the help text for the command should be displayed:
Device:/> help -category=COMMANDS arpDisplay a list all available commands:
Device:/> help
To get help about configuration object types, use the help
command. It is also possible to get information about each property in an object type, such
as data type, default value, etc. by entering the ? character
when entering the value of a property and pressing tab. More on this in Section 1.3.1, Inline Help with Tab Completion.
Example 1.8. Displaying Help for Object Types
Full help for IP4Address:
Device:/> help IP4Address
Help for the ARP
configuration object type, which collides with the arp command:
Device:/> help -category=TYPES ARP