radsecproxy-1.6.5.

[libradsec.git] / radsecproxy.1

diff --git a/radsecproxy.1 b/radsecproxy.1
index b8a8511..f0cdf46 100644 (file)
--- a/radsecproxy.1
+++ b/radsecproxy.1
@@ -1,10 +1,11 @@
-.TH radsecproxy 1 "14 May 2008"
+.TH radsecproxy 1 "1 Jun 2010"
 
 .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 ] [ -p ] [ -v ]
+.HP 12
+radsecproxy [\-c configfile] [\-d debuglevel] [\-f] [\-i pidfile] [\-p] [\-v]
 .sp
 
 .SH "DESCRIPTION"
@@ -31,8 +32,9 @@ 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
+.B \-f
 .sp
 \fIRun in foreground\fR
 .sp
@@ -40,16 +42,16 @@ By specifying this option, the proxy will run in foreground mode. That
 is, it won't detach. Also all logging will be done to stderr.
 
 .TP
-.B -d <debug level>
+.B \-d <debug level>
 .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
+.B \-p
 .sp
 \fIPretend\fR
 .sp
@@ -60,7 +62,7 @@ may be used to verify configuration files, and can be done while another
 instance is running.
 
 .TP
-.B -v
+.B \-v
 .sp
 \fIPrint version\fR
 .sp
@@ -68,12 +70,39 @@ When this option is specified, the proxy will simply print version
 information and exit.
 
 .TP
-.B -c <config file path>
+.B \-c <config file path>
 .sp
 \fIConfig file path\fR
 .sp
 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