fix crash on discarding packets

[hippotat.git] / README.config

diff --git a/README.config b/README.config
index 881694f272ca50e8933c20c839c09f58a248847d..81f791d836b1417a48067d843d3540e34983079e 100644 (file)
--- a/README.config
+++ b/README.config
@@ -4,7 +4,7 @@ Sections
 
   [<servername> - <client>]
   [<client>]
-  [<servername>]      usually [SERVER]
+  [<servername>]      often [SERVER]
   [DEFAULT]
 
 Keys are looked up in that order, unless otherwise specified.
@@ -42,9 +42,9 @@ Exceptional settings:
      Command to run to create and communicate with local network
      interface.  Passed to sh -c.  Must speak SLIP on stdin/stdout.
      The following additional interpolations aare substituted:
-                       %(local)s      %(peer)s       %(rnet)s
-          on server    <vaddr>        <vrelay>       <vnetwork>
-          on client    <client>       <vaddr>        <vroutes>
+                       %(local)s  %(peer)s  %(rnet)s    %(ifname)s
+          on server    <vaddr>    <vrelay>  <vnetwork>  <ifname_server>
+          on client    <client>   <vaddr>   <vroutes>   <ifname_client>
      ["userv root ipif %(local)s,%(peer)s,%(mtu)s,slip %(rnets)s"]
 
      On server: applies to all clients; not looked up in
@@ -61,7 +61,12 @@ Capped settings:
      [65536 bytes; LIMIT: 262144 bytes]
 
   max_queue_time
-     Discard downwards packets after this long (used by server only)
+     Discard packets after they have been queued this long waiting
+     for http.
+     On server: setting applies to downward packets, and is capped
+      by LIMIT values.
+     On client: setting applies to upward packets, and is
+      not affected by LIMIT values.
      [10 s; LIMIT: 121 s]
 
   http_timeout
@@ -109,7 +114,13 @@ Ordinary settings, used by both, not client-specific:
      On client: used only to construct default url.
 
   mtu
-     Must match exactly.  (checked) [1500 bytes]
+     Must match exactly.  (UNCHECKED) [1500 bytes]
+
+  ifname_server
+     Virtual interface name on the server.  [shippo%d]
+  ifname_client
+     Virtual interface name on the client.  [hippo%d]
+     Any %d is interpolated (by the kernel).
 
 Ordinary settings, used by client only: