This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
[PATCH] *-Compress-* 2.020
[perl5.git] / ext / IO-Compress / README
CommitLineData
25f0751f 1
80b215cb 2 IO-Compress
25f0751f 3
dcfdccf9 4 Version 2.020
25f0751f 5
dcfdccf9 6 3rd June 2009
25f0751f 7
319fab50 8 Copyright (c) 1995-2009 Paul Marquess. All rights reserved.
25f0751f
PM
9 This program is free software; you can redistribute it
10 and/or modify it under the same terms as Perl itself.
11
25f0751f
PM
12DESCRIPTION
13-----------
14
319fab50 15This distribution provides a Perl interface to allow reading and writing of
dc82791d 16compressed data created with the zlib and bzip2 libraries.
319fab50 17
dc82791d
PM
18IO-Compress supports reading and writing of bzip2, RFC 1950, RFC
191951, RFC 1952 (i.e. gzip) and zip files/buffers.
20
21The following modules used to be distributed separately, but are now
22included with the IO-Compress distribution.
23
24 Compress-Zlib
25 IO-Compress-Zlib
26 IO-Compress-Bzip2
27 IO-Compress-Base
25f0751f 28
25f0751f
PM
29PREREQUISITES
30-------------
31
319fab50 32Before you can build IO-Compress you need to have the following
25f0751f
PM
33installed on your system:
34
25f0751f 35 * Perl 5.004 or better.
319fab50
PM
36 * Compress::Raw::Zlib
37 * Compress::Raw::Bzip2
25f0751f 38
25f0751f
PM
39BUILDING THE MODULE
40-------------------
41
42Assuming you have met all the prerequisites, the module can now be built
43using this sequence of commands:
44
45 perl Makefile.PL
46 make
47 make test
48
25f0751f
PM
49INSTALLATION
50------------
51
319fab50 52To install IO-Compress, run the command below:
25f0751f
PM
53
54 make install
55
25f0751f
PM
56TROUBLESHOOTING
57---------------
58
25f0751f
PM
59FEEDBACK
60--------
61
319fab50 62How to report a problem with IO-Compress.
25f0751f
PM
63
64To help me help you, I need all of the following information:
65
66 1. The Versions of everything relevant.
67 This includes:
68
69 a. The *complete* output from running this
70
71 perl -V
72
73 Do not edit the output in any way.
74 Note, I want you to run "perl -V" and NOT "perl -v".
75
76 If your perl does not understand the "-V" option it is too
77 old. This module needs Perl version 5.004 or better.
78
319fab50
PM
79 b. The version of IO-Compress you have.
80 If you have successfully installed IO-Compress, this one-liner
25f0751f
PM
81 will tell you:
82
319fab50 83 perl -MIO::Compress::Gzip -e 'print qq[ver $IO::Compress::Gzip::VERSION\n]'
25f0751f
PM
84
85 If you are running windows use this
86
319fab50 87 perl -MIO::Compress::Gzip -e "print qq[ver $IO::Compress::Gzip::VERSION\n]"
25f0751f 88
319fab50 89 If you haven't installed IO-Compress then search IO::Compress::Gzip.pm
25f0751f
PM
90 for a line like this:
91
dcfdccf9 92 $VERSION = "2.020" ;
25f0751f 93
319fab50
PM
94 2. If you are having problems building IO-Compress, send me a
95 complete log of what happened. Start by unpacking the IO-Compress
25f0751f
PM
96 module into a fresh directory and keep a log of all the steps
97
98 [edit config.in, if necessary]
99 perl Makefile.PL
100 make
101 make test TEST_VERBOSE=1
102
25f0751f 103Paul Marquess <pmqs@cpan.org>