Repository : ssh://git@open-mesh.org/doc

On branches: backup-redmine/2017-07-17,master

commit 166a39d2644902281d58c8d8a727c03d0a9835e2 Author: Sven Eckelmann sven@narfation.org Date: Sun Jul 16 23:08:25 2017 +0000

doc: batman-adv/Doc-overview: Include subpages for each documentation section

166a39d2644902281d58c8d8a727c03d0a9835e2 batman-adv/Doc-overview.textile | 54 +++-------------------------------------- 1 file changed, 4 insertions(+), 50 deletions(-)

diff --git a/batman-adv/Doc-overview.textile b/batman-adv/Doc-overview.textile index 85147cfd..4297dee3 100644 --- a/batman-adv/Doc-overview.textile +++ b/batman-adv/Doc-overview.textile @@ -4,62 +4,16 @@ h1. B.A.T.M.A.N. Advanced Documentation Overview

How to get a mesh network up and running, how to configure the many features of B.A.T.M.A.N. Advanced, and how to shoot down your troubles.

-h2. Getting started - -* [[Wiki|B.A.T.M.A.N. Advanced overview]] - information about the Layer 2 version of B.A.T.M.A.N. -* [[building-with-openwrt|Building B.A.T.M.A.N. Advanced with OpenWRT]] - how to download and configure your OpenWRT build environment to compile batman-adv. -* [[quick-start-guide|B.A.T.M.A.N. Advanced quick start guide]] - or: what the hell is bat0 for? -* [[using-batctl|Features of batctl]] - A quick introduction to batctl. -* "batctl online man page":https://downloads.open-mesh.org/batman/manpages/batctl.8.html - read the current batctl man page online -* "Wireless Kernel Tweaking (video)":https://downloads.open-mesh.org/batman/misc/24c3-2292-en-wireless_kernel_twe... - introduction to batman-advanced by Marek and Simon [December 2007] (also available at "c3tv":https://media.ccc.de/browse/congress/2007/24c3-2292-en-wireless_kernel_tweak...) -* [[faq|Frequently asked questions]] - A list of frequently asked questions and answers. - -h2. Features - -* [[gateways|Gateway support]] - How batman-adv can be used to choose the nearest internet gateway node. -* news#38 - The inner workings of the non-mesh client integration revealed. -* [[bridge-loop-avoidance|Bridge loop avoidance]] - Document explaining the bridge loop avoidance implemented in batman-adv. -* [[Multi-link-optimize|Multi-Link Optimizations]] - how to optimize traffic by using multiple links -* [[ap-isolation|AP Isolation]] - How to prevent wifi-client to wifi-client communication. -* [[DistributedArpTable|Distributed ARP Table]] - How batman-adv can speed up your mesh experience by caching ARP replies. -* news#43 - basic concept behind the layer2 fragmentation (GSoC final report) -* [[Multicast-optimizations|Multicast Optimizations]] - multicast optimizations overview -* [[NetworkCoding|Network Coding]] - Combine two packets into a single transmission to save air time. -* [[alfred:|Alfred]] - Use alfred to send local information or visualize your mesh network +{{include(gettingstarted)}} +{{include(features)}}

h2. Troubleshooting

* [[Understand-your-batman-adv-network|Available Information]] - Read about the information exported by the module. * [[troubleshooting|Troubleshooting FAQ]] - What if my batman-adv setup does not behave as expected ?

-h2. Developer Information / Advanced Features - -* [[tweaking|Tweaking the B.A.T.M.A.N. Advanced behaviour]] - get an overview about the various settings batman-adv offers -* [[uevent|B.A.T.M.A.N. user space events]] - batman-adv's uevent documentation -* [[open-mesh:UsingBatmanGit|Using the batman git repos]] - this page explains how the git repository is structured and how to use it -* [[open-mesh:Emulation|Emulation HowTo]] - how to create an environment to emulate wireless setups using QEMU and VDE -* [[TVLV|TVLV]] - details regarding the TVLV (type-version-length-value) API and defined TVLV containers - -h2. Protocol Documentation - -* [[open-mesh:BATMANConcept|B.A.T.M.A.N. Concept]] - get an overview about B.A.T.M.A.N.'s main concepts -* [[open-mesh:routing_scenarios|Routing scenarios]] - a collection of routing scenarios a routing protocol should be able to handle -* [[Network-wide-multi-link-optimization|Multi-Link Optimizations]] - Use multiple links in batman-adv for fun and profit (technical documentation) -* [[Client-announcement|Client announcement]] - how batman-adv handles non-mesh clients bridged into the mesh -* [[Client-roaming|Client roaming]] - non-mesh clients moving from one mesh node to the next -* [[TT-Flags|TT Flags]] - explanation for internal flags used by the translation table code -* [[Packet-types|Batman-adv packet types]] - backward compatibility for batman-adv -* [[Compatversion|Compat versions]] - packet versions / formats used by batman-adv -* [[BATMAN_V|B.A.T.M.A.N. V]] - throughput based mesh routing with B.A.T.M.A.N. V -* [[Bridge-loop-avoidance-II]] - bridge loop avoidance to allow multiple gateways between LAN and mesh, redesigned -* [[DistributedArpTable-technical|Distributed ARP Table]] - technical details regarding the inner working of the DAT mechanism -* [[Fragmentation-technical|Fragmentation]] - technical details explaining the layer2 fragmentation -* [[Multicast-optimizations-tech|Multicast optimizations]] - technical details concerning the multicast optimizations -* [[NetworkCoding-technical|Network Coding]] - technical details regarding the network coding implementation -* "Batman-adv multicast optimization (video)":https://downloads.open-mesh.org/batman/misc/wbmv4-multicast.avi - how batman-adv optimizes multicast traffic by Linus and Simon [March 2011] -* "Bisect the batman-adv routing protocol (video)":https://downloads.open-mesh.org/batman/misc/wbmv4-bisect.avi - the bisect tool explained & demonstrated by Marek [March 2011] -* "Project CATWOMAN - network coding with batman-adv (video)":https://downloads.open-mesh.org/batman/misc/wbmv4-network_coding.avi - introduction into network coding with batman-adv by Martin and Jeppe [March 2011] -* "Random Linear Coding (video)":https://downloads.open-mesh.org/batman/misc/wbmv6-random-linear-network-codi... - presentation on network coding by Martin [April 2013] +{{include(developerinformation)}} +{{include(protocol_information)}}

h2. Who uses B.A.T.M.A.N. Advanced?