README in file-find-0.2.0 vs README in file-find-0.2.1
- old
+ new
@@ -2,22 +2,22 @@
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",
+ :pattern => "*.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)
+* 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'
@@ -29,15 +29,15 @@
= Options
* atime
* ctime
* follow
* ftype
-* inum
+* inum (except Windows)
* group
-* name
+* name (or 'pattern')
* path
-* perm
+* perm (except Windows)
* prune
* size
* user
See the RDoc documentation for more details about these options.
@@ -50,30 +50,35 @@
Some specific things I plan on adding:
* exec
* links
-= Options that I won't support
+= Options I won't support
Generally speaking, anything that would require mucking around with C code
or is just too difficult to implement in a cross platform manner will not be
supported. These include the following options:
-* acl/xattr - Way to difficult to implement in a cross platform manner, and a
- rarely used option to boot.
+* acl/xattr - Way too difficult to implement in a cross platform manner, and
+ a rarely used option to boot.
* cpio/ncpio - You can shell out on your own if you want, but I'm not going to
- do it for you. The same goes for any similar options that your particular
- platform may support.
+ do it for you. The same goes for any similar options for 3rd party apps that
+ your particular platform may support.
* ls/print - You can print file names as you see fit on your own. This isn't
a shell command replacement.
* ok - This is not interactive software.
= Options I may or may not support
-* local/mount/xdev - This will probably not be added until I'm satisified with
+* local/mount/xdev - This will probably not be added until I'm satisfied with
the sys-filesystem package.
+
+= Known Issues
+The 'perm' option does not work on MS Windows, even for its limited subset of
+permissions, i.e. 664 and 666. This is arguably a bug in Ruby's
+File::Stat.mode method on MS Windows.
= Bugs
None that I'm aware of. Please log any bug reports on the project page at
http://www.rubyforge.org/projects/shards.