'\" te
.\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14)
.\"
.\" 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 "CPANPLUS::Internals::Extract 3"
.TH CPANPLUS::Internals::Extract 3 "2012-11-03" "perl v5.12.5" "Perl Programmers Reference Guide"
.\" 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"
CPANPLUS::Internals::Extract
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&    ### for source files ###
\&    $self\->_gunzip( file => \*(Aqfoo.gz\*(Aq, output => \*(Aqblah.txt\*(Aq );
\&    
\&    ### for modules/packages ###
\&    $dir = $self\->_extract( module      => $modobj, 
\&                            extractdir  => \*(Aq/some/where\*(Aq );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
CPANPLUS::Internals::Extract extracts compressed files for \s-1CPANPLUS\s0.
It can do this by either a pure perl solution (preferred) with the 
use of \f(CW\*(C`Archive::Tar\*(C'\fR and \f(CW\*(C`Compress::Zlib\*(C'\fR, or with binaries, like
\&\f(CW\*(C`gzip\*(C'\fR and \f(CW\*(C`tar\*(C'\fR.
.PP
The flow looks like this:
.PP
.Vb 2
\&    $cb\->_extract
\&        Delegate to Archive::Extract
.Ve
.SH "METHODS"
.IX Header "METHODS"
.ie n .SS "$dir = _extract( module => $modobj, [perl => '/path/to/perl', extractdir => '/path/to/extract/to', prefer_bin => \s-1BOOL\s0, verbose => \s-1BOOL\s0, force => \s-1BOOL\s0] )"
.el .SS "\f(CW$dir\fP = _extract( module => \f(CW$modobj\fP, [perl => '/path/to/perl', extractdir => '/path/to/extract/to', prefer_bin => \s-1BOOL\s0, verbose => \s-1BOOL\s0, force => \s-1BOOL\s0] )"
.IX Subsection "$dir = _extract( module => $modobj, [perl => '/path/to/perl', extractdir => '/path/to/extract/to', prefer_bin => BOOL, verbose => BOOL, force => BOOL] )"
\&\f(CW\*(C`_extract\*(C'\fR will take a module object and extract it to \f(CW\*(C`extractdir\*(C'\fR
if provided, or the default location which is obtained from your 
config.
.PP
The file name is obtained by looking at \f(CW\*(C`$modobj\->status\->fetch\*(C'\fR
and will be parsed to see if it's a tar or zip archive.
.PP
If it's a zip archive, \f(CW\*(C`_\|_unzip\*(C'\fR will be called, otherwise \f(CW\*(C`_\|_untar\*(C'\fR
will be called. In the unlikely event the file is of neither format,
an error will be thrown.
.PP
\&\f(CW\*(C`_extract\*(C'\fR takes the following options:
.IP "module" 4
.IX Item "module"
A \f(CW\*(C`CPANPLUS::Module\*(C'\fR object. This is required.
.IP "extractdir" 4
.IX Item "extractdir"
The directory to extract the archive to. By default this looks 
something like:
    /CPANPLUS_BASE/PERL_VERSION/BUILD/MODULE_NAME
.IP "prefer_bin" 4
.IX Item "prefer_bin"
A flag indicating whether you prefer a pure perl solution, ie
\&\f(CW\*(C`Archive::Tar\*(C'\fR or \f(CW\*(C`Archive::Zip\*(C'\fR respectively, or a binary solution
like \f(CW\*(C`unzip\*(C'\fR and \f(CW\*(C`tar\*(C'\fR.
.IP "perl" 4
.IX Item "perl"
The path to the perl executable to use for any perl calls. Also used
to determine the build version directory for extraction.
.IP "verbose" 4
.IX Item "verbose"
Specifies whether to be verbose or not. Defaults to your corresponding
config entry.
.IP "force" 4
.IX Item "force"
Specifies whether to force the extraction or not. Defaults to your
corresponding config entry.
.PP
All other options are passed on verbatim to \f(CW\*(C`_\|_unzip\*(C'\fR or \f(CW\*(C`_\|_untar\*(C'\fR.
.PP
Returns the directory the file was extracted to on success and false
on failure.


.\" Oracle has added the ARC stability level to this manual page
.SH ATTRIBUTES
See
.BR attributes (5)
for descriptions of the following attributes:
.sp
.TS
box;
cbp-1 | cbp-1
l | l .
ATTRIBUTE TYPE	ATTRIBUTE VALUE 
=
Availability	runtime/perl-512
=
Stability	Uncommitted
.TE 
.PP

.SH NOTES

.\" Oracle has added source availability information to this manual page
This software was built from source available at https://java.net/projects/solaris-userland.  The original community source was downloaded from  http://www.cpan.org/src/5.0/perl-5.12.5.tar.bz2

Further information about this software can be found on the open source community website at http://www.perl.org/.