config: Substitutions prefer %{...} to %(...)s, document, etc.

[hippotat.git] / README.config

diff --git a/README.config b/README.config
index 4a9affad30be3bd950a030065a8288f282c3d066..cc921c1ceef71ce188b834957eaafc62f715128f 100644 (file)
--- a/README.config
+++ b/README.config
@@ -70,11 +70,14 @@ 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}   %{peer}   %{rnets}    %{ifname}
           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"]
+     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}'"]
 
      On server: applies to all clients; not looked up in
       client-specific sections.