.. SPDX-License-Identifier: GPL-2.0

B.A.T.M.A.N. daemon Documentation Overview
==========================================

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

Getting started
---------------

-  :doc:`InternetTuning <InternetTuning>` - get information how B.A.T.M.A.N.
   handles internet access and what features it offers
-  :doc:`Visualizing the network <VisualizeMesh>` - this document explains
   how to get fancy graphics of the batman mesh
-  :doc:`Announcing networks <AnnouncingNetworks>` - learn how to announce
   and / or revoke HNA on the fly
-  `B.A.T.M.A.N. online man
   page <https://downloads.open-mesh.org/batman/manpages/batmand.8.html>`__
   - read the current batman man page online
-  :doc:`Frequently Asked Questions <Faq>` - list of questions and answers
   of batmand.

Developer Information / Advanced Features
-----------------------------------------

-  :doc:`Getting behind the routing vodoo <RoutingVodoo>` - learn about the
   B.A.T.M.A.N. routing table manipulation
-  :doc:`Understanding the debug output <DebugOutput>` - documentation that
   helps you to understand the debug output
-  :doc:`Vis output <VisOutput>` - working with the vis server output
-  :doc:`How to get a coredump <Coredump>` - documentation about coredump
   configuration & retrieval

Protocol Documentation
----------------------

-  :doc:`B.A.T.M.A.N. Concept </open-mesh/BATMANConcept>` - get an overview
   about B.A.T.M.A.N.'s main concepts
-  :doc:`Routing scenarios </open-mesh/Routing\_scenarios>` - a collection of
   routing scenarios a routing protocol should be able to handle
-  :doc:`The OLSR story </open-mesh/The-olsr-story>` - this text explains the
   roots of B.A.T.M.A.N. (Dec 2006)
-  `CCCamp 2007 talk
   (video) <https://downloads.open-mesh.org/batman/misc/cccamp07-B.A.T.M.A.N._-_Better_Approach_to_Mobile_Ad-Hoc_Networking.m4v>`__
   - Elektra and Marek explain the batman routing algorithm and features
   of batmand [August 2007]
-  `B.A.T.M.A.N. RFC
   Draft <https://tools.ietf.org/html/draft-wunderlich-openmesh-manet-routing-00>`__
   - a draft explaining the routing algorithm used in batman 0.2
-  `B.A.T.M.A.N.
   Status <https://downloads.open-mesh.org/batman/papers/batman-status.pdf>`__
   - read about the B.A.T.M.A.N. (June 2007)