The following commit has been merged in the master branch: commit 2dc3eb129a68bb65af65eccb37a2bc0bfd1d6b52 Author: simon simon@45894c77-fb22-0410-b583-ff6e7d5dbf6c Date: Sat Nov 7 10:59:00 2009 +0000
update README and adjust year numbers in copyright notice
git-svn-id: http://downloads.open-mesh.net/svn/batman/trunk/batman-adv-kernelland@1462 45894c77-fb22-0410-b583-ff6e7d5dbf6c
diff --git a/Makefile b/Makefile index d49514a..062149b 100644 --- a/Makefile +++ b/Makefile @@ -1,6 +1,8 @@ # -# Copyright (C) 2007-2008 B.A.T.M.A.N. contributors: +# Copyright (C) 2007-2009 B.A.T.M.A.N. contributors: +# # Marek Lindner, Simon Wunderlich +# # This program is free software; you can redistribute it and/or # modify it under the terms of version 2 of the GNU General Public # License as published by the Free Software Foundation. diff --git a/Makefile.kbuild b/Makefile.kbuild index 4210267..6be1223 100644 --- a/Makefile.kbuild +++ b/Makefile.kbuild @@ -1,6 +1,8 @@ # -# Copyright (C) 2007-2008 B.A.T.M.A.N. contributors: +# Copyright (C) 2007-2009 B.A.T.M.A.N. contributors: +# # Marek Lindner, Simon Wunderlich +# # This program is free software; you can redistribute it and/or # modify it under the terms of version 2 of the GNU General Public # License as published by the Free Software Foundation. diff --git a/README b/README index 63465c2..d554a6c 100644 --- a/README +++ b/README @@ -1,11 +1,20 @@ -[state: 17-11-2008] +[state: 07-11-2009]
BATMAN-ADV ----------
-The kernel implementation of batman-advanced. It does not depend on any network -driver, and can be used on wifi as well as ethernet, vpn, etc ... (anything -with ethernet-style layer 2). +Batman-advanced is a new approach to wireless networking which does no longer +operate on the IP basis. Unlike B.A.T.M.A.N, which exchanges information +using UDP packets and sets routing 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 protocols won't be +affected by any changes within the network. You can run almost any protocol +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.31. 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. :-) @@ -53,18 +62,54 @@ as VIS-server:
# echo "server" > /proc/net/batman-adv/vis
+Each node is either configured as "server" or as "client" (default: +"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 information will be +transmitted. With these "synchronizing servers", there can be 1 or +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 can be processed with graphviz-tools like dot. +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 + +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 +that all nodes in your mesh use the same interval. The default value +is 1000 ms (1 second). + +# echo 1000 > /proc/net/batman-adv/orig_interval + To deactivate batman, do:
# echo "" > /proc/net/batman-adv/interfaces
+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. + +For more information, please see the manpage (man batctl). + +batctl is available on http://www.open-mesh.net/ + CONTACT -------
diff --git a/aggregation.c b/aggregation.c index 9b88b14..5a31e94 100644 --- a/aggregation.c +++ b/aggregation.c @@ -1,6 +1,8 @@ /* * Copyright (C) 2007-2009 B.A.T.M.A.N. contributors: + * * Marek Lindner, Simon Wunderlich + * * This program is free software; you can redistribute it and/or * modify it under the terms of version 2 of the GNU General Public * License as published by the Free Software Foundation. diff --git a/aggregation.h b/aggregation.h index a0500b2..6da8df9 100644 --- a/aggregation.h +++ b/aggregation.h @@ -1,6 +1,8 @@ /* * Copyright (C) 2007-2009 B.A.T.M.A.N. contributors: + * * Marek Lindner, Simon Wunderlich + * * This program is free software; you can redistribute it and/or * modify it under the terms of version 2 of the GNU General Public * License as published by the Free Software Foundation. diff --git a/bitarray.c b/bitarray.c index e4c4087..32a16e2 100644 --- a/bitarray.c +++ b/bitarray.c @@ -1,6 +1,8 @@ /* - * Copyright (C) 2006-2008 B.A.T.M.A.N. contributors: + * Copyright (C) 2006-2009 B.A.T.M.A.N. contributors: + * * Simon Wunderlich, Marek Lindner + * * This program is free software; you can redistribute it and/or * modify it under the terms of version 2 of the GNU General Public * License as published by the Free Software Foundation. diff --git a/bitarray.h b/bitarray.h index 9f1b36f..2f1f523 100644 --- a/bitarray.h +++ b/bitarray.h @@ -1,6 +1,8 @@ /* - * Copyright (C) 2006-2008 B.A.T.M.A.N. contributors: + * Copyright (C) 2006-2009 B.A.T.M.A.N. contributors: + * * Simon Wunderlich, Marek Lindner + * * This program is free software; you can redistribute it and/or * modify it under the terms of version 2 of the GNU General Public * License as published by the Free Software Foundation. diff --git a/compat.h b/compat.h index cd3e71f..f4e0a45 100644 --- a/compat.h +++ b/compat.h @@ -1,6 +1,8 @@ /* - * Copyright (C) 2007-2008 B.A.T.M.A.N. contributors: + * Copyright (C) 2007-2009 B.A.T.M.A.N. contributors: + * * Marek Lindner, Simon Wunderlich + * * This program is free software; you can redistribute it and/or * modify it under the terms of version 2 of the GNU General Public * License as published by the Free Software Foundation. diff --git a/device.c b/device.c index c5fc6fe..45bc1f8 100644 --- a/device.c +++ b/device.c @@ -1,6 +1,8 @@ /* - * Copyright (C) 2007-2008 B.A.T.M.A.N. contributors: + * Copyright (C) 2007-2009 B.A.T.M.A.N. contributors: + * * Marek Lindner + * * This program is free software; you can redistribute it and/or * modify it under the terms of version 2 of the GNU General Public * License as published by the Free Software Foundation. diff --git a/device.h b/device.h index 5e53531..46c0f44 100644 --- a/device.h +++ b/device.h @@ -1,6 +1,8 @@ /* - * Copyright (C) 2007-2008 B.A.T.M.A.N. contributors: + * Copyright (C) 2007-2009 B.A.T.M.A.N. contributors: + * * Marek Lindner + * * This program is free software; you can redistribute it and/or * modify it under the terms of version 2 of the GNU General Public * License as published by the Free Software Foundation. diff --git a/hard-interface.c b/hard-interface.c index 960e86c..e0d0342 100644 --- a/hard-interface.c +++ b/hard-interface.c @@ -1,6 +1,8 @@ /* - * Copyright (C) 2007-2008 B.A.T.M.A.N. contributors: + * Copyright (C) 2007-2009 B.A.T.M.A.N. contributors: + * * Marek Lindner, Simon Wunderlich + * * This program is free software; you can redistribute it and/or * modify it under the terms of version 2 of the GNU General Public * License as published by the Free Software Foundation. diff --git a/hard-interface.h b/hard-interface.h index 29d010b..742358c 100644 --- a/hard-interface.h +++ b/hard-interface.h @@ -1,6 +1,8 @@ /* - * Copyright (C) 2007-2008 B.A.T.M.A.N. contributors: + * Copyright (C) 2007-2009 B.A.T.M.A.N. contributors: + * * Marek Lindner, Simon Wunderlich + * * This program is free software; you can redistribute it and/or * modify it under the terms of version 2 of the GNU General Public * License as published by the Free Software Foundation. diff --git a/hash.c b/hash.c index 576464d..61cb4a2 100644 --- a/hash.c +++ b/hash.c @@ -1,6 +1,8 @@ /* - * Copyright (C) 2006-2008 B.A.T.M.A.N. contributors: + * Copyright (C) 2006-2009 B.A.T.M.A.N. contributors: + * * Simon Wunderlich, Marek Lindner + * * This program is free software; you can redistribute it and/or * modify it under the terms of version 2 of the GNU General Public * License as published by the Free Software Foundation. diff --git a/hash.h b/hash.h index c27687e..bb60f08 100644 --- a/hash.h +++ b/hash.h @@ -1,6 +1,8 @@ /* - * Copyright (C) 2006-2008 B.A.T.M.A.N. contributors: + * Copyright (C) 2006-2009 B.A.T.M.A.N. contributors: + * * Simon Wunderlich, Marek Lindner + * * This program is free software; you can redistribute it and/or * modify it under the terms of version 2 of the GNU General Public * License as published by the Free Software Foundation. diff --git a/log.c b/log.c index 939bf0d..ae8370b 100644 --- a/log.c +++ b/log.c @@ -1,6 +1,8 @@ /* - * Copyright (C) 2007-2008 B.A.T.M.A.N. contributors: + * Copyright (C) 2007-2009 B.A.T.M.A.N. contributors: + * * Marek Lindner, Simon Wunderlich + * * This program is free software; you can redistribute it and/or * modify it under the terms of version 2 of the GNU General Public * License as published by the Free Software Foundation. diff --git a/log.h b/log.h index 685f539..780e3ab 100644 --- a/log.h +++ b/log.h @@ -1,6 +1,8 @@ /* - * Copyright (C) 2007-2008 B.A.T.M.A.N. contributors: + * Copyright (C) 2007-2009 B.A.T.M.A.N. contributors: + * * Marek Lindner, Simon Wunderlich + * * This program is free software; you can redistribute it and/or * modify it under the terms of version 2 of the GNU General Public * License as published by the Free Software Foundation. diff --git a/main.c b/main.c index 4e70c95..bb89bfc 100644 --- a/main.c +++ b/main.c @@ -1,6 +1,8 @@ /* - * Copyright (C) 2007-2008 B.A.T.M.A.N. contributors: + * Copyright (C) 2007-2009 B.A.T.M.A.N. contributors: + * * Marek Lindner, Simon Wunderlich + * * This program is free software; you can redistribute it and/or * modify it under the terms of version 2 of the GNU General Public * License as published by the Free Software Foundation. diff --git a/main.h b/main.h index 9493f96..5d2e27c 100644 --- a/main.h +++ b/main.h @@ -1,6 +1,8 @@ /* - * Copyright (C) 2007-2008 B.A.T.M.A.N. contributors: + * Copyright (C) 2007-2009 B.A.T.M.A.N. contributors: + * * Marek Lindner, Simon Wunderlich + * * This program is free software; you can redistribute it and/or * modify it under the terms of version 2 of the GNU General Public * License as published by the Free Software Foundation. diff --git a/packet.h b/packet.h index 021bcec..5627ca3 100644 --- a/packet.h +++ b/packet.h @@ -1,6 +1,8 @@ /* * Copyright (C) 2007-2009 B.A.T.M.A.N. contributors: + * * Marek Lindner, Simon Wunderlich + * * This program is free software; you can redistribute it and/or * modify it under the terms of version 2 of the GNU General Public * License as published by the Free Software Foundation. diff --git a/proc.c b/proc.c index 7677de0..b3eb69d 100644 --- a/proc.c +++ b/proc.c @@ -1,6 +1,8 @@ /* - * Copyright (C) 2007-2008 B.A.T.M.A.N. contributors: + * Copyright (C) 2007-2009 B.A.T.M.A.N. contributors: + * * Marek Lindner, Simon Wunderlich + * * This program is free software; you can redistribute it and/or * modify it under the terms of version 2 of the GNU General Public * License as published by the Free Software Foundation. diff --git a/proc.h b/proc.h index 23c4fe4..ebce50d 100644 --- a/proc.h +++ b/proc.h @@ -1,6 +1,8 @@ /* - * Copyright (C) 2007-2008 B.A.T.M.A.N. contributors: + * Copyright (C) 2007-2009 B.A.T.M.A.N. contributors: + * * Marek Lindner, Simon Wunderlich + * * This program is free software; you can redistribute it and/or * modify it under the terms of version 2 of the GNU General Public * License as published by the Free Software Foundation. diff --git a/ring_buffer.c b/ring_buffer.c index dee6fba..751c899 100644 --- a/ring_buffer.c +++ b/ring_buffer.c @@ -1,6 +1,8 @@ /* - * Copyright (C) 2007-2008 B.A.T.M.A.N. contributors: + * Copyright (C) 2007-2009 B.A.T.M.A.N. contributors: + * * Marek Lindner + * * This program is free software; you can redistribute it and/or * modify it under the terms of version 2 of the GNU General Public * License as published by the Free Software Foundation. diff --git a/ring_buffer.h b/ring_buffer.h index 246f354..6839ba9 100644 --- a/ring_buffer.h +++ b/ring_buffer.h @@ -1,6 +1,8 @@ /* - * Copyright (C) 2007-2008 B.A.T.M.A.N. contributors: + * Copyright (C) 2007-2009 B.A.T.M.A.N. contributors: + * * Marek Lindner + * * This program is free software; you can redistribute it and/or * modify it under the terms of version 2 of the GNU General Public * License as published by the Free Software Foundation. diff --git a/routing.c b/routing.c index a5a7c61..220dbf7 100644 --- a/routing.c +++ b/routing.c @@ -1,6 +1,8 @@ /* - * Copyright (C) 2007-2008 B.A.T.M.A.N. contributors: + * Copyright (C) 2007-2009 B.A.T.M.A.N. contributors: + * * Marek Lindner, Simon Wunderlich + * * This program is free software; you can redistribute it and/or * modify it under the terms of version 2 of the GNU General Public * License as published by the Free Software Foundation. diff --git a/routing.h b/routing.h index 97db3f2..0123ea8 100644 --- a/routing.h +++ b/routing.h @@ -1,6 +1,8 @@ /* - * Copyright (C) 2007-2008 B.A.T.M.A.N. contributors: + * Copyright (C) 2007-2009 B.A.T.M.A.N. contributors: + * * Marek Lindner, Simon Wunderlich + * * This program is free software; you can redistribute it and/or * modify it under the terms of version 2 of the GNU General Public * License as published by the Free Software Foundation. diff --git a/send.c b/send.c index 01396b4..d724798 100644 --- a/send.c +++ b/send.c @@ -1,6 +1,8 @@ /* * Copyright (C) 2007-2009 B.A.T.M.A.N. contributors: + * * Marek Lindner, Simon Wunderlich + * * This program is free software; you can redistribute it and/or * modify it under the terms of version 2 of the GNU General Public * License as published by the Free Software Foundation. diff --git a/send.h b/send.h index ca7f3f0..59d5009 100644 --- a/send.h +++ b/send.h @@ -1,6 +1,8 @@ /* * Copyright (C) 2007-2009 B.A.T.M.A.N. contributors: + * * Marek Lindner, Simon Wunderlich + * * This program is free software; you can redistribute it and/or * modify it under the terms of version 2 of the GNU General Public * License as published by the Free Software Foundation. diff --git a/soft-interface.c b/soft-interface.c index fa5289e..18e5e8f 100644 --- a/soft-interface.c +++ b/soft-interface.c @@ -1,6 +1,8 @@ /* - * Copyright (C) 2007-2008 B.A.T.M.A.N. contributors: + * Copyright (C) 2007-2009 B.A.T.M.A.N. contributors: + * * Marek Lindner, Simon Wunderlich + * * This program is free software; you can redistribute it and/or * modify it under the terms of version 2 of the GNU General Public * License as published by the Free Software Foundation. diff --git a/soft-interface.h b/soft-interface.h index 32ed968..515e276 100644 --- a/soft-interface.h +++ b/soft-interface.h @@ -1,6 +1,8 @@ /* - * Copyright (C) 2007-2008 B.A.T.M.A.N. contributors: + * Copyright (C) 2007-2009 B.A.T.M.A.N. contributors: + * * Marek Lindner + * * This program is free software; you can redistribute it and/or * modify it under the terms of version 2 of the GNU General Public * License as published by the Free Software Foundation. diff --git a/translation-table.c b/translation-table.c index 8d7ea6d..9936bc2 100644 --- a/translation-table.c +++ b/translation-table.c @@ -1,6 +1,8 @@ /* - * Copyright (C) 2007-2008 B.A.T.M.A.N. contributors: + * Copyright (C) 2007-2009 B.A.T.M.A.N. contributors: + * * Marek Lindner, Simon Wunderlich + * * This program is free software; you can redistribute it and/or * modify it under the terms of version 2 of the GNU General Public * License as published by the Free Software Foundation. diff --git a/translation-table.h b/translation-table.h index 660fcd8..f7da811 100644 --- a/translation-table.h +++ b/translation-table.h @@ -1,6 +1,8 @@ /* - * Copyright (C) 2007-2008 B.A.T.M.A.N. contributors: + * Copyright (C) 2007-2009 B.A.T.M.A.N. contributors: + * * Marek Lindner, Simon Wunderlich + * * This program is free software; you can redistribute it and/or * modify it under the terms of version 2 of the GNU General Public * License as published by the Free Software Foundation. diff --git a/types.h b/types.h index 0c31b4d..3a0ef0c 100644 --- a/types.h +++ b/types.h @@ -1,6 +1,8 @@ /* - * Copyright (C) 2007-2008 B.A.T.M.A.N. contributors: + * Copyright (C) 2007-2009 B.A.T.M.A.N. contributors: + * * Marek Lindner, Simon Wunderlich + * * This program is free software; you can redistribute it and/or * modify it under the terms of version 2 of the GNU General Public * License as published by the Free Software Foundation. diff --git a/vis.c b/vis.c index 8c16ad4..22235ad 100644 --- a/vis.c +++ b/vis.c @@ -1,6 +1,8 @@ /* - * Copyright (C) 2008 B.A.T.M.A.N. contributors: + * Copyright (C) 2008-2009 B.A.T.M.A.N. contributors: + * * Simon Wunderlich + * * This program is free software; you can redistribute it and/or * modify it under the terms of version 2 of the GNU General Public * License as published by the Free Software Foundation. diff --git a/vis.h b/vis.h index 6d5ddcf..276faba 100644 --- a/vis.h +++ b/vis.h @@ -1,6 +1,8 @@ /* - * Copyright (C) 2008 B.A.T.M.A.N. contributors: + * Copyright (C) 2008-2009 B.A.T.M.A.N. contributors: + * * Simon Wunderlich, Marek Lindner + * * This program is free software; you can redistribute it and/or * modify it under the terms of version 2 of the GNU General Public * License as published by the Free Software Foundation.