Import release 0.1.8

[secnet] / README

diff --git a/README b/README
index 957fe06..79b5447 100644 (file)
--- a/README
+++ b/README
@@ -167,12 +167,11 @@ udp: dict argument
   buffer (buffer closure): buffer for incoming packets
   authbind (string): optional, path to authbind-helper program
 
-** util
+** log
 
 Defines:
   logfile (closure => log closure)
   syslog (closure => log closure)
-  sysbuffer (closure => buffer closure)
 
 logfile: dict argument
   filename (string): where to log to
@@ -191,6 +190,8 @@ logfile: dict argument
     { "verbose", M_INFO|M_NOTICE|M_WARNING|M_ERROR|M_SECURITY|M_FATAL },
     { "quiet", M_FATAL }
 
+logfile will close and reopen its file upon receipt of SIGHUP.
+
 syslog: dict argument
   ident (string): include this string in every log message
   facility (string): facility to log as
@@ -213,6 +214,11 @@ syslog: dict argument
     { "user", LOG_USER },
     { "uucp", LOG_UUCP }
 
+** util
+
+Defines:
+  sysbuffer (closure => buffer closure)
+
 sysbuffer: integer[,dict]
   arg1: buffer length
   arg2: options:
@@ -285,8 +291,16 @@ null-netlink: dict argument
     by any 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
   mtu (integer): MTU of host's tunnel interface
 
+Only one of secnet-address or ptp-address may be specified. If
+point-to-point mode is in use then precisely one tunnel must register
+with the netlink device.
+
+Netlink will dump its current routing table to the system/log on
+receipt of SIGUSR1.
+
 ** slip
 
 Defines:
@@ -322,6 +336,9 @@ tun-old: dict argument
   route-path (string): optional, path to route command
  plus generic netlink options, as for 'null-netlink'
 
+ I recommend you don't specify the 'interface' option unless you're
+ doing something that requires the interface name to be constant.
+
 ** rsa
 
 Defines:
@@ -355,3 +372,21 @@ Defines:
 
 Defines:
   sha1 (hash closure)
+
+** conffile
+
+Defines:
+  makelist (dictionary => list of definitions)
+  readfile (string => string)
+  map (closure,list => list)
+
+makelist: dictionary
+  returns a list consisting of the definitions in the dictionary. The keys
+  are discarded.
+
+readfile: string
+  reads the named file and returns its contents as a string
+
+map:
+  applies the closure specified as arg1 to each of the elements in the list.
+  Returns a list made up of the outputs of the closure.