| Andrew J. Schorr | f366ad3 | 2006-07-27 18:01:41 +0000 | [diff] [blame] | 1 | .TH VTYSH 1 "27 July 2006" "Quagga VTY shell" "Version 0.96.5" |
| paul | 718e374 | 2002-12-13 20:15:29 +0000 | [diff] [blame] | 2 | .SH NAME |
| hasso | 246c135 | 2004-08-10 12:00:34 +0000 | [diff] [blame] | 3 | vtysh \- a integrated shell for Quagga routing software |
| paul | 718e374 | 2002-12-13 20:15:29 +0000 | [diff] [blame] | 4 | .SH SYNOPSIS |
| 5 | .B vtysh |
| 6 | [ |
| hasso | 246c135 | 2004-08-10 12:00:34 +0000 | [diff] [blame] | 7 | .B \-b |
| paul | 718e374 | 2002-12-13 20:15:29 +0000 | [diff] [blame] | 8 | ] |
| hasso | 246c135 | 2004-08-10 12:00:34 +0000 | [diff] [blame] | 9 | .br |
| 10 | .B vtysh |
| 11 | [ |
| Andrew J. Schorr | f366ad3 | 2006-07-27 18:01:41 +0000 | [diff] [blame] | 12 | .B \-E |
| 13 | ] [ |
| 14 | .B \-d |
| 15 | .I daemon |
| 16 | ] |
| 17 | ] [ |
| hasso | 246c135 | 2004-08-10 12:00:34 +0000 | [diff] [blame] | 18 | .B \-c |
| 19 | .I command |
| 20 | ] |
| 21 | .SH DESCRIPTION |
| paul | 718e374 | 2002-12-13 20:15:29 +0000 | [diff] [blame] | 22 | .B vtysh |
| 23 | is a integrated shell for |
| hasso | 246c135 | 2004-08-10 12:00:34 +0000 | [diff] [blame] | 24 | .B Quagga |
| paul | 718e374 | 2002-12-13 20:15:29 +0000 | [diff] [blame] | 25 | routing engine. |
| paul | 718e374 | 2002-12-13 20:15:29 +0000 | [diff] [blame] | 26 | .SH OPTIONS |
| hasso | 246c135 | 2004-08-10 12:00:34 +0000 | [diff] [blame] | 27 | Options available for the |
| 28 | .B vtysh |
| 29 | command: |
| 30 | .IP "\fB\-b, \-\-boot\fP" |
| 31 | Execute boot startup configuration. It makes sense only if integrated config |
| 32 | file is in use (not default in Quagga). See Info file \fBQuagga\fR for more |
| 33 | info. |
| 34 | .IP "\fB\-c, \-\-command \fIcommand\fP" |
| 35 | Specify command to be executed under batch mode. It behaves like -c option in |
| 36 | any other shell - |
| 37 | .I command |
| Andrew J. Schorr | f366ad3 | 2006-07-27 18:01:41 +0000 | [diff] [blame] | 38 | is executed and |
| 39 | .B vtysh |
| 40 | exits. |
| paul | 718e374 | 2002-12-13 20:15:29 +0000 | [diff] [blame] | 41 | |
| Andrew J. Schorr | f366ad3 | 2006-07-27 18:01:41 +0000 | [diff] [blame] | 42 | It's useful for gathering info from Quagga routing software or reconfiguring |
| 43 | daemons from inside shell scripts, etc. |
| 44 | Note that multiple commands may be executed by using more than one |
| 45 | -c option and/or embedding linefeed characters inside the |
| 46 | .I command |
| 47 | string. |
| 48 | .IP "\fB\-d, \-\-daemon \fIdaemon_name\fP" |
| 49 | Specify which daemon to connect to. By default, |
| 50 | .B vtysh |
| 51 | attempts to connect to all Quagga daemons running on the system. With this |
| 52 | flag, one can specify a single daemon to connect to instead. For example, |
| 53 | specifying '-d ospfd' will connect only to ospfd. This can be particularly |
| 54 | useful inside scripts with -c where the command is targeted for a single daemon. |
| hasso | 246c135 | 2004-08-10 12:00:34 +0000 | [diff] [blame] | 55 | .IP "\fB\-e, \-\-execute \fIcommand\fP" |
| hasso | 67e29ab | 2004-08-26 22:21:31 +0000 | [diff] [blame] | 56 | Alias for -c. It's here only for compatibility with Zebra routing software and |
| 57 | older Quagga versions. This will be removed in future. |
| Andrew J. Schorr | f366ad3 | 2006-07-27 18:01:41 +0000 | [diff] [blame] | 58 | .IP "\fB\-E, \-\-echo\fP" |
| 59 | When the -c option is being used, this flag will cause the standard |
| 60 | .B vtysh |
| 61 | prompt and command to be echoed prior to displaying the results. |
| 62 | This is particularly useful to separate the results |
| 63 | when executing multiple commands. |
| hasso | 246c135 | 2004-08-10 12:00:34 +0000 | [diff] [blame] | 64 | .IP "\fB\-h, \-\-help\fP" |
| 65 | Display a usage message on standard output and exit. |
| hasso | 00b0bbc | 2004-03-04 20:41:36 +0000 | [diff] [blame] | 66 | .SH ENVIRONMENT VARIABLES |
| hasso | 00b0bbc | 2004-03-04 20:41:36 +0000 | [diff] [blame] | 67 | .IP "\fBVTYSH_PAGER\fR" |
| 68 | This should be the name of the pager to use. Default is \fBmore\fR. |
| paul | 718e374 | 2002-12-13 20:15:29 +0000 | [diff] [blame] | 69 | .SH FILES |
| paul | 718e374 | 2002-12-13 20:15:29 +0000 | [diff] [blame] | 70 | .TP |
| hasso | 246c135 | 2004-08-10 12:00:34 +0000 | [diff] [blame] | 71 | .BI /usr/local/etc/vtysh.conf |
| paul | 718e374 | 2002-12-13 20:15:29 +0000 | [diff] [blame] | 72 | The default location of the |
| 73 | .B vtysh |
| 74 | config file. |
| hasso | 246c135 | 2004-08-10 12:00:34 +0000 | [diff] [blame] | 75 | .TP |
| 76 | .BI /usr/local/etc/Quagga.conf |
| 77 | The default location of the integrated Quagga routing engine config file |
| 78 | if integrated config file is in use (not default). |
| paul | 718e374 | 2002-12-13 20:15:29 +0000 | [diff] [blame] | 79 | .SH WARNING |
| hasso | 246c135 | 2004-08-10 12:00:34 +0000 | [diff] [blame] | 80 | This man page is intended to be a quick reference for command line |
| 81 | options. The definitive document is the Info file \fBQuagga\fR. |
| paul | 718e374 | 2002-12-13 20:15:29 +0000 | [diff] [blame] | 82 | .SH "SEE ALSO" |
| hasso | 246c135 | 2004-08-10 12:00:34 +0000 | [diff] [blame] | 83 | .BR bgpd (8), |
| 84 | .BR ripd (8), |
| 85 | .BR ripngd (8), |
| 86 | .BR ospfd (8), |
| 87 | .BR ospf6d (8), |
| 88 | .BR isisd (8), |
| 89 | .BR zebra (8) |
| paul | 718e374 | 2002-12-13 20:15:29 +0000 | [diff] [blame] | 90 | .SH BUGS |
| 91 | .B vtysh |
| 92 | eats bugs for breakfast. If you have food for the maintainers try |
| hasso | 00b0bbc | 2004-03-04 20:41:36 +0000 | [diff] [blame] | 93 | .BI http://bugzilla.quagga.net |
| hasso | 246c135 | 2004-08-10 12:00:34 +0000 | [diff] [blame] | 94 | .SH AUTHORS |
| 95 | See |
| 96 | .BI http://www.zebra.org |
| 97 | and |
| Denis Ovsienko | 2bbd71a | 2009-06-01 20:07:46 +0400 | [diff] [blame^] | 98 | .BI http://www.quagga.net |
| hasso | 246c135 | 2004-08-10 12:00:34 +0000 | [diff] [blame] | 99 | or the Info file for an accurate list of authors. |
| paul | 718e374 | 2002-12-13 20:15:29 +0000 | [diff] [blame] | 100 | |