Current File : //proc/self/root/usr/local/share/man/man3/CPAN::SQLite::META.3pm
.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.13)
.\"
.\" 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" ''
'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 turned on, 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.
.ie \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. nr % 0
. rr F
.\}
.el \{\
. de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
.if n \{\
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #] \fP
.\}
.if t \{\
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
.if n \{\
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
.if t \{\
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "CPAN::SQLite::META 3"
.TH CPAN::SQLite::META 3 "2013-06-29" "perl v5.10.1" "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"
CPAN::SQLite::META \- helper module for CPAN.pm integration
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module has no direct public interface, but is intended
as a helper module for use of CPAN::SQLite within the \s-1CPAN\s0.pm
module. A new object is created as
.PP
.Vb 1
\& my $obj = CPAN::SQLite::META\->new($CPAN::META);
.Ve
.PP
where \f(CW$CPAN::META\fR comes from \s-1CPAN\s0.pm. There are then
two main methods available.
.ie n .IP """set""" 4
.el .IP "\f(CWset\fR" 4
.IX Item "set"
This is used as
.Sp
.Vb 1
\& $obj\->set($class, $id);
.Ve
.Sp
where \f(CW$class\fR is one of \f(CW\*(C`CPAN::Author\*(C'\fR, \f(CW\*(C`CPAN::Module\*(C'\fR, or
\&\f(CW\*(C`CPAN::Distribution\*(C'\fR, and \f(CW$id\fR is the id \s-1CPAN\s0.pm uses to
identify the class. The method searches the \f(CW\*(C`CPAN::SQLite\*(C'\fR
database by name using the appropriate \f(CW\*(C`author\*(C'\fR, \f(CW\*(C`dist\*(C'\fR,
or \f(CW\*(C`module\*(C'\fR mode, and if a result is found, calls
.Sp
.Vb 5
\& $CPAN::META\->instance(
\& $class => $id
\& )\->set(
\& %attributes
\& );
.Ve
.Sp
to register an instance of this class within \f(CW\*(C`CPAN.pm\*(C'\fR.
.ie n .IP """ssearch""" 4
.el .IP "\f(CWssearch\fR" 4
.IX Item "ssearch"
This is used as
.Sp
.Vb 1
\& $obj\->search($class, $id);
.Ve
.Sp
where \f(CW$class\fR is one of \f(CW\*(C`CPAN::Author\*(C'\fR, \f(CW\*(C`CPAN::Module\*(C'\fR, or
\&\f(CW\*(C`CPAN::Distribution\*(C'\fR, and \f(CW$id\fR is the id \s-1CPAN\s0.pm uses to
identify the class. The method searches the \f(CW\*(C`CPAN::SQLite\*(C'\fR
database by \f(CW\*(C`query\*(C'\fR using the appropriate \f(CW\*(C`author\*(C'\fR, \f(CW\*(C`dist\*(C'\fR,
or \f(CW\*(C`module\*(C'\fR mode, and if results are found, calls
.Sp
.Vb 5
\& $CPAN::META\->instance(
\& $class => $id
\& )\->set(
\& %attributes
\& );
.Ve
.Sp
for each match to register an instance of this class
within \f(CW\*(C`CPAN.pm\*(C'\fR.
.PP
The attributes set within \f(CW\*(C`$CPAN::META\-\*(C'\fRinstance> depend
on the particular class.
.IP "author" 4
.IX Item "author"
The attributes are
.Sp
.Vb 2
\& \*(AqFULLNAME\*(Aq => $results\->{fullname},
\& \*(AqEMAIL\*(Aq => $results\->{email},
.Ve
.Sp
where \f(CW$results\fR are the results returned from \f(CW\*(C`CPAN::SQLite\*(C'\fR.
.IP "module" 4
.IX Item "module"
The attributes are
.Sp
.Vb 7
\& \*(Aqdescription\*(Aq => $results\->{mod_abs},
\& \*(Aquserid\*(Aq => $results\->{cpanid},
\& \*(AqCPAN_VERSION\*(Aq => $results\->{mod_vers},
\& \*(AqCPAN_FILE\*(Aq => $results\->{download},
\& \*(AqCPAN_USERID\*(Aq => $results\->{cpanid},
\& \*(Aqchapterid\*(Aq => $results\->{chapterid},
\& %dslip,
.Ve
.Sp
where \f(CW$results\fR are the results returned from \f(CW\*(C`CPAN::SQLite\*(C'\fR.
Here, \f(CW%dslip\fR is a hash containing keys \f(CW\*(C`statd\*(C'\fR, \f(CW\*(C`stats\*(C'\fR,
\&\f(CW\*(C`statl\*(C'\fR, \f(CW\*(C`stati\*(C'\fR, and \f(CW\*(C`statp\*(C'\fR, with corresponding values
being the registered dslip entries for the module, if present.
.IP "dist" 4
.IX Item "dist"
The attributes are
.Sp
.Vb 3
\& \*(AqDESCRIPTION\*(Aq => $results\->{dist_abs},
\& \*(AqCPAN_USERID\*(Aq => $results\->{cpanid},
\& \*(AqCPAN_VERSION\*(Aq => $results\->{dist_vers},
.Ve
.Sp
As well, a \f(CW\*(C`CONTAINSMODS\*(C'\fR key to \f(CW$CPAN::META\fR is added, this
being a hash reference whose keys are the modules contained
within the distribution.
.PP
There is also a method available \f(CW\*(C`reload\*(C'\fR, which rebuilds
the database. It can be used as
.PP
.Vb 1
\& $obj\->reload(force => 1, time => $time);
.Ve
.PP
The \f(CW\*(C`time\*(C'\fR option (which, if not passed in, will default to the
current time) will be used to compare the current time to
the mtime of the database file; if they differ by more than
one day, the database will be rebuilt. The <force> option, if
given, will force a rebuilding of the database regardless
of the time difference.
Mini Shell