c499b178d7bd5245480edd897f7810ae91c608d1
[urisagit/Perl-Docs.git] / README
1 File::Slurp.pm
2 ===========================
3
4 This module provides subroutines to read or write entire files with a
5 simple call.  It also has a subroutine for reading the list of filenames
6 in a directory.
7
8 In the extras/ directory you can read an article (slurp_article.pod)
9 about file slurping and also run a benchmark (slurp_bench.pl) that
10 compares many ways of slurping/spewing files. This benchmark was
11 rewritten for .14 and is much better.
12
13 This module was first written and owned by David Muir Sharnoff (MUIR on
14 CPAN).  I checked out his module and decided to write a new version
15 which would be faster and with many more features.  To that end, David
16 graciously transfered the namespace to me.
17
18 There have been some comments about the somewhat unusual version number.
19 The problem was that David used a future date (2004.0904) in his version
20 number, and the only way I could get CPAN to index my new module was to
21 make it have a version number higher than the old one, so I chose the
22 9999 prefix and appended the real revision number to it.
23
24 INSTALLATION
25
26 To install this module type the following:
27
28    perl Makefile.PL
29    make
30    make test
31    make install
32
33 COPYRIGHT AND LICENCE
34
35 Copyright (C) 2010 Uri Guttman <uri@PerlHunter.com>
36
37 Licensed the same as Perl.