tidy up a load of lintian warnings
[freeradius.git] / man / man8 / radsqlrelay.8
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 RADSQLRELAY 8 "19 June 2005" "" "FreeRADIUS helper program"
14
15 .SH NAME
16 radsqlrelay - relay SQL queries to a central database server
17
18 .SH SYNOPSIS
19 .B radsqlrelay
20 .RB [ \-? ]
21 .RB [ \-d
22 .IR sql_driver ]
23 .RB [ \-b
24 .IR database ]
25 .RB [ \-f
26 .IR file ]
27 .RB [ \-h
28 .IR host ]
29 .RB [ \-u
30 .IR user ]
31 .RB [ \-P
32 .IR port ]
33 .RB [ \-p
34 .IR password ]
35 .RB [ \-1 ]
36 .RB [ \-x ]
37 \fIfile_path\fP
38
39 .SH DESCRIPTION
40 \fBradsqlrelay\fP tails a SQL \fIlogfile\fP and forwards the queries
41 to a database server. Used to replicate accounting records to one
42 (central) database, even if the database has extended downtime.
43 .PP
44 The SQL logfile is created by the \fBrlm_sql_log\fP module. The module
45 must be configured in the \fBradiusd\fP server before you can use
46 \fBradsqlrelay\fP.
47
48 .SH OPTIONS
49 .IP "\-?"
50 Print usage help information.
51 .IP "\-d \fIsql_driver\fP"
52 Driver to use: mysql, pg, oracle.
53 .IP "\-b \fIdatabase\fP"
54 Name of the database to use.
55 .IP "\-f \fIfile\fP"
56 Read password from file, instead of command line.
57 .IP "\-h \fIhost\fP"
58 Connect to host.
59 .IP "\-u \fIuser\fP"
60 User for login.
61 .IP "\-P \fIport\fP"
62 Port number to use for connection.
63 .IP "\-p \fIpassword\fP"
64 Password to use when connecting to server.
65 .IP "\-1"
66 One-shot mode: push the file to database and exit.
67 .IP "\-x"
68 Turn on debugging.
69 .IP "file_path"
70 The pathname of the SQL logfile to use.
71
72 .SH NOTES
73 .SS Oracle driver
74 The command "radsqlrelay \-d oracle \-b db.domain.tld sql-relay" reads the
75 database description stored in $TNS_ADMIN/tnsnames.ora:
76 .PP
77 .DS
78 db.domain.tld =
79   (DESCRIPTION =
80     (ADDRESS_LIST =
81       (ADDRESS = (PROTOCOL = TCP)(HOST = db.domain.tld)(PORT = 1521))
82     )
83     (CONNECT_DATA =
84       (SERVICE_NAME = <DB SID>)
85     )
86   )
87 .DE
88
89 .SH SEE ALSO
90 .BR rlm_sql_log (5)
91
92 .SH AUTHOR
93 Nicolas Baradakis <nicolas.baradakis@cegetel.net>