new config definition

[hippotat.git] / README.config

diff --git a/README.config b/README.config
index 4c0a43ea752f6918ac007c82cd8e0c99a4042473..fc2bbf808a1e4e955835c872df95499e21ef7129 100644 (file)
--- a/README.config
+++ b/README.config
@@ -3,31 +3,39 @@
 Sections
 
   [<servername> - <clientaddr>]
-  [<clientaddr>]
-  [<servername>]   usually [SERVER]
+  [<client>]
+  [<servername>]      usually [SERVER]
   [DEFAULT]
 
-Keys are looked up in that order.  <servername> must not
-be a valid IPv4 or IPv6 address.
+Keys are looked up in that order.
+<client> is the client's virtual address.
+<servername> must not look like an address.
 
 Exceptional settings:
 
   server
-
      Specifies <servername>.
      Is looked up in [SERVER] and [DEFAULT] only.
      If not specified there, it is SERVER.
 
+     Used by server to select the appropriate parts of the
+     rest of the configuration.  Ignored by the client.
+
   password
+     Looked up in the usual way, but used by client and server to
+     determine which possible peerings to try to set up, and which to
+     ignore.
 
-     Looked up in the usual way, but used by client to
-     determine its own <clientaddr>s.
+     We define the sets of putative clients and servers, as follows:
+     all those, for which there is any section (even an empty one)
+     whose name is based on <client> or <servername> (as applicable).
 
-     The client will create a local interface, and try to communicate
-     with the server, for Each (<servername>,<clientaddr>) pair for
-     which the config search yields a password.
+     The server queue packets for, and accept requests from, each
+     putative client for which the config search yields a password.
 
-     On the server: clients with no password are ignored.
+     Each client will create a local interface, and try to communicate
+     with the server, for each possible pair (putative server,
+     putative client) for which the config search yields a password.
 
 Capped settings: