Minor fixes to "zap" functionality, and documentation

[freeradius.git] / man / man1 / radwho.1

diff --git a/man/man1/radwho.1 b/man/man1/radwho.1
index 8e26c7c..d1a4e08 100644 (file)
--- a/man/man1/radwho.1
+++ b/man/man1/radwho.1
@@ -1,4 +1,4 @@
-.TH RADWHO 1 "23 February 2001" "" "FreeRADIUS Daemon"
+.TH RADWHO 1 "7 April 2005" "" "FreeRADIUS Daemon"
 .SH NAME
 radwho - show online users
 .SH SYNOPSIS
@@ -9,10 +9,20 @@ radwho - show online users
 .RB [ \-f ]
 .RB [ \-i ]
 .RB [ \-n ]
+.RB [ \-N
+.IR nas_ip_addres ]
 .RB [ \-p ]
+.RB [ \-P
+.IR nas_port ]
 .RB [ \-r ]
+.RB [ \-R ]
 .RB [ \-s ]
 .RB [ \-S ]
+.RB [ \-u
+.IR user ]
+.RB [ \-U
+.IR user ]
+.RB [ \-Z ]
 .SH DESCRIPTION
 The FreeRADIUS server can be configured to maintain an active session
 database in a file called \fIradutmp\fP. This utility shows the
@@ -31,26 +41,58 @@ Shows the session ID instead of the full name.
 .IP \-n
 Normally radwho looks up the username in the systems password file,
 and shows the full username as well. The \fB-n\fP flags prevents this.
+.IP \-N\ \fInas_ip_address\fP
+Show only those entries which match the given NAS IP address.
 .IP \-p
 Adds an extra column for the port type - I for ISDN, A for Analog.
+.IP \-P\ \fInas_port\fP
+Show only those entries which match the given NAS port.
 .IP \-r
 Outputs all data in \fIraw\fP format - no headers, no formatting,
-fields are comma-seperated.
+fields are comma-separated.
+.IP \-R
+Output all data in RADIUS attribute format.  All fields are printed.
 .IP \-s
 Show full name.
 .IP \-S
 Hide shell users. Doesn't show the entries for users that do not
 have a SLIP or PPP session.
+.IP \-u\ \fIuser\fP
+Show only those entries which match the given username (case insensitive).
+.IP \-U\ \fIuser\fP
+Show only those entries which match the given username (case sensitive).
+.IP \-Z
+When combined with \fI-R\fP, prints out the contents of an
+Accounting-Request packet which can be passed to \fIradclient\fP, in
+order to "zap" that users session from \fIradutmp\fP.
+.PP
+For example,
+.RS
+.sp
+.nf
+.ne 3
+$ radwho -ZRN 10.0.0.1 | radclient -f - radius.example.net acct testing123
+.fi
+.sp
+.RE
+will result in all an Accounting-Request packet being sent to the
+RADIUS server, which tells the server that the NAS rebooted.  i.e. It
+"zaps" all of the users on that NAS.
 
-.SH SEE ALSO
-radiusd(8).
-.SH AUTHOR
-Miquel van Smoorenburg, miquels@cistron.nl.
+To "zap" one user, specifiy NAS, username, and NAS port:
+.RS
+.sp
+.nf
+.ne 3
+$ radwho -ZRN 10.0.0.1 -u user -P 10 | radclient -f - radius.example.net acct testing123
+.fi
+.sp
+.RE
+Other combinations are also possible.
 
 .SH SEE ALSO
 radiusd(8),
-radiusd.conf(5),
-wtmp(5),
-last(1).
+radclient(1),
+radiusd.conf(5).
 .SH AUTHOR
 Miquel van Smoorenburg, miquels@cistron.nl.