From 1b55b1a3640da3ec2b032dcea3f4f7cbdff82303 Mon Sep 17 00:00:00 2001
From: Martin Mares <mj@ucw.cz>
Date: Mon, 29 May 2000 10:32:37 +0000
Subject: Spelling fixes.

Added skeleton for subchapters on all the protocols. Each subchapter should
contain:

	Introduction (brief intro to the protocol, where should it be used,
		references to the relevant standards)
	Configuration
	Attributes
	Example

Added a more detailed description of RIP attributes.
---
 doc/bird.sgml | 43 +++++++++++++++++++++++++++++++++++--------
 1 file changed, 35 insertions(+), 8 deletions(-)

(limited to 'doc')

diff --git a/doc/bird.sgml b/doc/bird.sgml
index a1fb863d..c813993c 100644
--- a/doc/bird.sgml
+++ b/doc/bird.sgml
@@ -64,7 +64,7 @@ section in filters.
 <p>BIRD is configured using text configuration file. At startup, BIRD reads <file/bird.conf/ (unless
 -c command line parameter is given). Configuration may be changed on user request: if you modify
 config file and then signal BIRD with SIGHUP, it will adjust to new config. There's BIRD client,
-which allows you to talk with BIRD in more extensive way than just telling it to reconfig. BIRD
+which allows you to talk with BIRD in more extensive way than just telling it to reconfigure. BIRD
 writes messages about its work to log files or syslog (according to config).
 
 <p>Bird is configured using text configuration file. At startup, bird
@@ -134,7 +134,7 @@ protocol rip {
 <descrip>
 	<tag>preference <m/expr/</tag> sets preference of routes generated by this protocol.
 
-	<tag>disabled</tag> disables given protocol. You can disable/enable protcol from command
+	<tag>disabled</tag> disables given protocol. You can disable/enable protocol from command
 	line interface without needing to touch config.
 
 	<tag>debug <m/setting/</tag> this is similar to global debug setting, except that it only
@@ -311,7 +311,7 @@ booleans (that is to prevent you from shooting in the foot).
 
 <sect1>Operations
 
-<p>Filter language supports common integer operations <cf>(+,-,*,/)</cf>, parenthesis <cf/(a*(b+c))/, comparation
+<p>Filter language supports common integer operations <cf>(+,-,*,/)</cf>, parentheses <cf/(a*(b+c))/, comparison
 <cf/(a=b, a!=b, a&lt;b, a&gt;=b)/. Special operators include <cf/&tilde;/ for "in" operation. In operation can be
 used on element and set of that elements, or on ip and prefix, or on prefix and prefix or on bgppath and bgpmask. Its result
 is true if element is in given set or if ip address is inside given prefix. Operator <cf/=/ is used to assign value
@@ -368,7 +368,7 @@ if 1234 = i then printn "."; else { print "*** FAIL: if 1 else"; }
 
 <sect1>Utility functions
 
-<p>There are few functions you might find convient to use:
+<p>There are few functions you might find convenient to use:
 
 <descrip>
 	<tag>print <m/expr/ [ <m/, expr .../ ]</tag>
@@ -380,6 +380,18 @@ if 1234 = i then printn "."; else { print "*** FAIL: if 1 else"; }
 
 <sect>Protocols
 
+<sect1>BGP
+
+<sect1>Device
+
+<sect1>Direct
+
+<sect1>Kernel
+
+<sect1>OSPF
+
+<sect1>Pipe
+
 <sect1>Rip
 
 <sect2>Introduction
@@ -411,7 +423,7 @@ URL="http://www.ietf.org/html.charters/rip-charter.html">.
 
 <p>There are two options that can be specified per-interface. First is <cf>metric</cf>, with
 default one.  Second is <cf>mode multicast|broadcast|quiet|nolisten|version1</cf>, it selects mode for
-rip to work in. If nothing is specified, rip runs in multicasts mode. <cf>version1</cf> is
+rip to work in. If nothing is specified, rip runs in multicast mode. <cf>version1</cf> is
 currently equivalent to <cf>broadcast</cf>, and it makes rip talk at broadcast address even
 through multicast mode is possible. <cf>quiet</cf> option means that rip will not transmit
 periodic messages onto this interface and <cf>nolisten</cf> means that rip will talk to this
@@ -441,10 +453,23 @@ other than equally misconfigured BIRD. I warned you.
 	  </tag>specifies how old route has to be to be discarded. Default is 10*period.
 </descrip>
 
-<p>In addition, rip defines two filter variables, both of type it. <cf>rip_metric</cf> is rip
-metric of current route, <cf>rip_tag</cf> is tag of current route.
+<sect2>Attributes
 
-<code>
+<p>RIP defines two route attributes:
+
+<descrip>
+	<tag>int <cf/rip_metric/</tag> RIP metric of the route (ranging from 0 to <cf/infinity/).
+	When routes from different RIP instances are available and all of them have the same
+	preference, BIRD prefers the route with lowest <cf/rip_metric/.
+
+	<tag>int <cf/rip_tag/</tag> RIP route tag: a 16-bit number which can be used
+	to carry additional information with the route (for example, an originating AS number
+	in case of external routes).
+</descrip>
+
+<sect2>Example
+
+<p><code>
 protocol rip MyRIP_test {
         debug all;
         port 1520;
@@ -461,6 +486,8 @@ protocol rip MyRIP_test {
 }
 </code>
 
+<sect1>Static
+
 <sect>Getting more help
 
 <p>This is really last section of this file, should give pointers to
-- 
cgit v1.2.3