Author: marek Date: 2010-05-04 09:31:55 +0200 (Tue, 04 May 2010) New Revision: 1654
Modified: trunk/batman-adv-kernelland/README Log: batman-adv: strip utf8 characters from the README
Signed-off-by: Marek Lindner lindner_marek@yahoo.de
Modified: trunk/batman-adv-kernelland/README =================================================================== --- trunk/batman-adv-kernelland/README 2010-05-04 02:07:21 UTC (rev 1653) +++ trunk/batman-adv-kernelland/README 2010-05-04 07:31:55 UTC (rev 1654) @@ -1,30 +1,30 @@ -[state: 03‐05‐2010] +[state: 03-05-2010]
-BATMAN‐ADV -‐‐‐‐‐‐‐‐‐‐ +BATMAN-ADV +----------
Batman advanced is a new approach to wireless networking which does no longer operate on the IP basis. Unlike the batman daemon, which exchanges information using UDP packets and sets routing -tables, batman‐advanced operates on ISO/OSI Layer 2 only and uses +tables, batman-advanced operates on ISO/OSI Layer 2 only and uses and routes (or better: bridges) Ethernet Frames. It emulates a virtual network switch of all nodes participating. Therefore all -nodes appear to be link local, thus all higher operating proto‐ -cols won’t be affected by any changes within the network. You can +nodes appear to be link local, thus all higher operating proto- +cols won't be affected by any changes within the network. You can run almost any protocol above batman advanced, prominent examples are: IPv4, IPv6, DHCP, IPX.
-Batman advanced was implemented as a Linux kernel driver to re‐ +Batman advanced was implemented as a Linux kernel driver to re- duce the overhead to a minimum. It does not depend on any (other) network driver, and can be used on wifi as well as ethernet lan, -vpn, etc ... (anything with ethernet‐style layer 2). It compiles -against and should work with Linux 2.6.21 ‐ 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. :‐) +vpn, etc ... (anything with ethernet-style layer 2). It compiles +against and should work with Linux 2.6.21 - 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. :-)
COMPILE -‐‐‐‐‐‐‐ +-------
To compile against your currently installed kernel, just type:
@@ -36,13 +36,13 @@
CONFIGURATION -‐‐‐‐‐‐‐‐‐‐‐‐‐ +-------------
-Load the batman‐adv module into your kernel: +Load the batman-adv module into your kernel:
-# insmod batman‐adv.ko +# insmod batman-adv.ko
-The module is now waiting for activation. You must add some in‐ +The module is now waiting for activation. You must add some in- terfaces on which batman can operate. After loading the module batman advanced will scan your systems interfaces to search for compatible interfaces. Once found, it will create subfolders in @@ -51,13 +51,13 @@ # ls /sys/class/net/eth0/batman_adv/ # iface_status mesh_iface
-If an interface does not have the "batman_adv" subfolder it prob‐ +If an interface does not have the "batman_adv" subfolder it prob- ably is not supported. Not supported interfaces are: loopback, -non‐ethernet and batman’s own interfaces. +non-ethernet and batman's own interfaces.
Note: After the module was loaded it will continuously watch for new interfaces to verify the compatibility. There is no need to -reload the module if you plug your USB wifi adapter into your ma‐ +reload the module if you plug your USB wifi adapter into your ma- chine after batman advanced was initially loaded.
To activate a given interface simply write "bat0" into its @@ -79,7 +79,7 @@ # echo none > /sys/class/net/eth0/batman_adv/mesh_iface
-All mesh wide settings can be found in batman’s own interface +All mesh wide settings can be found in batman's own interface folder:
# ls /sys/class/net/bat0/mesh/ @@ -87,13 +87,13 @@ # orig_interval transtable_local vis_data
-Some of the files contain all sort of status information regard‐ +Some of the files contain all sort of status information regard- ing the mesh network. For example, you can view the table of originators (mesh participants) with:
# cat /sys/class/net/bat0/mesh/originators
-Other files allow to change batman’s behaviour to better fit your +Other files allow to change batman's behaviour to better fit your requirements. For instance, you can check the current originator interval (value in milliseconds which determines how often batman sends its broadcast packets): @@ -106,12 +106,12 @@ # echo 3000 > /sys/class/net/bat0/mesh/orig_interval
In very mobile scenarios, you might want to adjust the originator -interval to a lower value. This will make the mesh more respon‐ +interval to a lower value. This will make the mesh more respon- sive to topology changes, but will also increase the overhead.
USAGE -‐‐‐‐‐ +-----
To make use of your newly created mesh, batman advanced provides a new interface "bat0" which you should use from this point on. @@ -120,28 +120,29 @@ over" the data by using the batman interface and batman will make sure it reaches its destination.
-The "bat0" interface can be used like any other regular inter‐ -face. It needs an IP address which can be either statically con‐ +The "bat0" interface can be used like any other regular inter- +face. It needs an IP address which can be either statically con- figured or dynamically (by using DHCP or similar services):
# NodeA: ifconfig bat0 192.168.0.1 # NodeB: ifconfig bat0 192.168.0.2 # NodeB: ping 192.168.0.1
-Note: In order to avoid problems remove all IP addresses previ‐ +Note: In order to avoid problems remove all IP addresses previ- ously assigned to interfaces now used by batman advanced, e.g.
# ifconfig eth0 0.0.0.0
-VISUALIZATION ‐‐‐‐‐‐‐‐‐‐‐‐‐ +VISUALIZATION +-------------
If you want topology visualization, at least one mesh node must -be configured as VIS‐server: +be configured as VIS-server:
# echo "server" > /sys/class/net/bat0/mesh/vis_mode
-Each node is either configured as "server" or as "client" (de‐ +Each node is either configured as "server" or as "client" (de- fault: "client"). Clients send their topology data to the server next to them, and server synchronize with other servers. If there is no server configured (default) within the mesh, no topology @@ -156,20 +157,20 @@
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 out‐ +vis output in dot or json format for instance and how those out- puts could then be visualised in an image.
The raw format consists of comma separated values per entry where -each entry is giving information about a certain source inter‐ +each entry is giving information about a certain source inter- face. Each entry can/has to have the following values: -‐> "mac" ‐ mac address of an originator’s source interface +-> "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 +-> "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 +-> "HNA mac" - HNA announced by source mac +-> "PRIMARY" - this is a primary interface +-> "SEC mac" - secondary mac address of source (requires preceding PRIMARY)
The TQ value has a range from 4 to 255 with 255 being the best. @@ -179,57 +180,57 @@
LOGGING/DEBUGGING -‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐ +-----------------
All error messages, warnings and information messages are sent to the kernel log. Depending on your operating system distribution -this can be read in one of a number of ways. Try using the com‐ +this can be read in one of a number of ways. Try using the com- mands: dmesg, logread, or looking in the files /var/log/kern.log -or /var/log/syslog. All batman‐adv messages are prefixed with -"batman‐adv:" So to see just these messages try +or /var/log/syslog. All batman-adv messages are prefixed with +"batman-adv:" So to see just these messages try
-# dmesg | grep batman‐adv +# dmesg | grep batman-adv
-When investigating problems with your mesh network it is some‐ +When investigating problems with your mesh network it is some- times necessary to see more detail debug messages. This must be -enabled when compiling the batman‐adv module. When building bat‐ -man‐adv as part of kernel, use "make menuconfig" and enable the +enabled when compiling the batman-adv module. When building bat- +man-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 +#EXTRA_CFLAGS += -DCONFIG_BATMAN_ADV_DEBUG
-The additional debug output is by default disabled. It can be en‐ +The additional debug output is by default disabled. It can be en- abled either at kernel modules 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.
-0 ‐ All debug output disabled -1 ‐ Enable messages related to routing / flooding / broadcasting -2 ‐ Enable route or hna added / changed / deleted -3 ‐ Enable all messages +0 - All debug output disabled +1 - Enable messages related to routing / flooding / broadcasting +2 - Enable route or hna added / changed / deleted +3 - Enable all messages
e.g.
-# modprobe batman‐adv debug=2 +# modprobe batman-adv debug=2
will load the module and enable debug messages for when routes or HNAs change.
The debug output can also be changed at runtime using the file -/sys/module/batman‐adv/parameters/debug. e.g. +/sys/module/batman-adv/parameters/debug. e.g.
-# echo 2 > /sys/module/batman‐adv/parameters/debug +# echo 2 > /sys/module/batman-adv/parameters/debug
enables debug messages for when routes or HNAs
-The debug output is sent to the kernel logs. So try dmesg, lo‐ +The debug output is sent to the kernel logs. So try dmesg, lo- gread, etc to see the debug messages.
BATCTL -‐‐‐‐‐‐ +------
As batman advanced operates on layer 2 all hosts participating in the virtual switch are completely transparent for all protocols @@ -240,20 +241,20 @@
For more information, please see the manpage (man batctl).
-batctl is available on http://www.open%E2%80%90mesh.org/ +batctl is available on http://www.open-mesh.org/
CONTACT -‐‐‐‐‐‐‐ +-------
Please send us comments, experiences, questions, anything :)
IRC: #batman on irc.freenode.org -Mailing‐list: b.a.t.m.a.n@open‐mesh.net (optional subscription - at https://lists.open%E2%80%90mesh.org/mm/listinfo/b.a.t.m.a.n) +Mailing-list: b.a.t.m.a.n@open-mesh.net (optional subscription + at https://lists.open-mesh.org/mm/listinfo/b.a.t.m.a.n)
You can also contact the Authors:
Marek Lindner lindner_marek@yahoo.de -Simon Wunderlich <siwu@hrz.tu‐chemnitz.de> +Simon Wunderlich siwu@hrz.tu-chemnitz.de