Escape "-" in SYNOPSIS. Thanks to Bas van Gompel for noticing this
[findutils.git] / README
blobf23736e75b99b0c7120c4d40a50b12413b56eb27
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 (with the
3 exception of the "+" modifier for the "-exec" action, which isn't
4 implemented yet).  They also support a large number of additional
5 options, some borrowed from Unix and some unique to GNU.
7 See the file NEWS for a list of major changes in the current release.
9 See the file INSTALL for compilation and installation instructions.
11 Special configure options:
13 --with-afs
14   Make find support "-fstype afs".  Requires /afs, /usr/afsws/lib, and
15 /usr/afsws/include.  configure doesn't add AFS support
16 automatically because it adds considerably to find's size, and the
17 AFS libraries need -lucb on Solaris, which breaks find.
19 --enable-id-cache
20   Make tables of used UIDs and GIDs at startup instead of using
21 getpwuid or getgrgid when needed.  Speeds up -nouser and -nogroup
22 unless you are running NIS or Hesiod, which make password and group
23 calls very expensive.
25 --enable-debug
26   Produce output on the standard error output indicating what find is
27 doing.  This information includes details about how the command line
28 has been parsed and what files have been stat()ed.  This output is
29 normally interesting only to the maintainer, and so is off by default.
32 To gain speed, GNU find avoids statting files whenever possible.
33 It does this by:
34 1. Checking the number of links to directories and not statting files
35 that it knows aren't directories until it encounters a test or action
36 that needs the stat info.
37 2.  Rearranging the command line, where possible, so that it can do tests
38 that don't require a stat before tests that do, in hopes that the
39 latter will be skipped because of an OR or AND.  (But it only does
40 this where it will leave the output unchanged.)
42 The locate program and its helper programs are derived (heavily
43 modified) from James Woods' public domain fast-find code, which is
44 also distributed with the 4.3BSD find.  Because POSIX.2 requires `find
45 foo' to have the same effect as `find foo -print', the fast-find
46 searching has been moved to a separate program, `locate'; the same
47 thing has been done in 4.4BSD.  If you use locate, you should run the
48 included `updatedb' script from cron periodically (typically nightly).
50 Mail suggestions and bug reports for these programs to
51 bug-findutils@gnu.org.