7064f6af6cd2826dd3dec601b81c3dfe7e13660a
[freeradius.git] / man / man5 / dictionary.5
1 .TH dictionary 5 "02 May 2000"
2 .SH NAME
3 dictionary \- RADIUS dictionary file
4 .SH DESCRIPTION
5 The \fIdictionary\fP file resides in the radius database directory,
6 by default \fI/etc/raddb\fP. It contains a list of RADIUS attributes
7 and values, which the server uses to map between descriptive names and
8 on-the-wire data.
9 Every line starting with a hash sign
10 .RB (' # ')
11 is treated as comment and ignored.
12 .PP
13 Each line of the file can contain one of the following strings
14 .TP 0.5i
15 .B ATTRIBUTE name  number  type
16 Define a name to RADIUS attribute number mapping.  The \fIname\fP
17 field can be any non-space text.  The \fInumber\fP must contain
18 an ASCII number for that name, as given in \fIRFC2138\fP. The
19 \fItype\fP field can be one of \fIstring\fP, \fIipaddr\fP,
20 \fIinteger\fP, or \fIdate\fP.
21
22 .TP 0.5i
23 .B VALUE attribute-name value-name number
24 Define a value name to value number mapping.  The \fIattribute-name\fP
25 field must be previously defined by an \fIATTRIBUTE\fP entry.  The
26 \fIvalue-name\fP can be any non-space text.  The \fInumber\fP must
27 contain an ASCII number for that name, as given in \fIRFC2138\fP.
28
29 .TP 0.5i
30 .B VENDOR vendor-name number
31 Define a Vendor Specific Attribute encapsulation for \fIvendor-name\fP to
32 \fInumber\fP.
33
34 .TP 0.5i
35 .B $INCLUDE filename
36 Include dictionary entries from the file \fIfilename\fP.  The
37 \fIfilename\fP is taken as relative to the location of the
38 \fIdictionary\fP which is doing the inclusion.
39
40 .PP
41 .SH FILES
42 .I /etc/raddb/dictionary ,
43 .I /etc/raddb/dictionary.*
44 .SH "SEE ALSO"
45 .BR radiusd (8),
46 .BR naslist (5),
47 .BR RFC2138 ,
48 .BR RFC2139