dyngw: update the readme
authorFerry Huberts <ferry.huberts@pelagic.nl>
Wed, 29 Apr 2015 16:58:22 +0000 (18:58 +0200)
committerFerry Huberts <ferry.huberts@pelagic.nl>
Thu, 30 Apr 2015 21:52:24 +0000 (23:52 +0200)
Signed-off-by: Ferry Huberts <ferry.huberts@pelagic.nl>
lib/dyn_gw/README_DYN_GW

index 8f3e02d..efc664d 100644 (file)
@@ -46,14 +46,16 @@ HOW TO USE (version 0.5)
 
 LoadPlugin "olsrd_dyn_gw.so.0.5"
 {
-    # The plugin check interval can be set here in milliseconds.
-    # The default is 1000 ms (1 second).
-    PlParam     "CheckInterval"  "5000"
-    
-    # The ping check interval in case there is any pinged host specified.
-    # The default is 5 seconds.
-    PlParam     "PingInterval"   "40"
-    
+    # The plugin check interval in milliseconds.
+    # PlParam     "checkinterval"      "1000"
+
+    # The ping check interval in seconds when any pinged host specified.
+    # PlParam     "interval"           "5"
+    # PlParam     "pinginterval"       "5"
+
+    # The ping command to use when any pinged host specified.
+    # PlParam     "pingcmd"            "ping -c 1 -q %s"
+
     # If one or more IPv4 addresses are given, do a ping on these in
     # descending order to validate that there is not only an entry in
     # routing table, but also a real network connection. If any of
@@ -61,35 +63,35 @@ LoadPlugin "olsrd_dyn_gw.so.0.5"
     # succesful, i.e. if the ping on the 1st address was successful,the
     # 2nd won't be pinged.
     #
-    # The Ping list applies to the group of HNAs specified above or to the 
-               # default internet gateway when no HNA is specified.
-               #
-               # Running the plugin without parameters acts as the 'old' dyn_gw_plain.
-    
-    #   The following ping entries for the internet gateway
-    PlParam "Ping"   "141.1.1.1"
-    PlParam "Ping"   "194.25.2.129"
-    
-    #   First group of HNAs with related ping host
-    PlParam    "HNA"      "192.168.80.0 255.255.255.0"
-    PlParam    "HNA"      "192.168.81.0 255.255.255.0"
-    PlParam    "Ping"   "192.168.81.12"
-    
-    #   Second HNA group with multiple related ping hosts.
-    #   Specifying multiple ping hosts provides redundancy.
-    PlParam "HNA"    "192.168.100.0 255.255.255.0"
-    PlParam "HNA"    "192.168.101.0 255.255.255.0"
-    PlParam "HNA"    "192.168.102.0 255.255.255.0"
-    PlParam "Ping"   "192.168.100.10"
-    PlParam "Ping"   "192.168.101.10"
-    
-    #   Third HNA group without ping check
-    PlParam "HNA"    "192.168.200.0 255.255.255.0"
-    PlParam "HNA"    "192.168.201.0 255.255.255.0"
-    PlParam "HNA"    "192.168.202.0 255.255.255.0"
-
-    #   Set custom ping command - %s will be replaced with IP to ping
-    PlParam "PingCmd" "ping -c 1 -q -I vpn %s"
+    # The Ping list applies to the group of HNAs specified above or to the
+    # default internet gateway when no HNA is specified.
+    #
+    # Running the plugin without parameters acts as the 'old' dyn_gw_plain.
+
+    # The following ping entries for the internet gateway
+    # PlParam     "ping"               "141.1.1.1"
+    # PlParam     "ping"               "194.25.2.129"
+
+    # First group of HNAs with related ping host
+    # PlParam     "hna"                "192.168.80.0   255.255.255.0"
+    # PlParam     "hna"                "192.168.81.0   255.255.255.0"
+    # PlParam     "ping"               "192.168.81.12"
+
+    # Second HNA group with multiple related ping hosts.
+    # Specifying multiple ping hosts provides redundancy.
+    # PlParam     "hna"                "192.168.100.0  255.255.255.0"
+    # PlParam     "hna"                "192.168.101.0  255.255.255.0"
+    # PlParam     "hna"                "192.168.102.0  255.255.255.0"
+    # PlParam     "ping"               "192.168.100.10"
+    # PlParam     "ping"               "192.168.101.10"
+
+    # Third HNA group without ping check
+    # PlParam     "hna"                "192.168.200.0  255.255.255.0"
+    # PlParam     "hna"                "192.168.201.0  255.255.255.0"
+    # PlParam     "hna"                "192.168.202.0  255.255.255.0"
+
+    # Set custom ping command - %s will be replaced with the IP address to ping
+    # PlParam     "pingcmd"            "ping -c 1 -q -I vpn %s"
 }
 
 --------------------------------------------------------------------------------