ext/IO_Compress_Zlib/README

   1
   2                              IO-Compress-Zlib
   3
   4                              Version 2.010
   5
   6                                5th May 2008
   7
   8        Copyright (c) 2005-2008 Paul Marquess. All rights reserved.
   9           This program is free software; you can redistribute it
  10            and/or modify it under the same terms as Perl itself.
  11
  12 DESCRIPTION
  13 -----------
  14
  15 This module provides a Perl interface to allow reading and writing of RFC
  16 1950, 1951, 1952 (i.e. gzip) and zip files/buffers.
  17
  18 PREREQUISITES
  19 -------------
  20
  21 Before you can build IO-Compress-Zlib you need to have the following
  22 installed on your system:
  23
  24     * Perl 5.004 or better.
  25     * Compress::Raw::Zlib
  26     * IO::Compress::Base
  27
  28 BUILDING THE MODULE
  29 -------------------
  30
  31 Assuming you have met all the prerequisites, the module can now be built
  32 using this sequence of commands:
  33
  34     perl Makefile.PL
  35     make
  36     make test
  37
  38 INSTALLATION
  39 ------------
  40
  41 To install IO-Compress-Zlib, run the command below:
  42
  43     make install
  44
  45 TROUBLESHOOTING
  46 ---------------
  47
  48 The t/020isize Test Suite
  49 ------------------------
  50
  51 This test suite checks that IO-Compress-Zlib can cope with gzip files
  52 that are larger than 2^32 bytes.
  53
  54 By default these tests are NOT run when you do a "make test". If you
  55 really want to run them, you need to execute "make longtest".
  56
  57 Be warned though -- this test suite can take hours to run on a slow box.
  58
  59 Also, due to the way the tests are constructed, some architectures will
  60 run out of memory during this test. This should not be considered a bug
  61 in the IO-Compress-Zlib module.
  62
  63 FEEDBACK
  64 --------
  65
  66 How to report a problem with IO-Compress-Zlib.
  67
  68 To help me help you, I need all of the following information:
  69
  70  1. The Versions of everything relevant.
  71     This includes:
  72
  73      a. The *complete* output from running this
  74
  75             perl -V
  76
  77         Do not edit the output in any way.
  78         Note, I want you to run "perl -V" and NOT "perl -v".
  79
  80         If your perl does not understand the "-V" option it is too
  81         old. This module needs Perl version 5.004 or better.
  82
  83      b. The version of IO-Compress-Zlib you have.
  84         If you have successfully installed IO-Compress-Zlib, this one-liner
  85         will tell you:
  86
  87            perl -MIO::Compress::Gzip -e 'print qq[ver $IO::Compress::Gzip::VERSION\n]'
  88
  89         If you are  running windows use this
  90
  91            perl -MIO::Compress::Gzip -e "print qq[ver $IO::Compress::Gzip::VERSION\n]"
  92
  93         If you haven't installed IO-Compress-Zlib then search IO::Compress::Gzip.pm
  94         for a line like this:
  95
  96           $VERSION = "2.010" ;
  97
  98  2. If you are having problems building IO-Compress-Zlib, send me a
  99     complete log of what happened. Start by unpacking the IO-Compress-Zlib
 100     module into a fresh directory and keep a log of all the steps
 101
 102         [edit config.in, if necessary]
 103         perl Makefile.PL
 104         make
 105         make test TEST_VERBOSE=1
 106
 107 Paul Marquess <pmqs@cpan.org>