]>
Commit | Line | Data |
---|---|---|
a07169b1 | 1 | .TH VTYSH 1 "27 July 2006" "@PACKAGE_FULLNAME@ VTY shell" "Version @PACKAGE_VERSION@" |
718e3744 | 2 | .SH NAME |
a07169b1 | 3 | vtysh \- a integrated shell for @PACKAGE_FULLNAME@. |
718e3744 | 4 | .SH SYNOPSIS |
5 | .B vtysh | |
6 | [ | |
246c135e | 7 | .B \-b |
718e3744 | 8 | ] |
246c135e | 9 | .br |
10 | .B vtysh | |
11 | [ | |
f366ad31 AS |
12 | .B \-E |
13 | ] [ | |
14 | .B \-d | |
15 | .I daemon | |
16 | ] | |
17 | ] [ | |
246c135e | 18 | .B \-c |
19 | .I command | |
20 | ] | |
21 | .SH DESCRIPTION | |
718e3744 | 22 | .B vtysh |
23 | is a integrated shell for | |
a07169b1 | 24 | .B @PACKAGE_FULLNAME@ |
718e3744 | 25 | routing engine. |
718e3744 | 26 | .SH OPTIONS |
246c135e | 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 | |
a07169b1 DL |
32 | file is in use (not default in @PACKAGE_FULLNAME@). See Info file |
33 | \fB@PACKAGE_NAME@\fR for more info. | |
246c135e | 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 | |
f366ad31 AS |
38 | is executed and |
39 | .B vtysh | |
40 | exits. | |
246c135e | 41 | |
a07169b1 | 42 | It's useful for gathering info from @PACKAGE_FULLNAME@ daemons or reconfiguring |
f366ad31 AS |
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 | |
a07169b1 | 51 | attempts to connect to all @PACKAGE_FULLNAME@ daemons running on the system. With this |
f366ad31 AS |
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. | |
246c135e | 55 | .IP "\fB\-e, \-\-execute \fIcommand\fP" |
67e29abc | 56 | Alias for -c. It's here only for compatibility with Zebra routing software and |
438f5286 | 57 | older Frr versions. This will be removed in future. |
f366ad31 AS |
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. | |
246c135e | 64 | .IP "\fB\-h, \-\-help\fP" |
65 | Display a usage message on standard output and exit. | |
00b0bbcd | 66 | .SH ENVIRONMENT VARIABLES |
00b0bbcd | 67 | .IP "\fBVTYSH_PAGER\fR" |
68 | This should be the name of the pager to use. Default is \fBmore\fR. | |
718e3744 | 69 | .SH FILES |
718e3744 | 70 | .TP |
a07169b1 | 71 | .BI @CFG_SYSCONF@/vtysh.conf |
718e3744 | 72 | The default location of the |
73 | .B vtysh | |
74 | config file. | |
246c135e | 75 | .TP |
e20dc2ba | 76 | .BI @CFG_SYSCONF@/frr.conf |
a07169b1 | 77 | The default location of the integrated @PACKAGE_FULLNAME@ routing engine config file |
246c135e | 78 | if integrated config file is in use (not default). |
fba55c8a | 79 | .TP |
438f5286 | 80 | .BI ${HOME}/.history_frr |
fba55c8a | 81 | Location of history of commands entered via cli |
718e3744 | 82 | .SH WARNING |
246c135e | 83 | This man page is intended to be a quick reference for command line |
a07169b1 | 84 | options. The definitive document is the Info file \fB@PACKAGE_NAME@\fR. |
718e3744 | 85 | .SH "SEE ALSO" |
246c135e | 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) | |
718e3744 | 93 | .SH BUGS |
94 | .B vtysh | |
95 | eats bugs for breakfast. If you have food for the maintainers try | |
a07169b1 | 96 | .BI @PACKAGE_BUGREPORT@ |
246c135e | 97 | .SH AUTHORS |
98 | See | |
99 | .BI http://www.zebra.org | |
100 | and | |
a07169b1 | 101 | .BI @PACKAGE_URL@ |
246c135e | 102 | or the Info file for an accurate list of authors. |
718e3744 | 103 |