Add an error code.

[radsecproxy.git] / radsecproxy.1

diff --git a/radsecproxy.1 b/radsecproxy.1
index 83bbc62..f1790e2 100644 (file)
--- a/radsecproxy.1
+++ b/radsecproxy.1
@@ -1,10 +1,11 @@
-.TH radsecproxy 1 "7 June 2007"
+.TH radsecproxy 1 "12 March 2009"
 
 .SH "NAME"
 radsecproxy - a generic RADIUS proxy that provides both RADIUS UDP and TCP/TLS (RadSec) transport.
 
 .SH "SYNOPSIS"
-radsecproxy [ -c configfile ] [ -d debuglevel ] [ -f ] [ -v ]
+.HP 12
+radsecproxy [-c configfile] [-d debuglevel] [-f] [-i pidfile] [-p] [-v]
 .sp
 
 .SH "DESCRIPTION"
@@ -23,14 +24,15 @@ RADIUS server or client, and configure the existing client/server to
 talk to localhost (the proxy) rather than other clients and servers
 directly.
 .sp
-There may however be other situations where a RADIUS proxy might be
+There are however other situations where a RADIUS proxy might be
 useful. Some people deploy RADIUS topologies where they want to
 route RADIUS messages to the right server. The nodes that do purely
 routing could be using a proxy. Some people may also wish to deploy
-a proxy on a firewall boundary. Since the proxy \fBsupports both IPv4
+a proxy on a site boundary. Since the proxy \fBsupports both IPv4
 and IPv6\fR, it could also be used to allow communication in cases
 where some RADIUS nodes use only IPv4 and some only IPv6.
 
+.SH "OPTIONS"
 .TP
 .B -f
 .sp
@@ -44,9 +46,20 @@ is, it won't detach. Also all logging will be done to stderr.
 .sp
 \fIDebug level\fR
 .sp
-This specifies the debug level. It must be set to 1, 2, 3 or 4, where 1
-logs only serious errors, and 4 logs everything. The default is 3 which
-logs errors, warnings and some informational messages.
+This specifies the debug level. It must be set to 1, 2, 3, 4 or 5, where
+1 logs only serious errors, and 5 logs everything. The default is 2 which
+logs errors, warnings and a few informational messages.
+
+.TP
+.B -p
+.sp
+\fIPretend\fR
+.sp
+The proxy reads configuration files and performs initialisation as
+usual, but exits prior to creating any sockets. It will return different
+exit codes depending on whether the configuration files are okay. This
+may be used to verify configuration files, and can be done while another
+instance is running.
 
 .TP
 .B -v
@@ -64,5 +77,32 @@ information and exit.
 This option allows you to specify which config file to use. This is useful
 if you want to use a config file that is not in any of the default locations.
 
+.TP
+.B -i <pid file path>
+.sp
+\fIPID file path\fR
+.sp
+This option tells the proxy to create a PID file with the specified path.
+
+.SH "SIGNALS"
+The proxy generally exits on all signals. The exceptions are listed below.
+
+.TP
+.B SIGHUP
+.sp
+When logging to a file, this signal forces a reopen of the log file.
+
+.TP
+.B SIGPIPE
+.sp
+This signal is ignored.
+
+.SH "FILES"
+.TP
+.B /etc/radsecproxy.conf
+.sp
+The default configuration file.
+
 .SH "SEE ALSO"
-radsecproxy.conf(5), RadSec draft paper.
+radsecproxy.conf(5), RadSec internet draft
+http://tools.ietf.org/html/draft-ietf-radext-radsec