README: improve the smart gateway text a bit
authorFerry Huberts <ferry.huberts@pelagic.nl>
Fri, 15 Aug 2014 12:27:43 +0000 (14:27 +0200)
committerFerry Huberts <ferry.huberts@pelagic.nl>
Fri, 15 Aug 2014 15:17:45 +0000 (17:17 +0200)
Signed-off-by: Ferry Huberts <ferry.huberts@pelagic.nl>
README-Olsr-Extensions

index 103fb46..52f1bea 100644 (file)
@@ -252,9 +252,9 @@ All other parameters will be ignored if SmartGateway is set to "no"
     5.2) Client Side
 
 1- SmartGatewayUseCount controls the maximum number of gateways that can be
-   in use at any given time. This setting is used to mitigate the effects of
-   breaking connections (due to the selection of a new gateway) on a dynamic
-   network.
+   in use at any given time. A setting higher than 1 is used to mitigate the
+   effects of breaking connections (due to the selection of a new gateway) on
+   a dynamic network.
    The default setting is 1.
 2- SmartGatewayTakeDownPercentage determines the take-down percentage for a
    non-current smart gateway tunnel. If the cost of the current smart gateway
@@ -262,7 +262,9 @@ All other parameters will be ignored if SmartGateway is set to "no"
    gateway tunnel, then the non-current smart gateway tunnel is taken down
    because it is then presumed to be 'too expensive'.
    This setting is only relevant when SmartGatewayUseCount is larger than 1;
-   a value of 0 will result in the tunnels not being taken down proactively.
+   a value of 0 will result in the tunnels not being taken down proactively,
+   only when a new tunnel is created while then are already
+   'SmartGatewayUseCount' tunnels.
    The default setting is 0.
 3- SmartGatewayPolicyRoutingScript controls the policy routing script that is
    executed during startup and shutdown of olsrd. The script is only executed
@@ -273,7 +275,8 @@ All other parameters will be ignored if SmartGateway is set to "no"
 4- SmartGatewayEgressInterfaces determines the egress interfaces that are part
    of the multi-gateway setup and therefore only relevant when
    SmartGatewayUseCount is larger than 1 (in which case it must be explicitly
-   set).
+   set). This setting can contain multiple interfaces, for example
+     SmartGatewayEgressInterfaces "eth0" "eth1" "ppp0"
    The default setting is <not set>.
 5- SmartGatewayTablesOffset and SmartGatewayRulesOffset determine the ranges of
    policy routing rule markings that are used in a multi-gateway setup (see the
@@ -287,12 +290,12 @@ All other parameters will be ignored if SmartGateway is set to "no"
 7- SmartGatewayPeriod determines the period (in milliseconds) on which
    a new smart gateway selection is performed.
    The default setting is 10000 milliseconds.
-8- SmartGatewayStableCount determines the number of times the link state
-   database must be stable before a new smart gateway is selected.
+8- SmartGatewayStableCount determines the number of times the same new gateway
+   must be chosen before that new smart gateway is actually selected.
    The default setting is 6.
-9- SmartGatewayThreshold controls whether you want to allow re-selection
-   of a new outgoing gateway if its routing cost is lower or equal to the
-   configured percentage of the routing cost of the current gateway.
+9- SmartGatewayThreshold (percentage) controls whether you want to allow
+   re-selection of a new outgoing gateway if its routing cost is lower or equal
+   to the configured percentage of the routing cost of the current gateway.
    The default setting is 0, which disables it.
 10-SmartGatewayWeightExitLinkUp, SmartGatewayWeightExitLinkDown,
    SmartGatewayWeightEtx and SmartGatewayDividerEtx control the weighing