[urisagit/Perl-Docs.git] / README

File::Slurp.pm version 0.04
===========================

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 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.

Since then, I discovered and fixed a bug in the original module's test
script (which had only 7 tests), which is included now as t/original.t.
This module now has 164 tests in 7 test scripts, and passes on Windows,
Linux, Solaris and Mac OS X.

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) 2003 Uri Guttman <uri@stemsystems.com>

Licensed the same as Perl.
Commit	Line	Data
635c7876	1	File::Slurp.pm version 0.04
	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.
	11
	12	This module was first written and owned by David Muir Sharnoff (MUIR on
	13	CPAN). I checked out his module and decided to write a new version
	14	which would be faster, and with many more features. To that end, David
	15	graciously transfered the namespace to me.
	16
	17	Since then, I discovered and fixed a bug in the original module's test
	18	script (which had only 7 tests), which is included now as t/original.t.
	19	This module now has 164 tests in 7 test scripts, and passes on Windows,
	20	Linux, Solaris and Mac OS X.
	21
	22	There have been some comments about the somewhat unusual version number.
	23	The problem was that David used a future date (2004.0904) in his version
	24	number, and the only way I could get CPAN to index my new module was to
	25	make it have a version number higher than the old one, so I chose the
	26	9999 prefix and appended the real revision number to it.
	27
	28	INSTALLATION
	29
	30	To install this module type the following:
	31
	32	perl Makefile.PL
	33	make
	34	make test
	35	make install
	36
	37	COPYRIGHT AND LICENCE
	38
	39	Copyright (C) 2003 Uri Guttman <uri@stemsystems.com>
	40
	41	Licensed the same as Perl.