Brian Horakh > Compress-Bzip2-1.01 > Compress::Bzip2

Download:
Compress-Bzip2-1.01.tar.gz

Dependencies

Annotate this POD

Related Modules

Archive::Tar
Compress::Zlib
XML::Parser
Archive::Zip
XML::Twig
Net::SSLeay
DBD::CSV
IO::Scalar
List::Util
XML::XPath
more...
By perlmonks.org

CPAN RT

New  11
Open  0
View Bugs
Report a bug
Module Version: 1.00   Source   Latest Release: Compress-Bzip2-1.03

NAME ^

Compress::Bzip2 - Interface to Bzip2 compression library

SYNOPSIS ^

    use Compress::Bzip2;

    $dest = Compress::Bzip2::compress($source, [$level]);
    $dest = Compress::Bzip2::decompress($source);

DESCRIPTION ^

The Compress::Bzip2 module provides a Perl interface to the Bzip2 compression library (see "AUTHOR" for details about where to get Bzip2). A relevant subset of the functionality provided by Bzip2 is available in Compress::Bzip2.

All string parameters can either be a scalar or a scalar reference.

COMPRESSION FUNCTIONS ^

$dest = Compress::Bzip2::compress($string)

Compress a string using the default compression level, returning a string containing compressed data.

$dest = Compress::Bzip2::compress($string, $level)

Compress string, using the chosen compression level (either 1 or 9). Return a string containing the compressed data.

On error undef is returned.

DECOMPRESSION FUNCTIONS ^

$dest = Compress::Bzip2::decompress($string)

Decompress the data in string, returning a string containing the decompressed data.

On error undef is returned.

AUTHOR ^

The Compress::Bzip2 module was written by Gawdi Azem azemgi@rupert.informatik.uni-stuttgart.de.

MODIFICATION HISTORY ^

1.00 First public release of Compress::Bzip2.