X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=secnet.git;a=blobdiff_plain;f=README;h=564b216ce6d57a9a221d9e33f14837677852c58d;hp=3c1df8ba3011160329f0f421f7552ab8baae7ed1;hb=2b4b615531dd73456bcc71670d8744878a1684bf;hpb=ff05a229397c75142725f45cad191ce4a00625ce diff --git a/README b/README index 3c1df8b..564b216 100644 --- a/README +++ b/README @@ -2,7 +2,7 @@ secnet - flexible VPN software * Copying -secnet is Copyright (C) 1995--2001 Stephen Early +secnet is Copyright (C) 1995--2003 Stephen Early It is distributed under the terms of the GNU General Public License, version 2 or later. See the file COPYING for more information. @@ -121,12 +121,6 @@ f is a dictionary: Note that f/g/e is NOT 4. -In a future version of secnet it will also be permissible to list -other dictionaries before a dictionary definition, -eg. {definitions}. These will be searched in -order for keys, before the lexical parent. (This is not yet -implemented) - Elements that are lists are inserted into lists in definitions, not referenced by them (i.e. you can't have lists of lists). @@ -140,11 +134,14 @@ closure { definitions } is short for closure({definitions}). The main body of secnet, and all the additional modules, predefine some keys in the root dictionary. The main ones are: - yes, true, True, TRUE: the boolean value True - no, false, False, FALSE: the boolean value False + yes, true, True, TRUE, on: the boolean value True + no, false, False, FALSE, off: the boolean value False 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. @@ -202,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