1e557c97e67f73322c9e7b8dbf14cd0a10dfa378
[p5sagit/p5-mst-13.2.git] / ext / IO_Compress_Base / README
1
2                              IO::Compress::Base
3
4                              Version 2.004
5
6                               3rd March 2007
7
8
9        Copyright (c) 2005-2007 Paul Marquess. All rights reserved.
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
16 DESCRIPTION
17 -----------
18
19
20 This module is the base class for all IO::Compress and IO::Uncompress
21 modules.
22
23
24
25
26
27 PREREQUISITES
28 -------------
29
30 Before you can build IO::Compress::Base you need to have the following
31 installed on your system:
32
33
34     * Perl 5.004 or better. 
35
36
37
38
39
40 BUILDING THE MODULE
41 -------------------
42
43 Assuming you have met all the prerequisites, the module can now be built
44 using this sequence of commands:
45
46     perl Makefile.PL
47     make
48     make test
49
50
51
52 INSTALLATION
53 ------------
54
55 To install IO::Compress::Base, run the command below:
56
57     make install
58
59
60
61
62
63 TROUBLESHOOTING
64 ---------------
65
66
67
68
69
70
71
72
73
74
75
76
77 FEEDBACK
78 --------
79
80 How to report a problem with IO::Compress::Base.
81
82 To help me help you, I need all of the following information:
83
84  1. The Versions of everything relevant.
85     This includes:
86
87      a. The *complete* output from running this
88      
89             perl -V
90      
91         Do not edit the output in any way.
92         Note, I want you to run "perl -V" and NOT "perl -v".
93      
94         If your perl does not understand the "-V" option it is too
95         old. This module needs Perl version 5.004 or better.     
96
97      b. The version of IO::Compress::Base you have. 
98         If you have successfully installed IO::Compress::Base, this one-liner
99         will tell you:
100
101            perl -MIO::Compress::Base -e 'print qq[ver $IO::Compress::Base::VERSION\n]'
102
103         If you areplete* output from running this
104      
105             perl -V
106      
107         Do not edit the output in any way.
108         Note, I want you to run "perl -V" and NOT "perl -v".
109      
110         If your perl does not understand the "-V" option it is too
111         old. This module needs Perl version 5.004 or better.     
112
113      b. The version of IO::Compress::Base you have. 
114         If you have successfully installed IO::Compress::Base, this one-liner
115         will tell you:
116
117            perl -MIO::Compress::Base -e 'print qq[ver $IO::Compress::Base::VERSION\n]'
118
119         If you are  running windows use this
120
121            perl -MIO::Compress::Base -e "print qq[ver $IO::Compress::Base::VERSION\n]"
122
123         If you haven't installed IO::Compress::Base then search IO::Compress::Base.pm
124         for a line like this:
125
126           $VERSION = "1.05" ;
127
128
129
130  2. If you are having problems building IO::Compress::Base, send me a
131     complete log of what happened. Start by unpacking the IO::Compress::Base
132     module into a fresh directory and keep a log of all the steps
133
134         [edit config.in, if necessary]
135         perl Makefile.PL
136         make
137         make test TEST_VERBOSE=1          
138
139
140 Paul Marquess <pmqs@cpan.org>