config: Substutiton, improve docs

[hippotat.git] / README.config

diff --git a/README.config b/README.config
index 5bd6daf2e4bb1f5a3acd01eb88ebb2b46ef5b477..a28be23feb97176de3b70a6e64106111567bfb1c 100644 (file)
--- a/README.config
+++ b/README.config
@@ -6,13 +6,17 @@ Sections
   [<client>]
   [<servername>]      often [SERVER]
   [COMMON]
-  [DEFAULT]
 
 Keys are looked up in that order, unless otherwise specified.
 <client> is the client's virtual address.
 <servername> must be a valid lowercase DNS hostname and not look like 
 an address, or be COMMON, DEFAULT or SERVER.
 
+There are also:
+
+  [<servername> LIMIT]
+  [LIMIT]
+
 Things not in a section are an error.
 
 
@@ -66,10 +70,11 @@ Exceptional settings:
   ipif
      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    %(ifname)s
+     The following interpolations aare substituted:
+                       %(local)s  %(peer)s  %(rnets)s   %(ifname)s
           on server    <vaddr>    <vrelay>  <vnetwork>  <ifname_server>
           on client    <client>   <vaddr>   <vroutes>   <ifname_client>
+     Plus %(mtu)s (and %% to indicate a literal %).
      ["userv root ipif %(local)s,%(peer)s,%(mtu)s,slip %(rnets)s"]
 
      On server: applies to all clients; not looked up in
@@ -126,6 +131,7 @@ Ordinary settings, used by both, not client-specific:
 
   vaddr
      Address of server's virtual interface.
+     [first host entry in <vnetwork>, so 172.24.230.193]
 
   vrelay
      Virtual point-to-point address used for tunnel routing
@@ -139,7 +145,8 @@ Ordinary settings, used by both, not client-specific:
      On client: used only to construct default url.
 
   mtu
-     Must match exactly.  (UNCHECKED) [1500 bytes]
+     Of virtual interface.  Must match exactly at each end.
+     (UNCHECKED) [1500 bytes]
 
   ifname_server
      Virtual interface name on the server.  [shippo%d]