Fix display issues. Patch from Stephen Gran

[freeradius.git] / man / man5 / rlm_files.5

diff --git a/man/man5/rlm_files.5 b/man/man5/rlm_files.5
index 70d5cb5..0366394 100644 (file)
--- a/man/man5/rlm_files.5
+++ b/man/man5/rlm_files.5
@@ -1,3 +1,15 @@
+.\"     # DS - begin display
+.de DS
+.RS
+.nf
+.sp
+..
+.\"     # DE - end display
+.de DE
+.fi
+.RE
+.sp
+..
 .TH rlm_files 5 "5 February 2004" "" "FreeRADIUS Module"
 .SH NAME
 rlm_files \- FreeRADIUS Module
@@ -21,6 +33,24 @@ pre_proxy stage of this module.
 This option allows FreeRADIUS to parse an old style Cistron syntax.
 The default is 'no'.  If you need to parse an old style Cistron
 file, set this option to 'cistron'.
+.IP key
+This option lets you set the attribute to use as a key to find
+entries.  The default is "%{Stripped-User-Name:-%{User-Name}}".  Note
+that the key MUST supply real data.  Dynamic attributes like "Group"
+will not work, because the "Group" attribute can only be used as a
+comparison, to see if a user is in a Unix group.  It will not return
+the name of the Unix group that a user is in.
+.PP
+If you want to use groups as a key, see the \fIrlm_passed\fP, which
+will create a real attribute that contains the group name.
+.PP
+This configuration entry enables you to have configurations that
+perform per-group checks, and return per-group attributes, where the
+group membership is dynamically defined by a previous module.  It also
+lets you do things like key off of attributes in the reply, and
+express policies like like "when I send replies containing attribute
+FOO with value BAR, do more checks, and maybe send additional
+attributes".
 .SH CONFIGURATION
 .PP
 .DS
@@ -37,6 +67,8 @@ modules {
 .br
     compat = no
 .br
+    key = %{Stripped-User-Name:-%{User-Name}}
+.br
   }
 .br
   ... stuff here ...