Adam Kennedy > Archive-Builder-1.16 > Archive::Builder::Archive

Download:
Archive-Builder-1.16.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Module Version: 1.16   Source  

NAME ^

Archive::Builder::Archive - Archive abstraction handles

DESCRIPTION ^

Archive::Builder::Archive objects provide a type neutral handle for outputing the various archive file types Archive::Builder objects.

For more information on Archive::Builder objects, see its POD documentation.

METHODS ^

types

When loaded, Archive::Builder::Archive examines your system to determine which archive types it is capable of creating, based on dependencies.

The types method returns a list of types that are supported by your system.

new( type, Archive::Builder|Archive::Builder::Section )

Although obtained via the Archive::Builder and Archive::Builder::Section archive methods, archives can be created directly, by passing them a valid type and either an Archive::Builder or Archive::Builder::Section object.

type

Returns the type of an Archive::Builder::Archive object.

generate

Generates and returns the actual archive object, with will be an Archive::Zip, Archive::Tar, or whatever, depending on the type.

Returns undef if an error occurs during file generation, or archive generation.

save( filename )

Generates and saves the archive file to a specific filename. If the file name does NOT end in the file type you have specified, it will be appended for you.

That is, save('file') will result in the creation of file.zip for an archive of type 'zip'.

TODO ^

More Archive types, like rar.

SUPPORT ^

Bugs should always be submitted via the CPAN bug tracker.

http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Archive-Builder

For other issues, contact the maintainer.

AUTHOR ^

Adam Kennedy <adamk@cpan.org>

SEE ALSO ^

Archive::Builder, Archive::Builder::Generators, Archive::Tar, Archive::Zip.

COPYRIGHT ^

Copyright 2002 - 2011 Adam Kennedy.

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

The full text of the license can be found in the LICENSE file included with this module.

syntax highlighting: