archive::any(3pm) [debian man page]

Archive::Any(3pm)					User Contributed Perl Documentation					 Archive::Any(3pm)

NAME

       Archive::Any - Single interface to deal with file archives.

SYNOPSIS

	 use Archive::Any;

	 my $archive = Archive::Any->new($archive_file);

	 my @files = $archive->files;

	 $archive->extract;

	 my $type = $archive->type;

	 $archive->is_impolite;
	 $archive->is_naughty;

DESCRIPTION

       This module is a single interface for manipulating different archive formats.  Tarballs, zip files, etc.

       new
	     my $archive = Archive::Any->new($archive_file);
	     my $archive = Archive::Any->new($archive_file, $type);

	   $type is optional.  It lets you force the file type in-case Archive::Any can't figure it out.

       extract
	     $archive->extract;
	     $archive->extract($directory);

	   Extracts the files in the archive to the given $directory.  If no $directory is given, it will go into the current working directory.

       files
	     my @file = $archive->files;

	   A list of files in the archive.

       mime_type
	    my $mime_type = $archive->mime_type();

	   Returns the mime type of the archive.

       is_impolite
	     my $is_impolite = $archive->is_impolite;

	   Checks to see if this archive is going to unpack into the current directory rather than create its own.

       is_naughty
	     my $is_naughty = $archive->is_naughty;

	   Checks to see if this archive is going to unpack outside the current directory.

DEPRECATED

       type
	     my $type = $archive->type;

	   Returns the type of archive.  This method is provided for backwards compatibility in the Tar and Zip plugins and will be going away
	   soon in favor of "mime_type".

PLUGINS

       For detailed information on writing plugins to work with Archive::Any, please see the pod documentation for Archive::Any::Plugin.

AUTHOR

       Clint Moore <cmoore@cpan.org>

AUTHOR EMERITUS

       Michael G Schwern

SEE ALSO

       Archive::Any::Plugin

SUPPORT

       You can find documentation for this module with the perldoc command.

	perldoc Archive::Any

       You can also look for information at:

       o   AnnoCPAN: Annotated CPAN documentation

	   <http://annocpan.org/dist/Archive-Any>

       o   CPAN Ratings

	   <http://cpanratings.perl.org/d/Archive-Any>

       o   RT: CPAN's request tracker

	   <http://rt.cpan.org/NoAuth/Bugs.html?Dist=Archive-Any>

       o   Search CPAN

	   <http://search.cpan.org/dist/Archive-Any>

LICENSE

       This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

       See <http://www.perl.com/perl/misc/Artistic.html>

perl v5.10.0							    2008-06-25							 Archive::Any(3pm)

Check Out this Related Man Page

CPANPLUS::Internals::Extract(3pm)			 Perl Programmers Reference Guide			 CPANPLUS::Internals::Extract(3pm)

NAME

       CPANPLUS::Internals::Extract - internals for archive extraction

SYNOPSIS

	   ### for source files ###
	   $self->_gunzip( file => 'foo.gz', output => 'blah.txt' );

	   ### for modules/packages ###
	   $dir = $self->_extract( module      => $modobj,
				   extractdir  => '/some/where' );

DESCRIPTION

       CPANPLUS::Internals::Extract extracts compressed files for CPANPLUS.  It can do this by either a pure perl solution (preferred) with the
       use of "Archive::Tar" and "Compress::Zlib", or with binaries, like "gzip" and "tar".

       The flow looks like this:

	   $cb->_extract
	       Delegate to Archive::Extract

METHODS

   $dir = _extract( module => $modobj, [perl => '/path/to/perl', extractdir => '/path/to/extract/to', prefer_bin => BOOL, verbose => BOOL, force
       => BOOL] )
       "_extract" will take a module object and extract it to "extractdir" if provided, or the default location which is obtained from your
       config.

       The file name is obtained by looking at "$modobj->status->fetch" and will be parsed to see if it's a tar or zip archive.

       If it's a zip archive, "__unzip" will be called, otherwise "__untar" will be called. In the unlikely event the file is of neither format,
       an error will be thrown.

       "_extract" takes the following options:

       module
	   A "CPANPLUS::Module" object. This is required.

       extractdir
	   The directory to extract the archive to. By default this looks something like:
	       /CPANPLUS_BASE/PERL_VERSION/BUILD/MODULE_NAME

       prefer_bin
	   A flag indicating whether you prefer a pure perl solution, ie "Archive::Tar" or "Archive::Zip" respectively, or a binary solution like
	   "unzip" and "tar".

       perl
	   The path to the perl executable to use for any perl calls. Also used to determine the build version directory for extraction.

       verbose
	   Specifies whether to be verbose or not. Defaults to your corresponding config entry.

       force
	   Specifies whether to force the extraction or not. Defaults to your corresponding config entry.

       All other options are passed on verbatim to "__unzip" or "__untar".

       Returns the directory the file was extracted to on success and false on failure.

perl v5.16.2							    2012-10-11					 CPANPLUS::Internals::Extract(3pm)

Linux and UNIX Man Pages

archive::any(3pm) [debian man page]

Check Out this Related Man Page