radsecproxy-1.6.
[radsecproxy.git] / README
diff --git a/README b/README
index 6646a03..3640993 100644 (file)
--- a/README
+++ b/README
@@ -1,14 +1,22 @@
-This is radsecproxy 1.4.1 from June 11 2010.
+This is radsecproxy 1.6 from April 27 2012.
 
-radsecproxy is a generic RADIUS proxy that can support various RADIUS
-clients over UDP or TLS (RadSec).
+radsecproxy is a generic RADIUS proxy that supports both UDP and TLS
+(RadSec) RADIUS transports.  There is also experimental support for
+TCP and DTLS.
 
-It should build on most Linux and BSD platforms by simply typing
+It should build on most Unix and OSX platforms by simply typing
 "./configure && make".  It is possible to specify which RADIUS
 transport the build should support.  Without any special options to
 configure, all transports supported by the system will be enabled.
 See the output from "configure --help" for how to change this.
 
+Known build issues:
+- Older BSD's (like NetBSD 4.x) need newer OpenSSL in order to support
+  DTLS.  Workaround: ./configure --disable-dtls.
+
+- FreeBSD 6.x need newer OpenSSL to build at all.  OpenSSL 1.0.0c from
+  ports is fine f.ex., configure radsecproxy with `--with-ssl=/usr/local'.
+
 To use radsecproxy you need to create a config file which normally is
 called "/etc/radsecproxy.conf".  You can also specify the location
 with the "-c" command line option (see below).  For further
@@ -16,13 +24,14 @@ instructions, please see the enclosed example file and the
 documentation at
 http://software.uninett.no/radsecproxy/?page=documentation
 
-There are five options that may be specified on the command line:
+The following options may be specified on the command line:
 "-c configfile" to specify a non-default config file path.
 "-d loglevel" to set a loglevel of 1, 2, 3, 4 and 5 where 5 is the
               most detailed.
 "-f" to run the proxy in the foreground with logging to stderr.
      Without "-f" the default is to detach as a daemon and log to
      syslog.
+"-i pidfile" to name a file to which the PID is written.
 "-v" just prints version information and exits.
 "-p" (pretend) makes the proxy go through the configuration files as
      normal, but stops before creating any sockets or doing any