X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ian/git?p=hippotat.git;a=blobdiff_plain;f=README.config;h=2b58512eaaedad3677c9c24934a232011d3440a6;hp=9c0e4fefed935e22779154b27330abf33af43322;hb=f963d7a3638b5e3bd16ac62d037034185e6ab8a2;hpb=c66915fd92d23d42694111e7910444626d04f49c

diff --git a/README.config b/README.config
index 9c0e4fe..2b58512 100644
--- a/README.config
+++ b/README.config
@@ -5,7 +5,7 @@ Sections
   [<servername> - <client>]
   [<client>]
   [<servername>]      often [SERVER]
-  [DEFAULT]
+  [COMMON]
 
 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>.
-     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
@@ -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
@@ -54,7 +54,7 @@ Exceptional settings:
 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)
@@ -116,6 +116,12 @@ Ordinary settings, used by both, not client-specific:
   mtu
      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:
 
   http_timeout_grace