summaryrefslogtreecommitdiff
path: root/cpan/IO-Compress/README
blob: 6ce4705ffb482257f17d5bf5f2d921e66fbc57fe (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103

                             IO-Compress

                             Version 2.040

                             28th october 2011

       Copyright (c) 1995-2011 Paul Marquess. All rights reserved.
          This program is free software; you can redistribute it
           and/or modify it under the same terms as Perl itself.

DESCRIPTION
-----------

This distribution provides a Perl interface to allow reading and writing of
compressed data created with the zlib and bzip2 libraries.

IO-Compress supports reading and writing of bzip2, RFC 1950, RFC
1951, RFC 1952 (i.e. gzip) and zip files/buffers.

The following modules used to be distributed separately, but are now
included with the IO-Compress distribution.

    Compress-Zlib
    IO-Compress-Zlib
    IO-Compress-Bzip2
    IO-Compress-Base

PREREQUISITES
-------------

Before you can build IO-Compress you need to have the following
installed on your system:

    * Perl 5.004 or better. 
    * Compress::Raw::Zlib
    * Compress::Raw::Bzip2

BUILDING THE MODULE
-------------------

Assuming you have met all the prerequisites, the module can now be built
using this sequence of commands:

    perl Makefile.PL
    make
    make test

INSTALLATION
------------

To install IO-Compress, run the command below:

    make install

TROUBLESHOOTING
---------------

FEEDBACK
--------

How to report a problem with IO-Compress.

To help me help you, I need all of the following information:

 1. The Versions of everything relevant.
    This includes:

     a. The *complete* output from running this
     
            perl -V
     
        Do not edit the output in any way.
        Note, I want you to run "perl -V" and NOT "perl -v".
     
        If your perl does not understand the "-V" option it is too
        old. This module needs Perl version 5.004 or better.     

     b. The version of IO-Compress you have. 
        If you have successfully installed IO-Compress, this one-liner
        will tell you:

           perl -MIO::Compress::Gzip -e 'print qq[ver $IO::Compress::Gzip::VERSION\n]'

        If you are  running windows use this

           perl -MIO::Compress::Gzip -e "print qq[ver $IO::Compress::Gzip::VERSION\n]"

        If you haven't installed IO-Compress then search IO::Compress::Gzip.pm
        for a line like this:

          $VERSION = "2.040" ;

 2. If you are having problems building IO-Compress, send me a
    complete log of what happened. Start by unpacking the IO-Compress
    module into a fresh directory and keep a log of all the steps

        [edit config.in, if necessary]
        perl Makefile.PL
        make
        make test TEST_VERBOSE=1          

Paul Marquess <pmqs@cpan.org>