doc/frr.texi

   1 \input texinfo @c -*- texinfo -*-
   2
   3 @c Set variables - sourced from defines.texi
   4 @include defines.texi
   5
   6 @c %**start of header
   7 @setfilename frr.info
   8 @c Set variables - sourced from defines.texi
   9 @include defines.texi
  10 @settitle @uref{http://www.frrouting.org,,@value{PACKAGE_NAME}}
  11 @c %**end of header
  12
  13 @c automake will automatically generate version.texi
  14 @c and set EDITION, VERSION, UPDATED and UPDATED-MONTH
  15 @include version.texi
  16
  17 @copying
  18 @value{COPYRIGHT_STR}
  19 @quotation
  20
  21 Permission is granted to make and distribute verbatim copies of this
  22 manual provided the copyright notice and this permission notice are
  23 preserved on all copies.
  24
  25 Permission is granted to copy and distribute modified versions of this
  26 manual under the conditions for verbatim copying, provided that the
  27 entire resulting derived work is distributed under the terms of a
  28 permission notice identical to this one.
  29
  30 Permission is granted to copy and distribute translations of this manual
  31 into another language, under the above conditions for modified versions,
  32 except that this permission notice may be stated in a translation
  33 approved by Kunihiro Ishiguro.
  34
  35 @end quotation
  36 @end copying
  37
  38 @c Info entry
  39 @dircategory Routing Software:
  40 @direntry
  41 * @value{PACKAGE_NAME}: (frr).          The Frr Suite
  42 @end direntry
  43
  44 @c @smallbook
  45
  46 @ifinfo
  47 This file documents the Frr Software Routing Suite which manages common
  48 TCP/IP routing protocols.
  49
  50 This is Edition @value{EDITION}, last updated @value{UPDATED} of
  51 @cite{The Frr Manual}, for @uref{http://www.frrouting.org/,,@value{PACKAGE_NAME}}
  52 Version @value{VERSION}.
  53
  54 @insertcopying
  55 @end ifinfo
  56
  57 @titlepage
  58 @title @uref{http://www.frrouting.org,,Frr}
  59 @subtitle A routing software package for TCP/IP networks
  60 @subtitle @uref{http://www.frrouting.org,,@value{PACKAGE_NAME}} @value{VERSION}
  61 @subtitle @value{UPDATED-MONTH}
  62 @author @value{AUTHORS}
  63
  64 @page
  65 @vskip 0pt plus 1filll
  66
  67 @insertcopying
  68 @end titlepage
  69 @page
  70
  71 @ifnottex
  72 @node Top
  73 @top Frr -- With Virtual Network Control
  74
  75 @uref{http://www.frrouting.org,,Frr} is an advanced routing software package
  76 that provides a suite of TCP/IP based routing protocols.  This is the Manual
  77 for @value{PACKAGE_STRING}. @uref{http://www.frrouting.org,,Frr} is a fork of
  78 @uref{http://www.quagga.net,,Quagga}.
  79
  80 @insertcopying
  81 @end ifnottex
  82
  83 @menu
  84 * Overview::
  85 * Installation::
  86 * Basic commands::
  87 * Zebra::
  88 * RIP::
  89 * RIPng::
  90 * OSPFv2::
  91 * OSPFv3::
  92 * ISIS::
  93 * NHRP::
  94 * BGP::
  95 * Configuring Frr as a Route Server::
  96 * VNC and VNC-GW::
  97 * VTY shell::
  98 * Filtering::
  99 * Route Map::
 100 * IPv6 Support::
 101 * Kernel Interface::
 102 * SNMP Support::
 103 * Zebra Protocol::
 104 * Packet Binary Dump Format::
 105 * Command Index::
 106 * VTY Key Index::
 107 * Index::
 108 @end menu
 109 @contents
 110
 111 @include overview.texi
 112 @include install.texi
 113 @include basic.texi
 114 @include main.texi
 115 @include ripd.texi
 116 @include ripngd.texi
 117 @include ospfd.texi
 118 @include ospf6d.texi
 119 @include isisd.texi
 120 @include nhrpd.texi
 121 @include bgpd.texi
 122 @include routeserver.texi
 123 @include vnc.texi
 124 @include vtysh.texi
 125 @include filter.texi
 126 @include routemap.texi
 127 @include ipv6.texi
 128 @include kernel.texi
 129 @include snmp.texi
 130 @include protocol.texi
 131 @include appendix.texi
 132
 133 @node Command Index
 134 @unnumbered Command Index
 135
 136 @printindex fn
 137
 138 @node VTY Key Index
 139 @unnumbered VTY Key Index
 140
 141 @printindex ky
 142
 143 @node Index
 144 @unnumbered Index
 145
 146 @printindex cp
 147 @bye