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

[hippotat.git] / README.config

diff --git a/README.config b/README.config
index cde9e130d248f5e183338d3e76960ca4839e16f8..cc921c1ceef71ce188b834957eaafc62f715128f 100644 (file)
--- a/README.config
+++ b/README.config
@@ -71,11 +71,13 @@ 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 interpolations aare substituted:
-                       %(local)s  %(peer)s  %(rnets)s   %(ifname)s
+                       %{local}   %{peer}   %{rnets}    %{ifname}
           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'"]
+     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.