diff mbox

[2/3] batman-adv: Merge README with 0.2.1 release

Message ID 1272838458-13899-2-git-send-email-sven.eckelmann@gmx.de
State Accepted, archived
Headers show

Commit Message

Sven Eckelmann May 2, 2010, 10:14 p.m. UTC
Signed-off-by: Sven Eckelmann <sven.eckelmann@gmx.de>
 batman-adv-kernelland/README |   45 +++++++++++++++++++++++++++--------------
 1 files changed, 29 insertions(+), 16 deletions(-)
diff mbox


diff --git a/batman-adv-kernelland/README b/batman-adv-kernelland/README
index df21c61..4c2a6c6 100644
--- a/batman-adv-kernelland/README
+++ b/batman-adv-kernelland/README
@@ -1,4 +1,4 @@ 
-[state: 01-01-2010]
+[state: 22-03-2010]
@@ -15,7 +15,7 @@  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
+It compiles against and should work with Linux 2.6.20 - 2.6.33. 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.  :-)
@@ -57,10 +57,11 @@  regular interface:
 # ping
 If you want topology visualization, your meshnode must be configured
 as VIS-server:
-# echo "server" > /proc/net/batman-adv/vis
+# echo "server" > /proc/net/batman-adv/vis_server
 Each node is either configured as "server" or as "client" (default:
 "client"). Clients send their topology data to the server next to them,
@@ -71,19 +72,31 @@  more vis servers sharing the same (or at least very similar) data.
 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
+# cat /proc/net/batman-adv/vis_data
+This raw output is intended to be easily parsable and convertable with
+other tools. Have a look at the batctl README if you want a vis output
+in dot or json format for instance and how those outputs could then be
+visualised in an image.
+The raw format consists of comma seperated values per entry where each
+entry is giving information about a certain source interface. Each entry
+can/has to have the following values:
+-> "mac" -> mac address of an originator's source interface
+           (each line begins with it)
+-> "TQ mac value" -> src mac's link quality towards mac address of a neighbor
+                     originator's interface which is being used for routing
+-> "HNA mac" -> HNA announced by source mac
+-> "PRIMARY" -> this is a primary interface
+-> "SEC mac" -> secondary mac address of source (requires preceeding
+The TQ value has a range from 4 to 255 with 255 being the best.
+The HNA entries are showing which hosts are connected to the mesh via bat0
+or being bridged into the mesh network.
+The PRIMARY/SEC values are only applied on primary interfaces
 In very mobile scenarios, you might want to adjust the originator
 interval to a lower value. This will make the mesh more responsive to
 topology changes, but will also increase the overhead. Please make sure