[ Contents] [ Prev] [ Next] [ Index] [ Report an Error]

Online Help

The CLI provides context-sensitive help at every level of the command hierarchy. The help information tells you which commands are available at the current level in the hierarchy and provides a brief description of each.

To get help while in the CLI, type a question mark (?) in one of the following ways:

Type a question mark at the command-line prompt. The CLI lists the available commands and options. For examples, see CLI Operational Mode and CLI Configuration Mode.

Type a question mark after entering the complete name of a command or command option. The CLI lists the available commands and options, then redisplays the command names and options that you typed:
user@host> request ?

Possible completions:
  chassis              Perform chassis-specific operations
  ipsec                Perform IP Security operations
  message              Send text message to other users
  routing-engine       Log in to Routing Engine
  security             Perform security-level operations
  services             Perform service application operations
  support              Perform JUNOS support tasks
  system               Perform system-level operations
user@host> request

Type a question mark in the middle of a command name. The CLI lists possible command completions that match the letters you have entered so far, then redisplays the letters that you typed. For example, to list all operational mode commands that start with the letter s, type the following:
user@host> s?
```
Possible completions:
  set                  Set CLI properties, date/time, craft interface message
  show                 Show system information
  ssh                  Start secure shell on another host
  start                Start shell
user@host> s
```

When you enter the help commands described in Table 28, the CLI displays usage guidelines and summary information for configuration statements and operational mode commands. You can enter help commands in operational or configuration mode.

Table 28: help Commands

CLI Command	Description
help apropos string	Displays help based on a text string contained in a statement or command name. If the string contains spaces, enclose it in quotation marks. You also can specify a regular expression for the string, using standard UNIX-style regular expression syntax. In configuration mode, this command displays statement names and help text that match the string specified. In operational mode, this command displays the following types of commands that match the string specified, plus help text: Operational mode commands help topic and help reference commands you can enter for more information For example, to get a list of statements that contain the string traps, enter the help apropos traps command in configuration mode.
help reference string	Displays summary information for configuration statements. For example, to display summary information for the OSPF hello interval, enter the command help reference ospf hello-interval.
help topic string	Displays usage guidelines for configuration statements. For example, to display usage guidelines for the OSPF hello interval, enter the command help topic ospf hello-interval.

CLI Command

Description

help apropos string

Displays help based on a text string contained in a statement or command name.

If the string contains spaces, enclose it in quotation marks. You also can specify a regular expression for the string, using standard UNIX-style regular expression syntax.

In configuration mode, this command displays statement names and help text that match the string specified.

In operational mode, this command displays the following types of commands that match the string specified, plus help text:

Operational mode commands
help topic and help reference commands you can enter for more information

For example, to get a list of statements that contain the string traps, enter the help apropos traps command in configuration mode.

help reference string

Displays summary information for configuration statements.

For example, to display summary information for the OSPF hello interval, enter the command help reference ospf hello-interval.

help topic string

Displays usage guidelines for configuration statements.

For example, to display usage guidelines for the OSPF hello interval, enter the command help topic ospf hello-interval.

[ Contents] [ Prev] [ Next] [ Index] [ Report an Error]