Commit 7d67832c authored by Juliusz Chroboczek's avatar Juliusz Chroboczek

Update manual page for protocol version 1.

parent 21045b56
...@@ -7,17 +7,17 @@ babel \- ad-hoc network routing daemon ...@@ -7,17 +7,17 @@ babel \- ad-hoc network routing daemon
[ [
.B \-\- .B \-\-
] ]
.I address .I id
.IR interface ... .IR interface ...
.SH DESCRIPTION .SH DESCRIPTION
Babel is a loop-avoiding distance-vector routing protocol roughly Babel is a loop-avoiding distance-vector routing protocol roughly
based on DSDV and AODV, but with provisions for link cost estimation based on DSDV and AODV, but with provisions for link cost estimation
and injection of external routes. and redistribution of routes from other routing protocols.
While it is optimised for wireless mesh networks, Babel will also work While it is optimised for wireless mesh networks, Babel will also work
efficiently on wired networks. In the worst case, it will generate efficiently on wired networks. It will generate between roughly the
roughly double the amount of traffic that RIPng would generate, while same and double the amount of routing traffic that RIPng would
never counting to infinity. generate, while never counting to infinity.
.SH OPTIONS .SH OPTIONS
.TP .TP
.BI \-m " multicast-address" .BI \-m " multicast-address"
...@@ -38,7 +38,7 @@ below), and other hosts might initially ignore it. The default is ...@@ -38,7 +38,7 @@ below), and other hosts might initially ignore it. The default is
.TP .TP
.BI \-h " hello-interval" .BI \-h " hello-interval"
Specify the interval in seconds at which scheduled hello packets are Specify the interval in seconds at which scheduled hello packets are
sent on wireless interfaces. The default is 8. sent on wireless interfaces. The default is 6.
.TP .TP
.BI \-H " wired-hello-interval" .BI \-H " wired-hello-interval"
Specify the interval in seconds at which scheduled hello packets are Specify the interval in seconds at which scheduled hello packets are
...@@ -68,12 +68,13 @@ Do not perform split-horizon processing on wired interfaces. ...@@ -68,12 +68,13 @@ Do not perform split-horizon processing on wired interfaces.
Split-horizon is never performed on wireless interfaces. Split-horizon is never performed on wireless interfaces.
.TP .TP
.B \-b .B \-b
Use a single broadcast message for reverse reachability information on Use a single broadcast
wired interfaces rather then messages specific to each peer. This .I I Heard You
will slightly reduce traffic on interfaces with many neighbours, but message for reverse reachability information on wired interfaces
will disable detection of asymmetric links, and is therefore not rather than messages specific to each peer. This will slightly reduce
recommended. Messages specific to each peer are always sent on traffic on interfaces with many neighbours, but will disable detection
wireless interfaces. of asymmetric links, and is therefore not recommended. Messages
specific to each peer are always sent on wireless interfaces.
.TP .TP
.BI \-c " cost" .BI \-c " cost"
Add Add
...@@ -82,8 +83,8 @@ to the metrics of advertised routes. This is useful for example when ...@@ -82,8 +83,8 @@ to the metrics of advertised routes. This is useful for example when
we are low on battery and hardly eager to forward packets. we are low on battery and hardly eager to forward packets.
.TP .TP
.B \-P .B \-P
Run in parasitic (passive) mode. The daemon will not announce any Run in parasitic (passive) mode. The daemon will only announce
routes except to itself. redistributed routes.
.TP .TP
.BI \-d " level" .BI \-d " level"
Debug level. A value of 1 requests a routing table dump at every Debug level. A value of 1 requests a routing table dump at every
...@@ -110,13 +111,14 @@ wired link. ...@@ -110,13 +111,14 @@ wired link.
.TP .TP
.BI \-X " network cost" .BI \-X " network cost"
Advertise a route for the given network or host with the given cost, Advertise a route for the given network or host with the given cost,
even if it is not currently installed. Use of this option is even if it is not currently installed. This is normally used for
discouraged, as it can cause persistent routing loops. advertising the local addresses of this machine. Use of this option
for any other purpose is discouraged, as it can cause persistent
routing loops.
.TP .TP
.I address .I id
The IPv6 address that the node should advertise for itself. The router-id of this daemon. This should normally be an IPv6 address
(Additional addresses can be advertised as external routes with a cost of this machine, but can be any unique 128-bit string.
of 0.)
.TP .TP
.IR interface ... .IR interface ...
The list of interfaces on which the protocol should operate. The list of interfaces on which the protocol should operate.
...@@ -128,7 +130,7 @@ be one of your node's IPv6 addresses, and suppose that ...@@ -128,7 +130,7 @@ be one of your node's IPv6 addresses, and suppose that
is a wireless interface. You can participate in a Babel mesh network is a wireless interface. You can participate in a Babel mesh network
by simply running by simply running
.IP .IP
# babel $IPv6 eth1 # babel -X $IPv6 0 $IPv6 eth1
.PP .PP
In order to gateway between multiple interfaces, just list them all on In order to gateway between multiple interfaces, just list them all on
...@@ -163,8 +165,8 @@ peers, at the benefit of a very slight decrease in traffic. This is ...@@ -163,8 +165,8 @@ peers, at the benefit of a very slight decrease in traffic. This is
not recommended. not recommended.
No link cost estimation is ever performed on wired interfaces: a wired No link cost estimation is ever performed on wired interfaces: a wired
adjacency is assumed to be up if at least one of the last three hello adjacency is assumed to be up if at least two of the last three hello
messages has been received, and down otherwise. messages have been received, and down otherwise.
.SH FILES .SH FILES
.TP .TP
.B /var/lib/babel-state .B /var/lib/babel-state
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment