.\" Automatically generated by Pod::Man 4.14 (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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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 "Password 3pm"
.TH Password 3pm "2022-12-04" "perl v5.36.0" "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"
DBIx::Password \- Allows you to create a global password file for DB passwords
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 6
\&  use DBIx::Password;
\&  my $dbh = DBIx::Password\->connect($user);
\&  my $dbh = DBIx::Password\->connect_cached($user);
\&  $dbh\->getDriver;
\&  DBIx::Password::getDriver($user);
\&  DBIx::Password::checkVirtualUser($user);
\&
\&  DBIx::Password::clearConfig();
\&  DBIx::Password::readConfig("$ENV{HOME}/.my.secret.file");
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Don't you hate keeping track of database passwords and such throughout
your scripts? How about the problem of changing those passwords 
on a mass scale? This module is one possible solution. It stores all your
virtual users and data in /etc/dbix\-password.conf.
For each user you need to specify the database module to use,
the database connect string, the username and the password.
You will have to give a name to this virtual user.
You can add as many as you like.
.PP
I would recommend that if you are only using this with
web applications that you change the final permissions on this 
package after it is installed in site_perl such that only
the webserver can read it.
.PP
A method called getDriver has been added so that you
can determine what driver is being used (handy for
working out database indepence issues).
.PP
If you want to find out if the virtual user is valid,
you can call the class method \fBcheckVirtualUser()\fR.
It returns true (1) if the username is valid, and
zero if not.
.PP
Once your are done you can use the connect method (or
the connect_cache method) that comes with DBIx-Password 
and just specify one of the virtual users you defined 
while making the module.
.PP
\&\s-1BTW I\s0 learned the bless hack that is used from Apache::DBI
so some credit should go to the authors of that module.
This is a rewrite of the module Tangent::DB that I did
for slashcode.
.PP
If your program does not need the system-wide information stored
in the /etc/dbix\-password.conf file, you may use the \fBclearConfig()\fR
and \fBreadConfig()\fR functions to get the data from another source.
At any time, \fBreadConfig()\fR may also be used to merge the data from
another file into the currently-loaded configuration.
.PP
Hope you enjoy it.
.SH "HOME"
.IX Header "HOME"
To find out more information look at: http://www.tangent.org/DBIx\-Password/
.SH "AUTHOR"
.IX Header "AUTHOR"
Brian Aker, brian@tangent.org
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBperl\fR\|(1). \s-1\fBDBI\s0\fR\|(3).