README
1FileHandle::Unget - A FileHandle which supports ungetting of multiple bytes
2
3FileHandle::Unget is a drop-in replacement for FileHandle which allows more
4than one byte to be placed back on the input. It supports an ungetc(ORD) which
5can be called more than once in a row, and an ungets(SCALAR) which places a
6string of bytes back on the input.
7
8
9MODULE DEPENDENCIES
10
11To use this module, you will need to install:
12
13- Scalar::Util
14
15To test this module, you will need to install:
16
17- Test::More
18- File::Spec
19
20
21INSTALLATION
22
23To install this package, change to the directory where you unarchived this
24distribution and type the following:
25
26 perl Makefile.PL
27 make
28 make test
29 make install
30
31You can install this package into a non-default location by appending one of
32the following to the "perl Makefile.PL" command:
33
34- "PREFIX=/installation/path" (for installation into a custom location),
35- "INSTALLDIRS=site" (for installation into site-specific Perl directories)
36- "INSTALLDIRS=perl" (for installation into standard Perl directories).
37
38If you make the installation into your own directory, then remember that you
39must tell perl where to search for modules before trying to 'use' them. For
40example:
41
42 use lib '/home/userid/lib';
43 use FileHandle::Unget;
44
45If make test fails, please see the INSTALLATION PROBLEMS section below.
46
47
48INSTALLATION PROBLEMS
49
50If you get warnings about weak references not being implemented in your
51version of Perl, try upgrading your installation of Scalar::Util.
52
53If "make test" fails, run
54
55 make test TEST_VERBOSE=1
56
57and see which test(s) are failing. Please email the results to the address
58below, or submit a bug report on the project website as described in the
59section REPORTING BUGS below.
60
61For other bugs, see the section REPORTING BUGS below.
62
63
64SECURITY NOTE
65
66On Windows, this module will use a temporary file to decompress a file handle
67when necessary. This could pose a security risk.
68
69
70DOCUMENTATION
71
72Just "perldoc FileHandle::Unget". After installation on Unix systems,
73you can also do "man FileHandle::Unget".
74
75
76RESOURCES
77
78The CPAN Page:
79http://search.cpan.org/dist/FileHandle-Unget/
80
81The GitHub page:
82https://github.com/coppit/filehandle-unget/
83
84Bug and feature tracking:
85http://rt.cpan.org/Public/Dist/Display.html?Name=FileHandle-Unget
86
87
88COPYRIGHT
89
90Copyright (c) 1998-Sep 1 2000 Broc Seib. Copyright (c) Sep 1 2000-2015 David
91Coppit. All rights reserved, save those granted by the license. See the file
92LICENSE for licensing terms.
93
94
95AUTHOR
96
97David Coppit <david@coppit.org>
98