release of 1.1-beta. merging from trunk to 1.1. updating readme, changelog etc for...
[libradsec.git] / README
diff --git a/README b/README
index 788ee5a..8b8ae78 100644 (file)
--- a/README
+++ b/README
@@ -1,31 +1,40 @@
-This is a beta version of a generic RADIUS proxy that can support
-various RADIUS clients over UDP or TLS (RadSec).
+This is a revision from the radsecproxy 1.2 devel branch.
+
+radsecproxy is a generic RADIUS proxy that can support various
+RADIUS clients over UDP or TLS (RadSec).
 
 It should build on most Linux and BSD platforms by simply typing
-"make". You may also try to use autoconf if you like.
+"make". You may also try to use autoconf, but this is currently
+unsupported.
 
-To use it you need to create a config file called
-"radsecproxy.conf" which must be in /etc/radsecproxy (unless
-you alter it in the header file), the current directory, or
-you can specify the location with the "-c" command line
-option (see below). See the enclosed example file for further
-instructions.
+To use it 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
 
-There are three options that may be specified on the command line.
+There are five options that 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 or 4 where 4 is the most
 detailed; and "-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.
+log to syslog. "-v" just prints version information and exits, while
+"-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.
+
+Thanks to Stefan Winter and Andreas Solberg for talking me into
+doing this, and the funding from GEANT2. Stefan as well as Kolbjørn
+Barmen, Ralf Paffrath and Maja Wolniewicz have helped with early
+testing of the code.
 
-Thanks to Stefan Winter and Andreas Solberg for making me do this,
-and the funding from GEANT2. Stefan as well as Kolbjørn Barmen
-and Maja Wolniewicz have helped with early testing of the code.
 All of the above plus Milan Sova have provided good feedback on
 several implementation choices. Finally thanks to Hans Zandbelt
 for providing the autoconf stuff. I may have forgotten someone,
 let me know if you feel left out.
 
-For more information, feedback etc. contact <venaas@uninett.no>.
+For more information, feedback etc. please see the information
+at http://software.uninett.no/radsecproxy/
 
-Stig Venaas, 2007.05.24
+Stig Venaas <venaas@uninett.no> -- 2008.05.14