README for File::Find::Rule 0.22
=head1 NAME
File::Find::Rule - Alternative interface to File::Find
=head1 SYNOPSIS
use File::Find::Rule;
# find all the subdirectories of a given directory
my @subdirs = File::Find::Rule->directory->in( $directory );
# find all the .pm files in @INC
my @files = File::Find::Rule->file()
->name( '*.pm' )
->in( @INC );
# as above, but without method chaining
my $rule = File::Find::Rule->new;
$rule->file;
$rule->name( '*.pm' );
my @files = $rule->in( @INC );
=head1 DEPENDENCIES
This module has external dependencies on the following modules:
Cwd
File::Find
File::Spec
Number::Compare
Test::More
Text::Glob
=head1 INSTALLATION
perl Build.PL
perl Build test
and if all goes well
perl Build install
=head1 HISTORY
What changed over the last 3 revisions
=over
=item 0.22 Friday 3rd October, 2003
add in ->extras hash for passing things through to File::Find::find
=item 0.21 Monday 15th September, 2003
pod glitch in File::Find::Rule::Procedural spotted and fixed
by Tom Hukins
=item 0.20 8th September, 2003
- relative flag
- Fix maxdepth? - this is undertested.
- MANIFEST fixes (thanks to the cpan smokers)
- split the documentation of the procedural interface out to
File::Find::Rule::Procedural, as people often seem to get
confused that the method calls don't take anonymous arrays
after seeing the procedural code that did
- Chunky internal restructure. Now we compile a match sub
from code fragments. Though more complex, this is a big
speed win as it eliminates a lot of the subroutine dispatch.
- During the restructure we lost the ->test method. I hope
that it's not missed, since maintining it through a
deprecation cycle would be fiddly with the current _compile code.
- Split the findrule tests into their own file, and just skip
the tricky ones on Win32.
=back
=head1 AUTHOR
Richard Clamp <richardc@unixbeard.net> with input gained from this
use.perl discussion: http://use.perl.org/~richardc/journal/6467
Additional proofreading and input provided by Kake, Greg McCarroll,
and Andy Lester andy@petdance.com.
=head1 COPYRIGHT
Copyright (C) 2002,2003 Richard Clamp. All Rights Reserved.
This module is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
=head1 SEE ALSO
L<File::Find>, L<Text::Glob>, L<Number::Compare>, find(1)
If you want to know about the procedural interface, see
L<File::Find::Rule::Procedural>, and if you have an idea for a neat
extension L<File::Find::Rule::Extending>