| hasso | 67e29ab | 2004-08-26 22:21:31 +0000 | [diff] [blame] | 1 | .TH VTYSH 1 "27 August 2004" "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 | 67e29ab | 2004-08-26 22:21:31 +0000 | [diff] [blame] | 7 | .B \-f |
| 8 | .I config-file |
| 9 | ] |
| 10 | [ |
| hasso | 246c135 | 2004-08-10 12:00:34 +0000 | [diff] [blame] | 11 | .B \-b |
| paul | 718e374 | 2002-12-13 20:15:29 +0000 | [diff] [blame] | 12 | ] |
| hasso | 246c135 | 2004-08-10 12:00:34 +0000 | [diff] [blame] | 13 | .br |
| 14 | .B vtysh |
| 15 | [ |
| hasso | 67e29ab | 2004-08-26 22:21:31 +0000 | [diff] [blame] | 16 | .B \-f |
| 17 | .I config-file |
| 18 | ] |
| 19 | [ |
| hasso | 246c135 | 2004-08-10 12:00:34 +0000 | [diff] [blame] | 20 | .B \-c |
| 21 | .I command |
| 22 | ] |
| 23 | .SH DESCRIPTION |
| paul | 718e374 | 2002-12-13 20:15:29 +0000 | [diff] [blame] | 24 | .B vtysh |
| 25 | is a integrated shell for |
| hasso | 246c135 | 2004-08-10 12:00:34 +0000 | [diff] [blame] | 26 | .B Quagga |
| paul | 718e374 | 2002-12-13 20:15:29 +0000 | [diff] [blame] | 27 | routing engine. |
| paul | 718e374 | 2002-12-13 20:15:29 +0000 | [diff] [blame] | 28 | .SH OPTIONS |
| hasso | 246c135 | 2004-08-10 12:00:34 +0000 | [diff] [blame] | 29 | Options available for the |
| 30 | .B vtysh |
| 31 | command: |
| 32 | .IP "\fB\-b, \-\-boot\fP" |
| 33 | Execute boot startup configuration. It makes sense only if integrated config |
| 34 | file is in use (not default in Quagga). See Info file \fBQuagga\fR for more |
| 35 | info. |
| 36 | .IP "\fB\-c, \-\-command \fIcommand\fP" |
| 37 | Specify command to be executed under batch mode. It behaves like -c option in |
| 38 | any other shell - |
| 39 | .I command |
| 40 | is executed and vtysh exits. |
| paul | 718e374 | 2002-12-13 20:15:29 +0000 | [diff] [blame] | 41 | |
| hasso | 246c135 | 2004-08-10 12:00:34 +0000 | [diff] [blame] | 42 | It's useful for gathering info from Quagga routing software from shell scripts |
| 43 | etc. |
| 44 | .IP "\fB\-e, \-\-execute \fIcommand\fP" |
| hasso | 67e29ab | 2004-08-26 22:21:31 +0000 | [diff] [blame] | 45 | Alias for -c. It's here only for compatibility with Zebra routing software and |
| 46 | older Quagga versions. This will be removed in future. |
| 47 | .IP "\fB\-f, \-\-config-file \fIconfig-file\fP" |
| 48 | Specifies the config file to use for startup. If not specified this option will |
| 49 | likely default to \fB\fI/usr/local/etc/vtysh.conf\fR. |
| hasso | 246c135 | 2004-08-10 12:00:34 +0000 | [diff] [blame] | 50 | .IP "\fB\-h, \-\-help\fP" |
| 51 | Display a usage message on standard output and exit. |
| hasso | 00b0bbc | 2004-03-04 20:41:36 +0000 | [diff] [blame] | 52 | .SH ENVIRONMENT VARIABLES |
| hasso | 00b0bbc | 2004-03-04 20:41:36 +0000 | [diff] [blame] | 53 | .IP "\fBVTYSH_PAGER\fR" |
| 54 | 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] | 55 | .SH FILES |
| paul | 718e374 | 2002-12-13 20:15:29 +0000 | [diff] [blame] | 56 | .TP |
| hasso | 246c135 | 2004-08-10 12:00:34 +0000 | [diff] [blame] | 57 | .BI /usr/local/etc/vtysh.conf |
| paul | 718e374 | 2002-12-13 20:15:29 +0000 | [diff] [blame] | 58 | The default location of the |
| 59 | .B vtysh |
| 60 | config file. |
| hasso | 246c135 | 2004-08-10 12:00:34 +0000 | [diff] [blame] | 61 | .TP |
| 62 | .BI /usr/local/etc/Quagga.conf |
| 63 | The default location of the integrated Quagga routing engine config file |
| 64 | if integrated config file is in use (not default). |
| paul | 718e374 | 2002-12-13 20:15:29 +0000 | [diff] [blame] | 65 | .SH WARNING |
| hasso | 246c135 | 2004-08-10 12:00:34 +0000 | [diff] [blame] | 66 | This man page is intended to be a quick reference for command line |
| 67 | options. The definitive document is the Info file \fBQuagga\fR. |
| paul | 718e374 | 2002-12-13 20:15:29 +0000 | [diff] [blame] | 68 | .SH "SEE ALSO" |
| hasso | 246c135 | 2004-08-10 12:00:34 +0000 | [diff] [blame] | 69 | .BR bgpd (8), |
| 70 | .BR ripd (8), |
| 71 | .BR ripngd (8), |
| 72 | .BR ospfd (8), |
| 73 | .BR ospf6d (8), |
| 74 | .BR isisd (8), |
| 75 | .BR zebra (8) |
| paul | 718e374 | 2002-12-13 20:15:29 +0000 | [diff] [blame] | 76 | .SH BUGS |
| hasso | 246c135 | 2004-08-10 12:00:34 +0000 | [diff] [blame] | 77 | Running the command which outputs large amount of data through pager ("show ip |
| 78 | ospf database", "show ip bgp" etc. in big networks) will cause daemon to be |
| 79 | unresponsive until vtysh returns back to the prompt. |
| 80 | |
| paul | 718e374 | 2002-12-13 20:15:29 +0000 | [diff] [blame] | 81 | .B vtysh |
| 82 | eats bugs for breakfast. If you have food for the maintainers try |
| hasso | 00b0bbc | 2004-03-04 20:41:36 +0000 | [diff] [blame] | 83 | .BI http://bugzilla.quagga.net |
| hasso | 246c135 | 2004-08-10 12:00:34 +0000 | [diff] [blame] | 84 | .SH AUTHORS |
| 85 | See |
| 86 | .BI http://www.zebra.org |
| 87 | and |
| 88 | .BI http://www.quagga.org |
| 89 | or the Info file for an accurate list of authors. |
| paul | 718e374 | 2002-12-13 20:15:29 +0000 | [diff] [blame] | 90 | |