Import release 0.1.9

[secnet.git] / README

diff --git a/README b/README
index a21a2e7797e63bf36f9f258ce28889f3aaa7a204..255892d9eebb32cf9d336e2c57d3bfc8c1f12852 100644 (file)
--- a/README
+++ b/README
@@ -1,5 +1,20 @@
 secnet - flexible VPN software
 
+* Copying
+
+secnet is Copyright (C) 1995--2001 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.
+
+The portable snprintf implementation in snprintf.c is Copyright (C)
+1999 Mark Martinec <mark.martinec@ijs.si> and is distributed under the
+terms of the Frontier Artistic License.  You can find the standard
+version of snprintf.c at http://www.ijs.si/software/snprintf/
+
+The IP address handling library in ipaddr.py is Copyright (C)
+1996--2000 Cendio Systems AB, and is distributed under the terms of
+the GPL.
+
 * Introduction
 
 secnet allows large virtual private networks to be constructed
@@ -291,8 +306,13 @@ 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.
 
@@ -331,6 +351,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:
@@ -364,3 +387,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.