| 1 | .\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13 |
| 2 | .\" |
| 3 | .\" Standard preamble: |
| 4 | .\" ======================================================================== |
| 5 | .de Sh \" Subsection heading |
| 6 | .br |
| 7 | .if t .Sp |
| 8 | .ne 5 |
| 9 | .PP |
| 10 | \fB\\$1\fR |
| 11 | .PP |
| 12 | .. |
| 13 | .de Sp \" Vertical space (when we can't use .PP) |
| 14 | .if t .sp .5v |
| 15 | .if n .sp |
| 16 | .. |
| 17 | .de Vb \" Begin verbatim text |
| 18 | .ft CW |
| 19 | .nf |
| 20 | .ne \\$1 |
| 21 | .. |
| 22 | .de Ve \" End verbatim text |
| 23 | .ft R |
| 24 | .fi |
| 25 | .. |
| 26 | .\" Set up some character translations and predefined strings. \*(-- will |
| 27 | .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left |
| 28 | .\" double quote, and \*(R" will give a right double quote. | will give a |
| 29 | .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to |
| 30 | .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' |
| 31 | .\" expand to `' in nroff, nothing in troff, for use with C<>. |
| 32 | .tr \(*W-|\(bv\*(Tr |
| 33 | .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' |
| 34 | .ie n \{\ |
| 35 | . ds -- \(*W- |
| 36 | . ds PI pi |
| 37 | . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch |
| 38 | . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch |
| 39 | . ds L" "" |
| 40 | . ds R" "" |
| 41 | . ds C` "" |
| 42 | . ds C' "" |
| 43 | 'br\} |
| 44 | .el\{\ |
| 45 | . ds -- \|\(em\| |
| 46 | . ds PI \(*p |
| 47 | . ds L" `` |
| 48 | . ds R" '' |
| 49 | 'br\} |
| 50 | .\" |
| 51 | .\" If the F register is turned on, we'll generate index entries on stderr for |
| 52 | .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index |
| 53 | .\" entries marked with X<> in POD. Of course, you'll have to process the |
| 54 | .\" output yourself in some meaningful fashion. |
| 55 | .if \nF \{\ |
| 56 | . de IX |
| 57 | . tm Index:\\$1\t\\n%\t"\\$2" |
| 58 | .. |
| 59 | . nr % 0 |
| 60 | . rr F |
| 61 | .\} |
| 62 | .\" |
| 63 | .\" For nroff, turn off justification. Always turn off hyphenation; it makes |
| 64 | .\" way too many mistakes in technical documents. |
| 65 | .hy 0 |
| 66 | .if n .na |
| 67 | .\" |
| 68 | .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). |
| 69 | .\" Fear. Run. Save yourself. No user-serviceable parts. |
| 70 | . \" fudge factors for nroff and troff |
| 71 | .if n \{\ |
| 72 | . ds #H 0 |
| 73 | . ds #V .8m |
| 74 | . ds #F .3m |
| 75 | . ds #[ \f1 |
| 76 | . ds #] \fP |
| 77 | .\} |
| 78 | .if t \{\ |
| 79 | . ds #H ((1u-(\\\\n(.fu%2u))*.13m) |
| 80 | . ds #V .6m |
| 81 | . ds #F 0 |
| 82 | . ds #[ \& |
| 83 | . ds #] \& |
| 84 | .\} |
| 85 | . \" simple accents for nroff and troff |
| 86 | .if n \{\ |
| 87 | . ds ' \& |
| 88 | . ds ` \& |
| 89 | . ds ^ \& |
| 90 | . ds , \& |
| 91 | . ds ~ ~ |
| 92 | . ds / |
| 93 | .\} |
| 94 | .if t \{\ |
| 95 | . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" |
| 96 | . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' |
| 97 | . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' |
| 98 | . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' |
| 99 | . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' |
| 100 | . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' |
| 101 | .\} |
| 102 | . \" troff and (daisy-wheel) nroff accents |
| 103 | .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' |
| 104 | .ds 8 \h'\*(#H'\(*b\h'-\*(#H' |
| 105 | .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] |
| 106 | .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' |
| 107 | .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' |
| 108 | .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] |
| 109 | .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] |
| 110 | .ds ae a\h'-(\w'a'u*4/10)'e |
| 111 | .ds Ae A\h'-(\w'A'u*4/10)'E |
| 112 | . \" corrections for vroff |
| 113 | .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' |
| 114 | .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' |
| 115 | . \" for low resolution devices (crt and lpr) |
| 116 | .if \n(.H>23 .if \n(.V>19 \ |
| 117 | \{\ |
| 118 | . ds : e |
| 119 | . ds 8 ss |
| 120 | . ds o a |
| 121 | . ds d- d\h'-1'\(ga |
| 122 | . ds D- D\h'-1'\(hy |
| 123 | . ds th \o'bp' |
| 124 | . ds Th \o'LP' |
| 125 | . ds ae ae |
| 126 | . ds Ae AE |
| 127 | .\} |
| 128 | .rm #[ #] #H #V #F C |
| 129 | .\" ======================================================================== |
| 130 | .\" |
| 131 | .IX Title "DBIPROXY 1" |
| 132 | .TH DBIPROXY 1 "2002-10-01" "perl v5.8.0" "User Contributed Perl Documentation" |
| 133 | .SH "NAME" |
| 134 | dbiproxy \- A proxy server for the DBD::Proxy driver |
| 135 | .SH "SYNOPSIS" |
| 136 | .IX Header "SYNOPSIS" |
| 137 | .Vb 1 |
| 138 | \& dbiproxy <options> --port <port> |
| 139 | .Ve |
| 140 | .SH "DESCRIPTION" |
| 141 | .IX Header "DESCRIPTION" |
| 142 | This tool is just a front end for the DBI::ProxyServer package. All it |
| 143 | does is picking options from the command line and calling |
| 144 | \&\fIDBI::ProxyServer::main()\fR. See \fIDBI::ProxyServer\fR\|(3) for details. |
| 145 | .PP |
| 146 | Available options include: |
| 147 | .IP "\fB\-\-chroot=dir\fR" 4 |
| 148 | .IX Item "--chroot=dir" |
| 149 | (\s-1UNIX\s0 only) After doing a \fIbind()\fR, change root directory to the given |
| 150 | directory by doing a \fIchroot()\fR. This is usefull for security, but it |
| 151 | restricts the environment a lot. For example, you need to load \s-1DBI\s0 |
| 152 | drivers in the config file or you have to create hard links to Unix |
| 153 | sockets, if your drivers are using them. For example, with MySQL, a |
| 154 | config file might contain the following lines: |
| 155 | .Sp |
| 156 | .Vb 9 |
| 157 | \& my $rootdir = '/var/dbiproxy'; |
| 158 | \& my $unixsockdir = '/tmp'; |
| 159 | \& my $unixsockfile = 'mysql.sock'; |
| 160 | \& foreach $dir ($rootdir, "$rootdir$unixsockdir") { |
| 161 | \& mkdir 0755, $dir; |
| 162 | \& } |
| 163 | \& link("$unixsockdir/$unixsockfile", |
| 164 | \& "$rootdir$unixsockdir/$unixsockfile"); |
| 165 | \& require DBD::mysql; |
| 166 | .Ve |
| 167 | .Sp |
| 168 | .Vb 4 |
| 169 | \& { |
| 170 | \& 'chroot' => $rootdir, |
| 171 | \& ... |
| 172 | \& } |
| 173 | .Ve |
| 174 | .Sp |
| 175 | If you don't know \fIchroot()\fR, think of an \s-1FTP\s0 server where you can see a |
| 176 | certain directory tree only after logging in. See also the \-\-group and |
| 177 | \&\-\-user options. |
| 178 | .IP "\fB\-\-configfile=file\fR" 4 |
| 179 | .IX Item "--configfile=file" |
| 180 | Config files are assumed to return a single hash ref that overrides the |
| 181 | arguments of the new method. However, command line arguments in turn take |
| 182 | precedence over the config file. See the \*(L"\s-1CONFIGURATION\s0 \s-1FILE\s0\*(R" section |
| 183 | below for details on the config file. |
| 184 | .IP "\fB\-\-debug\fR" 4 |
| 185 | .IX Item "--debug" |
| 186 | Turn debugging mode on. Mainly this asserts that logging messages of |
| 187 | level \*(L"debug\*(R" are created. |
| 188 | .IP "\fB\-\-facility=mode\fR" 4 |
| 189 | .IX Item "--facility=mode" |
| 190 | (\s-1UNIX\s0 only) Facility to use for \*(L"Sys::Syslog (3)\*(R". The default is |
| 191 | \&\fBdaemon\fR. |
| 192 | .IP "\fB\-\-group=gid\fR" 4 |
| 193 | .IX Item "--group=gid" |
| 194 | After doing a \fIbind()\fR, change the real and effective \s-1GID\s0 to the given. |
| 195 | This is usefull, if you want your server to bind to a privileged port |
| 196 | (<1024), but don't want the server to execute as root. See also |
| 197 | the \-\-user option. |
| 198 | .Sp |
| 199 | \&\s-1GID\s0's can be passed as group names or numeric values. |
| 200 | .IP "\fB\-\-localaddr=ip\fR" 4 |
| 201 | .IX Item "--localaddr=ip" |
| 202 | By default a daemon is listening to any \s-1IP\s0 number that a machine |
| 203 | has. This attribute allows to restrict the server to the given |
| 204 | \&\s-1IP\s0 number. |
| 205 | .IP "\fB\-\-localport=port\fR" 4 |
| 206 | .IX Item "--localport=port" |
| 207 | This attribute sets the port on which the daemon is listening. It |
| 208 | must be given somehow, as there's no default. |
| 209 | .IP "\fB\-\-logfile=file\fR" 4 |
| 210 | .IX Item "--logfile=file" |
| 211 | Be default logging messages will be written to the syslog (Unix) or |
| 212 | to the event log (Windows \s-1NT\s0). On other operating systems you need to |
| 213 | specify a log file. The special value \*(L"\s-1STDERR\s0\*(R" forces logging to |
| 214 | stderr. See \fINet::Daemon::Log\fR\|(3) for details. |
| 215 | .IP "\fB\-\-mode=modename\fR" 4 |
| 216 | .IX Item "--mode=modename" |
| 217 | The server can run in three different modes, depending on the environment. |
| 218 | .Sp |
| 219 | If you are running Perl 5.005 and did compile it for threads, then the |
| 220 | server will create a new thread for each connection. The thread will |
| 221 | execute the server's \fIRun()\fR method and then terminate. This mode is the |
| 222 | default, you can force it with \*(L"\-\-mode=threads\*(R". |
| 223 | .Sp |
| 224 | If threads are not available, but you have a working \fIfork()\fR, then the |
| 225 | server will behave similar by creating a new process for each connection. |
| 226 | This mode will be used automatically in the absence of threads or if |
| 227 | you use the \*(L"\-\-mode=fork\*(R" option. |
| 228 | .Sp |
| 229 | Finally there's a single-connection mode: If the server has accepted a |
| 230 | connection, he will enter the \fIRun()\fR method. No other connections are |
| 231 | accepted until the \fIRun()\fR method returns (if the client disconnects). |
| 232 | This operation mode is usefull if you have neither threads nor \fIfork()\fR, |
| 233 | for example on the Macintosh. For debugging purposes you can force this |
| 234 | mode with \*(L"\-\-mode=single\*(R". |
| 235 | .IP "\fB\-\-pidfile=file\fR" 4 |
| 236 | .IX Item "--pidfile=file" |
| 237 | (\s-1UNIX\s0 only) If this option is present, a \s-1PID\s0 file will be created at the |
| 238 | given location. |
| 239 | .IP "\fB\-\-user=uid\fR" 4 |
| 240 | .IX Item "--user=uid" |
| 241 | After doing a \fIbind()\fR, change the real and effective \s-1UID\s0 to the given. |
| 242 | This is usefull, if you want your server to bind to a privileged port |
| 243 | (<1024), but don't want the server to execute as root. See also |
| 244 | the \-\-group and the \-\-chroot options. |
| 245 | .Sp |
| 246 | \&\s-1UID\s0's can be passed as group names or numeric values. |
| 247 | .IP "\fB\-\-version\fR" 4 |
| 248 | .IX Item "--version" |
| 249 | Supresses startup of the server; instead the version string will |
| 250 | be printed and the program exits immediately. |
| 251 | .SH "AUTHOR" |
| 252 | .IX Header "AUTHOR" |
| 253 | .Vb 4 |
| 254 | \& Copyright (c) 1997 Jochen Wiedmann |
| 255 | \& Am Eisteich 9 |
| 256 | \& 72555 Metzingen |
| 257 | \& Germany |
| 258 | .Ve |
| 259 | .PP |
| 260 | .Vb 2 |
| 261 | \& Email: joe@ispsoft.de |
| 262 | \& Phone: +49 7123 14881 |
| 263 | .Ve |
| 264 | .PP |
| 265 | The DBI::ProxyServer module is free software; you can redistribute it |
| 266 | and/or modify it under the same terms as Perl itself. In particular |
| 267 | permission is granted to Tim Bunce for distributing this as a part of |
| 268 | the \s-1DBI\s0. |
| 269 | .SH "SEE ALSO" |
| 270 | .IX Header "SEE ALSO" |
| 271 | \&\fIDBI::ProxyServer\fR\|(3), \fIDBD::Proxy\fR\|(3), \s-1\fIDBI\s0\fR\|(3) |