import from HEAD
[freeradius.git] / man / man8 / radrelay.8
1 .TH RADRELAY 1 "09 June 2002" "" "FreeRADIUS Daemon"
2 .SH NAME
3 radrelay -- replicate accounting data to another RADIUS server
4 .SH SYNOPSIS
5 .B radrelay
6 .RB [ \-a
7 .IR accounting_dir ]
8 .RB [ \-d
9 .IR radius_dir ]
10 .RB [ \-f ]
11 .RB [ \-i
12 .IR source_ip ]
13 .RB [ \-n
14 .IR shortname ]
15 .RB [ \-r
16 .IR remote-server[:port] ]
17 .RB [ \-s
18 .IR secret ]
19 .RB [ \-S
20 .IR secret_file ]
21 .RB [ \-x ]
22 \fIdetailfile\fP
23 .SH DESCRIPTION
24 \fBRadrelay\fP reads a file in the \fIdetail\fP file format,
25 reconstructs radius packets from it and sends them to a remote
26 radius server. When end-of-file is reached, the file is truncated.
27 \fBRadrelay\fP then waits for additional data to be written to
28 the file, and starts over again.
29 .PP
30
31 .SH OPTIONS
32
33 .IP "\-a \fIaccounting_directory\fP"
34 The base directory to use to read the detail file from.
35
36 .IP "\-d \fIradius_directory\fP"
37 The base radius (raddb) directory, where the config files live.
38
39 .IP \-f
40 Do \fInot\fP fork and run in the background as a daemon.
41
42 .IP "\-i \fIsource_ip\fP"
43 The source IP address to use for sending radius packets.
44
45 .IP "\-n \fIshortname\fP"
46 The radius configuration files (most probably clients.conf), will be
47 searched for a client section with 'shortname' set to the used argument.
48 Both the server secret and the remote-server address are obtained in
49 this way. Do not use the -r, -s or -S parameters in combination with -n.
50
51 .IP "\-r \fIremote-server\fP"
52 The hostname or IP address of the remote server. Optionally a UDP port
53 can be specified. If no UDP port is specified, it is looked up in
54 \fI/etc/services\fP. The service name looked for is \fBradacct\fP for
55 accounting packets. If a service is not found in \fI/etc/services\fP,
56 1813 is used. The -r parameter can't be used in combination with -n.
57
58 .IP "\-s \fIsecret\fP"
59 Remote server secret.
60
61 .IP "\-S \fIsecret_file\fP"
62 Read remote server secret from file, the file should contain
63 nothing other then the plain-text secret.
64
65 .IP \-x
66 Enable debug mode, -x will activate radrelay internal debugging, -xx will
67 also activate librad debugging.
68
69 .IP "detailfile"
70 The detail file to use, this will be appended to the base accounting
71 directory.
72
73 .SH SEE ALSO
74 radiusd(8),
75 doc/radrelay.
76 .SH AUTHOR
77 Miquel van Smoorenburg, miquels@cistron.nl.