From 3eb7a2f08bc8ee3b3f69ae0fda37a662fdb752a1 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Tue, 30 Jan 2018 16:14:24 -0500 Subject: [PATCH] doc: reorganize * Move all developer related docs into developer/ * Move all figures into their own directory * Move manpages to own directory Signed-off-by: Quentin Young --- doc/{ => developer}/BGP-TypeCode | 0 doc/{ => developer}/OSPF-API.md | 0 doc/{ => developer}/dev-modules.md | 0 doc/{ => developer}/draft-zebra-00.ms | 0 doc/{ => developer}/ldpd-basic-test-setup.md | 0 doc/{ => figures}/fig-normal-processing.dia | 0 doc/{ => figures}/fig-normal-processing.png | Bin doc/{ => figures}/fig-normal-processing.txt | 0 doc/{ => figures}/fig-rs-processing.dia | 0 doc/{ => figures}/fig-rs-processing.png | Bin doc/{ => figures}/fig-rs-processing.txt | 0 .../fig-vnc-commercial-route-reflector.dia | 0 .../fig-vnc-commercial-route-reflector.png | Bin .../fig-vnc-commercial-route-reflector.txt | 0 .../fig-vnc-frr-route-reflector.dia | 0 .../fig-vnc-frr-route-reflector.png | Bin .../fig-vnc-frr-route-reflector.txt | 0 doc/{ => figures}/fig-vnc-gw-rr.dia | 0 doc/{ => figures}/fig-vnc-gw-rr.png | Bin doc/{ => figures}/fig-vnc-gw-rr.txt | 0 doc/{ => figures}/fig-vnc-gw.dia | 0 doc/{ => figures}/fig-vnc-gw.png | Bin doc/{ => figures}/fig-vnc-gw.txt | 0 doc/{ => figures}/fig-vnc-mesh.dia | 0 doc/{ => figures}/fig-vnc-mesh.png | Bin doc/{ => figures}/fig-vnc-mesh.txt | 0 .../fig-vnc-redundant-route-reflectors.dia | 0 .../fig-vnc-redundant-route-reflectors.png | Bin .../fig-vnc-redundant-route-reflectors.txt | 0 doc/{ => figures}/fig_topologies_full.dia | 0 doc/{ => figures}/fig_topologies_full.png | Bin doc/{ => figures}/fig_topologies_full.txt | 0 doc/{ => figures}/fig_topologies_rs.dia | 0 doc/{ => figures}/fig_topologies_rs.png | Bin doc/{ => figures}/fig_topologies_rs.txt | 0 doc/{ => figures}/git_branches.svg | 0 doc/{ => figures}/ospf_api_architecture.png | Bin doc/{ => figures}/ospf_api_msghdr.png | Bin doc/{ => figures}/ospf_api_msgs1.png | Bin doc/{ => figures}/ospf_api_msgs2.png | Bin doc/frr.1.in | 65 -------- doc/frr.texi | 140 ------------------ doc/index.rst | 0 doc/{ => manpages}/bgpd.8.in | 0 doc/{ => manpages}/eigrpd.8.in | 0 doc/{ => manpages}/frr-args.8.in | 0 doc/{ => manpages}/isisd.8.in | 0 doc/{ => manpages}/ldpd.8.in | 0 doc/{ => manpages}/nhrpd.8.in | 0 doc/{ => manpages}/ospf6d.8.in | 0 doc/{ => manpages}/ospfclient.8.in | 0 doc/{ => manpages}/ospfd.8.in | 0 doc/{ => manpages}/pimd.8.in | 0 doc/{ => manpages}/ripd.8.in | 0 doc/{ => manpages}/ripngd.8.in | 0 doc/{ => manpages}/watchfrr.8.in | 0 doc/{ => manpages}/zebra.8.in | 0 doc/{ => user}/Useful_Sysctl_Settings.md | 0 doc/vtysh.1.in | 103 ------------- 59 files changed, 308 deletions(-) rename doc/{ => developer}/BGP-TypeCode (100%) rename doc/{ => developer}/OSPF-API.md (100%) rename doc/{ => developer}/dev-modules.md (100%) rename doc/{ => developer}/draft-zebra-00.ms (100%) rename doc/{ => developer}/ldpd-basic-test-setup.md (100%) rename doc/{ => figures}/fig-normal-processing.dia (100%) rename doc/{ => figures}/fig-normal-processing.png (100%) rename doc/{ => figures}/fig-normal-processing.txt (100%) rename doc/{ => figures}/fig-rs-processing.dia (100%) rename doc/{ => figures}/fig-rs-processing.png (100%) rename doc/{ => figures}/fig-rs-processing.txt (100%) rename doc/{ => figures}/fig-vnc-commercial-route-reflector.dia (100%) rename doc/{ => figures}/fig-vnc-commercial-route-reflector.png (100%) rename doc/{ => figures}/fig-vnc-commercial-route-reflector.txt (100%) rename doc/{ => figures}/fig-vnc-frr-route-reflector.dia (100%) rename doc/{ => figures}/fig-vnc-frr-route-reflector.png (100%) rename doc/{ => figures}/fig-vnc-frr-route-reflector.txt (100%) rename doc/{ => figures}/fig-vnc-gw-rr.dia (100%) rename doc/{ => figures}/fig-vnc-gw-rr.png (100%) rename doc/{ => figures}/fig-vnc-gw-rr.txt (100%) rename doc/{ => figures}/fig-vnc-gw.dia (100%) rename doc/{ => figures}/fig-vnc-gw.png (100%) rename doc/{ => figures}/fig-vnc-gw.txt (100%) rename doc/{ => figures}/fig-vnc-mesh.dia (100%) rename doc/{ => figures}/fig-vnc-mesh.png (100%) rename doc/{ => figures}/fig-vnc-mesh.txt (100%) rename doc/{ => figures}/fig-vnc-redundant-route-reflectors.dia (100%) rename doc/{ => figures}/fig-vnc-redundant-route-reflectors.png (100%) rename doc/{ => figures}/fig-vnc-redundant-route-reflectors.txt (100%) rename doc/{ => figures}/fig_topologies_full.dia (100%) rename doc/{ => figures}/fig_topologies_full.png (100%) rename doc/{ => figures}/fig_topologies_full.txt (100%) rename doc/{ => figures}/fig_topologies_rs.dia (100%) rename doc/{ => figures}/fig_topologies_rs.png (100%) rename doc/{ => figures}/fig_topologies_rs.txt (100%) rename doc/{ => figures}/git_branches.svg (100%) rename doc/{ => figures}/ospf_api_architecture.png (100%) rename doc/{ => figures}/ospf_api_msghdr.png (100%) rename doc/{ => figures}/ospf_api_msgs1.png (100%) rename doc/{ => figures}/ospf_api_msgs2.png (100%) delete mode 100644 doc/frr.1.in delete mode 100644 doc/frr.texi delete mode 100644 doc/index.rst rename doc/{ => manpages}/bgpd.8.in (100%) rename doc/{ => manpages}/eigrpd.8.in (100%) rename doc/{ => manpages}/frr-args.8.in (100%) rename doc/{ => manpages}/isisd.8.in (100%) rename doc/{ => manpages}/ldpd.8.in (100%) rename doc/{ => manpages}/nhrpd.8.in (100%) rename doc/{ => manpages}/ospf6d.8.in (100%) rename doc/{ => manpages}/ospfclient.8.in (100%) rename doc/{ => manpages}/ospfd.8.in (100%) rename doc/{ => manpages}/pimd.8.in (100%) rename doc/{ => manpages}/ripd.8.in (100%) rename doc/{ => manpages}/ripngd.8.in (100%) rename doc/{ => manpages}/watchfrr.8.in (100%) rename doc/{ => manpages}/zebra.8.in (100%) rename doc/{ => user}/Useful_Sysctl_Settings.md (100%) delete mode 100644 doc/vtysh.1.in diff --git a/doc/BGP-TypeCode b/doc/developer/BGP-TypeCode similarity index 100% rename from doc/BGP-TypeCode rename to doc/developer/BGP-TypeCode diff --git a/doc/OSPF-API.md b/doc/developer/OSPF-API.md similarity index 100% rename from doc/OSPF-API.md rename to doc/developer/OSPF-API.md diff --git a/doc/dev-modules.md b/doc/developer/dev-modules.md similarity index 100% rename from doc/dev-modules.md rename to doc/developer/dev-modules.md diff --git a/doc/draft-zebra-00.ms b/doc/developer/draft-zebra-00.ms similarity index 100% rename from doc/draft-zebra-00.ms rename to doc/developer/draft-zebra-00.ms diff --git a/doc/ldpd-basic-test-setup.md b/doc/developer/ldpd-basic-test-setup.md similarity index 100% rename from doc/ldpd-basic-test-setup.md rename to doc/developer/ldpd-basic-test-setup.md diff --git a/doc/fig-normal-processing.dia b/doc/figures/fig-normal-processing.dia similarity index 100% rename from doc/fig-normal-processing.dia rename to doc/figures/fig-normal-processing.dia diff --git a/doc/fig-normal-processing.png b/doc/figures/fig-normal-processing.png similarity index 100% rename from doc/fig-normal-processing.png rename to doc/figures/fig-normal-processing.png diff --git a/doc/fig-normal-processing.txt b/doc/figures/fig-normal-processing.txt similarity index 100% rename from doc/fig-normal-processing.txt rename to doc/figures/fig-normal-processing.txt diff --git a/doc/fig-rs-processing.dia b/doc/figures/fig-rs-processing.dia similarity index 100% rename from doc/fig-rs-processing.dia rename to doc/figures/fig-rs-processing.dia diff --git a/doc/fig-rs-processing.png b/doc/figures/fig-rs-processing.png similarity index 100% rename from doc/fig-rs-processing.png rename to doc/figures/fig-rs-processing.png diff --git a/doc/fig-rs-processing.txt b/doc/figures/fig-rs-processing.txt similarity index 100% rename from doc/fig-rs-processing.txt rename to doc/figures/fig-rs-processing.txt diff --git a/doc/fig-vnc-commercial-route-reflector.dia b/doc/figures/fig-vnc-commercial-route-reflector.dia similarity index 100% rename from doc/fig-vnc-commercial-route-reflector.dia rename to doc/figures/fig-vnc-commercial-route-reflector.dia diff --git a/doc/fig-vnc-commercial-route-reflector.png b/doc/figures/fig-vnc-commercial-route-reflector.png similarity index 100% rename from doc/fig-vnc-commercial-route-reflector.png rename to doc/figures/fig-vnc-commercial-route-reflector.png diff --git a/doc/fig-vnc-commercial-route-reflector.txt b/doc/figures/fig-vnc-commercial-route-reflector.txt similarity index 100% rename from doc/fig-vnc-commercial-route-reflector.txt rename to doc/figures/fig-vnc-commercial-route-reflector.txt diff --git a/doc/fig-vnc-frr-route-reflector.dia b/doc/figures/fig-vnc-frr-route-reflector.dia similarity index 100% rename from doc/fig-vnc-frr-route-reflector.dia rename to doc/figures/fig-vnc-frr-route-reflector.dia diff --git a/doc/fig-vnc-frr-route-reflector.png b/doc/figures/fig-vnc-frr-route-reflector.png similarity index 100% rename from doc/fig-vnc-frr-route-reflector.png rename to doc/figures/fig-vnc-frr-route-reflector.png diff --git a/doc/fig-vnc-frr-route-reflector.txt b/doc/figures/fig-vnc-frr-route-reflector.txt similarity index 100% rename from doc/fig-vnc-frr-route-reflector.txt rename to doc/figures/fig-vnc-frr-route-reflector.txt diff --git a/doc/fig-vnc-gw-rr.dia b/doc/figures/fig-vnc-gw-rr.dia similarity index 100% rename from doc/fig-vnc-gw-rr.dia rename to doc/figures/fig-vnc-gw-rr.dia diff --git a/doc/fig-vnc-gw-rr.png b/doc/figures/fig-vnc-gw-rr.png similarity index 100% rename from doc/fig-vnc-gw-rr.png rename to doc/figures/fig-vnc-gw-rr.png diff --git a/doc/fig-vnc-gw-rr.txt b/doc/figures/fig-vnc-gw-rr.txt similarity index 100% rename from doc/fig-vnc-gw-rr.txt rename to doc/figures/fig-vnc-gw-rr.txt diff --git a/doc/fig-vnc-gw.dia b/doc/figures/fig-vnc-gw.dia similarity index 100% rename from doc/fig-vnc-gw.dia rename to doc/figures/fig-vnc-gw.dia diff --git a/doc/fig-vnc-gw.png b/doc/figures/fig-vnc-gw.png similarity index 100% rename from doc/fig-vnc-gw.png rename to doc/figures/fig-vnc-gw.png diff --git a/doc/fig-vnc-gw.txt b/doc/figures/fig-vnc-gw.txt similarity index 100% rename from doc/fig-vnc-gw.txt rename to doc/figures/fig-vnc-gw.txt diff --git a/doc/fig-vnc-mesh.dia b/doc/figures/fig-vnc-mesh.dia similarity index 100% rename from doc/fig-vnc-mesh.dia rename to doc/figures/fig-vnc-mesh.dia diff --git a/doc/fig-vnc-mesh.png b/doc/figures/fig-vnc-mesh.png similarity index 100% rename from doc/fig-vnc-mesh.png rename to doc/figures/fig-vnc-mesh.png diff --git a/doc/fig-vnc-mesh.txt b/doc/figures/fig-vnc-mesh.txt similarity index 100% rename from doc/fig-vnc-mesh.txt rename to doc/figures/fig-vnc-mesh.txt diff --git a/doc/fig-vnc-redundant-route-reflectors.dia b/doc/figures/fig-vnc-redundant-route-reflectors.dia similarity index 100% rename from doc/fig-vnc-redundant-route-reflectors.dia rename to doc/figures/fig-vnc-redundant-route-reflectors.dia diff --git a/doc/fig-vnc-redundant-route-reflectors.png b/doc/figures/fig-vnc-redundant-route-reflectors.png similarity index 100% rename from doc/fig-vnc-redundant-route-reflectors.png rename to doc/figures/fig-vnc-redundant-route-reflectors.png diff --git a/doc/fig-vnc-redundant-route-reflectors.txt b/doc/figures/fig-vnc-redundant-route-reflectors.txt similarity index 100% rename from doc/fig-vnc-redundant-route-reflectors.txt rename to doc/figures/fig-vnc-redundant-route-reflectors.txt diff --git a/doc/fig_topologies_full.dia b/doc/figures/fig_topologies_full.dia similarity index 100% rename from doc/fig_topologies_full.dia rename to doc/figures/fig_topologies_full.dia diff --git a/doc/fig_topologies_full.png b/doc/figures/fig_topologies_full.png similarity index 100% rename from doc/fig_topologies_full.png rename to doc/figures/fig_topologies_full.png diff --git a/doc/fig_topologies_full.txt b/doc/figures/fig_topologies_full.txt similarity index 100% rename from doc/fig_topologies_full.txt rename to doc/figures/fig_topologies_full.txt diff --git a/doc/fig_topologies_rs.dia b/doc/figures/fig_topologies_rs.dia similarity index 100% rename from doc/fig_topologies_rs.dia rename to doc/figures/fig_topologies_rs.dia diff --git a/doc/fig_topologies_rs.png b/doc/figures/fig_topologies_rs.png similarity index 100% rename from doc/fig_topologies_rs.png rename to doc/figures/fig_topologies_rs.png diff --git a/doc/fig_topologies_rs.txt b/doc/figures/fig_topologies_rs.txt similarity index 100% rename from doc/fig_topologies_rs.txt rename to doc/figures/fig_topologies_rs.txt diff --git a/doc/git_branches.svg b/doc/figures/git_branches.svg similarity index 100% rename from doc/git_branches.svg rename to doc/figures/git_branches.svg diff --git a/doc/ospf_api_architecture.png b/doc/figures/ospf_api_architecture.png similarity index 100% rename from doc/ospf_api_architecture.png rename to doc/figures/ospf_api_architecture.png diff --git a/doc/ospf_api_msghdr.png b/doc/figures/ospf_api_msghdr.png similarity index 100% rename from doc/ospf_api_msghdr.png rename to doc/figures/ospf_api_msghdr.png diff --git a/doc/ospf_api_msgs1.png b/doc/figures/ospf_api_msgs1.png similarity index 100% rename from doc/ospf_api_msgs1.png rename to doc/figures/ospf_api_msgs1.png diff --git a/doc/ospf_api_msgs2.png b/doc/figures/ospf_api_msgs2.png similarity index 100% rename from doc/ospf_api_msgs2.png rename to doc/figures/ospf_api_msgs2.png diff --git a/doc/frr.1.in b/doc/frr.1.in deleted file mode 100644 index 528358a8d0..0000000000 --- a/doc/frr.1.in +++ /dev/null @@ -1,65 +0,0 @@ -.TH Frr 1 "27 July 2006" "@PACKAGE_FULLNAME@ Systemd Script" "Version @PACKAGE_VERSION@" -.SH NAME -frr \- a systemd interaction script -.SH SYNOPSIS -.B frr -[ -.B start -] -.br -.B frr -[ -.B stop -] -.br -.B frr -[ -.B reload -] -.br -.B frr -[ -.B restart -] -.br -.B frr -[ -.B status -] -.br -.SH DESCRIPTION -.B @PACKAGE_NAME@ -is a systemd interaction script for the -.B @PACKAGE_FULLNAME@ -routing engine. -.SH OPTIONS -Options available for the -.B frr -command: -.IP start -Start enabled Frr daemons -.IP stop -Stop enabled Frr daemons -.IP reload -Reload modified configuration files -.IP restart -Stop all running daemons and then restart them -.IP status -Status of all the daemons -.SH "SEE ALSO" -.BR bgpd (8), -.BR ripd (8), -.BR ripngd (8), -.BR ospfd (8), -.BR ospf6d (8), -.BR isisd (8), -.BR zebra (8) -.SH BUGS -.B frr -eats bugs for breakfast. If you have food for the maintainers try -.BI @PACKAGE_BUGREPORT@ -.SH AUTHORS -See -.BI @PACKAGE_URL@ -or the Info file for an accurate list of authors. - diff --git a/doc/frr.texi b/doc/frr.texi deleted file mode 100644 index d268b4b981..0000000000 --- a/doc/frr.texi +++ /dev/null @@ -1,140 +0,0 @@ -\input texinfo @c -*- texinfo -*- - -@c Set variables - sourced from defines.texi -@include defines.texi - -@c %**start of header -@setfilename frr.info -@c Set variables - sourced from defines.texi -@include defines.texi -@settitle @uref{@value{PACKAGE_URL},,@value{PACKAGE_NAME}} -@c %**end of header - -@copying -@value{COPYRIGHT_STR} -@quotation - -Permission is granted to make and distribute verbatim copies of this -manual provided the copyright notice and this permission notice are -preserved on all copies. - -Permission is granted to copy and distribute modified versions of this -manual under the conditions for verbatim copying, provided that the -entire resulting derived work is distributed under the terms of a -permission notice identical to this one. - -Permission is granted to copy and distribute translations of this manual -into another language, under the above conditions for modified versions, -except that this permission notice may be stated in a translation -approved by Kunihiro Ishiguro. - -@end quotation -@end copying - -@c Info entry -@dircategory Routing Software: -@direntry -* @value{PACKAGE_NAME}: (frr). The Frr Suite -@end direntry - -@c @smallbook - -@ifinfo -This file documents the @uref{@value{PACKAGE_URL},,Frr Software Routing Suite} -which manages common TCP/IP routing protocols. - -This document was generated for version @value{PACKAGE_VERSION}. - -@insertcopying -@end ifinfo - -@titlepage -@title @uref{@value{PACKAGE_URL},,Frr} -@subtitle A routing software package for TCP/IP networks -@subtitle @uref{@value{PACKAGE_URL},,@value{PACKAGE_NAME}} @value{PACKAGE_VERSION} -@author @value{AUTHORS} - -@page -@vskip 0pt plus 1filll - -@insertcopying -@end titlepage -@page - -@ifnottex -@node Top -@top Frr -- With Virtual Network Control - -@uref{@value{PACKAGE_URL},,Frr} is an advanced routing software package -that provides a suite of TCP/IP based routing protocols. This is the Manual -for @value{PACKAGE_STRING}. @uref{@value{PACKAGE_URL},,Frr} is a fork of -@uref{http://www.quagga.net,,Quagga}. - -@insertcopying -@end ifnottex - -@menu -* Overview:: -* Installation:: -* Basic commands:: -* Zebra:: -* RIP:: -* RIPng:: -* OSPFv2:: -* OSPFv3:: -* ISIS:: -* NHRP:: -* BGP:: -* Configuring Frr as a Route Server:: -* VNC and VNC-GW:: -* VTY shell:: -* Filtering:: -* Route Map:: -* IPv6 Support:: -* Kernel Interface:: -* SNMP Support:: -* Zebra Protocol:: -* Packet Binary Dump Format:: -* Command Index:: -* VTY Key Index:: -* Index:: -@end menu -@contents - -@include overview.texi -@include install.texi -@include basic.texi -@include main.texi -@include ripd.texi -@include ripngd.texi -@include ospfd.texi -@include ospf6d.texi -@include isisd.texi -@include nhrpd.texi -@include bgpd.texi -@include routeserver.texi -@include vnc.texi -@include vtysh.texi -@include filter.texi -@include routemap.texi -@include ipv6.texi -@include kernel.texi -@include snmp.texi -@include protocol.texi -@include appendix.texi - -@node Command Index -@unnumbered Command Index - -@printindex fn - -@node VTY Key Index -@unnumbered VTY Key Index - -@printindex ky - -@node Index -@unnumbered Index - -@printindex cp -@bye diff --git a/doc/index.rst b/doc/index.rst deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/doc/bgpd.8.in b/doc/manpages/bgpd.8.in similarity index 100% rename from doc/bgpd.8.in rename to doc/manpages/bgpd.8.in diff --git a/doc/eigrpd.8.in b/doc/manpages/eigrpd.8.in similarity index 100% rename from doc/eigrpd.8.in rename to doc/manpages/eigrpd.8.in diff --git a/doc/frr-args.8.in b/doc/manpages/frr-args.8.in similarity index 100% rename from doc/frr-args.8.in rename to doc/manpages/frr-args.8.in diff --git a/doc/isisd.8.in b/doc/manpages/isisd.8.in similarity index 100% rename from doc/isisd.8.in rename to doc/manpages/isisd.8.in diff --git a/doc/ldpd.8.in b/doc/manpages/ldpd.8.in similarity index 100% rename from doc/ldpd.8.in rename to doc/manpages/ldpd.8.in diff --git a/doc/nhrpd.8.in b/doc/manpages/nhrpd.8.in similarity index 100% rename from doc/nhrpd.8.in rename to doc/manpages/nhrpd.8.in diff --git a/doc/ospf6d.8.in b/doc/manpages/ospf6d.8.in similarity index 100% rename from doc/ospf6d.8.in rename to doc/manpages/ospf6d.8.in diff --git a/doc/ospfclient.8.in b/doc/manpages/ospfclient.8.in similarity index 100% rename from doc/ospfclient.8.in rename to doc/manpages/ospfclient.8.in diff --git a/doc/ospfd.8.in b/doc/manpages/ospfd.8.in similarity index 100% rename from doc/ospfd.8.in rename to doc/manpages/ospfd.8.in diff --git a/doc/pimd.8.in b/doc/manpages/pimd.8.in similarity index 100% rename from doc/pimd.8.in rename to doc/manpages/pimd.8.in diff --git a/doc/ripd.8.in b/doc/manpages/ripd.8.in similarity index 100% rename from doc/ripd.8.in rename to doc/manpages/ripd.8.in diff --git a/doc/ripngd.8.in b/doc/manpages/ripngd.8.in similarity index 100% rename from doc/ripngd.8.in rename to doc/manpages/ripngd.8.in diff --git a/doc/watchfrr.8.in b/doc/manpages/watchfrr.8.in similarity index 100% rename from doc/watchfrr.8.in rename to doc/manpages/watchfrr.8.in diff --git a/doc/zebra.8.in b/doc/manpages/zebra.8.in similarity index 100% rename from doc/zebra.8.in rename to doc/manpages/zebra.8.in diff --git a/doc/Useful_Sysctl_Settings.md b/doc/user/Useful_Sysctl_Settings.md similarity index 100% rename from doc/Useful_Sysctl_Settings.md rename to doc/user/Useful_Sysctl_Settings.md diff --git a/doc/vtysh.1.in b/doc/vtysh.1.in deleted file mode 100644 index ba8f3df720..0000000000 --- a/doc/vtysh.1.in +++ /dev/null @@ -1,103 +0,0 @@ -.TH VTYSH 1 "27 July 2006" "@PACKAGE_FULLNAME@ VTY shell" "Version @PACKAGE_VERSION@" -.SH NAME -vtysh \- a integrated shell for @PACKAGE_FULLNAME@. -.SH SYNOPSIS -.B vtysh -[ -.B \-b -] -.br -.B vtysh -[ -.B \-E -] [ -.B \-d -.I daemon -] -] [ -.B \-c -.I command -] -.SH DESCRIPTION -.B vtysh -is a integrated shell for -.B @PACKAGE_FULLNAME@ -routing engine. -.SH OPTIONS -Options available for the -.B vtysh -command: -.IP "\fB\-b, \-\-boot\fP" -Execute boot startup configuration. It makes sense only if integrated config -file is in use (not default in @PACKAGE_FULLNAME@). See Info file -\fB@PACKAGE_NAME@\fR for more info. -.IP "\fB\-c, \-\-command \fIcommand\fP" -Specify command to be executed under batch mode. It behaves like -c option in -any other shell - -.I command -is executed and -.B vtysh -exits. - -It's useful for gathering info from @PACKAGE_FULLNAME@ daemons or reconfiguring -daemons from inside shell scripts, etc. -Note that multiple commands may be executed by using more than one --c option and/or embedding linefeed characters inside the -.I command -string. -.IP "\fB\-d, \-\-daemon \fIdaemon_name\fP" -Specify which daemon to connect to. By default, -.B vtysh -attempts to connect to all @PACKAGE_FULLNAME@ daemons running on the system. With this -flag, one can specify a single daemon to connect to instead. For example, -specifying '-d ospfd' will connect only to ospfd. This can be particularly -useful inside scripts with -c where the command is targeted for a single daemon. -.IP "\fB\-e, \-\-execute \fIcommand\fP" -Alias for -c. It's here only for compatibility with Zebra routing software and -older Frr versions. This will be removed in future. -.IP "\fB\-E, \-\-echo\fP" -When the -c option is being used, this flag will cause the standard -.B vtysh -prompt and command to be echoed prior to displaying the results. -This is particularly useful to separate the results -when executing multiple commands. -.IP "\fB\-h, \-\-help\fP" -Display a usage message on standard output and exit. -.SH ENVIRONMENT VARIABLES -.IP "\fBVTYSH_PAGER\fR" -This should be the name of the pager to use. Default is \fBmore\fR. -.SH FILES -.TP -.BI @CFG_SYSCONF@/vtysh.conf -The default location of the -.B vtysh -config file. -.TP -.BI @CFG_SYSCONF@/frr.conf -The default location of the integrated @PACKAGE_FULLNAME@ routing engine config file -if integrated config file is in use (not default). -.TP -.BI ${HOME}/.history_frr -Location of history of commands entered via cli -.SH WARNING -This man page is intended to be a quick reference for command line -options. The definitive document is the Info file \fB@PACKAGE_NAME@\fR. -.SH "SEE ALSO" -.BR bgpd (8), -.BR ripd (8), -.BR ripngd (8), -.BR ospfd (8), -.BR ospf6d (8), -.BR isisd (8), -.BR zebra (8) -.SH BUGS -.B vtysh -eats bugs for breakfast. If you have food for the maintainers try -.BI @PACKAGE_BUGREPORT@ -.SH AUTHORS -See -.BI http://www.zebra.org -and -.BI @PACKAGE_URL@ -or the Info file for an accurate list of authors. - -- 2.39.5