Compress::unLZMA - Interface to LZMA decompression library


Compress-unLZMA documentation  | view source Contained in the Compress-unLZMA distribution.

Index


NAME

Top

Compress::unLZMA - Interface to LZMA decompression library

SYNOPSIS

Top

  use Compress::unLZMA qw(uncompress uncompressfile);
  my $data = uncompressfile('foo.lzma');
  my $data = uncompress($content);

DESCRIPTION

Top

LZMA is default and general compression method of 7z format in 7-Zip program. LZMA provides high compression ratio and very fast decompression.

This module is based on the LZMA SDK which provides a cross-platform implementation of the LZMA decompression algorithm in ANSI C.

From SDK lzma.txt file:

  LZMA decompression code was ported from original C++ sources to C.
  Also it was simplified and optimized for code size.
  But it is fully compatible with LZMA from 7-Zip.

METHODS

Top

$data = uncompress($content)

Uncompress $data. if successfull, it returns the uncompressed data. Otherwise it returns undef and $@ contains the error message.

The source buffer can be either be a scalar or a scalar reference.

$data = uncompressfile($file)

Uncompress the file $file. if successfull, it returns the uncompressed data. Otherwise it returns undef and $@ contains the error message.

CAVEATS

Top

This version only implements in-memory decompression (patches are welcomed).

There is no way to recognize a valid LZMA encoded file with the SDK. So, in some cases, you can crash your script if you try to uncompress a non valid LZMA encoded file.

REQUESTS & BUGS

Top

Please report any requests, suggestions or bugs via the RT bug-tracking system at http://rt.cpan.org/ or email to bug-Compress-unLZMA\@rt.cpan.org.

http://rt.cpan.org/NoAuth/Bugs.html?Dist=Compress-unLZMA is the RT queue for Compress::unLZMA. Please check to see if your bug has already been reported.

MAINTAINER

Top

Adriano Ferreira, ferreira@cpan.org

COPYRIGHT

Top

LZMA COPYRIGHT

Top

SEE ALSO

Top

perl(1), http://www.7-zip.org/.


Compress-unLZMA documentation  | view source Contained in the Compress-unLZMA distribution.