X-Git-Url: http://www.project-moonshot.org/gitweb/?a=blobdiff_plain;f=README;h=fc46ec146de39493ae87bf59a576528070d8607c;hb=8c8d6467725823150483bf6e09f2d2caaee9a4d3;hp=ee6523353562f6c6a607eae861e044e41084b8c7;hpb=5cb1bcd04d40925247aee2538940b8b6a2be0f4f;p=libradsec.git

diff --git a/README b/README
index ee65233..fc46ec1 100644
--- a/README
+++ b/README
@@ -1,16 +1,38 @@
-This is the very first experimental version of a generic RADIUS proxy
-that can support various RADIUS clients over UDP or TLS (RadSec).
+This is unreleasead radsecproxy 1.6-rc0.
 
-It should build on most Linux platforms by simply typing "make".
-To use it you need to create three config files. These are the
-main config file "radsecproxy.conf" and server and client files
-"servers.conf" and "clients.conf". See the enclosed example files
-for further instructions.
+radsecproxy is a generic RADIUS proxy that supports both UDP and TLS
+(RadSec) RADIUS transports.  There is also experimental support for
+TCP and DTLS.
 
-The config files must be in either "/etc/radsecproxy" or the
-proxy's current work directory. You may alter the path near
-the top of radsecproxy.h if necessary.
+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.
 
-For more information, feedback etc. contact <venaas@uninett.no>.
+Known build issues:
+- Older BSD's (like NetBSD 4.x) need newer OpenSSL in order to support
+  DTLS.  Workaround: ./configure --disable-dtls.
 
-Stig Venaas, 2007.01.08
+- 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
+instructions, please see the enclosed example file and the
+documentation at
+http://software.uninett.no/radsecproxy/?page=documentation
+
+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
+     serious work.  This is useful for validating config files.