[B.A.T.M.A.N.] batctl: Add section to explain gateway selection class for BATMAN_V

[Ruben Barkow <github@r.z11.de>]

[-- Attachment #1.1.1: Type: text/plain, Size: 181 bytes --]

As mentioned here: https://www.open-mesh.org/issues/366#note-8

I added a fix to the formatting, so this is the final patch:

Signed-off-by: Ruben Barkow <github@r.z11.de>



[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1.1.2: 0001-batctl-Add-section-to-explain-gateway-selection-clas.patch --]
[-- Type: text/x-patch; name="0001-batctl-Add-section-to-explain-gateway-selection-clas.patch", Size: 1673 bytes --]

From c3561b556c57546b2a089b830bd78ada7cd46218 Mon Sep 17 00:00:00 2001
From: rubo77 <github@r.z11.de>
Date: Tue, 27 Nov 2018 13:40:29 +0100
Subject: [PATCH] batctl: Add section to explain gateway selection class for
 BATMAN_V

Signed-off-by: Ruben Barkow <github@r.z11.de>
---
 man/batctl.8 | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/man/batctl.8 b/man/batctl.8
index 2e3232f..ed8e71f 100644
--- a/man/batctl.8
+++ b/man/batctl.8
@@ -144,6 +144,9 @@ examples:  5000 \->  5.0/1.0 MBit
 If the node is a gateway client the parameter will decide which criteria to consider when the batman-adv module has to choose
 between different internet connections announced by the aforementioned servers.
 .RE
+.RS 7
+B.A.T.M.A.N. IV:
+.RE
 .RS 17
 default: 20 \-> late switch (TQ 20)
 .RE
@@ -168,6 +171,20 @@ chooses the gateway with the best link quality but switches to another gateway a
 least XX TQ better than the currently selected gateway (XX has to be a number between 3 and 256).
 .RE
 .RE
+.RS 7
+B.A.T.M.A.N. V:
+.RE
+.RS 17
+default: 5000 \-> late switch (5000 kbit/s throughput)
+.br
+example: 1500 \-> fast switch connection
+.RS 17
+switches to another gateway as soon as a better one is found which is at least 
+1500 kbit/s faster throughput than the currently selected gateway. Throughput is
+determined by evaluating which is lower: the advertised throughput by the
+gateway or the maximum bandwidth across the entire path.
+.RE
+.RE
 .br
 .IP "\fBrouting_algo\fP|\fBra\fP [\fBalgorithm\fP]\fP"
 If no parameter is given the current routing algorithm configuration as well as
-- 
2.17.1


[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 833 bytes --]