@@ -1,5 +1,5 @@
#
-# Copyright (C) 2006-2009 BATMAN contributors
+# Copyright (C) 2006-2010 BATMAN contributors
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of version 2 of the GNU General Public
@@ -335,7 +335,7 @@ Globally announced HNAs received via the mesh (translation table):
* ca:a1:5b:e5:00:00 via fe:fe:00:00:06:01
batctl vis_server
-================
+=================
display or modify the status of the VIS server
@@ -348,4 +348,81 @@ $ batctl vis_server
[ ] server mode (server enabled)
+batctl vis_data
+===============
+display the VIS data in dot or JSON format
+
+
+Usage:
+
+batctl vis dot {-h}{--no-HNA|-H} {--no-2nd|-2} {--numbers|-n}
+or
+batctl vis json {-h}{--no-HNA|-H} {--no-2nd|-2} {--numbers|-n}
+
+
+Example:
+(A <- 100% -> B,B-if2 <- 50% -> C)
+
+$ batctl vis_data dot
+digraph {
+ "A" -> "B" [label="1.00"]
+ "A" -> "00:ff:f3:cc:68:ac" [label="HNA"]
+ subgraph "cluster_A" {
+ "A" [peripheries=2]
+ }
+ "B" -> "A" [label="1.00"]
+ "B-if2" -> "C" [label="2.00"]
+ "B" -> "22:ff:f3:cc:68:ac" [label="HNA"]
+ subgraph "cluster_B" {
+ "B" [peripheries=2]
+ "B-if2"
+ }
+ "C" -> "B-if2" [label="2.00"]
+ "C" -> "44:ff:f3:cc:68:ac" [label="HNA"]
+ subgraph "cluster_C" {
+ "C" [peripheries=2]
+ }
+}
+
+
+Explanation:
+
+The vis dot (or json) output is adding an entry for each link between two
+originator's interfaces which are being used for internal routing in batman.
+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.
+
+A host's mac address which is currently connected to the interface of a mesh
+node (either the mesh node itself or hosts being bridged into the mesh) is
+being displayed with an "HNA"-label. (--no-hna omits this output)
+
+To still have the information about which interfaces belong to which mesh node
+a subgraph/cluster is being added. The subpgraph is being labeled with a mesh
+nodes primary interface mac (= Originator MAC). It also has an additional tag
+[peripheries=2] to make this important MAC address visible, for instance in an
+image. (--no-2nd omits this output)
+After the conversion to a png file with graphviz-tools' fdp, all interfaces of
+a node would be combined in a visual box (see below for details).
+
+
+vis-dot to png
+--------------
+
+The vis dot output could then further be converted to an image of the topology
+graph, e.g. with the help of the graphviz-tools. The according commands could
+then look like this:
+
+$ batctl vis_data dot > /tmp/graph.dot
+$ fdp -Tpng /tmp/graph.dot > graph.png
+
+Meaning of the shapes in this image file:
+* Ellipses: All BATMAN-node and host interfaces can be found in here
+ labeled with the according interface MAC-address.
+* Boxes: interfaces belonging to one BATMAN-node
+* double circled interfaces: the primary interface of a BATMAN-node
+ (which is known to other BATMAN-nodes only, except direct neighbours)
+* Ellipses with an HNA-arrow: mesh clients (this can be a BATMAN-node itself
+ with its bat0 interface or computers/devices being bridged into the mesh)
+* Arrows with numbers: the transmit quality (in the form 1/TQ) from one
+ BATMAN interface to another BATMAN interface
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2009 B.A.T.M.A.N. contributors:
+ * Copyright (C) 2009-2010 B.A.T.M.A.N. contributors:
*
* Marek Lindner <lindner_marek@yahoo.de>
*
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2007-2009 B.A.T.M.A.N. contributors:
+ * Copyright (C) 2007-2010 B.A.T.M.A.N. contributors:
*
* Andreas Langer <a.langer@q-dsl.de>, Marek Lindner <lindner_marek@yahoo.de>
*
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2009 B.A.T.M.A.N. contributors:
+ * Copyright (C) 2009-2010 B.A.T.M.A.N. contributors:
*
* Marek Lindner <lindner_marek@yahoo.de>
*
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2009 B.A.T.M.A.N. contributors:
+ * Copyright (C) 2009-2010 B.A.T.M.A.N. contributors:
*
* Marek Lindner <lindner_marek@yahoo.de>
*
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2009 B.A.T.M.A.N. contributors:
+ * Copyright (C) 2009-2010 B.A.T.M.A.N. contributors:
*
* Marek Lindner <lindner_marek@yahoo.de>
*
@@ -100,4 +100,4 @@ int handle_debug_table(int argc, char **argv, char *file_path, void table_usage(
debugfs_make_path(DEBUG_BATIF_PATH "/", full_path, sizeof(full_path));
return read_file(full_path, file_path, read_opt);
-}
\ No newline at end of file
+}
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2007-2009 B.A.T.M.A.N. contributors:
+ * Copyright (C) 2007-2010 B.A.T.M.A.N. contributors:
*
* Andreas Langer <a.langer@q-dsl.de>, Marek Lindner <lindner_marek@yahoo.de>
*
@@ -99,7 +99,7 @@ char *get_name_by_macstr(char *mac_str, int read_opt)
return get_name_by_macaddr(mac_addr, read_opt);
}
-int check_proc_dir(char *dir)
+static int check_proc_dir(char *dir)
{
struct stat st;
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2007-2009 B.A.T.M.A.N. contributors:
+ * Copyright (C) 2007-2010 B.A.T.M.A.N. contributors:
*
* Andreas Langer <a.langer@q-dsl.de>, Marek Lindner <lindner_marek@yahoo.de>
*
@@ -35,7 +35,6 @@ char *get_name_by_macaddr(struct ether_addr *mac_addr, int read_opt);
char *get_name_by_macstr(char *mac_str, int read_opt);
int read_file(char *dir, char *path, int read_opt);
int write_file(char *dir, char *fname, char *arg1, char *arg2);
-int check_proc_dir(char *dir);
char *strchr_anyof(const char *s, const char *n);
extern char *line_ptr;
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2007-2009 B.A.T.M.A.N. contributors:
+ * Copyright (C) 2007-2010 B.A.T.M.A.N. contributors:
*
* Andreas Langer <a.langer@q-dsl.de>, Marek Lindner <lindner_marek@yahoo.de>
*
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2007-2009 B.A.T.M.A.N. contributors:
+ * Copyright (C) 2007-2010 B.A.T.M.A.N. contributors:
*
* Andreas Langer <a.langer@q-dsl.de>, Marek Lindner <lindner_marek@yahoo.de>
*
@@ -53,115 +53,85 @@ protocol.
.br
.TP
.I \fBcommands:
-.IP "\fBinterface\fP|\fBif\fP [\fBadd\fP|\fBdel iface(s)\fP]"
-If no parameter is given or the first parameter is neither "add" nor "del" the current interface settings are displayed. In order to add or delete interfaces specify "add" or "del" as first argument and append the interface names you wish to add or delete.
-.br
-.IP "\fBoriginators\fP|\fBo\fP [\fB\-b\fP][\fB\-n\fP]"
-Once started batctl will display the list of announced gateways in the network. Use the "\-w" option to let batctl refresh the list every second. If "\-n" is given batctl will not replace the MAC addresses with bat\-host names in the output.
-.br
-.IP "\fBinterval\fP|\fBit\fP [\fBorig_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\fP|\fBll\fP [\fBlevel\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. Make sure to have debugging output enabled when compiling the module otherwise the output as well as the loglevel options won't be available.
-.br
-.IP "\fBlog\fP|\fBl\fP [\fBlogfile\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. Once the end of the file has been reached batctl will exit unless the option "\-w" was specified which causes batctl to continue reading the file and print log output whenever new log data has been appended to the file.
-.br
-.IP "\fBgw_mode|gw\fP [\fBoff\fP|\fBclient\fP|\fBserver\fP] [\fBgw_class\fP]\fP"
-If no parameter is given the current gateway mode is displayed otherwise the parameter is used to set the gateway mode. The second (optional) argument specifies the gateway class. Its function depends on whether the node is a server or a client. If the node is a server this parameter is used to inform other nodes in the network about this node's internet connection bandwidth. Just enter any number (optionally followed by "kbit" or "mbit") and the batman-adv module will guess your appropriate gateway class. Use "/" to separate the down\(hy and upload rates. You can omit the upload rate and the module will assume an upload of download / 5.
-.RS 17
-default: 2000 \-> gateway class 20
-.RE
-.RS 16
-examples: 5000 \-> gateway class 49
-.RE
-.RS 25
- 5000kbit
- 5mbit
- 5mbit/1024
- 5mbit/1024kbit
- 5mbit/1mbit
-.RE
-.RS 7
-If the node is a gateway client the parameter will decide which criterias to consider when the batman-adv module has to choose between different internet connections announced by the aforementioned servers.
-.RE
-.RS 17
-default: 20 \-> late switch (TQ 20)
-.RE
-.RS 16
-examples: 1 -> fast connection
-.RS 16
-consider the gateway's advertised throughput as well as the link quality towards the gateway
-.RE
-.RE
-.RS 25
- 2 \-> stable connection
-.RS 7
-chooses the gateway with the best link quality and stick with it (ignore the advertised throughput)
-.RE
- 3 \-> fast switch connection
-.RS 7
-chooses the gateway with the best link quality but switches to another gateway as soon as a better one is found
-.RE
- XX \-> late switch connection
-.RS 7
-chooses the gateway with the best link quality but switches to another gateway as soon as a better one is found which is at least XX TQ better than the currently selected gateway (XX has to be a number between 3 and 256).
-.RE
-.RE
-.br
-.IP "\fBgateways|gwl\fP [\fB\-w\fP][\fB\-n\fP]"
-Once started batctl will display the list of announced gateways in the network. Use the "\-w" option to let batctl refresh the list every second. If "\-n" was given batctl will not replace the mac addresses with bat\-host names in the output.
-.br
-.IP "\fBtranslocal\fP|\fBtl\fP [\fB\-w\fP][\fB\-n\fP]"
-Display the local translation table. batctl will refresh the displayed table every second if the "\-w" option was given. Use "\-n" to let batctl not replace the MAC addresses with bat\-host names in the output.
-.br
-.IP "\fBtransglobal\fP|\fBtg\fP [\fB\-w\fP][\fB\-n\fP]"
-Display the global translation table. batctl will refresh the displayed table every second if the "\-w" option was given. Use "\-n" to let batctl not replace the MAC addresses with bat\-host names in the output.
-.br
-.IP "\fBvis_mode|vm\fP [\fBmode\fP]\fP"
-If no parameter is given the current vis mode is displayed otherwise the parameter is used to set the vis mode.
-.br
-.IP "\fBvis_data|vd 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_data|vd 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
+.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\fP|\fBo\fP [\fB\-w\fP][\fB\-n\fP]"
+Once started batctl will display the originator table. Use the "\-w"
+option to let batctl refresh the list every second. If "\-n" is
+given batctl will not replace the MAC addresses with bat\-host names
+in the output.
+.br
+.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\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 verbose 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. Make sure to have debugging output
+enabled when compiling the module otherwise the verbose logging output as
+well as the loglevel options won't be available.
+.br
+.IP "\fBlog\fP|\fBl\fP [\fIlogfile\fP][\fB\-w\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. Once the end of the file has been reached batctl
+will exit unless the option "\-w" was specified which causes batctl to
+continue reading the file and print log output whenever new log data has
+been appended to the file. If "\-n" is given batctl will not replace the
+MAC addresses with bat\-host names in the output.
+.br
+.IP "\fBtranslocal\fP|\fBtl\fP [\fB\-w\fP][\fB\-n\fP]"
+Display the local translation table. Use the "\-w" option to let batctl
+refresh the list every second. If "\-n" is given batctl will not replace
+the MAC addresses with bat\-host names in the output.
+.br
+.IP "\fBtransglobal\fP|\fBtg\fP [\fB\-w\fP][\fB\-n\fP]"
+Display the global translation table. Use the "\-w" option to let batctl
+refresh the list every second. If "\-n" is given batctl will not replace
+the MAC addresses with bat\-host names in the output.
+.br
+.IP "\fBvis_server\fP|\fBvs\fP [\fBenabled\fP|\fBdisabled\fP]"
+If no parameter is given the current vis server setting is displayed.
+Otherwise the parameter is used to enable or disable the vis server.
+.br
+.IP "\fBvis_data\fP|\fBvd\fP \fBdot|\fBjson [\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 \fBdot\fP(1) or 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\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.
+.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 "\fBbonding\fP|\fBb\fP [\fB1\fP|\fB0\fP]"
-If no parameter is given the current bonding mode setting is displayed. Otherwise the parameter is used to enable or disable the bonding mode.
-.br
-.IP "\fBping\fP|\fBp\fP [\fB\-c count\fP][\fB\-i interval\fP][\fB\-t time\fP][\fB\-R\fP] \fBMAC_address\fP|\fBbat\-host_name\fP"
+.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. When run with "\-R", the route taken by
-the ping messages will be recorded.
+for replies, both in seconds.
.br
-.IP "\fBtraceroute\fP|\fBtr\fP [\fB\-n\fP] \fBMAC_address\fP|\fBbat\-host_name\fP"
+.IP "\fBtraceroute\fP|\fBtr\fP [\fB\-n\fP] \fIMAC_address\fP|\fBbat\-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 "\fBtcpdump\fP|\fBtd\fP [\fB\-p filter\fP][\fB\-n\fP] \fBinterface ...\fP"
+.IP "\fBtcpdump\fP|\fBtd\fP [\fB\-p \fP\fIfilter\fP][\fB\-n\fP] \fBinterface ...\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
@@ -171,7 +141,7 @@ 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 MAC\fP][\fB\-t MAC\fP][\fB\-r MAC\fP][\fB\-s min\fP [\fB\- max\fP]][\fB\-o MAC\fP][\fB\-n\fP] \fBlogfile1\fP [\fBlogfile2\fP ... \fBlogfileN\fP]"
+.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
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2007-2009 B.A.T.M.A.N. contributors:
+ * Copyright (C) 2007-2010 B.A.T.M.A.N. contributors:
*
* Andreas Langer <a.langer@q-dsl.de>, Marek Lindner <lindner_marek@yahoo.de>
*
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2009 B.A.T.M.A.N. contributors:
+ * Copyright (C) 2009-2010 B.A.T.M.A.N. contributors:
*
* Marek Lindner <lindner_marek@yahoo.de>
*
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2007-2009 B.A.T.M.A.N. contributors:
+ * Copyright (C) 2007-2010 B.A.T.M.A.N. contributors:
*
* Andreas Langer <a.langer@q-dsl.de>
*
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2007-2009 B.A.T.M.A.N. contributors:
+ * Copyright (C) 2007-2010 B.A.T.M.A.N. contributors:
*
* Andreas Langer <a.langer@q-dsl.de>, Marek Lindner <lindner_marek@yahoo.de>
*
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2007-2009 B.A.T.M.A.N. contributors:
+ * Copyright (C) 2007-2010 B.A.T.M.A.N. contributors:
*
* Andreas Langer <a.langer@q-dsl.de>, Marek Lindner <lindner_marek@yahoo.de>
*
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2009 B.A.T.M.A.N. contributors:
+ * Copyright (C) 2009-2010 B.A.T.M.A.N. contributors:
*
* Marek Lindner <lindner_marek@yahoo.de>
*
@@ -1,4 +1,6 @@
-/* Copyright (C) 2009 B.A.T.M.A.N. contributors:
+/*
+ * Copyright (C) 2009-2010 B.A.T.M.A.N. contributors:
+ *
* Andrew Lunn <andrew@lunn.ch>
*
* This program is free software; you can redistribute it and/or
@@ -1,4 +1,6 @@
-/* Copyright (C) 2009 B.A.T.M.A.N. contributors:
+/*
+ * Copyright (C) 2009-2010 B.A.T.M.A.N. contributors:
+ *
* Andrew Lunn <andrew@lunn.ch>
*
* This program is free software; you can redistribute it and/or
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2006-2009 B.A.T.M.A.N. contributors:
+ * Copyright (C) 2006-2010 B.A.T.M.A.N. contributors:
*
* Simon Wunderlich, Marek Lindner
*
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2006-2009 B.A.T.M.A.N. contributors:
+ * Copyright (C) 2006-2010 B.A.T.M.A.N. contributors:
*
* Simon Wunderlich, Marek Lindner
*
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2006-2009 B.A.T.M.A.N. contributors:
+ * Copyright (C) 2006-2010 B.A.T.M.A.N. contributors:
*
* Marek Lindner
*
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2006-2009 B.A.T.M.A.N. contributors:
+ * Copyright (C) 2006-2010 B.A.T.M.A.N. contributors:
*
* Marek Lindner
*