chiark / gitweb /
cleanup: Style improvement to python literals in make-secnet-sites
[secnet.git] / README
diff --git a/README b/README
index 46df88166f13e036bab81ffa7120cb1af972df50..b094e662d40412cb88fbee5ca86c1f2772ee133e 100644 (file)
--- a/README
+++ b/README
@@ -2,7 +2,7 @@ secnet - flexible VPN software
 
 * Copying
 
-secnet is Copyright (C) 1995--2001 Stephen Early <steve@greenend.org.uk>
+secnet is Copyright (C) 1995--2003 Stephen Early <steve@greenend.org.uk>
 It is distributed under the terms of the GNU General Public License,
 version 2 or later.  See the file COPYING for more information.
 
@@ -139,6 +139,9 @@ some keys in the root dictionary.  The main ones are:
   makelist:   turns a dictionary (arg1) into a list of definitions
               (ignoring the keys)
   readfile:   reads a file (arg1) and returns it as a string
+  map:        applies the closure specified as arg1 to each of the
+              remaining elements in the list in turn.  Returns a list
+              made up of the outputs of the closure.
 
 Keys defined by modules are described below, in the module
 documentation.
@@ -196,6 +199,7 @@ Defines:
   udp (closure => comm closure)
 
 udp: dict argument
+  address (string): IP address to listen and send on
   port (integer): UDP port to listen and send on
   buffer (buffer closure): buffer for incoming packets
   authbind (string): optional, path to authbind-helper program
@@ -313,8 +317,8 @@ Defines:
 null-netlink: dict argument
   name (string): name for netlink device, used in log messages
   networks (string list): networks on the host side of the netlink device
-  exclude-remote-networks (string list): networks that may never be claimed
-    by any remote site using this netlink device
+  remote-networks (string list): networks that may be claimed
+    by the remote site using this netlink device
   local-address (string): IP address of host's tunnel interface
   secnet-address (string): IP address of this netlink device
   ptp-address (string): IP address of the other end of a point-to-point link
@@ -332,7 +336,7 @@ a netlink closure:
   options (string list):
     allow-route: allow packets coming from this tunnel to be routed to
       other tunnels as well as the host (used for mobile devices like laptops)
-    soft-route: remove these routes from the host's routing table when
+    soft: remove these routes from the host's routing table when
       the tunnel link quality is zero
   mtu (integer): default MTU over this link; may be updated by tunnel code