Contents

= Description
This is a drop-in replacement for the find module currently in the standard
library. It is modeled on a typical 'find' command found on most Unix systems.

= Synopsis
   rule = File::Find.new(
      :name    => "*.rb",
      :follow  => false,
      :path    => ['/usr/local/lib', '/opt/local/lib']
   )

   rule.find{ |f|
      puts f
   }

= Installation
rake test (optional)
rake install (non-gem) or rake install_gem (gem)

= Rationale
The current find module in the standard library is inadequate. It is, quite
frankly, not much more than a plain Dir.glob call. This package provides an
interface based on options typically available on your command line 'find'
command, thus allowing you much greater control over how you find your files.

I am aware of the find2 package by Motoyuki Kasahara, but it supports very
few options, hasn't been updated in over six years and isn't packaged properly.

= Options
* atime
* ctime
* follow
* ftype
* inum
* group
* name
* path
* size
* user

See the RDoc documentation for more details about these options.

= Future Plans
More options will be added as time permits, and requests will definitely be
considered. Please log any feature requests on the project page at
http://www.rubyforge.org/projects/shards.

Some specific things I plan on adding:

* Support for limiting depth.
* Greater flexibility with the size option (and perhaps others).

= Bugs
None that I'm aware of. Please log any bug reports on the project page at
http://www.rubyforge.org/projects/shards.

= License
Ruby's

= Copyright
(C) 2007, Daniel J. Berger, All Rights Reserved

= Author
Daniel J. Berger

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
file-find-0.1.0	README
file-find-0.1.1	README