1
2                            IO-Compress
3
4                           Version 2.101
5
6                          20 Feburary 2021
7
8        Copyright (c) 1995-2021 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
12DESCRIPTION
13-----------
14
15This distribution provides a Perl interface to allow reading and writing of
16compressed data created with the zlib and bzip2.
17
18IO-Compress supports reading and writing of the following compressed data formats
19  * bzip2
20  * RFC 1950
21  * RFC 1951
22  * RFC 1952 (i.e. gzip)
23  * zip
24
25There are a number of companion modules for IO-Compress that extend
26the suite of compression formats available.
27
28 * IO-Compress-Zstd
29   Adds support for zstd (Zstandard).
30 * IO-Compress-Lzma
31   Adds support for lzma, xz and lzip.
32 * IO-Compress-Lzf
33   Adds support for lzf.
34 * IO-Compress-Lzop
35   Adds support for lzop.
36
37Note that the following modules used to be distributed separately, but are now
38included with the IO-Compress distribution.
39
40    Compress-Zlib
41    IO-Compress-Zlib
42    IO-Compress-Bzip2
43    IO-Compress-Base
44
45PREREQUISITES
46-------------
47
48Before you can build IO-Compress you need to have the following
49installed on your system:
50
51    * Perl 5.006 or better.
52    * Compress::Raw::Zlib
53    * Compress::Raw::Bzip2
54
55BUILDING THE MODULE
56-------------------
57
58Assuming you have met all the prerequisites, the module can now be built
59using this sequence of commands:
60
61    perl Makefile.PL
62    make
63    make test
64
65INSTALLATION
66------------
67
68To install IO-Compress, run the command below:
69
70    make install
71
72TROUBLESHOOTING
73---------------
74
75SUPPORT
76-------
77
78General feedback/questions/bug reports should be sent to
79https://github.com/pmqs/IO-Compress/issues (preferred) or
80https://rt.cpan.org/Public/Dist/Display.html?Name=IO-Compress.
81
82FEEDBACK
83--------
84
85How to report a problem with IO-Compress.
86
87To help me help you, I need all of the following information:
88
89 1. The Versions of everything relevant.
90    This includes:
91
92     a. The *complete* output from running this
93
94            perl -V
95
96        Do not edit the output in any way.
97        Note, I want you to run "perl -V" and NOT "perl -v".
98
99        If your perl does not understand the "-V" option it is too
100        old. This module needs Perl version 5.004 or better.
101
102     b. The version of IO-Compress you have.
103        If you have successfully installed IO-Compress, this one-liner
104        will tell you:
105
106           perl -MIO::Compress::Gzip -e 'print qq[ver $IO::Compress::Gzip::VERSION\n]'
107
108        If you are  running windows use this
109
110           perl -MIO::Compress::Gzip -e "print qq[ver $IO::Compress::Gzip::VERSION\n]"
111
112        If you haven't installed IO-Compress then search IO::Compress::Gzip.pm
113        for a line like this:
114
115          $VERSION = "2.101" ;
116
117 2. If you are having problems building IO-Compress, send me a
118    complete log of what happened. Start by unpacking the IO-Compress
119    module into a fresh directory and keep a log of all the steps
120
121        [edit config.in, if necessary]
122        perl Makefile.PL
123        make
124        make test TEST_VERBOSE=1
125
126Paul Marquess <pmqs@cpan.org>
127