chiark / gitweb /
Import release 0.1.7
[secnet.git] / README
diff --git a/README b/README
index 957fe0658a9cee7a63ce3e3cfe0f31ff0989a7f6..a21a2e7797e63bf36f9f258ce28889f3aaa7a204 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:
@@ -287,6 +293,9 @@ null-netlink: dict argument
   secnet-address (string): IP address of this netlink device
   mtu (integer): MTU of host's tunnel interface
 
+Netlink will dump its current routing table to the system/log on
+receipt of SIGUSR1.
+
 ** slip
 
 Defines: