New build path variable
[freeradius.git] / man / man5 / rlm_always.5
1 .\"     # DS - begin display
2 .de DS
3 .RS
4 .nf
5 .sp
6 ..
7 .\"     # DE - end display
8 .de DE
9 .fi
10 .RE
11 .sp
12 ..
13 .TH rlm_always 5 "3 February 2004" "" "FreeRADIUS Module"
14 .SH NAME
15 rlm_always \- FreeRADIUS Module
16 .SH DESCRIPTION
17 The \fIrlm_always\fP module provides a simple way to "always" return a
18 value during the processing of a configuration section.  The module
19 does nothing other than return a configured value.
20 .PP
21 .PP
22 The main configuration item to be aware of is:
23 .IP rcode
24 This module will always return with the rcode specified.  The
25 default, if none specified is: fail (RLM_MODULE_FAIL).
26 .PP
27 The valid options are:
28 .IP reject
29 RLM_MODULE_REJECT
30 .IP fail
31 RLM_MODULE_FAIL
32 .IP ok
33 RLM_MODULE_OK
34 .IP handled
35 RLM_MODULE_HANDLED
36 .IP invalid
37 RLM_MODULE_INVALID
38 .IP userlock
39 RLM_MODULE_USERLOCK
40 .IP notfound
41 RLM_MODULE_NOTFOUND
42 .IP noop
43 RLM_MODULE_NOOP
44 .IP updated
45 RLM_MODULE_UPDATED
46 .SH CONFIGURATION
47 .DS
48 modules {
49   ...
50 .br
51   always ok {
52 .br
53         rcode = ok
54 .br
55   }
56 .br
57   ...
58 .br
59 }
60 .br
61  ...
62 .br
63 authorize {
64   ...
65 .br
66   redundant {
67      sql1          # try to find the user in sql1
68 .br
69      sql2          # try to find the user in sql2
70 .br
71      ok            # if still not found, it's OK.
72 .br
73   }
74   ...
75 .br
76 }
77 .DE
78 .PP
79 .SH SECTIONS
80 .BR authorization,
81 .BR authentication,
82 .BR postauthentication,
83 .BR preaccounting,
84 .BR accounting,
85 .BR preproxy,
86 .BR postproxy
87 .PP
88 .SH FILES
89 .I /etc/raddb/radiusd.conf
90 .PP
91 .SH "SEE ALSO"
92 .BR radiusd (8),
93 .BR radiusd.conf (5)
94 .SH AUTHOR
95 Chris Parker, cparker@segv.org