ext/Compress/IO/Base/README

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