diff options
Diffstat (limited to 'ext/IO_Compress_Zlib/README')
-rw-r--r-- | ext/IO_Compress_Zlib/README | 157 |
1 files changed, 157 insertions, 0 deletions
diff --git a/ext/IO_Compress_Zlib/README b/ext/IO_Compress_Zlib/README new file mode 100644 index 0000000000..d0e48d4248 --- /dev/null +++ b/ext/IO_Compress_Zlib/README @@ -0,0 +1,157 @@ + + IO::Compress::Zlib + + Version 2.004 + + 3rd March 2007 + + + Copyright (c) 2005-2007 Paul Marquess. All rights reserved. + This program is free software; you can redistribute it + and/or modify it under the same terms as Perl itself. + + + + +DESCRIPTION +----------- + + +This module provides a Perl interface to allow reading and writing of RFC +1950, 1951, 1952 (i.e. gzip) and zip files/buffers. + + + + + +PREREQUISITES +------------- + +Before you can build IO::Compress::Zlib you need to have the following +installed on your system: + + + * Perl 5.004 or better. + * Compress::Raw::Zlib + * IO::Compress::Base + + + + + +BUILDING THE MODULE +------------------- + +Assuming you have met all the prerequisites, the module can now be built +using this sequence of commands: + + perl Makefile.PL + make + make test + + + +INSTALLATION +------------ + +To install IO::Compress::Zlib, run the command below: + + make install + + + + + +TROUBLESHOOTING +--------------- + + + + + + + + + +The t/020isize Test Suite +------------------------ + +This test suite checks that IO::Compress::Zlib can cope with gzip files +that are larger than 2^32 bytes. + +By default these test are NOT run when you do a "make test". If you +really want to run them, you need to execute "make longtest". + +Be warned though -- this test suite can take hours to run on a slow box. + +Also, due to the way the tests are constructed, some architectures will +run out of memory during this test. This should not be considered a bug +in the IO::Compress::Zlib module. + + + + +FEEDBACK +-------- + +How to report a problem with IO::Compress::Zlib. + +To help me help you, I need all of the following information: + + 1. The Versions of everything relevant. + This includes: + + a. The *complete* output from running this + + perl -V + + Do not edit the output in any way. + Note, I want you to run "perl -V" and NOT "perl -v". + + If your perl does not understand the "-V" option it is too + old. This module needs Perl version 5.004 or better. + + b. The version of IO::Compress::Zlib you have. + If you have successfully installed IO::Compress::Zlib, this one-liner + will tell you: + + perl -MIO::Compress::Zlib -e 'print qq[ver $IO::Compress::Zlib::VERSION\n]' + + If you areplete* output from running this + + perl -V + + Do not edit the output in any way. + Note, I want you to run "perl -V" and NOT "perl -v". + + If your perl does not understand the "-V" option it is too + old. This module needs Perl version 5.004 or better. + + b. The version of IO::Compress::Zlib you have. + If you have successfully installed IO::Compress::Zlib, this one-liner + will tell you: + + perl -MIO::Compress::Zlib -e 'print qq[ver $IO::Compress::Zlib::VERSION\n]' + + If you are running windows use this + + perl -MIO::Compress::Zlib -e "print qq[ver $IO::Compress::Zlib::VERSION\n]" + + If you haven't installed IO::Compress::Zlib then search IO::Compress::Zlib.pm + for a line like this: + + $VERSION = "1.05" ; + + + + 2. If you are having problems building IO::Compress::Zlib, send me a + complete log of what happened. Start by unpacking the IO::Compress::Zlib + module into a fresh directory and keep a log of all the steps + + [edit config.in, if necessary] + perl Makefile.PL + make + make test TEST_VERBOSE=1 + + +Paul Marquess <pmqs@cpan.org> |