.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "DBIPROXY 1p"
.TH DBIPROXY 1p 2024-03-07 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
dbiproxy \- A proxy server for the DBD::Proxy driver
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&    dbiproxy <options> \-\-localport=<port>
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This tool is just a front end for the DBI::ProxyServer package. All it
does is picking options from the command line and calling
\&\fBDBI::ProxyServer::main()\fR. See DBI::ProxyServer for details.
.PP
Available options include:
.IP \fB\-\-chroot=dir\fR 4
.IX Item "--chroot=dir"
(UNIX only)  After doing a \fBbind()\fR, change root directory to the given
directory by doing a \fBchroot()\fR. This is useful for security, but it
restricts the environment a lot. For example, you need to load DBI
drivers in the config file or you have to create hard links to Unix
sockets, if your drivers are using them. For example, with MySQL, a
config file might contain the following lines:
.Sp
.Vb 9
\&    my $rootdir = \*(Aq/var/dbiproxy\*(Aq;
\&    my $unixsockdir = \*(Aq/tmp\*(Aq;
\&    my $unixsockfile = \*(Aqmysql.sock\*(Aq;
\&    foreach $dir ($rootdir, "$rootdir$unixsockdir") {
\&        mkdir 0755, $dir;
\&    }
\&    link("$unixsockdir/$unixsockfile",
\&         "$rootdir$unixsockdir/$unixsockfile");
\&    require DBD::mysql;
\&
\&    {
\&        \*(Aqchroot\*(Aq => $rootdir,
\&        ...
\&    }
.Ve
.Sp
If you don't know \fBchroot()\fR, think of an FTP server where you can see a
certain directory tree only after logging in. See also the \-\-group and
\&\-\-user options.
.IP \fB\-\-configfile=file\fR 4
.IX Item "--configfile=file"
Config files are assumed to return a single hash ref that overrides the
arguments of the new method. However, command line arguments in turn take
precedence over the config file. See the "CONFIGURATION FILE" section
in the DBI::ProxyServer documentation for details on the config file.
.IP \fB\-\-debug\fR 4
.IX Item "--debug"
Turn debugging mode on. Mainly this asserts that logging messages of
level "debug" are created.
.IP \fB\-\-facility=mode\fR 4
.IX Item "--facility=mode"
(UNIX only) Facility to use for Sys::Syslog. The default is
\&\fBdaemon\fR.
.IP \fB\-\-group=gid\fR 4
.IX Item "--group=gid"
After doing a \fBbind()\fR, change the real and effective GID to the given.
This is useful, if you want your server to bind to a privileged port
(<1024), but don't want the server to execute as root. See also
the \-\-user option.
.Sp
GID's can be passed as group names or numeric values.
.IP \fB\-\-localaddr=ip\fR 4
.IX Item "--localaddr=ip"
By default a daemon is listening to any IP number that a machine
has. This attribute allows one to restrict the server to the given
IP number.
.IP \fB\-\-localport=port\fR 4
.IX Item "--localport=port"
This attribute sets the port on which the daemon is listening. It
must be given somehow, as there's no default.
.IP \fB\-\-logfile=file\fR 4
.IX Item "--logfile=file"
Be default logging messages will be written to the syslog (Unix) or
to the event log (Windows NT). On other operating systems you need to
specify a log file. The special value "STDERR" forces logging to
stderr. See Net::Daemon::Log for details.
.IP \fB\-\-mode=modename\fR 4
.IX Item "--mode=modename"
The server can run in three different modes, depending on the environment.
.Sp
If you are running Perl 5.005 and did compile it for threads, then the
server will create a new thread for each connection. The thread will
execute the server's \fBRun()\fR method and then terminate. This mode is the
default, you can force it with "\-\-mode=threads".
.Sp
If threads are not available, but you have a working \fBfork()\fR, then the
server will behave similar by creating a new process for each connection.
This mode will be used automatically in the absence of threads or if
you use the "\-\-mode=fork" option.
.Sp
Finally there's a single-connection mode: If the server has accepted a
connection, he will enter the \fBRun()\fR method. No other connections are
accepted until the \fBRun()\fR method returns (if the client disconnects).
This operation mode is useful if you have neither threads nor \fBfork()\fR,
for example on the Macintosh. For debugging purposes you can force this
mode with "\-\-mode=single".
.IP \fB\-\-pidfile=file\fR 4
.IX Item "--pidfile=file"
(UNIX only) If this option is present, a PID file will be created at the
given location. Default is to not create a pidfile.
.IP \fB\-\-user=uid\fR 4
.IX Item "--user=uid"
After doing a \fBbind()\fR, change the real and effective UID to the given.
This is useful, if you want your server to bind to a privileged port
(<1024), but don't want the server to execute as root. See also
the \-\-group and the \-\-chroot options.
.Sp
UID's can be passed as group names or numeric values.
.IP \fB\-\-version\fR 4
.IX Item "--version"
Suppresses startup of the server; instead the version string will
be printed and the program exits immediately.
.SH AUTHOR
.IX Header "AUTHOR"
.Vb 4
\&    Copyright (c) 1997    Jochen Wiedmann
\&                          Am Eisteich 9
\&                          72555 Metzingen
\&                          Germany
\&
\&                          Email: joe@ispsoft.de
\&                          Phone: +49 7123 14881
.Ve
.PP
The DBI::ProxyServer module is free software; you can redistribute it
and/or modify it under the same terms as Perl itself. In particular
permission is granted to Tim Bunce for distributing this as a part of
the DBI.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
DBI::ProxyServer, DBD::Proxy, DBI