process putatives: Fix processing of [<servername> <client>] sections
[hippotat] / README.config
index 881694f..2b58512 100644 (file)
@@ -4,8 +4,8 @@ Sections
 
   [<servername> - <client>]
   [<client>]
 
   [<servername> - <client>]
   [<client>]
-  [<servername>]      usually [SERVER]
-  [DEFAULT]
+  [<servername>]      often [SERVER]
+  [COMMON]
 
 Keys are looked up in that order, unless otherwise specified.
 <client> is the client's virtual address.
 
 Keys are looked up in that order, unless otherwise specified.
 <client> is the client's virtual address.
@@ -15,7 +15,7 @@ Exceptional settings:
 
   server
      Specifies <servername>.
 
   server
      Specifies <servername>.
-     Is looked up in [SERVER] and [DEFAULT] only.
+     Is looked up in [SERVER] and [COMMON] only.
      If not specified there, it is SERVER.
 
      Used by server to select the appropriate parts of the
      If not specified there, it is SERVER.
 
      Used by server to select the appropriate parts of the
@@ -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:
      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
      ["userv root ipif %(local)s,%(peer)s,%(mtu)s,slip %(rnets)s"]
 
      On server: applies to all clients; not looked up in
@@ -54,14 +54,19 @@ Exceptional settings:
 Capped settings:
 
      Values in [<server> LIMIT] and [LIMIT] are a cap (maximum) on
 Capped settings:
 
      Values in [<server> LIMIT] and [LIMIT] are a cap (maximum) on
-     those from the other sections (including DEFAULT).
+     those from the other sections (including COMMON).
 
   max_batch_down
      Size limit for response payloads (used by server only)
      [65536 bytes; LIMIT: 262144 bytes]
 
   max_queue_time
 
   max_batch_down
      Size limit for response payloads (used by server only)
      [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
      [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
      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:
 
 
 Ordinary settings, used by client only: