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