Update Compression modules to version 2.012
[p5sagit/p5-mst-13.2.git] / ext / Compress / Zlib / README
1
2                              Compress-Zlib
3
4                              Version 2.012
5
6                               15th July 2008
7
8        Copyright (c) 1995-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 the zlib compression library.  
16
17 PREREQUISITES
18 -------------
19
20 Before you can build Compress-Zlib you need to have the following
21 installed on your system:
22
23     * Perl 5.004 or better. 
24     * Compress::Raw::Zlib
25     * IO::Compress::Gzip
26
27 BUILDING THE MODULE
28 -------------------
29
30 Assuming you have met all the prerequisites, the module can now be built
31 using this sequence of commands:
32
33     perl Makefile.PL
34     make
35     make test
36
37 INSTALLATION
38 ------------
39
40 To install Compress-Zlib, run the command below:
41
42     make install
43
44 TROUBLESHOOTING
45 ---------------
46
47 Undefined Symbol gzsetparams
48 ----------------------------
49
50 If you get the error shown below when you run the Compress-Zlib test
51 harness it probably means you are running a copy of zlib that is
52 version 1.0.5 or older.
53
54 t/01version.........Can't load 'blib/arch/auto/Compress/Zlib/Zlib.so' for 
55                     module Compress::Raw::Zlib: blib/arch/auto/Compress/Raw/Zlib/Zlib.so:
56                     undefined symbol: gzsetparams at ...
57
58 There are two ways to fix this problem:
59
60     1. Upgrade to the latest version of zlib.
61
62     2. Edit config.in and set the OLD_ZLIB variable to True.
63
64 Test Harness 01version fails
65 ----------------------------
66 If the 01version test harness fails, and the problem isn't covered by the
67 scenario above, it probably means that you have two versions of 
68 zlib installed on your system.
69
70 Run the command below to see if this is indeed the case
71
72     make test TEST_VERBOSE=1 TEST_FILES=t/01version.t 
73
74 Try removing the one you don't want to use and rebuild.   
75
76 FEEDBACK
77 --------
78
79 How to report a problem with Compress-Zlib.
80
81 To help me help you, I need all of the following information:
82
83  1. The Versions of everything relevant.
84     This includes:
85
86      a. The *complete* output from running this
87      
88             perl -V
89      
90         Do not edit the output in any way.
91         Note, I want you to run "perl -V" and NOT "perl -v".
92      
93         If your perl does not understand the "-V" option it is too
94         old. This module needs Perl version 5.004 or better.     
95
96      b. The version of Compress-Zlib you have. 
97         If you have successfully installed Compress-Zlib, this one-liner
98         will tell you:
99
100            perl -MCompress::Zlib -e 'print qq[ver $Compress::Zlib::VERSION\n]'
101
102         If you are  running windows use this
103
104            perl -MCompress::Zlib -e "print qq[ver $Compress::Zlib::VERSION\n]"
105
106         If you haven't installed Compress-Zlib then search Compress::Zlib.pm
107         for a line like this:
108
109           $VERSION = "2.012" ;
110
111  2. If you are having problems building Compress-Zlib, send me a
112     complete log of what happened. Start by unpacking the Compress-Zlib
113     module into a fresh directory and keep a log of all the steps
114
115         [edit config.in, if necessary]
116         perl Makefile.PL
117         make
118         make test TEST_VERBOSE=1          
119
120 Paul Marquess <pmqs@cpan.org>