IO::Compress* 2.000_12
[p5sagit/p5-mst-13.2.git] / ext / Compress / IO / Zlib / README
CommitLineData
25f0751f 1
2 IO::Compress::Zlib
3
c70c1701 4 Version 2.000_12
25f0751f 5
c70c1701 6 17 May 2006
25f0751f 7
8
9 Copyright (c) 2005-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
22DESCRIPTION
23-----------
24
25
cb7abd7f 26This module provides a Perl interface to allow reading and writing of RFC
25f0751f 271950, 1951, 1952 (i.e. gzip) and zip files/buffers.
28
29
30
31
32
33PREREQUISITES
34-------------
35
36Before you can build IO::Compress::Zlib you need to have the following
37installed on your system:
38
39
40 * Perl 5.004 or better.
41 * Compress::Raw::Zlib
42 * IO::Compress::Base
43
44
45
46
47
48BUILDING THE MODULE
49-------------------
50
51Assuming you have met all the prerequisites, the module can now be built
52using this sequence of commands:
53
54 perl Makefile.PL
55 make
56 make test
57
58
59
60INSTALLATION
61------------
62
63To install IO::Compress::Zlib, run the command below:
64
65 make install
66
67
68
69
70
71TROUBLESHOOTING
72---------------
73
74
75
76
77
78
79
80
81
cb7abd7f 82The t/020isize Test Suite
25f0751f 83------------------------
84
85This test suite checks that IO::Compress::Zlib can cope with gzip files
86that are larger than 2^32 bytes.
87
88By default these test are NOT run when you do a "make test". If you
89really want to run them, you need to execute "make longtest".
90
91Be warned though -- this test suite can take hours to run on a slow box.
92
93Also, due to the way the tests are constructed, some architectures will
94run out of memory during this test. This should not be considered a bug
95in the IO::Compress::Zlib module.
96
97
98
99
100FEEDBACK
101--------
102
103How to report a problem with IO::Compress::Zlib.
104
105To help me help you, I need all of the following information:
106
107 1. The Versions of everything relevant.
108 This includes:
109
110 a. The *complete* output from running this
111
112 perl -V
113
114 Do not edit the output in any way.
115 Note, I want you to run "perl -V" and NOT "perl -v".
116
117 If your perl does not understand the "-V" option it is too
118 old. This module needs Perl version 5.004 or better.
119
120 b. The version of IO::Compress::Zlib you have.
121 If you have successfully installed IO::Compress::Zlib, this one-liner
122 will tell you:
123
124 perl -MIO::Compress::Zlib -e 'print qq[ver $IO::Compress::Zlib::VERSION\n]'
125
126 If you areplete* output from running this
127
128 perl -V
129
130 Do not edit the output in any way.
131 Note, I want you to run "perl -V" and NOT "perl -v".
132
133 If your perl does not understand the "-V" option it is too
134 old. This module needs Perl version 5.004 or better.
135
136 b. The version of IO::Compress::Zlib you have.
137 If you have successfully installed IO::Compress::Zlib, this one-liner
138 will tell you:
139
140 perl -MIO::Compress::Zlib -e 'print qq[ver $IO::Compress::Zlib::VERSION\n]'
141
142 If you are running windows use this
143
144 perl -MIO::Compress::Zlib -e "print qq[ver $IO::Compress::Zlib::VERSION\n]"
145
146 If you haven't installed IO::Compress::Zlib then search IO::Compress::Zlib.pm
147 for a line like this:
148
149 $VERSION = "1.05" ;
150
151
152
153 2. If you are having problems building IO::Compress::Zlib, send me a
154 complete log of what happened. Start by unpacking the IO::Compress::Zlib
155 module into a fresh directory and keep a log of all the steps
156
157 [edit config.in, if necessary]
158 perl Makefile.PL
159 make
160 make test TEST_VERBOSE=1
161
162
163Paul Marquess <pmqs@cpan.org>