Help function

Help function

Yamaha router supports you with various help functions on the console. You can use help functions by using following commands.

  • 'help' command - Shows the usage of the console
  • 'show command' command - Shows the list of all commands
  • Command help - Shows the command description of the current inputting command

'help' command

'help' command shows the usage of the console.

(In the case of Rev.11.01 series)

| > help
| 1) At any time, you can type a '?' to help your typing on the console.
|    In case typing command name is not complete, lists the available keywords.
|    In case complete, displays the command format and description.
| 2) You can use following functions when typing commands: keyword completion,
|    putting a previous command on the line, moving cursor or editing the line.
|     Note: 'Ctrl + X' means typing the Ctrl key and X key simultaneously.
|    ------------------------------------------------------------------------
|    Completes keyword                         : Tab key
|    ------------------------------------------------------------------------
|    Puts the previous command on the line     : Ctrl + p, or UP arrow key
|    Puts the next command on the line         : Ctrl + n, or DOWN arrow key
|    ------------------------------------------------------------------------
|    Moves cursor forward one character        : Ctrl + f, or RIGHT arrow key
|    Moves cursor backward one character       : Ctrl + b, or LEFT arrow key
|    Moves cursor to the end of the line       : Ctrl + e
|    Moves cursor to the beginning of the line : Ctrl + a
|    ------------------------------------------------------------------------
|    Kills the pending input                   : Ctrl + c
|    Erases one character at the cursor        : Ctrl + d
|    Kills to the end of the line              : Ctrl + k
|    Interchanges two characters around cursor : Ctrl + t
|    Clears the line                           : Ctrl + u
|    Erases the characters before the cursor   : Ctrl + w
|    ------------------------------------------------------------------------
| 3) There are two access level discriminated by prompts.
|    The prompt '>' means you are now common user, and the prompt '#' means
|    an administrator.
|    Execute the administrator command to configure the router, when you are
|    a common user.
| >

'show command' command

'show command' command shows the list of all command names and their simple descriptions

| > show command
| administrator:          Logs in as an administrator.
| administrator password: Assigns a password for administrator.
| administrator password encrypted: Assigns a password for administrator.
|                         Saves to encrypt a password
| administrator radius auth: Enables or disables RADIUS for administrative
|                         authentication.
| alarm batch:            Enable or disable alarm on executing batch file.
| alarm entire:           Enables or disables alarm sound.
| alarm http revision-up: Enable or disable alarm on http revision-up.
| alarm lua:              Enable or disable alarm on executing Lua script
|                         function.
| alarm mobile:           Enable or disable alarm on mobile connection.
| alarm sd:               Enable or disable alarm on microSD module.
| alarm startup:          The kind of the alarm when starting is set.
| alarm usbhost:          Enable or disable alarm on USB-host module.
| auth user:              Assigns a username and a password for Authentication.
| auth user attribute:    Set user attribute for Authentication.
| auth user group:        Assigns userid to an Authentication group.
| auth user group attribute: Set group attribute for Authentication.
| bgp aggregate:          Defines aggregated route to BGP.
| bgp aggregate filter:   Defines the filter for aggregated route.
| bgp autonomous-system:  Set the autonomous system number.
| ---more---

Command help

You can type '?' key at any time when inputting a command line.
If '?' key is inputted before completing a command name, the candidates of the keywords to complete the command name are displayed.
If '?' key is inputted after the command name is completed, the syntax of the command and its description are displayed.

For example, the following is the case for 'console character' command.
You type '?' key after 'cons', 'console' and 'console character'

| > cons?
| ? console
| > cons
| > console ?
| ? character columns info lines prompt speed
| > console 
| > console character ?
|    Command Format: console character CODE
|                    CODE = 'ascii', 'sjis' or 'euc'
|       Description: Selects character set.
| Default Parameter: sjis
| > console character

Return to Top