2004-11-06 Paul Jakma <paul@dishone.st>
* defines.texi.in: New file, texi variables should be set here,
autoconf substitution is available. Define common AUTHORS,
COPYRIGHT_YEAR and COPYRIGHT_STR vars.
* (global): Make use of makeinfo node pointer auto-creation
to avoid having to fully specify links for nodes, so we only have
to specify current node name - simplifies text slightly.
Remove extraneous newlines which appear to cause extra blank pages
to be added in output.
Update copyright strings which appear in various places to
use the new COPYRIGHT_STR texinfo variable.
Change url to uref, the former need not output an actual
hyperlink depending on version of texinfo, the latter should if
supported by the format (eg PDF).
* texinfo.tex: Update to a more recent version. previous file
was many many years old. This file should possibly be removed
altogether, and allowed to be installed by automake.
* quagga.texi: Make use of automake's version.texi feature to
have VERSION and some other vars auto-defined. include
defines.texi. Change copyright strings to use the COPYRIGHT_STR
variable.
* install.texi: Make the privs section an actual section. Ditto for
the Linux notes.
* overview.texi: Supply URL for Quagga, where format allows. Tidy up
one or two paragraphs slightly.
Update the section on supported platforms.
Remove the ZNOG list stuff, direct reader to the website for
further information on email lists.
* vtysh.texi: Update the integrated config file section. Make the
commands sections so correct PDF indexes are built.
diff --git a/doc/bgpd.texi b/doc/bgpd.texi
index bdec688..dab367c 100644
--- a/doc/bgpd.texi
+++ b/doc/bgpd.texi
@@ -1,9 +1,8 @@
@c -*-texinfo-*-
@c This is part of the Quagga Manual.
-@c Copyright (C) 1999, 2000, 2001 2002 Kunihiro Ishiguro <kunihiro@zebra.org>
-@c See file zebra.texi for copying conditions.
+@c @value{COPYRIGHT_STR}
+@c See file quagga.texi for copying conditions.
@node BGP
-@comment node-name, next, previous, up
@chapter BGP
BGP stands for a Border Gateway Protocol. The lastest BGP version
@@ -34,8 +33,7 @@
* Dump BGP packets and table::
@end menu
-@node Starting BGP, BGP router, BGP, BGP
-@comment node-name, next, previous, up
+@node Starting BGP
@section Starting BGP
Default configuration file of @command{bgpd} is @file{bgpd.conf}.
@@ -56,8 +54,7 @@
When program terminates, retain BGP routes added by zebra.
@end table
-@node BGP router, BGP network, Starting BGP, BGP
-@comment node-name, next, previous, up
+@node BGP router
@section BGP router
First of all you must configure BGP router with @command{router bgp}
@@ -89,8 +86,7 @@
* BGP decision process::
@end menu
-@node BGP distance, BGP decision process, BGP router, BGP router
-@comment node-name, next, previous, up
+@node BGP distance
@subsection BGP distance
@deffn {BGP} {distance bgp <1-255> <1-255> <1-255>} {}
@@ -103,8 +99,7 @@
This command set distance value to
@end deffn
-@node BGP decision process, , BGP distance, BGP router
-@comment node-name, next, previous, up
+@node BGP decision process
@subsection BGP decision process
@table @asis
@@ -121,8 +116,7 @@
@item 6. MED check.
@end table
-@node BGP network, BGP Peer, BGP router, BGP
-@comment node-name, next, previous, up
+@node BGP network
@section BGP network
@menu
@@ -131,8 +125,7 @@
* Redistribute to BGP::
@end menu
-@node BGP route, Route Aggregation, BGP network, BGP network
-@comment node-name, next, previous, up
+@node BGP route
@subsection BGP route
@deffn {BGP} {network @var{A.B.C.D/M}} {}
@@ -152,8 +145,7 @@
@deffn {BGP} {no network @var{A.B.C.D/M}} {}
@end deffn
-@node Route Aggregation, Redistribute to BGP, BGP route, BGP network
-@comment node-name, next, previous, up
+@node Route Aggregation
@subsection Route Aggregation
@deffn {BGP} {aggregate-address @var{A.B.C.D/M}} {}
@@ -173,8 +165,7 @@
@deffn {BGP} {no aggregate-address @var{A.B.C.D/M}} {}
@end deffn
-@node Redistribute to BGP, , Route Aggregation, BGP network
-@comment node-name, next, previous, up
+@node Redistribute to BGP
@subsection Redistribute to BGP
@deffn {BGP} {redistribute kernel} {}
@@ -197,8 +188,7 @@
Redistribute OSPF route to BGP process.
@end deffn
-@node BGP Peer, BGP Peer Group, BGP network, BGP
-@comment node-name, next, previous, up
+@node BGP Peer
@section BGP Peer
@menu
@@ -207,8 +197,7 @@
* Peer filtering::
@end menu
-@node Defining Peer, BGP Peer commands, BGP Peer, BGP Peer
-@comment node-name, next, previous, up
+@node Defining Peer
@subsection Defining Peer
@deffn {BGP} {neighbor @var{peer} remote-as @var{asn}} {}
@@ -230,8 +219,7 @@
@end example
@end deffn
-@node BGP Peer commands, Peer filtering, Defining Peer, BGP Peer
-@comment node-name, next, previous, up
+@node BGP Peer commands
@subsection BGP Peer commands
In a @code{router bgp} clause there are neighbor specific configurations
@@ -306,8 +294,7 @@
@deffnx {BGP} {no neighbor @var{peer} maximum-prefix @var{number}} {}
@end deffn
-@node Peer filtering, , BGP Peer commands, BGP Peer
-@comment node-name, next, previous, up
+@node Peer filtering
@subsection Peer filtering
@deffn {BGP} {neighbor @var{peer} distribute-list @var{name} [in|out]} {}
@@ -327,8 +314,7 @@
@end deffn
@c -----------------------------------------------------------------------
-@node BGP Peer Group, BGP Address Family, BGP Peer, BGP
-@comment node-name, next, previous, up
+@node BGP Peer Group
@section BGP Peer Group
@deffn {BGP} {neighbor @var{word} peer-group} {}
@@ -339,16 +325,14 @@
This command bind specific peer to peer group @var{word}.
@end deffn
-@node BGP Address Family, Autonomous System, BGP Peer Group, BGP
-@comment node-name, next, previous, up
+@node BGP Address Family
@section BGP Address Family
@page
@c -----------------------------------------------------------------------
-@node Autonomous System, BGP Communities Attribute, BGP Address Family, BGP
-@comment node-name, next, previous, up
+@node Autonomous System
@section Autonomous System
AS (Autonomous System) is one of the essential element of BGP. BGP
@@ -370,8 +354,7 @@
* Private AS Numbers::
@end menu
-@node AS Path Regular Expression, Display BGP Routes by AS Path, Autonomous System, Autonomous System
-@comment node-name, next, previous, up
+@node AS Path Regular Expression
@subsection AS Path Regular Expression
AS path regular expression can be used for displaying BGP routes and
@@ -403,8 +386,7 @@
matches to all of BGP routes which as AS number include @var{7675}.
@end table
-@node Display BGP Routes by AS Path, AS Path Access List, AS Path Regular Expression, Autonomous System
-@comment node-name, next, previous, up
+@node Display BGP Routes by AS Path
@subsection Display BGP Routes by AS Path
To show BGP routes which has specific AS path information @code{show
@@ -415,8 +397,7 @@
expression @var{line}.
@end deffn
-@node AS Path Access List, Using AS Path in Route Map, Display BGP Routes by AS Path, Autonomous System
-@comment node-name, next, previous, up
+@node AS Path Access List
@subsection AS Path Access List
AS path access list is user defined AS path.
@@ -429,8 +410,7 @@
@deffnx {Command} {no ip as-path access-list @var{word} @{permit|deny@} @var{line}} {}
@end deffn
-@node Using AS Path in Route Map, Private AS Numbers, AS Path Access List, Autonomous System
-@comment node-name, next, previous, up
+@node Using AS Path in Route Map
@subsection Using AS Path in Route Map
@deffn {Route Map} {match as-path @var{word}} {}
@@ -439,14 +419,12 @@
@deffn {Route Map} {set as-path prepend @var{as-path}} {}
@end deffn
-@node Private AS Numbers, , Using AS Path in Route Map, Autonomous System
-@comment node-name, next, previous, up
+@node Private AS Numbers
@subsection Private AS Numbers
@page
@c -----------------------------------------------------------------------
-@node BGP Communities Attribute, BGP Extended Communities Attribute, Autonomous System, BGP
-@comment node-name, next, previous, up
+@node BGP Communities Attribute
@section BGP Communities Attribute
BGP communities attribute is widely used for implementing policy
@@ -500,8 +478,7 @@
* Using BGP Communities Attribute::
@end menu
-@node BGP Community Lists, Numbered BGP Community Lists, BGP Communities Attribute, BGP Communities Attribute
-@comment node-name, next, previous, up
+@node BGP Community Lists
@subsection BGP Community Lists
BGP community list is a user defined BGP communites attribute list.
@@ -563,8 +540,7 @@
@end example
@end deffn
-@node Numbered BGP Community Lists, BGP Community in Route Map, BGP Community Lists, BGP Communities Attribute
-@comment node-name, next, previous, up
+@node Numbered BGP Community Lists
@subsection Numbered BGP Community Lists
When number is used for BGP community list name, the number has
@@ -596,8 +572,7 @@
feature is not recommended.
@end deffn
-@node BGP Community in Route Map, Display BGP Routes by Community, Numbered BGP Community Lists, BGP Communities Attribute
-@comment node-name, next, previous, up
+@node BGP Community in Route Map
@subsection BGP Community in Route Map
In Route Map (@pxref{Route Map}), we can match or set BGP
@@ -637,8 +612,7 @@
BGP update's communities attribute is completely removed.
@end deffn
-@node Display BGP Routes by Community, Using BGP Communities Attribute, BGP Community in Route Map, BGP Communities Attribute
-@comment node-name, next, previous, up
+@node Display BGP Routes by Community
@subsection Display BGP Routes by Community
To show BGP routes which has specific BGP communities attribute,
@@ -663,8 +637,7 @@
that have an exact match.
@end deffn
-@node Using BGP Communities Attribute, , Display BGP Routes by Community, BGP Communities Attribute
-@comment node-name, next, previous, up
+@node Using BGP Communities Attribute
@subsection Using BGP Communities Attribute
Following configuration is the most typical usage of BGP communities
@@ -777,8 +750,7 @@
@end example
@c -----------------------------------------------------------------------
-@node BGP Extended Communities Attribute, Displaying BGP routes, BGP Communities Attribute, BGP
-@comment node-name, next, previous, up
+@node BGP Extended Communities Attribute
@section BGP Extended Communities Attribute
BGP extended communities attribute is introduced with MPLS VPN/BGP
@@ -818,8 +790,7 @@
* BGP Extended Communities in Route Map::
@end menu
-@node BGP Extended Community Lists, BGP Extended Communities in Route Map, BGP Extended Communities Attribute, BGP Extended Communities Attribute
-@comment node-name, next, previous, up
+@node BGP Extended Community Lists
@subsection BGP Extended Community Lists
Expanded Community Lists is a user defined BGP Expanded Community
@@ -863,8 +834,7 @@
@end example
@end deffn
-@node BGP Extended Communities in Route Map, , BGP Extended Community Lists, BGP Extended Communities Attribute
-@comment node-name, next, previous, up
+@node BGP Extended Communities in Route Map
@subsection BGP Extended Communities in Route Map
@deffn {Route Map} {match extcommunity @var{word}} {}
@@ -879,8 +849,7 @@
@end deffn
@c -----------------------------------------------------------------------
-@node Displaying BGP routes, Capability Negotiation, BGP Extended Communities Attribute, BGP
-@comment node-name, next, previous, up
+@node Displaying BGP routes
@section Displaying BGP Routes
@menu
@@ -888,8 +857,7 @@
* More Show IP BGP::
@end menu
-@node Show IP BGP, More Show IP BGP, Displaying BGP routes, Displaying BGP routes
-@comment node-name, next, previous, up
+@node Show IP BGP
@subsection Show IP BGP
@deffn {Command} {show ip bgp} {}
@@ -910,8 +878,7 @@
Total number of prefixes 1
@end example
-@node More Show IP BGP, , Show IP BGP, Displaying BGP routes
-@comment node-name, next, previous, up
+@node More Show IP BGP
@subsection More Show IP BGP
@deffn {Command} {show ip bgp regexp @var{line}} {}
@@ -965,8 +932,7 @@
@deffn {Command} {no debug keepalive} {}
@end deffn
-@node Capability Negotiation, Route Reflector, Displaying BGP routes, BGP
-@comment node-name, next, previous, up
+@node Capability Negotiation
@section Capability Negotiation
When adding IPv6 routing information exchange feature to BGP. There
@@ -1033,8 +999,7 @@
Ignore remote peer's capability value.
@end deffn
-@node Route Reflector, Route Server, Capability Negotiation, BGP
-@comment node-name, next, previous, up
+@node Route Reflector
@section Route Reflector
@deffn {BGP} {bgp cluster-id @var{a.b.c.d}} {}
@@ -1044,8 +1009,7 @@
@deffnx {BGP} {no neighbor @var{peer} route-reflector-client} {}
@end deffn
-@node Route Server, How to set up a 6-Bone connection, Route Reflector, BGP
-@comment node-name, next, previous, up
+@node Route Server
@section Route Server
At an Internet Exchange point, many ISPs are connected to each other by
@@ -1071,8 +1035,7 @@
* Viewing the view::
@end menu
-@node Multiple instance, BGP instance and view, Route Server, Route Server
-@comment node-name, next, previous, up
+@node Multiple instance
@subsection Multiple instance
To enable multiple view function of @code{bgpd}, you must turn on
@@ -1132,8 +1095,7 @@
Quagga style BGP configuration. This is default.
@end deffn
-@node BGP instance and view, Routing policy, Multiple instance, Route Server
-@comment node-name, next, previous, up
+@node BGP instance and view
@subsection BGP instance and view
BGP instance is a normal BGP process. The result of route selection
@@ -1183,8 +1145,7 @@
@end group
@end example
-@node Routing policy, Viewing the view, BGP instance and view, Route Server
-@comment node-name, next, previous, up
+@node Routing policy
@subsection Routing policy
You can set different routing policy for a peer. For example, you can
@@ -1209,8 +1170,7 @@
applied. On the other hand, when the update is inserted into view 2,
distribute-list 2 is applied.
-@node Viewing the view, , Routing policy, Route Server
-@comment node-name, next, previous, up
+@node Viewing the view
@subsection Viewing the view
To display routing table of BGP view, you must specify view name.
@@ -1219,8 +1179,7 @@
Display routing table of BGP view @var{name}.
@end deffn
-@node How to set up a 6-Bone connection, Dump BGP packets and table, Route Server, BGP
-@comment node-name, next, previous, up
+@node How to set up a 6-Bone connection
@section How to set up a 6-Bone connection
@example
@@ -1268,8 +1227,7 @@
@end group
@end example
-@node Dump BGP packets and table, , How to set up a 6-Bone connection, BGP
-@comment node-name, next, previous, up
+@node Dump BGP packets and table
@section Dump BGP packets and table
@deffn Command {dump bgp all @var{path}} {}