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