chiark / gitweb /
changelog: start 0.6.8
[secnet.git] / README.make-secnet-sites
index aa4b216d2f580f96f7dc8047bbc0bce7bc69b6cd..4fc812ca90a6abcba2c18b38fe89eb3556c468b7 100644 (file)
@@ -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
@@ -308,3 +314,12 @@ OUTPUT STRUCTURE
        named `netlink' used to set the `link' key in each site
        definition.  Usually, this will be constructed by a partial
        application of the built-in `userv-ipif' or `tun' closures.
+
+
+
+
+-- 
+This file is part of secnet.
+See LICENCE and this file CREDITS for full list of copyright holders.
+SPDX-License-Identifier: GPL-3.0-or-later
+There is NO WARRANTY.