Mini Shell

.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" 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 "CPAN::API::HOWTO 3"
.TH CPAN::API::HOWTO 3 "2012-09-08" "perl v5.32.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::API::HOWTO \- a recipe book for programming with CPAN.pm
.SH "RECIPES"
.IX Header "RECIPES"
All of these recipes assume that you have put \*(L"use \s-1CPAN\*(R"\s0 at the top of
your program.
.SS "What distribution contains a particular module?"
.IX Subsection "What distribution contains a particular module?"
.Vb 3
\&    my $distribution = CPAN::Shell\->expand(
\&        "Module", "Data::UUID"
\&    )\->distribution()\->pretty_id();
.Ve
.PP
This returns a string of the form \*(L"\s-1AUTHORID/TARBALL\*(R".\s0  If you want the
full path and filename to this distribution on a \s-1CPAN\s0 mirror, then it is
\&\f(CW\*(C`.../authors/id/A/AU/AUTHORID/TARBALL\*(C'\fR.
.SS "What modules does a particular distribution contain?"
.IX Subsection "What modules does a particular distribution contain?"
.Vb 4
\&    CPAN::Index\->reload();
\&    my @modules = CPAN::Shell\->expand(
\&        "Distribution", "JHI/Graph\-0.83.tar.gz"
\&    )\->containsmods();
.Ve
.PP
You may also refer to a distribution in the form A/AU/AUTHORID/TARBALL.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
the main \s-1CPAN\s0.pm documentation
.SH "LICENSE"
.IX Header "LICENSE"
This program is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
.PP
See <http://www.perl.com/perl/misc/Artistic.html>
.SH "AUTHOR"
.IX Header "AUTHOR"
David Cantrell