Blame README

Packit 26bf30
README for File::Find::Object::Rule
Packit 26bf30
Packit 26bf30
=head1 NAME
Packit 26bf30
Packit 26bf30
File::Find::Object::Rule - Alternative interface to File::Find::Object
Packit 26bf30
Packit 26bf30
=head1 SYNOPSIS
Packit 26bf30
Packit 26bf30
  use File::Find::Object::Rule;
Packit 26bf30
  # find all the subdirectories of a given directory
Packit 26bf30
  my @subdirs = File::Find::Object::Rule->directory->in( $directory );
Packit 26bf30
Packit 26bf30
  # find all the .pm files in @INC
Packit 26bf30
  my @files = File::Find::Object::Rule->file()
Packit 26bf30
                              ->name( '*.pm' )
Packit 26bf30
                              ->in( @INC );
Packit 26bf30
Packit 26bf30
  # as above, but without method chaining
Packit 26bf30
  my $rule =  File::Find::Object::Rule->new;
Packit 26bf30
  $rule->file;
Packit 26bf30
  $rule->name( '*.pm' );
Packit 26bf30
  my @files = $rule->in( @INC );
Packit 26bf30
Packit 26bf30
Packit 26bf30
=head1 DEPENDENCIES
Packit 26bf30
Packit 26bf30
This module has external dependencies on the following modules:
Packit 26bf30
Packit 26bf30
 Cwd
Packit 26bf30
 File::Find::Object
Packit 26bf30
 File::Spec
Packit 26bf30
 Number::Compare
Packit 26bf30
 Test::More
Packit 26bf30
 Text::Glob
Packit 26bf30
Packit 26bf30
=head1 INSTALLATION
Packit 26bf30
Packit 26bf30
 perl Build.PL
Packit 26bf30
 perl Build test
Packit 26bf30
Packit 26bf30
and if all goes well
Packit 26bf30
Packit 26bf30
 perl Build install
Packit 26bf30
Packit 26bf30
=head1 AUTHOR
Packit 26bf30
Packit 26bf30
=head2 File::Find::Rule
Packit 26bf30
Packit 26bf30
Richard Clamp <richardc@unixbeard.net> with input gained from this
Packit 26bf30
use.perl discussion: http://use.perl.org/~richardc/journal/6467
Packit 26bf30
Packit 26bf30
Additional proofreading and input provided by Kake, Greg McCarroll,
Packit 26bf30
and Andy Lester andy@petdance.com.
Packit 26bf30
Packit 26bf30
=head2 File::Find::Object::Rule
Packit 26bf30
Packit 26bf30
Shlomi Fish converted the code to use L<File::Find::Object> instead. All
Packit 26bf30
copyrights disclaimed.
Packit 26bf30
Packit 26bf30
=head1 COPYRIGHT
Packit 26bf30
Packit 26bf30
Copyright (C) 2002, 2003, 2004, 2006 Richard Clamp.  All Rights Reserved.
Packit 26bf30
Packit 26bf30
This module is free software; you can redistribute it and/or modify it
Packit 26bf30
under the same terms as Perl itself.
Packit 26bf30
Packit 26bf30
=head1 SEE ALSO
Packit 26bf30
Packit 26bf30
L<File::Find::Object>, L<Text::Glob>, L<Number::Compare>,
Packit 26bf30
L<File::Find::Object::Rule>, find(1)
Packit 26bf30
Packit 26bf30
If you want to know about the procedural interface, see
Packit 26bf30
L<File::Find::Object::Rule::Procedural>, and if you have an idea for a neat
Packit 26bf30
extension L<File::Find::Object::Rule::Extending>
Packit 26bf30