ext/Compress/Zlib/README

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