.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
.\"
.\" 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 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.
.\"
.\" 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 "CPAN::SQLite::Info 3"
.TH CPAN::SQLite::Info 3 "2015-07-15" "perl v5.16.3" "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::Info \- extract information from CPAN indices
.SH "VERSION"
.IX Header "VERSION"
version 0.211
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module extracts information from the \s-1CPAN\s0 indices
\&\fI\f(CI$CPAN\fI/modules/03modlist.data.gz\fR,
\&\fI\f(CI$CPAN\fI/modules/02packages.details.txt.gz\fR, and
\&\fI\f(CI$CPAN\fI/authors/01mailrc.txt.gz\fR.
.PP
A \f(CW\*(C`CPAN::SQLite::Info\*(C'\fR object is created with
.PP
.Vb 1
\&    my $info = CPAN::SQLite::Info\->new(CPAN => $cpan);
.Ve
.PP
where \f(CW$cpan\fR specifies the top-level \s-1CPAN\s0 directory
underneath which the index files are found. Calling
.PP
.Vb 1
\&    $info\->fetch_info();
.Ve
.PP
will result in the object being populated with 3 hash references:
.IP "\(bu" 3
\&\f(CW\*(C`$info\->{dists}\*(C'\fR
.Sp
This contains information on distributions. Keys of this hash
reference are the distribution names, with the associated value being a
hash reference with keys of
.RS 3
.ie n .IP """dist_vers"" \- the version of the \s-1CPAN\s0 file" 3
.el .IP "\f(CWdist_vers\fR \- the version of the \s-1CPAN\s0 file" 3
.IX Item "dist_vers - the version of the CPAN file"
.PD 0
.ie n .IP """dist_file"" \- the \s-1CPAN\s0 filename" 3
.el .IP "\f(CWdist_file\fR \- the \s-1CPAN\s0 filename" 3
.IX Item "dist_file - the CPAN filename"
.ie n .IP """cpanid"" \- the \s-1CPAN\s0 author id" 3
.el .IP "\f(CWcpanid\fR \- the \s-1CPAN\s0 author id" 3
.IX Item "cpanid - the CPAN author id"
.ie n .IP """dist_abs"" \- a description, if available" 3
.el .IP "\f(CWdist_abs\fR \- a description, if available" 3
.IX Item "dist_abs - a description, if available"
.ie n .IP """modules"" \- specifies the modules present in the distribution:" 3
.el .IP "\f(CWmodules\fR \- specifies the modules present in the distribution:" 3
.IX Item "modules - specifies the modules present in the distribution:"
.PD
.Vb 3
\&  for my $module (keys %{$info\->{$distname}\->{modules}}) {
\&    print "Module: $module\en";
\&  }
.Ve
.ie n .IP """chapterid"" \- specifies the chapterid and the subchapter for the distribution:" 3
.el .IP "\f(CWchapterid\fR \- specifies the chapterid and the subchapter for the distribution:" 3
.IX Item "chapterid - specifies the chapterid and the subchapter for the distribution:"
.Vb 6
\&  for my $id (keys %{$info\->{$distname}\->{chapterid}}) {
\&    print "For chapterid $id\en";
\&    for my $sc (keys %{$info\->{$distname}\->{chapterid}\->{$id}}) {
\&      print "   Subchapter: $sc\en";
\&    }
\&  }
.Ve
.RE
.RS 3
.RE
.IP "\(bu" 3
\&\f(CW\*(C`$info\->{mods}\*(C'\fR
.Sp
This contains information on modules. Keys of this hash
reference are the module names, with the associated values being a
hash reference with keys of
.RS 3
.ie n .IP """dist_name"" \- the distribution name containing the module" 3
.el .IP "\f(CWdist_name\fR \- the distribution name containing the module" 3
.IX Item "dist_name - the distribution name containing the module"
.PD 0
.ie n .IP """mod_vers"" \- the version" 3
.el .IP "\f(CWmod_vers\fR \- the version" 3
.IX Item "mod_vers - the version"
.ie n .IP """mod_abs"" \- a description, if available" 3
.el .IP "\f(CWmod_abs\fR \- a description, if available" 3
.IX Item "mod_abs - a description, if available"
.ie n .IP """chapterid"" \- the chapter id of the module, if present" 3
.el .IP "\f(CWchapterid\fR \- the chapter id of the module, if present" 3
.IX Item "chapterid - the chapter id of the module, if present"
.ie n .IP """dslip"" \- a 5 character string specifying the dslip (development, support, language, interface, public licence) information." 3
.el .IP "\f(CWdslip\fR \- a 5 character string specifying the dslip (development, support, language, interface, public licence) information." 3
.IX Item "dslip - a 5 character string specifying the dslip (development, support, language, interface, public licence) information."
.RE
.RS 3
.RE
.IP "\(bu" 3
.PD
\&\f(CW\*(C`$info\->{auths}\*(C'\fR
.Sp
This contains information on \s-1CPAN\s0 authors. Keys of this hash
reference are the \s-1CPAN\s0 ids, with the associated value being a
hash reference with keys of
.RS 3
.ie n .IP """fullname"" \- the author's full name" 3
.el .IP "\f(CWfullname\fR \- the author's full name" 3
.IX Item "fullname - the author's full name"
.PD 0
.ie n .IP """email"" \- the author's email address" 3
.el .IP "\f(CWemail\fR \- the author's email address" 3
.IX Item "email - the author's email address"
.RE
.RS 3
.RE
.PD
.SH "SEE ALSO"
.IX Header "SEE ALSO"
CPAN::SQLite::Index