1.2. Help
1.2.1. Help for commands
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 cor-
responding 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.2, “help” for a more detailed
description. To list the available commands, just type help and press return.
Example 1.1. Help for commands
Brief help for the activate command:
gw-world:/> activate -?
gw-world:/> activate -h
Full help for activate:
gw-world:/> help activate
Help 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:
gw-world:/> help -category=COMMANDS arp
List all available commands:
gw-world:/> help
1.2.2. Help for object types
To get help about configuration object types, use the help command. It is also possible to get in-
formation 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.5.1,
“Inline help”.
Example 1.2. Help for object types
Full help for
IP4Address
:
gw-world:/> help IP4Address
Help for the
ARP
configuration object type, which collides with the arp command:
gw-world:/> help -category=TYPES ARP
1.2. Help
Chapter 1. Introduction
12
