Commit d275c6aa authored by Juliusz Chroboczek's avatar Juliusz Chroboczek

Tweak manual page.

parent 833849ed
...@@ -88,6 +88,9 @@ Export routes from the given kernel routing table. ...@@ -88,6 +88,9 @@ Export routes from the given kernel routing table.
Specify the name of the configuration file. The default is Specify the name of the configuration file. The default is
.BR /etc/babel.conf . .BR /etc/babel.conf .
.TP .TP
.BI \-C " statement"
Specify a configuration statement directly on the command line.
.TP
.B \-D .B \-D
Daemonise at startup. Daemonise at startup.
.TP .TP
...@@ -101,19 +104,14 @@ otherwise. ...@@ -101,19 +104,14 @@ otherwise.
Specify a file to write our process id to. The default is Specify a file to write our process id to. The default is
.BR /var/run/babel.pid . .BR /var/run/babel.pid .
.TP .TP
.RI "[ " id " ]"
The router-id of this daemon. This should normally be an IPv6 or IPv4
address of this machine, but can be any unique 128-bit string. If
omitted, Babel will try to determine a suitable router-id automatically.
.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.
.SH CONFIG FILE FORMAT .SH CONFIGURATION FILE FORMAT
The configuration file is a sequence of lines each of which specifies The configuration file is a sequence of lines each of which specifies
either an interface or a filtering rule. Blank lines are ignored. Comments either an interface or a filtering rule. Blank lines are ignored. Comments
are introduced with an octothorp are introduced with an octothorp
.RB `` # '' .RB `` # ''
and terminated by the end of line. and terminate at the end of the line.
.SS Interface configuration .SS Interface configuration
An interface is configured by a single line with the following format: An interface is configured by a single line with the following format:
.IP .IP
...@@ -166,7 +164,7 @@ command-line flags. ...@@ -166,7 +164,7 @@ command-line flags.
This defines the interval between full routing table dumps sent on this This defines the interval between full routing table dumps sent on this
interface; since Babel uses triggered updates and doesn't count to interface; since Babel uses triggered updates and doesn't count to
infinity, this can be set to a fairly large value, unless significant infinity, this can be set to a fairly large value, unless significant
packet loss is expected. This defaults to four times the hello interval. packet loss is expected. The default is four times the hello interval.
.SS Filtering rules .SS Filtering rules
A filtering rule is defined by a single line with the following format: A filtering rule is defined by a single line with the following format:
.IP .IP
...@@ -259,9 +257,8 @@ should include the line ...@@ -259,9 +257,8 @@ should include the line
redistribute local deny redistribute local deny
.PP .PP
as the last line in your configuration file. as the last line in your configuration file.
.SH EXAMPLES .SH EXAMPLES
You can participate in a Babel mesh network by simply running You can participate in a Babel network by simply running
.IP .IP
# babel wlan0 # babel wlan0
.PP .PP
...@@ -310,15 +307,13 @@ Check interfaces and kernel routes right now, then reopen the log file. ...@@ -310,15 +307,13 @@ Check interfaces and kernel routes right now, then reopen the log file.
.SH SECURITY .SH SECURITY
Babel is a completely insecure protocol: any attacker able to inject Babel is a completely insecure protocol: any attacker able to inject
IP packets with a link-local source address can disrupt the protocol's IP packets with a link-local source address can disrupt the protocol's
operation. This is no different from unsecured neighbour discovery operation. This is no different from unsecured neighbour discovery or ARP.
(ARP in IPv4).
Since Babel uses link-local addresses only, there is no need to update Since Babel uses link-local IPv6 packets only, there is no need to update
firewalls to allow forwarding of Babel protocol packets. If local firewalls to allow forwarding of Babel protocol packets. If local
filtering is being done, UDP datagrams to the port used by the filtering is being done, UDP datagrams to the port used by the protocol
protocol should be allowed. As Babel uses unicast packets in some should be allowed. As Babel uses unicast packets in some cases, it is not
cases, it is not enough to just allow packets destined to Babel's enough to just allow packets destined to Babel's multicast address.
multicast address.
.SH BUGS .SH BUGS
Plenty. This is experimental software, run at your own risk. Plenty. This is experimental software, run at your own risk.
.SH SEE ALSO .SH SEE ALSO
......
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