help

help

Displays a short description of the available help. The question mark (?) shows a list of available commands with short descriptions

Syntax: help

?

partial_command ?

command_name ?

help

Allows the user to view information outlining help command choices. See examples below.

?

Displays a complete description of commands available in the current command mode.

partial_command ?

Allows the user to type a partial command followed by the ? to display command options.

command_name ?

Displays help for the specified command.

Description: The help command displays a description of the available help on the Avici router command-line interface. The ? command provides a list of commands available in the current command mode, command completion help, or help on available keywords depending on how it is used.

Factory Default: None.

Command Mode: All.

Example 1: In the following example, the help command displays instructions about how to use the on-line help system:

router>help

To request help at any point while entering a command, enter the question mark (?). Help will return any commands or parameters, available in the current command mode, that match the letters you typed. If there are no matches, backspace and retry the question mark until help displays available options.

The TSR provides two styles of help:

1. Full help--describes each possible argument to a command. Type the command followed by a space and a question mark. (show ?)

2. Partial help--known as command resolution help, provides a resolution to partially entered commands (show cl?). Notice that there is no space before the question mark.

Example 2: In the following example, the ? lists the commands available in the current (Executive) command mode:

router> ?

calendar      Calendar functions

dir            List files on the current device

enable         Turn on privileged commands

exit           Exit from the Exec

.

.

.

router>

Example 3: In the following example, the ? lists the commands available in the current (BGP Configuration) command mode:

router(config)#router bgp 1

router(config-router)#bgp ?

always-compare-med Allow comparing MED from different neighbors

client-to-client Configure client to client route reflection

cluster-id          Configure Route-Reflector Cluster-id

confederation       AS confederation parameters

dampening           Enable route-flap dampening

default             Configure BGP defaults

router-id           Override configured router identifier

router(config-router)#bgp

Example 4: In the following example, the ? lists the possible options for completing a command:

router#terminal ?

length Number of lines on the display screen (0 defeats screen pause)

  width    Number of columns on the display screen

router#terminal

Example 5: In the following example the ? lists the possible completions for a partially completed command:

router(config-router)#bgp clie?

client-to-client

router(config-router)#

Related Commands: None

help	Allows the user to view information outlining help command choices. See examples below.
?	Displays a complete description of commands available in the current command mode.
partial_command ?	Allows the user to type a partial command followed by the ? to display command options.
command_name ?	Displays help for the specified command.

router>help To request help at any point while entering a command, enter the question mark (?). Help will return any commands or parameters, available in the current command mode, that match the letters you typed. If there are no matches, backspace and retry the question mark until help displays available options. The TSR provides two styles of help: 1. Full help--describes each possible argument to a command. Type the command followed by a space and a question mark. (show ?) 2. Partial help--known as command resolution help, provides a resolution to partially entered commands (show cl?). Notice that there is no space before the question mark.

router> ? calendar Calendar functions dir List files on the current device enable Turn on privileged commands exit Exit from the Exec . . . router>

router(config)#router bgp 1 router(config-router)#bgp ? always-compare-med Allow comparing MED from different neighbors client-to-client Configure client to client route reflection cluster-id Configure Route-Reflector Cluster-id confederation AS confederation parameters dampening Enable route-flap dampening default Configure BGP defaults router-id Override configured router identifier router(config-router)#bgp

router#terminal ? length Number of lines on the display screen (0 defeats screen pause) width Number of columns on the display screen router#terminal

router(config-router)#bgp clie? client-to-client router(config-router)#

   Source File Name: navigation.fm
    HTML File Name: navigation9.html
    Last Updated: 02/25/05 at 14:25:22

help

Please email suggestions and comments to: doc@avici.com