packaging: fix init script user name (again)

[hippotat.git] / README.config

diff --git a/README.config b/README.config
index cc921c1ceef71ce188b834957eaafc62f715128f..842573cd6a153ca9d9f1e1f7041a2c066e8ea468 100644 (file)
--- a/README.config
+++ b/README.config
@@ -2,43 +2,14 @@
 
 Sections
 
-  [<servername> <client>]
+  [<servername> - <client>]
   [<client>]
   [<servername>]      often [SERVER]
   [COMMON]
 
 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.
-
-
-Both client and server read the files
-  /etc/hippotat/main.cfg
-  /etc/hippotat/config.d/*
-  /etc/hippotat/secrets.d/*
-and in each case if it's a directory, all contained files whose
-names consists of only ascii alphanumerics plus '-' and '_'.
-
-The ini file format sections from these files are all unioned.
-Later files (in the list above, or alphabetically later) can
-override settings from earlier ones.
-
-Note that although it is conventional for information for a particular
-server or client to be in a file named after that endpoint, there is
-no semantic link: all the files are always read and the appropriate
-section from each is applied to every endpoint.
-
-(If main.cfg does not exist, master.cfg will be tried for backward
-compatibility reasons.)
-
+<servername> must be a valid DNS hostname and not look like an address.
 
 Exceptional settings:
 
@@ -70,14 +41,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 interpolations aare substituted:
-                       %{local}   %{peer}   %{rnets}    %{ifname}
+     The following additional interpolations aare substituted:
+                       %(local)s  %(peer)s  %(rnet)s    %(ifname)s
           on server    <vaddr>    <vrelay>  <vnetwork>  <ifname_server>
           on client    <client>   <vaddr>   <vroutes>   <ifname_client>
-     Plus %{mtu} and %% to indicate a literal %.
-     (For compatibility with older hippotat, %(var)s is supported too
-     but this is deprecated since the extra `s` is confusing.)
-     ["userv root ipif %{local},%{peer},%{mtu},slip '%{rnets}'"]
+     ["userv root ipif %(local)s,%(peer)s,%(mtu)s,slip %(rnets)s"]
 
      On server: applies to all clients; not looked up in
       client-specific sections.
@@ -133,7 +101,6 @@ 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
@@ -147,8 +114,7 @@ Ordinary settings, used by both, not client-specific:
      On client: used only to construct default url.
 
   mtu
-     Of virtual interface.  Must match exactly at each end.
-     (UNCHECKED) [1500 bytes]
+     Must match exactly.  (UNCHECKED) [1500 bytes]
 
   ifname_server
      Virtual interface name on the server.  [shippo%d]