cvsimport
[findutils.git] / README
Commit [+]AuthorDateLineData
16808258 kevin1996-02-04 20:35:04 +00001This package contains the GNU find, xargs, and locate programs. find
38b4a963 jay2004-12-05 18:12:06 +00002and xargs comply with POSIX 1003.2, as far as I know (with the
2e4533c3 jay2004-12-05 21:15:33 +00003exception of the "+" modifier for the "-exec" action, which isn't
4implemented yet). They also support a large number of additional
38b4a963 jay2004-12-05 18:12:06 +00005options, some borrowed from Unix and some unique to GNU.
16808258 kevin1996-02-04 20:35:04 +00006
7See the file NEWS for a list of major changes in the current release.
8
9See the file INSTALL for compilation and installation instructions.
10
0404c9fb jay2005-02-27 22:04:44 +000011To verify the GPG signature of the release, you will need the public
12key of the findutils maintainer. You can download this from
13ftp://ftp.gnu.org/gnu/gnu-keyring.gpg. Alternatively, you could query
14a PGP keyserver, but you will need to use one that can cope with
15subkeys containing photos. Many older key servers cannot do this. I
16use subkeys.pgp.net. I think that one works. See also the
17"Downloading" section of http://www.gnu.org/software/findutils/.
18
16808258 kevin1996-02-04 20:35:04 +000019Special configure options:
20
21--with-afs
22 Make find support "-fstype afs". Requires /afs, /usr/afsws/lib, and
23/usr/afsws/include. configure doesn't add AFS support
24automatically because it adds considerably to find's size, and the
25AFS libraries need -lucb on Solaris, which breaks find.
26
27--enable-id-cache
28 Make tables of used UIDs and GIDs at startup instead of using
29getpwuid or getgrgid when needed. Speeds up -nouser and -nogroup
30unless you are running NIS or Hesiod, which make password and group
31calls very expensive.
32
d7e8cb24 jay2004-12-05 22:52:30 +000033--enable-debug
34 Produce output on the standard error output indicating what find is
35doing. This information includes details about how the command line
36has been parsed and what files have been stat()ed. This output is
37normally interesting only to the maintainer, and so is off by default.
38
e4a51c4d ericb2007-08-01 03:39:57 +000039DEFAULT_ARG_SIZE=<value>
40 If this environment variable is defined to a numeric expression
41during configure, it determines the default argument size limits used
42by xargs without -s, and by find, when spawning child processes.
43Otherwise, the default is set at 128 kibibytes. If the system cannot
44support the default limit, the system's limit will be used instead.
45
d7e8cb24 jay2004-12-05 22:52:30 +000046
16808258 kevin1996-02-04 20:35:04 +000047To gain speed, GNU find avoids statting files whenever possible.
48It does this by:
491. Checking the number of links to directories and not statting files
50that it knows aren't directories until it encounters a test or action
51that needs the stat info.
522. Rearranging the command line, where possible, so that it can do tests
53that don't require a stat before tests that do, in hopes that the
54latter will be skipped because of an OR or AND. (But it only does
55this where it will leave the output unchanged.)
56
57The locate program and its helper programs are derived (heavily
58modified) from James Woods' public domain fast-find code, which is
59also distributed with the 4.3BSD find. Because POSIX.2 requires `find
60foo' to have the same effect as `find foo -print', the fast-find
61searching has been moved to a separate program, `locate'; the same
62thing has been done in 4.4BSD. If you use locate, you should run the
63included `updatedb' script from cron periodically (typically nightly).
64
16808258 kevin1996-02-04 20:35:04 +000065Mail suggestions and bug reports for these programs to
82010e31 kevind2000-01-18 08:53:24 +000066bug-findutils@gnu.org.