changelog: document changes since 0.6.0

[secnet.git] / README.make-secnet-sites

diff --git a/README.make-secnet-sites b/README.make-secnet-sites
index 21d42fa809834000a2850ea7cd9a48dda922f473..cbf304e80eb3feb129ce72df6c59eefe6c1ef1c6 100644 (file)
--- a/README.make-secnet-sites
+++ b/README.make-secnet-sites
@@ -1,16 +1,22 @@
 USAGE
 
-       make-secnet-sites [-P PREFIX] [IN [OUT]]
-       make-secnet-sites -u HEADER GRPDIR SITESFILE GROUP
+       make-secnet-sites [-P PREFIX] [--conf] [IN [OUTCONF]]
+       make-secnet-sites --filter [IN [OUT]]
+       make-secnet-sites -u|--userv HEADER GRPDIR SITESFILE GROUP
 
        The `-P' option sets the PREFIX string, mentioned below in
        `OUTPUT STRUCTURE'; the default is empty.
 
-       In the former mode, `make-secnet-sites' reads a single input
+       In --conf mode, `make-secnet-sites' reads a single input
        file from IN (defaulting to standard input), and writes a Secnet
-       configuration fragment to OUT (defaulting to standard output).
+       configuration fragment to OUTCONF (defaulting to standard output).
 
-       In the latter, `make-secnet-sites' expects to have been invoked
+       In --filter mode, `make-secnet-sites' reads a single input
+       file from IN (defaulting to standard input), and writes a
+       version of that sites file to OUT (defaulting to standard
+       output).  The output is filtered according to --output-version.
+
+       In --userv mode, `make-secnet-sites' expects to have been invoked
        via GNU Userv.  It verifies that GROUP is listed in the
        `USERV_GROUP' environment variable.  It then processes the
        HEADER input, which should say `end-defintions' somewhere, to
@@ -55,6 +61,21 @@ OPTIONS
                refer to keys in PUBKEYS; also, the generated secnet
                configuration enables live peer public update.
 
+       --pubkeys-single
+
+               Specifies that one public key per site is to be
+               written directly into the sites.conf output.  If
+               --output-version=1, this is the rsa1 key 0000000000.
+               Otherwise it is an error if there are multiple public
+               keys defined for any site, in the input.
+               --pubkeys-single is the default.
+
+       --pubkeys-elide
+
+               In the sites.conf output, just write the peer-keys
+               entry referring to keys in PUBKEYS.  But do not write
+               public keys anywhere.
+
        --pubkeys-dir PUBKEYS
 
                Specifies the live pubkeys area pathname.