1: .TH VTYSH 1 "27 July 2006" "Quagga VTY shell" "Version 0.96.5"
2: .SH NAME
3: vtysh \- a integrated shell for Quagga routing software
4: .SH SYNOPSIS
5: .B vtysh
6: [
7: .B \-b
8: ]
9: .br
10: .B vtysh
11: [
12: .B \-E
13: ] [
14: .B \-d
15: .I daemon
16: ]
17: ] [
18: .B \-c
19: .I command
20: ]
21: .SH DESCRIPTION
22: .B vtysh
23: is a integrated shell for
24: .B Quagga
25: routing engine.
26: .SH OPTIONS
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
38: is executed and
39: .B vtysh
40: exits.
41:
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.
55: .IP "\fB\-e, \-\-execute \fIcommand\fP"
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.
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.
64: .IP "\fB\-h, \-\-help\fP"
65: Display a usage message on standard output and exit.
66: .SH ENVIRONMENT VARIABLES
67: .IP "\fBVTYSH_PAGER\fR"
68: This should be the name of the pager to use. Default is \fBmore\fR.
69: .SH FILES
70: .TP
71: .BI /usr/local/etc/vtysh.conf
72: The default location of the
73: .B vtysh
74: config file.
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).
79: .SH WARNING
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.
82: .SH "SEE ALSO"
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)
90: .SH BUGS
91: .B vtysh
92: eats bugs for breakfast. If you have food for the maintainers try
93: .BI http://bugzilla.quagga.net
94: .SH AUTHORS
95: See
96: .BI http://www.zebra.org
97: and
98: .BI http://www.quagga.net
99: or the Info file for an accurate list of authors.
100:
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>