[urisagit/Perl-Docs.git] / README

File::Slurp.pm
===========================

This module provides subroutines to read or write entire files with a
simple call.  It also has a subroutine for reading the list of filenames
in a directory.

In the extras/ directory you can read an article (slurp_article.pod)
about file slurping and also run a benchmark (slurp_bench.pl) that
compares many ways of slurping/spewing files. This benchmark was
rewritten for .14 and is much better.

This module was first written and owned by David Muir Sharnoff (MUIR on
CPAN).  I checked out his module and decided to write a new version
which would be faster and with many more features.  To that end, David
graciously transfered the namespace to me.

There have been some comments about the somewhat unusual version number.
The problem was that David used a future date (2004.0904) in his version
number, and the only way I could get CPAN to index my new module was to
make it have a version number higher than the old one, so I chose the
9999 prefix and appended the real revision number to it.

INSTALLATION

To install this module type the following:

   perl Makefile.PL
   make
   make test
   make install

COPYRIGHT AND LICENCE

Copyright (C) 2010 Uri Guttman <uri@PerlHunter.com>

Licensed the same as Perl.
Commit	Line	Data
99916a19	1	File::Slurp.pm
635c7876	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
99916a19	10	compares many ways of slurping/spewing files. This benchmark was
99916a19	11	rewritten for .14 and is much better.
635c7876	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
99916a19	15	which would be faster and with many more features. To that end, David
635c7876	16	graciously transfered the namespace to me.
635c7876	17
635c7876	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
99916a19	35	Copyright (C) 2010 Uri Guttman <uri@PerlHunter.com>
635c7876	36
635c7876	37	Licensed the same as Perl.