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 <qlyoung@cumulusnetworks.com>
Before Width: | Height: | Size: 29 KiB After Width: | Height: | Size: 29 KiB |
Before Width: | Height: | Size: 78 KiB After Width: | Height: | Size: 78 KiB |
Before Width: | Height: | Size: 50 KiB After Width: | Height: | Size: 50 KiB |
Before Width: | Height: | Size: 49 KiB After Width: | Height: | Size: 49 KiB |
Before Width: | Height: | Size: 78 KiB After Width: | Height: | Size: 78 KiB |
Before Width: | Height: | Size: 66 KiB After Width: | Height: | Size: 66 KiB |
Before Width: | Height: | Size: 60 KiB After Width: | Height: | Size: 60 KiB |
Before Width: | Height: | Size: 74 KiB After Width: | Height: | Size: 74 KiB |
Before Width: | Height: | Size: 8.3 KiB After Width: | Height: | Size: 8.3 KiB |
Before Width: | Height: | Size: 9.8 KiB After Width: | Height: | Size: 9.8 KiB |
Before Width: | Height: | Size: 22 KiB After Width: | Height: | Size: 22 KiB |
Before Width: | Height: | Size: 20 KiB After Width: | Height: | Size: 20 KiB |
Before Width: | Height: | Size: 6.4 KiB After Width: | Height: | Size: 6.4 KiB |
Before Width: | Height: | Size: 36 KiB After Width: | Height: | Size: 36 KiB |
Before Width: | Height: | Size: 35 KiB After Width: | Height: | Size: 35 KiB |
65
doc/frr.1.in
@ -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.
|
||||
|
140
doc/frr.texi
@ -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
|
103
doc/vtysh.1.in
@ -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.
|
||||
|