vtysh.1 2.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104
  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. It's useful for gathering info from Quagga routing software or reconfiguring
  42. daemons from inside shell scripts, etc.
  43. Note that multiple commands may be executed by using more than one
  44. -c option and/or embedding linefeed characters inside the
  45. .I command
  46. string.
  47. .IP "\fB\-d, \-\-daemon \fIdaemon_name\fP"
  48. Specify which daemon to connect to. By default,
  49. .B vtysh
  50. attempts to connect to all Quagga daemons running on the system. With this
  51. flag, one can specify a single daemon to connect to instead. For example,
  52. specifying '-d ospfd' will connect only to ospfd. This can be particularly
  53. useful inside scripts with -c where the command is targeted for a single daemon.
  54. .IP "\fB\-e, \-\-execute \fIcommand\fP"
  55. Alias for -c. It's here only for compatibility with Zebra routing software and
  56. older Quagga versions. This will be removed in future.
  57. .IP "\fB\-E, \-\-echo\fP"
  58. When the -c option is being used, this flag will cause the standard
  59. .B vtysh
  60. prompt and command to be echoed prior to displaying the results.
  61. This is particularly useful to separate the results
  62. when executing multiple commands.
  63. .IP "\fB\-h, \-\-help\fP"
  64. Display a usage message on standard output and exit.
  65. .SH ENVIRONMENT VARIABLES
  66. .IP "\fBVTYSH_PAGER\fR"
  67. This should be the name of the pager to use. Default is \fBmore\fR.
  68. .SH FILES
  69. .TP
  70. .BI /usr/local/etc/vtysh.conf
  71. The default location of the
  72. .B vtysh
  73. config file.
  74. .TP
  75. .BI /usr/local/etc/Quagga.conf
  76. The default location of the integrated Quagga routing engine config file
  77. if integrated config file is in use (not default).
  78. .TP
  79. .BI ${HOME}/.history_quagga
  80. Location of history of commands entered via cli
  81. .SH WARNING
  82. This man page is intended to be a quick reference for command line
  83. options. The definitive document is the Info file \fBQuagga\fR.
  84. .SH "SEE ALSO"
  85. .BR bgpd (8),
  86. .BR ripd (8),
  87. .BR ripngd (8),
  88. .BR ospfd (8),
  89. .BR ospf6d (8),
  90. .BR isisd (8),
  91. .BR zebra (8)
  92. .SH BUGS
  93. .B vtysh
  94. eats bugs for breakfast. If you have food for the maintainers try
  95. .BI http://bugzilla.quagga.net
  96. .SH AUTHORS
  97. See
  98. .BI http://www.zebra.org
  99. and
  100. .BI http://www.quagga.net
  101. or the Info file for an accurate list of authors.