Author: marek
Date: 2010-01-07 15:08:38 +0100 (Thu, 07 Jan 2010)
New Revision: 1539
Modified:
branches/batctl-0.2.x/man/batctl.8
branches/batctl-0.2.x/vis.c
Log:
batctl: VIS subcommand uses -h for help/usage.
Signed-off-by: Andrew Lunn <andrew(a)lunn.ch>
Modified: branches/batctl-0.2.x/man/batctl.8
===================================================================
--- branches/batctl-0.2.x/man/batctl.8 2010-01-07 14:08:34 UTC (rev 1538)
+++ branches/batctl-0.2.x/man/batctl.8 2010-01-07 14:08:38 UTC (rev 1539)
@@ -99,18 +99,18 @@
displayed only once (useful for scripts). If "\-n" is given batctl
will not replace the MAC addresses with bat\-host names in the output.
.br
-.IP "\fBvis dot\fP [\fB\-n\fP|\fB\-\-numbers\fP][\fB\-h\fP|\fB\-\-no-HNA\fP][\fB\-2\fP|\fB\-\-no-2nd\fP]"
+.IP "\fBvis dot\fP [\fB\-n\fP|\fB\-\-numbers\fP][\fB\-H\fP|\fB\-\-no-HNA\fP][\fB\-2\fP|\fB\-\-no-2nd\fP]"
Display the visualisation data in graphviz \fBdot\fP(1) format. If
"\-\-numbers" or "\-n" is given batctl will not replace the MAC
addresses with bat-host names in the output. With "\-\-no-HNA" or
-"\-h" the HNA entries are not displayed, so the pure mesh topology can
+"\-H" the HNA entries are not displayed, so the pure mesh topology can
be seen. With "\-\-no-2nd" or "\-2" a dot cluster is not formed around
primary and secondary addresses from the same device.
.br
-.IP "\fBvis json\fP [\fB\-n\fP|\fB\-\-numbers\fP][\fB\-h\fP|\fB\-\-no-HNA\fP][\fB\-2\fP|\fB\-\-no-2nd\fP]"
+.IP "\fBvis json\fP [\fB\-n\fP|\fB\-\-numbers\fP][\fB\-H\fP|\fB\-\-no-HNA\fP][\fB\-2\fP|\fB\-\-no-2nd\fP]"
Display the visualisation data in JSON format. If "\-\-numbers" or
"\-n" is given batctl will not replace the MAC addresses with bat-host
-names in the output. With "\-\-no-HNA" or "\-h" the HNA entries are
+names in the output. With "\-\-no-HNA" or "\-H" the HNA entries are
not displayed, so the pure mesh topology can be seen. With
"\-\-no-2nd" or "\-2" a dot cluster is not formed around primary and
secondary addresses from the same device.
Modified: branches/batctl-0.2.x/vis.c
===================================================================
--- branches/batctl-0.2.x/vis.c 2010-01-07 14:08:34 UTC (rev 1538)
+++ branches/batctl-0.2.x/vis.c 2010-01-07 14:08:38 UTC (rev 1539)
@@ -55,9 +55,9 @@
static void usage(void)
{
- printf("batctl vis dot {--no-HNA|-h} {--no-2nd|-2} {--numbers|-n}\n");
+ printf("batctl vis dot {-h}{--no-HNA|-H} {--no-2nd|-2} {--numbers|-n}\n");
printf("or\n");
- printf("batctl vis json {--no-HNA|-h} {--no-2nd|-2} {--numbers|-n}\n");
+ printf("batctl vis json {-h}{--no-HNA|-H} {--no-2nd|-2} {--numbers|-n}\n");
}
static void dot_print_tq(char *orig, char *from, const long tq)
@@ -271,18 +271,18 @@
while (1) {
int option_index = 0;
static struct option long_options[] = {
- {"no-HNA", 0, 0, 'h'},
+ {"no-HNA", 0, 0, 'H'},
{"no-2nd", 0, 0, '2'},
{"numbers", 0, 0, 'n'},
{0, 0, 0, 0}
};
- c = getopt_long(argc, argv, "h2n", long_options, &option_index);
+ c = getopt_long(argc, argv, "hH2n", long_options, &option_index);
if (c == -1)
break;
switch (c) {
- case 'h':
+ case 'H':
with_HNA = false;
break;
case '2':
@@ -291,6 +291,7 @@
case 'n':
with_names = false;
break;
+ case 'h':
default:
usage();
return -1;
Author: marek
Date: 2010-01-07 15:08:34 +0100 (Thu, 07 Jan 2010)
New Revision: 1538
Modified:
branches/batctl-0.2.x/man/batctl.8
Log:
batctl: manpage rework
General rework of the manpage to reflext the latest batctl changes
and fix numerous typos.
Signed-off-by: Andrew Lunn <andrew(a)lunn.ch>
Modified: branches/batctl-0.2.x/man/batctl.8
===================================================================
--- branches/batctl-0.2.x/man/batctl.8 2010-01-07 14:08:30 UTC (rev 1537)
+++ branches/batctl-0.2.x/man/batctl.8 2010-01-07 14:08:34 UTC (rev 1538)
@@ -2,7 +2,7 @@
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
-.TH batctl 8 "Aug 01, 2009"
+.TH "BATCTL" "8" "Jan 04, 2010" "Linux" "B.A.T.M.A.N. Advanced Control Tool"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
@@ -19,85 +19,164 @@
.\" Process this file with
.\" groff -man batctl.8 -Tutf8
.\" --------------------------------------------------------------------------
-.TH "batctl" 8
+.ad l
.SH NAME
-batctl \- B.A.T.M.A.N. advanced control and managing tool
+batctl \- B.A.T.M.A.N. advanced control and management tool
.SH SYNOPSIS
.B batctl
.I [\fIbatctl\-options\fP]\ \fIcommand\fP\ [\fIcommand\-options\fP]
.br
.SH DESCRIPTION
-B.A.T.M.A.N. advanced operates on layer 2 and thus all hosts participating in the virtual switch are completely transparent for all protocols above layer 2. Therefore the common diagnosis tools do not work as expected. To overcome these problems \fBbatctl\fP was created. At the moment the batctl contains \fBping\fP, \fBtraceroute\fP, \fBtcpdump\fP interfaces to the kernel module settings.
+batctl offers a convenient way to configure the batman\-adv kernel
+module as well as displaying debug information such as originator
+tables, translation tables and the debug log. In combination with a
+bat\-hosts file batctl allows the use of host names instead of MAC
+addresses.
.PP
-batctl uses the /dev/batman\-adv device provided by the B.A.T.M.A.N. advanced kernel module to inject custom icmp packets into the data flow. That's why ping and traceroute work almost like their IP based counterparts. Tcpdump analyzes the traffic and packet types used by B.A.T.M.A.N. advanced.
+B.A.T.M.A.N. advanced operates on layer 2. Thus all hosts
+participating in the virtual switched network are transparently
+connected together for all protocols above layer 2. Therefore the
+common diagnosis tools do not work as expected. To overcome these
+problems batctl contains the commands \fBping\fP, \fBtraceroute\fP,
+\fBtcpdump\fP which provide similar functionality to the normal
+\fBping\fP(1), \fBtraceroute\fP(1), \fBtcpdump\fP(1) commands, but
+modified to layer 2 behaviour or using the B.A.T.M.A.N. advanced
+protocol.
.PP
-Furthermore batctl offers an convenient way to configure the batman\-adv kernel module as well as displaying debug information such as originator tables, translation tables and debug log. In combination with a bat\-hosts file batctl allows working with easy to remember names instead of mac addresses.
.PP
.SH OPTIONS
.TP
.I \fBbatctl\-options:
-\-h print general batctl help
+\-h print general batctl help
.br
-\-v print batctl version
+\-v print batctl version
.br
.TP
.I \fBcommands:
-.IP "\fBinterface|if [none|interface]\fP"
-If no parameter is given the current interface settings are displayed otherwise the parameter(s) are added as new interfaces. Use the "none" keyword to deactivate all interfaces.
+.IP "\fBinterface\fP|\fBif\fP [\fBnone\fP|\fIinterface\fP]"
+If no parameter is given the current interface settings are displayed
+otherwise the parameter(s) are added as new interfaces. Use the "none"
+keyword to deactivate all interfaces.
.br
-.IP "\fBoriginators|o\fP"
-Once started batctl will refresh the displayed originator table every second. Use the "\-b" option to let batctl display the table only once (useful for scripts). If "\-n" was given batctl will not replace the mac addresses with bat\-host names in the output.
+.IP "\fBoriginators\fP|\fBo\fP [\fB\-b\fP][\fB\-n\fP]"
+Display the originator table. Once started batctl will refresh the
+displayed originator table every second. The "\-b" option causes the
+table to be displayed only once (useful for scripts). If "\-n" is
+given batctl will not replace the MAC addresses with bat\-host names
+in the output.
.br
-.IP "\fBinterval|it [orig_interval]\fP"
-If no parameter is given the current originator interval settings are displayed otherwise the parameter is used to set the originator interval.
+.IP "\fBinterval\fP|\fBit\fP [\fIorig_interval\fP]"
+If no parameter is given the current originator interval setting is
+displayed otherwise the parameter is used to set the originator
+interval. The interval is in units of milliseconds.
.br
-.IP "\fBloglevel|ll [level]\fP"
-If no parameter is given the current log level settings are displayed otherwise the parameter is used to set the log level.
+.IP "\fBloglevel\fP|\fBll\fP [\fIlevel\fP]"
+If no parameter is given the current log level settings are displayed
+otherwise the parameter is used to set the log level. Level 0 disables
+all logging. Level 1 enables messages related to routing / flooding /
+broadcasting. Level 2 enables messages related to route or hna added /
+changed / deleted. Level 3 enables all messages. The messages are sent
+to the kernel log. Use \fBdmesg\fP(1) to see them.
.br
-.IP "\fBlog|l\fP "
-Once started batctl will continuously read the log produced by the kernel module (the amount of log message can be influenced by modifying the log level). Whenever there are new log messages sent by the kernel batctl will display it. Use the "\-b" option to let batctl exit after the existing log buffer has been displayed. If "\-n" was given batctl will not replace the mac addresses with bat\-host names in the output.
+.IP "\fBlog\fP|\fBl\fP [\fIlogfile\fP][\fB\-b\fP][\fB\-n\fP]\fP"
+batctl will read the file logfile, or stdin if the logfile parameter
+is not given, applying filtering so only the B.A.T.M.A.N. Advanced
+messages are displayed. Whenever there are new log messages appended
+to the file batctl will display them. The option "\-b" causes batctl
+to exit once the end of the file has been reached. If "\-n" is given
+batctl will not replace the MAC addresses with bat\-host names in the
+output.
.br
-.IP "\fBtranslocal|tl\fP"
-Once started batctl will refresh the displayed local translation table every second. Use the "\-b" option to let batctl display the table only once (useful for scripts). If "\-n" was given batctl will not replace the mac addresses with bat\-host names in the output.
+.IP "\fBtranslocal\fP|\fBtl\fP [\fB\-b\fP][\fB\-n\fP]"
+Display the local translation table. batctl will refresh the
+displayed table every second. The "\-b" option causes the table to be
+displayed only once (useful for scripts). If "\-n" is given batctl
+will not replace the MAC addresses with bat\-host names in the output.
.br
-.IP "\fBtransglobal|tg\fP"
-Once started batctl will refresh the displayed global translation table every second. Use the "\-b" option to let batctl display the table only once (useful for scripts). If "\-n" was given batctl will not replace the mac addresses with bat\-host names in the output.
+.IP "\fBtransglobal\fP|\fBtg\fP [\fB\-b\fP][\fB\-n\fP]"
+Display the global translation table. batctl will refresh the
+displayed table every second. The "\-b" option causes the table to be
+displayed only once (useful for scripts). If "\-n" is given batctl
+will not replace the MAC addresses with bat\-host names in the output.
.br
-.IP "\fBvis dot\fP"
-Display the visualisation data in graphviz dot(1) format. If
-"\--numbers" or "\-n" batctl will not replace the mac addresses with
-bat-host names in the output. With "\--no-HNA" or "\-h" the HNA
-entries are not displayed, so the pure mesh topology can be seen. With
-"\--no-2nd" or "\-2" a dot cluster is not formed around primary and
-secondary addresses from the same device.
+.IP "\fBvis dot\fP [\fB\-n\fP|\fB\-\-numbers\fP][\fB\-h\fP|\fB\-\-no-HNA\fP][\fB\-2\fP|\fB\-\-no-2nd\fP]"
+Display the visualisation data in graphviz \fBdot\fP(1) format. If
+"\-\-numbers" or "\-n" is given batctl will not replace the MAC
+addresses with bat-host names in the output. With "\-\-no-HNA" or
+"\-h" the HNA entries are not displayed, so the pure mesh topology can
+be seen. With "\-\-no-2nd" or "\-2" a dot cluster is not formed around
+primary and secondary addresses from the same device.
.br
-.IP "\fBvis json\fP"
-Display the visualisation data in JSON format. If
-"\--numbers" or "\-n" batctl will not replace the mac addresses with
-bat-host names in the output. With "\--no-HNA" or "\-h" the HNA
-entries are not displayed, so the pure mesh topology can be seen. With
-"\--no-2nd" or "\-2" a dot cluster is not formed around primary and
+.IP "\fBvis json\fP [\fB\-n\fP|\fB\-\-numbers\fP][\fB\-h\fP|\fB\-\-no-HNA\fP][\fB\-2\fP|\fB\-\-no-2nd\fP]"
+Display the visualisation data in JSON format. If "\-\-numbers" or
+"\-n" is given batctl will not replace the MAC addresses with bat-host
+names in the output. With "\-\-no-HNA" or "\-h" the HNA entries are
+not displayed, so the pure mesh topology can be seen. With
+"\-\-no-2nd" or "\-2" a dot cluster is not formed around primary and
secondary addresses from the same device.
.br
-.IP "\fBaggregation|ag [0|1]\fP"
-If no parameter is given the current aggregation settings are displayed otherwise the parameter is used to enable or disable the packet aggregation.
+.IP "\fBaggregation\fP|\fBag\fP [\fB1\fP|\fB0\fP]"
+If no parameter is given the current aggregation setting is displayed.
+Otherwise the parameter is used to enable or disable packet
+aggregation.
.br
-.IP "\fBping|p mac\ address|bat\-host\ name\fP"
-Layer 2 ping mac address or bat\-host name (batctl will try to find bat\-host name if the given parameter was not a mac address) until batctl has been stopped with CTRL + C. The "\-c" option tells batctl how often it should ping the given host before it stops by itself. With "\-i" and "\-t" you can influence the default interval time between pings and the timeout time for replies respectively.
+.IP "\fBping\fP|\fBp\fP [\fB\-c \fP\fIcount\fP][\fB\-i \fP\fIinterval\fP][\fB\-t \fP\fItime\fP] \fIMAC_address\fP|\fIbat\-host_name\fP"
+Layer 2 ping of a MAC address or bat\-host name. batctl will try to
+find the bat\-host name if the given parameter was not a MAC
+address. The "\-c" option tells batctl how man pings should be sent
+before the program exits. Without the "\-c" option batctl will continue
+pinging without end. Use CTRL + C to stop it. With "\-i" and "\-t"
+you can set the default interval between pings and the timeout time
+for replies, both in seconds.
.br
-.IP "\fBtraceroute|tr mac\ address|bat\-host\ name\fP"
-Layer 2 traceroute mac address or bat\-host name (batctl will try to find bat\-host name if the given parameter was not a mac address). batctl will send 3 packets to each host and display the response time. If "\-n" was given batctl will not replace the mac addresses with bat\-host names in the output.
-.IP "\fBtcpdump|td interface [interface]\fP"
-Per default batctl will display all packets that were seen on the given interface(s). The "\-p" options allows to filter certain packet types: 1 displays batman ogm packets only, 2 displays batman icmp packets only, etc. These numbers can be added to filter more than one packet type, e.g. use "\-p 3" to display batman ogm packets and batman icmp packets only. If "\-n" was given batctl will not replace the mac addresses with bat\-host names in the output.
+.IP "\fBtraceroute\fP|\fBtr\fP [\fB\-n\fP] \fIMAC_address\fP|\fIbat\-host_name\fP"
+Layer 2 traceroute to a MAC address or bat\-host name. batctl will try
+to find the bat\-host name if the given parameter was not a MAC
+address. batctl will send 3 packets to each host and display the
+response time. If "\-n" is given batctl will not replace the MAC
+addresses with bat\-host names in the output.
.br
-.IP "\fBbisect logfile1 logfile2 .. logfileN\fP"
-Analyzes the logfiles to build a small internal database of all sent sequence numbers and routing table changes. This database can be used to search for routing loops (default action), to trace OGMs of a host (use "\-t" to specify the mac address or bat\-host name) throughout the network or to display routing tables of the nodes (use "\-r" to specify the mac address or bat\-host name). You can name a specific sequence number or a range using the "\-s" option to limit the output's range. Furthermore you can filter the output by specifying an originator (use "\-o" to specify the mac address or bat\-host name) to only see data connected to this originator. If "\-n" was given batctl will not replace the mac addresses with bat\-host names in the output.
+.IP "\fBtcpdump\fP|\fBtd\fP [\fB\-p \fP\fIfilter\fP][\fB\-n\fP] \fIinterface ...\fP"
+batctl will display all packets that are seen on the given
+interface(s). The "\-p" options allows the filtering of certain packet
+types: 1 - batman ogm packets, 2 - batman icmp packets, 4 - unicast
+packets, 8 - broadcast packets, 16 - vis packets, and 32 - none batman
+packets. These numbers can be added to filter more than one packet
+type, e.g. use "\-p 3" to display batman ogm packets and batman icmp
+packets only. If "\-n" is given batctl will not replace the MAC
+addresses with bat\-host names in the output.
.br
+.IP "\fBbisect\fP [\fB\-l \fP\fIMAC\fP][\fB\-t \fP\fIMAC\fP][\fB\-r \fP\fIMAC\fP][\fB\-s \fP\fImin\fP [\fB\- \fP\fImax\fP]][\fB\-o \fP\fIMAC\fP][\fB\-n\fP] \fIlogfile1\fP [\fIlogfile2\fP ... \fIlogfileN\fP]"
+Analyses the logfiles to build a small internal database of all sent
+sequence numbers and routing table changes. This database can then be
+analyzed in a number of different ways. With "\-l" the database can be
+used to search for routing loops. Use "\-t" to trace OGMs of a host
+throughout the network. Use "\-r" to display routing tables of the
+nodes. The option "\-s" can be used to limit the output to a range of
+sequence numbers, between min and max, or to one specific sequence
+number, min. Furthermore using "\-o" you can filter the output to a
+specified originator. If "\-n" is given batctl will not replace the
+MAC addresses with bat\-host names in the output.
+.br
.SH FILES
.TP
.I "\fBbat-hosts\fP"
-This file is similar to the /etc/hosts file. You can write one mac address and one host name per line. batctl will search for bat-hosts in /etc, your home directory and the current directory. The found data is used to match mac address to your provided host name or replace mac addresses in debug output and logs. Host names are much easier to remember than mac addresses.
+This file is similar to the /etc/hosts file. You can write one MAC
+address and one host name per line. batctl will search for bat-hosts
+in /etc, your home directory and the current directory. The found data
+is used to match MAC address to your provided host name or replace MAC
+addresses in debug output and logs. Host names are much easier to
+remember than MAC addresses.
+.SH SEE ALSO
+.BR ping (1),
+.BR traceroute (1),
+.BR tcpdump (1),
+.BR dmesg (1),
+.BR dot (1)
.SH AUTHOR
-batctl was written by Andreas Langer <a.langer(a)q-dsl.de> and Marek Lindner <lindner_marek(a)yahoo.de>.
+batctl was written by Andreas Langer <a.langer(a)q-dsl.de> and Marek
+Lindner <lindner_marek(a)yahoo.de>.
.PP
-This manual page was written by Simon Wunderlich <siwu(a)hrz.tu-chemnitz.de> and Marek Lindner <lindner_marek(a)yahoo.de>.
+This manual page was written by Simon Wunderlich
+<siwu(a)hrz.tu-chemnitz.de>, Marek Lindner <lindner_marek(a)yahoo.de> and
+Andrew Lunn <andrew(a)lunn.ch>
Author: marek
Date: 2010-01-07 15:08:30 +0100 (Thu, 07 Jan 2010)
New Revision: 1537
Modified:
branches/batctl-0.2.x/man/batctl.8
Log:
batctl: Differentiate between hyphen and minus in manpage
groff differentiate between minus signs and hyphens. The default option is to
interpret '-' as hyphens (U+2010) and makes it hard to use copy and paste for
options in UTF-8 environments.
See http://lists.debian.org/debian-devel/2003/03/msg01481.html for more
informations.
Signed-off-by: Sven Eckelmann <sven.eckelmann(a)gmx.de>
Modified: branches/batctl-0.2.x/man/batctl.8
===================================================================
--- branches/batctl-0.2.x/man/batctl.8 2010-01-07 14:05:59 UTC (rev 1536)
+++ branches/batctl-0.2.x/man/batctl.8 2010-01-07 14:08:30 UTC (rev 1537)
@@ -91,7 +91,7 @@
Per default batctl will display all packets that were seen on the given interface(s). The "\-p" options allows to filter certain packet types: 1 displays batman ogm packets only, 2 displays batman icmp packets only, etc. These numbers can be added to filter more than one packet type, e.g. use "\-p 3" to display batman ogm packets and batman icmp packets only. If "\-n" was given batctl will not replace the mac addresses with bat\-host names in the output.
.br
.IP "\fBbisect logfile1 logfile2 .. logfileN\fP"
-Analyzes the logfiles to build a small internal database of all sent sequence numbers and routing table changes. This database can be used to search for routing loops (default action), to trace OGMs of a host (use "-t" to specify the mac address or bat\-host name) throughout the network or to display routing tables of the nodes (use "-r" to specify the mac address or bat\-host name). You can name a specific sequence number or a range using the "-s" option to limit the output's range. Furthermore you can filter the output by specifying an originator (use "-o" to specify the mac address or bat\-host name) to only see data connected to this originator. If "\-n" was given batctl will not replace the mac addresses with bat\-host names in the output.
+Analyzes the logfiles to build a small internal database of all sent sequence numbers and routing table changes. This database can be used to search for routing loops (default action), to trace OGMs of a host (use "\-t" to specify the mac address or bat\-host name) throughout the network or to display routing tables of the nodes (use "\-r" to specify the mac address or bat\-host name). You can name a specific sequence number or a range using the "\-s" option to limit the output's range. Furthermore you can filter the output by specifying an originator (use "\-o" to specify the mac address or bat\-host name) to only see data connected to this originator. If "\-n" was given batctl will not replace the mac addresses with bat\-host names in the output.
.br
.SH FILES
.TP
Author: marek
Date: 2010-01-07 15:05:59 +0100 (Thu, 07 Jan 2010)
New Revision: 1536
Modified:
branches/batctl-0.2.x/bisect.c
branches/batctl-0.2.x/man/batctl.8
Log:
batctl: Correct typographical errors detected by lintian
Debian's Lintian detected different smaller typographical errors in the source
code and manpages of batctl.
* preceeding -> preceding
* simliar -> similar
Signed-off-by: Sven Eckelmann <sven.eckelmann(a)gmx.de>
Modified: branches/batctl-0.2.x/bisect.c
===================================================================
--- branches/batctl-0.2.x/bisect.c 2010-01-07 13:48:40 UTC (rev 1535)
+++ branches/batctl-0.2.x/bisect.c 2010-01-07 14:05:59 UTC (rev 1536)
@@ -197,7 +197,7 @@
int i, j;
if (!curr_bat_node) {
- fprintf(stderr, "Routing table change without preceeding OGM - skipping");
+ fprintf(stderr, "Routing table change without preceding OGM - skipping");
goto err;
}
@@ -225,7 +225,7 @@
goto err;
if (list_empty(&orig_event->event_list)) {
- fprintf(stderr, "Routing table change without any preceeding OGM of that originator - skipping");
+ fprintf(stderr, "Routing table change without any preceding OGM of that originator - skipping");
goto err;
}
Modified: branches/batctl-0.2.x/man/batctl.8
===================================================================
--- branches/batctl-0.2.x/man/batctl.8 2010-01-07 13:48:40 UTC (rev 1535)
+++ branches/batctl-0.2.x/man/batctl.8 2010-01-07 14:05:59 UTC (rev 1536)
@@ -96,7 +96,7 @@
.SH FILES
.TP
.I "\fBbat-hosts\fP"
-This file is simliar to the /etc/hosts file. You can write one mac address and one host name per line. batctl will search for bat-hosts in /etc, your home directory and the current directory. The found data is used to match mac address to your provided host name or replace mac addresses in debug output and logs. Host names are much easier to remember than mac addresses.
+This file is similar to the /etc/hosts file. You can write one mac address and one host name per line. batctl will search for bat-hosts in /etc, your home directory and the current directory. The found data is used to match mac address to your provided host name or replace mac addresses in debug output and logs. Host names are much easier to remember than mac addresses.
.SH AUTHOR
batctl was written by Andreas Langer <a.langer(a)q-dsl.de> and Marek Lindner <lindner_marek(a)yahoo.de>.
.PP
Author: marek
Date: 2010-01-07 14:48:40 +0100 (Thu, 07 Jan 2010)
New Revision: 1535
Modified:
trunk/batctl/man/batctl.8
trunk/batctl/vis.c
Log:
batctl: VIS subcommand uses -h for help/usage.
Signed-off-by: Andrew Lunn <andrew(a)lunn.ch>
Modified: trunk/batctl/man/batctl.8
===================================================================
--- trunk/batctl/man/batctl.8 2010-01-07 05:19:07 UTC (rev 1534)
+++ trunk/batctl/man/batctl.8 2010-01-07 13:48:40 UTC (rev 1535)
@@ -99,18 +99,18 @@
displayed only once (useful for scripts). If "\-n" is given batctl
will not replace the MAC addresses with bat\-host names in the output.
.br
-.IP "\fBvis dot\fP [\fB\-n\fP|\fB\-\-numbers\fP][\fB\-h\fP|\fB\-\-no-HNA\fP][\fB\-2\fP|\fB\-\-no-2nd\fP]"
+.IP "\fBvis dot\fP [\fB\-n\fP|\fB\-\-numbers\fP][\fB\-H\fP|\fB\-\-no-HNA\fP][\fB\-2\fP|\fB\-\-no-2nd\fP]"
Display the visualisation data in graphviz \fBdot\fP(1) format. If
"\-\-numbers" or "\-n" is given batctl will not replace the MAC
addresses with bat-host names in the output. With "\-\-no-HNA" or
-"\-h" the HNA entries are not displayed, so the pure mesh topology can
+"\-H" the HNA entries are not displayed, so the pure mesh topology can
be seen. With "\-\-no-2nd" or "\-2" a dot cluster is not formed around
primary and secondary addresses from the same device.
.br
-.IP "\fBvis json\fP [\fB\-n\fP|\fB\-\-numbers\fP][\fB\-h\fP|\fB\-\-no-HNA\fP][\fB\-2\fP|\fB\-\-no-2nd\fP]"
+.IP "\fBvis json\fP [\fB\-n\fP|\fB\-\-numbers\fP][\fB\-H\fP|\fB\-\-no-HNA\fP][\fB\-2\fP|\fB\-\-no-2nd\fP]"
Display the visualisation data in JSON format. If "\-\-numbers" or
"\-n" is given batctl will not replace the MAC addresses with bat-host
-names in the output. With "\-\-no-HNA" or "\-h" the HNA entries are
+names in the output. With "\-\-no-HNA" or "\-H" the HNA entries are
not displayed, so the pure mesh topology can be seen. With
"\-\-no-2nd" or "\-2" a dot cluster is not formed around primary and
secondary addresses from the same device.
Modified: trunk/batctl/vis.c
===================================================================
--- trunk/batctl/vis.c 2010-01-07 05:19:07 UTC (rev 1534)
+++ trunk/batctl/vis.c 2010-01-07 13:48:40 UTC (rev 1535)
@@ -55,9 +55,9 @@
static void usage(void)
{
- printf("batctl vis dot {--no-HNA|-h} {--no-2nd|-2} {--numbers|-n}\n");
+ printf("batctl vis dot {-h}{--no-HNA|-H} {--no-2nd|-2} {--numbers|-n}\n");
printf("or\n");
- printf("batctl vis json {--no-HNA|-h} {--no-2nd|-2} {--numbers|-n}\n");
+ printf("batctl vis json {-h}{--no-HNA|-H} {--no-2nd|-2} {--numbers|-n}\n");
}
static void dot_print_tq(char *orig, char *from, const long tq)
@@ -271,18 +271,18 @@
while (1) {
int option_index = 0;
static struct option long_options[] = {
- {"no-HNA", 0, 0, 'h'},
+ {"no-HNA", 0, 0, 'H'},
{"no-2nd", 0, 0, '2'},
{"numbers", 0, 0, 'n'},
{0, 0, 0, 0}
};
- c = getopt_long(argc, argv, "h2n", long_options, &option_index);
+ c = getopt_long(argc, argv, "hH2n", long_options, &option_index);
if (c == -1)
break;
switch (c) {
- case 'h':
+ case 'H':
with_HNA = false;
break;
case '2':
@@ -291,6 +291,7 @@
case 'n':
with_names = false;
break;
+ case 'h':
default:
usage();
return -1;
Author: marek
Date: 2010-01-07 06:19:07 +0100 (Thu, 07 Jan 2010)
New Revision: 1534
Modified:
trunk/batman/man/batmand.8
Log:
batman: correct smaller typographical errors
Modified: trunk/batman/man/batmand.8
===================================================================
--- trunk/batman/man/batmand.8 2010-01-07 05:19:03 UTC (rev 1533)
+++ trunk/batman/man/batmand.8 2010-01-07 05:19:07 UTC (rev 1534)
@@ -109,7 +109,7 @@
XX \-> use late\(hyswitch connection
.RE
.RS 7
-In level 1, B.A.T.M.A.N tries to find the best available connection by watching the uplinks throughput and the link quality.
+In level 1, B.A.T.M.A.N tries to find the best available connection by considering the gateway's advertised throughput as well as the link quality towards the gateway.
In level 2, B.A.T.M.A.N compares the link quality of the internet node and chooses the one with the best link quality.
In level 3, B.A.T.M.A.N compares the link quality of the internet node and chooses the one with the best link quality but switches to another gateway as soon as a better connection is found.
In level XX (number between 3 and 256) B.A.T.M.A.N compares the link quality of the internet node and chooses the one with the best link quality but switches to another gateway as soon as this gateway has a TQ value which is XX better than the currently selected gateway.
Author: marek
Date: 2010-01-07 06:19:03 +0100 (Thu, 07 Jan 2010)
New Revision: 1533
Modified:
trunk/batctl/man/batctl.8
Log:
batctl: manpage rework
General rework of the manpage to reflext the latest batctl changes
and fix numerous typos.
Signed-off-by: Andrew Lunn <andrew(a)lunn.ch>
Modified: trunk/batctl/man/batctl.8
===================================================================
--- trunk/batctl/man/batctl.8 2010-01-02 20:09:47 UTC (rev 1532)
+++ trunk/batctl/man/batctl.8 2010-01-07 05:19:03 UTC (rev 1533)
@@ -2,7 +2,7 @@
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
-.TH batctl 8 "Aug 01, 2009"
+.TH "BATCTL" "8" "Jan 04, 2010" "Linux" "B.A.T.M.A.N. Advanced Control Tool"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
@@ -19,85 +19,164 @@
.\" Process this file with
.\" groff -man batctl.8 -Tutf8
.\" --------------------------------------------------------------------------
-.TH "batctl" 8
+.ad l
.SH NAME
-batctl \- B.A.T.M.A.N. advanced control and managing tool
+batctl \- B.A.T.M.A.N. advanced control and management tool
.SH SYNOPSIS
.B batctl
.I [\fIbatctl\-options\fP]\ \fIcommand\fP\ [\fIcommand\-options\fP]
.br
.SH DESCRIPTION
-B.A.T.M.A.N. advanced operates on layer 2 and thus all hosts participating in the virtual switch are completely transparent for all protocols above layer 2. Therefore the common diagnosis tools do not work as expected. To overcome these problems \fBbatctl\fP was created. At the moment the batctl contains \fBping\fP, \fBtraceroute\fP, \fBtcpdump\fP interfaces to the kernel module settings.
+batctl offers a convenient way to configure the batman\-adv kernel
+module as well as displaying debug information such as originator
+tables, translation tables and the debug log. In combination with a
+bat\-hosts file batctl allows the use of host names instead of MAC
+addresses.
.PP
-batctl uses the /dev/batman\-adv device provided by the B.A.T.M.A.N. advanced kernel module to inject custom icmp packets into the data flow. That's why ping and traceroute work almost like their IP based counterparts. Tcpdump analyzes the traffic and packet types used by B.A.T.M.A.N. advanced.
+B.A.T.M.A.N. advanced operates on layer 2. Thus all hosts
+participating in the virtual switched network are transparently
+connected together for all protocols above layer 2. Therefore the
+common diagnosis tools do not work as expected. To overcome these
+problems batctl contains the commands \fBping\fP, \fBtraceroute\fP,
+\fBtcpdump\fP which provide similar functionality to the normal
+\fBping\fP(1), \fBtraceroute\fP(1), \fBtcpdump\fP(1) commands, but
+modified to layer 2 behaviour or using the B.A.T.M.A.N. advanced
+protocol.
.PP
-Furthermore batctl offers an convenient way to configure the batman\-adv kernel module as well as displaying debug information such as originator tables, translation tables and debug log. In combination with a bat\-hosts file batctl allows working with easy to remember names instead of mac addresses.
.PP
.SH OPTIONS
.TP
.I \fBbatctl\-options:
-\-h print general batctl help
+\-h print general batctl help
.br
-\-v print batctl version
+\-v print batctl version
.br
.TP
.I \fBcommands:
-.IP "\fBinterface|if [none|interface]\fP"
-If no parameter is given the current interface settings are displayed otherwise the parameter(s) are added as new interfaces. Use the "none" keyword to deactivate all interfaces.
+.IP "\fBinterface\fP|\fBif\fP [\fBnone\fP|\fIinterface\fP]"
+If no parameter is given the current interface settings are displayed
+otherwise the parameter(s) are added as new interfaces. Use the "none"
+keyword to deactivate all interfaces.
.br
-.IP "\fBoriginators|o\fP"
-Once started batctl will refresh the displayed originator table every second. Use the "\-b" option to let batctl display the table only once (useful for scripts). If "\-n" was given batctl will not replace the mac addresses with bat\-host names in the output.
+.IP "\fBoriginators\fP|\fBo\fP [\fB\-b\fP][\fB\-n\fP]"
+Display the originator table. Once started batctl will refresh the
+displayed originator table every second. The "\-b" option causes the
+table to be displayed only once (useful for scripts). If "\-n" is
+given batctl will not replace the MAC addresses with bat\-host names
+in the output.
.br
-.IP "\fBinterval|it [orig_interval]\fP"
-If no parameter is given the current originator interval settings are displayed otherwise the parameter is used to set the originator interval.
+.IP "\fBinterval\fP|\fBit\fP [\fIorig_interval\fP]"
+If no parameter is given the current originator interval setting is
+displayed otherwise the parameter is used to set the originator
+interval. The interval is in units of milliseconds.
.br
-.IP "\fBloglevel|ll [level]\fP"
-If no parameter is given the current log level settings are displayed otherwise the parameter is used to set the log level.
+.IP "\fBloglevel\fP|\fBll\fP [\fIlevel\fP]"
+If no parameter is given the current log level settings are displayed
+otherwise the parameter is used to set the log level. Level 0 disables
+all logging. Level 1 enables messages related to routing / flooding /
+broadcasting. Level 2 enables messages related to route or hna added /
+changed / deleted. Level 3 enables all messages. The messages are sent
+to the kernel log. Use \fBdmesg\fP(1) to see them.
.br
-.IP "\fBlog|l\fP "
-Once started batctl will continuously read the log produced by the kernel module (the amount of log message can be influenced by modifying the log level). Whenever there are new log messages sent by the kernel batctl will display it. Use the "\-b" option to let batctl exit after the existing log buffer has been displayed. If "\-n" was given batctl will not replace the mac addresses with bat\-host names in the output.
+.IP "\fBlog\fP|\fBl\fP [\fIlogfile\fP][\fB\-b\fP][\fB\-n\fP]\fP"
+batctl will read the file logfile, or stdin if the logfile parameter
+is not given, applying filtering so only the B.A.T.M.A.N. Advanced
+messages are displayed. Whenever there are new log messages appended
+to the file batctl will display them. The option "\-b" causes batctl
+to exit once the end of the file has been reached. If "\-n" is given
+batctl will not replace the MAC addresses with bat\-host names in the
+output.
.br
-.IP "\fBtranslocal|tl\fP"
-Once started batctl will refresh the displayed local translation table every second. Use the "\-b" option to let batctl display the table only once (useful for scripts). If "\-n" was given batctl will not replace the mac addresses with bat\-host names in the output.
+.IP "\fBtranslocal\fP|\fBtl\fP [\fB\-b\fP][\fB\-n\fP]"
+Display the local translation table. batctl will refresh the
+displayed table every second. The "\-b" option causes the table to be
+displayed only once (useful for scripts). If "\-n" is given batctl
+will not replace the MAC addresses with bat\-host names in the output.
.br
-.IP "\fBtransglobal|tg\fP"
-Once started batctl will refresh the displayed global translation table every second. Use the "\-b" option to let batctl display the table only once (useful for scripts). If "\-n" was given batctl will not replace the mac addresses with bat\-host names in the output.
+.IP "\fBtransglobal\fP|\fBtg\fP [\fB\-b\fP][\fB\-n\fP]"
+Display the global translation table. batctl will refresh the
+displayed table every second. The "\-b" option causes the table to be
+displayed only once (useful for scripts). If "\-n" is given batctl
+will not replace the MAC addresses with bat\-host names in the output.
.br
-.IP "\fBvis dot\fP"
-Display the visualisation data in graphviz dot(1) format. If
-"\--numbers" or "\-n" batctl will not replace the mac addresses with
-bat-host names in the output. With "\--no-HNA" or "\-h" the HNA
-entries are not displayed, so the pure mesh topology can be seen. With
-"\--no-2nd" or "\-2" a dot cluster is not formed around primary and
-secondary addresses from the same device.
+.IP "\fBvis dot\fP [\fB\-n\fP|\fB\-\-numbers\fP][\fB\-h\fP|\fB\-\-no-HNA\fP][\fB\-2\fP|\fB\-\-no-2nd\fP]"
+Display the visualisation data in graphviz \fBdot\fP(1) format. If
+"\-\-numbers" or "\-n" is given batctl will not replace the MAC
+addresses with bat-host names in the output. With "\-\-no-HNA" or
+"\-h" the HNA entries are not displayed, so the pure mesh topology can
+be seen. With "\-\-no-2nd" or "\-2" a dot cluster is not formed around
+primary and secondary addresses from the same device.
.br
-.IP "\fBvis json\fP"
-Display the visualisation data in JSON format. If
-"\--numbers" or "\-n" batctl will not replace the mac addresses with
-bat-host names in the output. With "\--no-HNA" or "\-h" the HNA
-entries are not displayed, so the pure mesh topology can be seen. With
-"\--no-2nd" or "\-2" a dot cluster is not formed around primary and
+.IP "\fBvis json\fP [\fB\-n\fP|\fB\-\-numbers\fP][\fB\-h\fP|\fB\-\-no-HNA\fP][\fB\-2\fP|\fB\-\-no-2nd\fP]"
+Display the visualisation data in JSON format. If "\-\-numbers" or
+"\-n" is given batctl will not replace the MAC addresses with bat-host
+names in the output. With "\-\-no-HNA" or "\-h" the HNA entries are
+not displayed, so the pure mesh topology can be seen. With
+"\-\-no-2nd" or "\-2" a dot cluster is not formed around primary and
secondary addresses from the same device.
.br
-.IP "\fBaggregation|ag [0|1]\fP"
-If no parameter is given the current aggregation settings are displayed otherwise the parameter is used to enable or disable the packet aggregation.
+.IP "\fBaggregation\fP|\fBag\fP [\fB1\fP|\fB0\fP]"
+If no parameter is given the current aggregation setting is displayed.
+Otherwise the parameter is used to enable or disable packet
+aggregation.
.br
-.IP "\fBping|p mac\ address|bat\-host\ name\fP"
-Layer 2 ping mac address or bat\-host name (batctl will try to find bat\-host name if the given parameter was not a mac address) until batctl has been stopped with CTRL + C. The "\-c" option tells batctl how often it should ping the given host before it stops by itself. With "\-i" and "\-t" you can influence the default interval time between pings and the timeout time for replies respectively.
+.IP "\fBping\fP|\fBp\fP [\fB\-c \fP\fIcount\fP][\fB\-i \fP\fIinterval\fP][\fB\-t \fP\fItime\fP] \fIMAC_address\fP|\fIbat\-host_name\fP"
+Layer 2 ping of a MAC address or bat\-host name. batctl will try to
+find the bat\-host name if the given parameter was not a MAC
+address. The "\-c" option tells batctl how man pings should be sent
+before the program exits. Without the "\-c" option batctl will continue
+pinging without end. Use CTRL + C to stop it. With "\-i" and "\-t"
+you can set the default interval between pings and the timeout time
+for replies, both in seconds.
.br
-.IP "\fBtraceroute|tr mac\ address|bat\-host\ name\fP"
-Layer 2 traceroute mac address or bat\-host name (batctl will try to find bat\-host name if the given parameter was not a mac address). batctl will send 3 packets to each host and display the response time. If "\-n" was given batctl will not replace the mac addresses with bat\-host names in the output.
-.IP "\fBtcpdump|td interface [interface]\fP"
-Per default batctl will display all packets that were seen on the given interface(s). The "\-p" options allows to filter certain packet types: 1 displays batman ogm packets only, 2 displays batman icmp packets only, etc. These numbers can be added to filter more than one packet type, e.g. use "\-p 3" to display batman ogm packets and batman icmp packets only. If "\-n" was given batctl will not replace the mac addresses with bat\-host names in the output.
+.IP "\fBtraceroute\fP|\fBtr\fP [\fB\-n\fP] \fIMAC_address\fP|\fIbat\-host_name\fP"
+Layer 2 traceroute to a MAC address or bat\-host name. batctl will try
+to find the bat\-host name if the given parameter was not a MAC
+address. batctl will send 3 packets to each host and display the
+response time. If "\-n" is given batctl will not replace the MAC
+addresses with bat\-host names in the output.
.br
-.IP "\fBbisect logfile1 logfile2 .. logfileN\fP"
-Analyzes the logfiles to build a small internal database of all sent sequence numbers and routing table changes. This database can be used to search for routing loops (default action), to trace OGMs of a host (use "\-t" to specify the mac address or bat\-host name) throughout the network or to display routing tables of the nodes (use "\-r" to specify the mac address or bat\-host name). You can name a specific sequence number or a range using the "\-s" option to limit the output's range. Furthermore you can filter the output by specifying an originator (use "\-o" to specify the mac address or bat\-host name) to only see data connected to this originator. If "\-n" was given batctl will not replace the mac addresses with bat\-host names in the output.
+.IP "\fBtcpdump\fP|\fBtd\fP [\fB\-p \fP\fIfilter\fP][\fB\-n\fP] \fIinterface ...\fP"
+batctl will display all packets that are seen on the given
+interface(s). The "\-p" options allows the filtering of certain packet
+types: 1 - batman ogm packets, 2 - batman icmp packets, 4 - unicast
+packets, 8 - broadcast packets, 16 - vis packets, and 32 - none batman
+packets. These numbers can be added to filter more than one packet
+type, e.g. use "\-p 3" to display batman ogm packets and batman icmp
+packets only. If "\-n" is given batctl will not replace the MAC
+addresses with bat\-host names in the output.
.br
+.IP "\fBbisect\fP [\fB\-l \fP\fIMAC\fP][\fB\-t \fP\fIMAC\fP][\fB\-r \fP\fIMAC\fP][\fB\-s \fP\fImin\fP [\fB\- \fP\fImax\fP]][\fB\-o \fP\fIMAC\fP][\fB\-n\fP] \fIlogfile1\fP [\fIlogfile2\fP ... \fIlogfileN\fP]"
+Analyses the logfiles to build a small internal database of all sent
+sequence numbers and routing table changes. This database can then be
+analyzed in a number of different ways. With "\-l" the database can be
+used to search for routing loops. Use "\-t" to trace OGMs of a host
+throughout the network. Use "\-r" to display routing tables of the
+nodes. The option "\-s" can be used to limit the output to a range of
+sequence numbers, between min and max, or to one specific sequence
+number, min. Furthermore using "\-o" you can filter the output to a
+specified originator. If "\-n" is given batctl will not replace the
+MAC addresses with bat\-host names in the output.
+.br
.SH FILES
.TP
.I "\fBbat-hosts\fP"
-This file is similar to the /etc/hosts file. You can write one mac address and one host name per line. batctl will search for bat-hosts in /etc, your home directory and the current directory. The found data is used to match mac address to your provided host name or replace mac addresses in debug output and logs. Host names are much easier to remember than mac addresses.
+This file is similar to the /etc/hosts file. You can write one MAC
+address and one host name per line. batctl will search for bat-hosts
+in /etc, your home directory and the current directory. The found data
+is used to match MAC address to your provided host name or replace MAC
+addresses in debug output and logs. Host names are much easier to
+remember than MAC addresses.
+.SH SEE ALSO
+.BR ping (1),
+.BR traceroute (1),
+.BR tcpdump (1),
+.BR dmesg (1),
+.BR dot (1)
.SH AUTHOR
-batctl was written by Andreas Langer <a.langer(a)q-dsl.de> and Marek Lindner <lindner_marek(a)yahoo.de>.
+batctl was written by Andreas Langer <a.langer(a)q-dsl.de> and Marek
+Lindner <lindner_marek(a)yahoo.de>.
.PP
-This manual page was written by Simon Wunderlich <siwu(a)hrz.tu-chemnitz.de> and Marek Lindner <lindner_marek(a)yahoo.de>.
+This manual page was written by Simon Wunderlich
+<siwu(a)hrz.tu-chemnitz.de>, Marek Lindner <lindner_marek(a)yahoo.de> and
+Andrew Lunn <andrew(a)lunn.ch>
The following commit has been merged in the linux branch:
commit 5e8c7f2de26ea64ab16eef5be3fd8540f594e3cc
Author: Andrew Lunn <andrew(a)lunn.ch>
Date: Wed Jan 6 07:28:11 2010 +0100
Staging: batman-adv: Update the README for mainline usage.
The module now only compiles inside mainline, so remove the comments
about different versions of the kernel it can be used with. Also
update comments about building with debug enabled and how to use the
VIS data now that it no longer natively outputs dot or JSON.
Signed-off-by: Andrew Lunn <andrew(a)lunn.ch>
diff --git a/drivers/staging/batman-adv/README b/drivers/staging/batman-adv/README
index df21c61..7d666ad 100644
--- a/drivers/staging/batman-adv/README
+++ b/drivers/staging/batman-adv/README
@@ -1,4 +1,4 @@
-[state: 01-01-2010]
+[state: 06-01-2010]
BATMAN-ADV
----------
@@ -15,19 +15,6 @@ above B.A.T.M.A.N. Advanced, prominent examples are: IPv4, IPv6, DHCP, IPX.
This is batman-advanced implemented as Linux kernel driver. It does not depend
on any network (other) driver, and can be used on wifi as well as ethernet,
vpn, etc ... (anything with ethernet-style layer 2).
-It compiles against and should work with Linux 2.6.20 - 2.6.32. Supporting older
-versions is not planned, but it's probably easy to backport it. If you work on a
-backport, feel free to contact us. :-)
-
-COMPILE
--------
-To compile against your currently installed kernel, just type:
-
-# make
-
-if you want to compile against some other kernel, use:
-
-# make KERNELPATH=/path/to/kernel
USAGE
-----
@@ -73,16 +60,9 @@ When configured as server, you can get a topology snapshot of your mesh:
# cat /proc/net/batman-adv/vis
-This output format is a graphviz formatted text file which can be
-processed with graphviz-tools like dot.
-The labels are similar/compatible to the ETX metric, 1.0 means perfect
-connection (100%), 2.0 means 50%, 3.0 means 33% and so on.
-
-Alternatively, a JSON output format is available. The format can be set
-using by writing either "dot_draw" or "json" into the vis_format file.
-"dot_draw" is selected by default.
-
-echo "json" > /proc/net/batman-adv/vis_format
+The output is in a generic raw format. Use the batctl tool (See below)
+to convert this to other formats more suitable for graphing, eg
+graphviz dot, or JSON data-interchange format.
In very mobile scenarios, you might want to adjust the originator
interval to a lower value. This will make the mesh more responsive to
@@ -110,15 +90,11 @@ dmesg | grep batman-adv
When investigating problems with your mesh network it is sometimes
necessary to see more detail debug messages. This must be enabled when
-compiling the batman-adv module. When building batman-adv as part of
-kernel, use "make menuconfig" and enable the option
-"B.A.T.M.A.N. debugging". When compiling outside of the kernel tree it
-is necessary to edit the file Makefile.kbuild and uncomment the line
-
-#EXTRA_CFLAGS += -DCONFIG_BATMAN_ADV_DEBUG
+compiling the batman-adv module. Use "make menuconfig" and enable the
+option "B.A.T.M.A.N. debugging".
The additional debug output is by default disabled. It can be enabled
-either at kernel modules load time or during run time. To enable debug
+either at kernel module load time or during run time. To enable debug
output at module load time, add the module parameter debug=<value>.
<value> can take one of four values.
@@ -147,12 +123,12 @@ to see the debug messages.
BATCTL
------
-B.A.T.M.A.N. advanced operates on layer 2 and thus all hosts partici-
-pating in the virtual switch are completely transparent for all proto-
-cols above layer 2. Therefore the common diagnosis tools do not work as
-expected. To overcome these problems batctl was created. At the moment
-the batctl contains ping, traceroute, tcpdump and interfaces to the
-kernel module settings.
+B.A.T.M.A.N. advanced operates on layer 2 and thus all hosts
+participating in the virtual switch are completely transparent for all
+protocols above layer 2. Therefore the common diagnosis tools do not
+work as expected. To overcome these problems batctl was created. At
+the moment the batctl contains ping, traceroute, tcpdump and
+interfaces to the kernel module settings.
For more information, please see the manpage (man batctl).
--
batman-adv
Author: marek
Date: 2010-01-02 21:09:47 +0100 (Sat, 02 Jan 2010)
New Revision: 1532
Modified:
trunk/batman/man/batmand.8
Log:
batman: Correct typographical errors detected by lintian
Debian's Lintian detected different smaller typographical errors in the source
code and manpages of batctl.
* seperate -> separate
* orginator -> originator
* modus -> mode
* deamon -> daemon
Signed-off-by: Sven Eckelmann <sven.eckelmann(a)gmx.de>
Modified: trunk/batman/man/batmand.8
===================================================================
--- trunk/batman/man/batmand.8 2010-01-02 20:00:24 UTC (rev 1531)
+++ trunk/batman/man/batmand.8 2010-01-02 20:09:47 UTC (rev 1532)
@@ -66,7 +66,7 @@
.RE
.TP
.B \-g gateway class
-The gateway class is used to tell other nodes in the network your available internet bandwidth. Just enter any number (optionally followed by "kbit" or "mbit") and the daemon will guess your appropriate gateway class. Use "/" to seperate the down\(hy and upload rates. You can omit the upload rate and batmand will assume an upload of download / 5.
+The gateway class is used to tell other nodes in the network your available internet bandwidth. Just enter any number (optionally followed by "kbit" or "mbit") and the daemon will guess your appropriate gateway class. Use "/" to separate the down\(hy and upload rates. You can omit the upload rate and batmand will assume an upload of download / 5.
.RS 17
default: 0 \-> gateway disabled
.RE
@@ -85,7 +85,7 @@
.TP
.B \-H verbose help
.TP
-.B \-o orginator interval in ms
+.B \-o originator interval in ms
A node transmits broadcast messages (we call them originator message or OGM) to inform the neighboring nodes about it's existence.
Originator interval is the time to wait after sending one message and before sending the next message. The default value is 1000 ms (1 second).
In a mobile network, you may want to detect network changes very quickly, so you need to send message very often, for example, use a value of 500 ms.
@@ -93,10 +93,10 @@
This option is only available in daemon mode.
.TP
.B \-p preferred gateway
-Set the internet gateway by yourself. Note: This automatically switches your daemon to "internet search modus" with "\-r 1" unless "\-r" is given. If the preferred gateway is not found the gateway selection will use the current routing class to choose a gateway.
+Set the internet gateway by yourself. Note: This automatically switches your daemon to "internet search mode" with "\-r 1" unless "\-r" is given. If the preferred gateway is not found the gateway selection will use the current routing class to choose a gateway.
.TP
.B \-r routing class
-The routing class can be set to four values \(hy it enables "internet search modus". The deamon will choose an internet gateway based on certain criteria (unless "\-p" is specified):
+The routing class can be set to four values \(hy it enables "internet search mode". The daemon will choose an internet gateway based on certain criteria (unless "\-p" is specified):
.RS 17
default: 0 \-> set no default route
.RE
Author: marek
Date: 2010-01-02 21:00:24 +0100 (Sat, 02 Jan 2010)
New Revision: 1531
Modified:
trunk/batctl/man/batctl.8
Log:
batctl: Differentiate between hyphen and minus in manpage
groff differentiate between minus signs and hyphens. The default option is to
interpret '-' as hyphens (U+2010) and makes it hard to use copy and paste for
options in UTF-8 environments.
See http://lists.debian.org/debian-devel/2003/03/msg01481.html for more
informations.
Signed-off-by: Sven Eckelmann <sven.eckelmann(a)gmx.de>
Modified: trunk/batctl/man/batctl.8
===================================================================
--- trunk/batctl/man/batctl.8 2010-01-02 19:57:30 UTC (rev 1530)
+++ trunk/batctl/man/batctl.8 2010-01-02 20:00:24 UTC (rev 1531)
@@ -91,7 +91,7 @@
Per default batctl will display all packets that were seen on the given interface(s). The "\-p" options allows to filter certain packet types: 1 displays batman ogm packets only, 2 displays batman icmp packets only, etc. These numbers can be added to filter more than one packet type, e.g. use "\-p 3" to display batman ogm packets and batman icmp packets only. If "\-n" was given batctl will not replace the mac addresses with bat\-host names in the output.
.br
.IP "\fBbisect logfile1 logfile2 .. logfileN\fP"
-Analyzes the logfiles to build a small internal database of all sent sequence numbers and routing table changes. This database can be used to search for routing loops (default action), to trace OGMs of a host (use "-t" to specify the mac address or bat\-host name) throughout the network or to display routing tables of the nodes (use "-r" to specify the mac address or bat\-host name). You can name a specific sequence number or a range using the "-s" option to limit the output's range. Furthermore you can filter the output by specifying an originator (use "-o" to specify the mac address or bat\-host name) to only see data connected to this originator. If "\-n" was given batctl will not replace the mac addresses with bat\-host names in the output.
+Analyzes the logfiles to build a small internal database of all sent sequence numbers and routing table changes. This database can be used to search for routing loops (default action), to trace OGMs of a host (use "\-t" to specify the mac address or bat\-host name) throughout the network or to display routing tables of the nodes (use "\-r" to specify the mac address or bat\-host name). You can name a specific sequence number or a range using the "\-s" option to limit the output's range. Furthermore you can filter the output by specifying an originator (use "\-o" to specify the mac address or bat\-host name) to only see data connected to this originator. If "\-n" was given batctl will not replace the mac addresses with bat\-host names in the output.
.br
.SH FILES
.TP