summaryrefslogtreecommitdiff
path: root/ext/IO_Compress_Zlib/README
blob: 2622fa003b19c96a9dba3998be23e5b946686802 (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
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157

                             IO::Compress::Zlib

                             Version 2.005

                              18th June 2007


       Copyright (c) 2005-2007 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 module provides a Perl interface to allow reading and writing of RFC
1950, 1951, 1952 (i.e. gzip) and zip files/buffers.





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

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


    * Perl 5.004 or better. 
    * Compress::Raw::Zlib
    * IO::Compress::Base





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::Zlib, run the command below:

    make install





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









The t/020isize Test Suite
------------------------

This test suite checks that IO::Compress::Zlib can cope with gzip files
that are larger than 2^32 bytes.

By default these test are NOT run when you do a "make test". If you
really want to run them, you need to execute "make longtest".

Be warned though -- this test suite can take hours to run on a slow box.

Also, due to the way the tests are constructed, some architectures will
run out of memory during this test. This should not be considered a bug
in the IO::Compress::Zlib module.




FEEDBACK
--------

How to report a problem with IO::Compress::Zlib.

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::Zlib you have. 
        If you have successfully installed IO::Compress::Zlib, this one-liner
        will tell you:

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

        If you areplete* 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::Zlib you have. 
        If you have successfully installed IO::Compress::Zlib, this one-liner
        will tell you:

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

        If you are  running windows use this

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

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

          $VERSION = "1.05" ;



 2. If you are having problems building IO::Compress::Zlib, send me a
    complete log of what happened. Start by unpacking the IO::Compress::Zlib
    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>