README.config: fix to match Python implementation

[hippotat.git] / README.config

diff --git a/README.config b/README.config
index 842573cd6a153ca9d9f1e1f7041a2c066e8ea468..f6054da5b3ef2a78c123c181dae3ecc7f9eb738f 100644 (file)
--- a/README.config
+++ b/README.config
@@ -2,15 +2,39 @@
 
 Sections
 
-  [<servername> - <client>]
+  [<servername> <client>]
   [<client>]
   [<servername>]      often [SERVER]
   [COMMON]
+  [DEFAULT]
 
 Keys are looked up in that order, unless otherwise specified.
 <client> is the client's virtual address.
 <servername> must be a valid DNS hostname and not look like an address.
 
+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.)
+
+
 Exceptional settings:
 
   server