This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Upgrade to Encode-2.26
[perl5.git] / ext / IO_Compress_Base / README
CommitLineData
25f0751f 1
80e5fcd6 2 IO-Compress-Base
25f0751f 3
a1787f24 4 Version 2.011
25f0751f 5
a1787f24 6 17th May 2008
25f0751f 7
d54256af 8 Copyright (c) 2005-2008 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
cb7abd7f 15This module is the base class for all IO::Compress and IO::Uncompress
25f0751f
PM
16modules.
17
25f0751f
PM
18PREREQUISITES
19-------------
20
80e5fcd6 21Before you can build IO-Compress-Base you need to have the following
25f0751f
PM
22installed on your system:
23
25f0751f
PM
24 * Perl 5.004 or better.
25
25f0751f
PM
26BUILDING THE MODULE
27-------------------
28
29Assuming you have met all the prerequisites, the module can now be built
30using this sequence of commands:
31
32 perl Makefile.PL
33 make
34 make test
35
25f0751f
PM
36INSTALLATION
37------------
38
80e5fcd6 39To install IO-Compress-Base, run the command below:
25f0751f
PM
40
41 make install
42
25f0751f
PM
43TROUBLESHOOTING
44---------------
45
25f0751f
PM
46FEEDBACK
47--------
48
80e5fcd6 49How to report a problem with IO-Compress-Base.
25f0751f
PM
50
51To help me help you, I need all of the following information:
52
53 1. The Versions of everything relevant.
54 This includes:
55
56 a. The *complete* output from running this
57
58 perl -V
59
60 Do not edit the output in any way.
61 Note, I want you to run "perl -V" and NOT "perl -v".
62
63 If your perl does not understand the "-V" option it is too
64 old. This module needs Perl version 5.004 or better.
65
80e5fcd6
PM
66 b. The version of IO-Compress-Base you have.
67 If you have successfully installed IO-Compress-Base, this one-liner
25f0751f
PM
68 will tell you:
69
70 perl -MIO::Compress::Base -e 'print qq[ver $IO::Compress::Base::VERSION\n]'
71
72 If you are running windows use this
73
74 perl -MIO::Compress::Base -e "print qq[ver $IO::Compress::Base::VERSION\n]"
75
80e5fcd6 76 If you haven't installed IO-Compress-Base then search IO::Compress::Base.pm
25f0751f
PM
77 for a line like this:
78
a1787f24 79 $VERSION = "2.011" ;
25f0751f 80
80e5fcd6
PM
81 2. If you are having problems building IO-Compress-Base, send me a
82 complete log of what happened. Start by unpacking the IO-Compress-Base
25f0751f
PM
83 module into a fresh directory and keep a log of all the steps
84
85 [edit config.in, if necessary]
86 perl Makefile.PL
87 make
88 make test TEST_VERBOSE=1
89
25f0751f 90Paul Marquess <pmqs@cpan.org>