[p5sagit/p5-mst-13.2.git] / ext / IO_Compress_Zlib / README


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