Brought up to date.
[findutils.git] / README
blobfcc12d170e8910df0e3941d040c1731016ce06d9
1 This package contains the GNU find, xargs, and locate programs.  find
2 and xargs comply with POSIX 1003.2, as far as I know.  They also
3 support some additional options, some borrowed from Unix and some
4 unique to GNU.
6 See the file NEWS for a list of major changes in the current release.
8 See the file INSTALL for compilation and installation instructions.
10 Special configure options:
12 --with-afs
13   Make find support "-fstype afs".  Requires /afs, /usr/afsws/lib, and
14 /usr/afsws/include.  configure doesn't add AFS support
15 automatically because it adds considerably to find's size, and the
16 AFS libraries need -lucb on Solaris, which breaks find.
18 --enable-id-cache
19   Make tables of used UIDs and GIDs at startup instead of using
20 getpwuid or getgrgid when needed.  Speeds up -nouser and -nogroup
21 unless you are running NIS or Hesiod, which make password and group
22 calls very expensive.
24 To gain speed, GNU find avoids statting files whenever possible.
25 It does this by:
26 1. Checking the number of links to directories and not statting files
27 that it knows aren't directories until it encounters a test or action
28 that needs the stat info.
29 2.  Rearranging the command line, where possible, so that it can do tests
30 that don't require a stat before tests that do, in hopes that the
31 latter will be skipped because of an OR or AND.  (But it only does
32 this where it will leave the output unchanged.)
34 The locate program and its helper programs are derived (heavily
35 modified) from James Woods' public domain fast-find code, which is
36 also distributed with the 4.3BSD find.  Because POSIX.2 requires `find
37 foo' to have the same effect as `find foo -print', the fast-find
38 searching has been moved to a separate program, `locate'; the same
39 thing has been done in 4.4BSD.  If you use locate, you should run the
40 included `updatedb' script from cron periodically (typically nightly).
42 The `Makefile.am' files are used by an experimental program called
43 AutoMake that is under development.  It's not ready for general use
44 yet, so don't worry about them.
46 Mail suggestions and bug reports for these programs to
47 bug-findutils@gnu.org.