ext/Compress/Zlib/README

   1
   2                              Compress::Zlib
   3
   4                              Version 2.005
   5
   6                               18th June 2007
   7
   8
   9        Copyright (c) 1995-2007 Paul Marquess. All rights reserved.
  10           This program is free software; you can redistribute it
  11            and/or modify it under the same terms as Perl itself.
  12
  13
  14
  15
  16 DESCRIPTION
  17 -----------
  18
  19
  20 This module provides a Perl interface to the zlib compression library.
  21
  22
  23
  24
  25
  26 PREREQUISITES
  27 -------------
  28
  29 Before you can build Compress::Zlib you need to have the following
  30 installed on your system:
  31
  32
  33     * Perl 5.004 or better.
  34     * Compress::Raw::Zlib
  35     * IO::Compress::Gzip
  36
  37
  38
  39
  40
  41 BUILDING THE MODULE
  42 -------------------
  43
  44 Assuming you have met all the prerequisites, the module can now be built
  45 using this sequence of commands:
  46
  47     perl Makefile.PL
  48     make
  49     make test
  50
  51
  52
  53 INSTALLATION
  54 ------------
  55
  56 To install Compress::Zlib, run the command below:
  57
  58     make install
  59
  60
  61
  62
  63
  64 TROUBLESHOOTING
  65 ---------------
  66
  67
  68 Undefined Symbol gzsetparams
  69 ----------------------------
  70
  71 If you get the error shown below when you run the Compress::Zlib test
  72 harness it probably means you are running a copy of zlib that is
  73 version 1.0.5 or older.
  74
  75 t/01version.........Can't load 'blib/arch/auto/Compress/Zlib/Zlib.so' for
  76                     module Compress::Raw::Zlib: blib/arch/auto/Compress/Raw/Zlib/Zlib.so:
  77                     undefined symbol: gzsetparams at ...
  78
  79 There are two ways to fix this problem:
  80
  81     1. Upgrade to the latest version of zlib.
  82
  83     2. Edit config.in and set the OLD_ZLIB variable to True.
  84
  85
  86
  87 Test Harness 01version fails
  88 ----------------------------
  89 If the 01version test harness fails, and the problem isn't covered by the
  90 scenario above, it probably means that you have two versions of
  91 zlib installed on your system.
  92
  93 Run the command below to see if this is indeed the case
  94
  95     make test TEST_VERBOSE=1 TEST_FILES=t/01version.t
  96
  97 Try removing the one you don't want to use and rebuild.
  98
  99
 100
 101
 102
 103
 104
 105
 106
 107 FEEDBACK
 108 --------
 109
 110 How to report a problem with Compress::Zlib.
 111
 112 To help me help you, I need all of the following information:
 113
 114  1. The Versions of everything relevant.
 115     This includes:
 116
 117      a. The *complete* output from running this
 118
 119             perl -V
 120
 121         Do not edit the output in any way.
 122         Note, I want you to run "perl -V" and NOT "perl -v".
 123
 124         If your perl does not understand the "-V" option it is too
 125         old. This module needs Perl version 5.004 or better.
 126
 127      b. The version of Compress::Zlib you have.
 128         If you have successfully installed Compress::Zlib, this one-liner
 129         will tell you:
 130
 131            perl -MCompress::Zlib -e 'print qq[ver $Compress::Zlib::VERSION\n]'
 132
 133         If you areplete* output from running this
 134
 135             perl -V
 136
 137         Do not edit the output in any way.
 138         Note, I want you to run "perl -V" and NOT "perl -v".
 139
 140         If your perl does not understand the "-V" option it is too
 141         old. This module needs Perl version 5.004 or better.
 142
 143      b. The version of Compress::Zlib you have.
 144         If you have successfully installed Compress::Zlib, this one-liner
 145         will tell you:
 146
 147            perl -MCompress::Zlib -e 'print qq[ver $Compress::Zlib::VERSION\n]'
 148
 149         If you are  running windows use this
 150
 151            perl -MCompress::Zlib -e "print qq[ver $Compress::Zlib::VERSION\n]"
 152
 153         If you haven't installed Compress::Zlib then search Compress::Zlib.pm
 154         for a line like this:
 155
 156           $VERSION = "1.05" ;
 157
 158
 159
 160  2. If you are having problems building Compress::Zlib, send me a
 161     complete log of what happened. Start by unpacking the Compress::Zlib
 162     module into a fresh directory and keep a log of all the steps
 163
 164         [edit config.in, if necessary]
 165         perl Makefile.PL
 166         make
 167         make test TEST_VERBOSE=1
 168
 169
 170 Paul Marquess <pmqs@cpan.org>