]>
Commit | Line | Data |
---|---|---|
c980cf18 JB |
1 | --- findutils-4.2.30/doc/find.texi.orig 2007-01-13 22:14:06.000000000 +0100 |
2 | +++ findutils-4.2.30/doc/find.texi 2007-03-19 14:10:51.332801131 +0100 | |
6a9f8a7c | 3 | @@ -12,17 +12,11 @@ |
3a694787 JB |
4 | @finalout |
5 | @end iftex | |
6fcd5b1d | 6 | |
3a694787 | 7 | -@dircategory Basics |
ba3aff84 | 8 | +@dircategory Shell utilities: |
3a694787 JB |
9 | @direntry |
10 | -* Finding files: (find). Operating on files matching certain criteria. | |
6a9f8a7c JB |
11 | -@end direntry |
12 | - | |
13 | -@dircategory Individual utilities | |
14 | -@direntry | |
15 | -* find: (find)Invoking find. Finding and acting on files. | |
16 | -* locate: (find)Invoking locate. Finding files in a database. | |
17 | -* updatedb: (find)Invoking updatedb. Building the locate database. | |
18 | -* xargs: (find)Invoking xargs. Operating on many files. | |
3a694787 | 19 | +* Finding files: (find). Operating on files matching certain criteria |
6a9f8a7c JB |
20 | +* find: (find)find. Finding and acting on files |
21 | +* xargs: (find)xargs. Operating on many files | |
3a694787 | 22 | @end direntry |
6fcd5b1d | 23 | |
6a9f8a7c | 24 | @copying |
69b40b10 | 25 | @@ -2397,10 +2391,6 @@ |
6a9f8a7c JB |
26 | fileserver where that filesystem is on a local disk, to prevent |
27 | thrashing the network. | |
28 | ||
29 | -@xref{Invoking updatedb}, | |
30 | -for the description of the options to @code{updatedb}, which specify | |
31 | -which directories would each database contain entries for. | |
32 | - | |
33 | ||
34 | @node Database Formats | |
35 | @section Database Formats | |
69b40b10 | 36 | @@ -2576,15 +2566,13 @@ |
6a9f8a7c JB |
37 | discussed in this manual. |
38 | ||
39 | @menu | |
40 | -* Invoking find:: | |
41 | -* Invoking locate:: | |
42 | -* Invoking updatedb:: | |
43 | -* Invoking xargs:: | |
44 | +* find:: | |
45 | +* xargs:: | |
46 | * Regular Expressions:: | |
5bd4a84c | 47 | * Environment Variables:: |
6a9f8a7c JB |
48 | @end menu |
49 | ||
50 | -@node Invoking find, Invoking locate, , Reference | |
51 | +@node find, xargs, , Reference | |
52 | @section Invoking @code{find} | |
53 | ||
54 | @example | |
69b40b10 | 55 | @@ -2655,7 +2643,7 @@ |
6a9f8a7c JB |
56 | @end menu |
57 | ||
58 | ||
59 | -@node Warning Messages,,, Invoking find | |
60 | +@node Warning Messages,,, find | |
61 | @subsection Warning Messages | |
62 | ||
63 | If there is an error on the @code{find} command line, an error message | |
69b40b10 | 64 | @@ -2706,249 +2694,7 @@ |
6a9f8a7c JB |
65 | Use of an unrecognised formatting directive with @samp{-fprintf} |
66 | @end itemize | |
67 | ||
68 | -@node Invoking locate, Invoking updatedb, Invoking find, Reference | |
69 | -@section Invoking @code{locate} | |
70 | - | |
71 | -@example | |
72 | -locate @r{[}@var{option}@dots{}@r{]} @var{pattern}@dots{} | |
73 | -@end example | |
74 | - | |
75 | -For each @var{pattern} given @code{locate} searches one or more file | |
76 | -name databases returning each match of @var{pattern}. | |
77 | - | |
78 | -For each @var{pattern} given @code{locate} searches one or more file | |
79 | -name databases returning each match of @var{pattern}. | |
80 | - | |
81 | -@table @code | |
82 | -@item --all | |
83 | -@itemx -A | |
84 | -Print only names which match all non-option arguments, not those | |
85 | -matching one or more non-option arguments. | |
86 | - | |
87 | -@item --basename | |
88 | -@itemx -b | |
89 | -The specified pattern is matched against just the last component of | |
90 | -the name of a file in the @code{locate} database. This last | |
91 | -component is also called the ``base name''. For example, the base | |
92 | -name of @file{/tmp/mystuff/foo.old.c} is @file{foo.old.c}. If the | |
93 | -pattern contains metacharacters, it must match the base name exactly. | |
94 | -If not, it must match part of the base name. | |
95 | - | |
96 | -@item --count | |
97 | -@itemx -c | |
98 | -Instead of printing the matched file names, just print the total | |
99 | -number of matches found, unless @samp{--print} (@samp{-p}) is also | |
100 | -present. | |
101 | - | |
102 | - | |
103 | -@item --database=@var{path} | |
104 | -@itemx -d @var{path} | |
105 | -Instead of searching the default @code{locate} database, @code{locate} search the file | |
106 | -name databases in @var{path}, which is a colon-separated list of | |
107 | -database file names. You can also use the environment variable | |
108 | -@code{LOCATE_PATH} to set the list of database files to search. The | |
109 | -option overrides the environment variable if both are used. Empty | |
110 | -elements in @var{path} (that is, a leading or trailing colon, or two | |
111 | -colons in a row) are taken to stand for the default database. | |
112 | -A database can be supplied on stdin, using @samp{-} as an element | |
113 | -of @samp{path}. If more than one element of @samp{path} is @samp{-}, | |
114 | -later instances are ignored (but a warning message is printed). | |
115 | - | |
116 | -@item --existing | |
117 | -@itemx -e | |
118 | -Only print out such names which currently exist (instead of such names | |
119 | -which existed when the database was created). Note that this may slow | |
120 | -down the program a lot, if there are many matches in the database. | |
121 | -The way in which broken symbolic links are treated is affected by the | |
5bd4a84c JB |
122 | -@samp{-L}, @samp{-P} and @samp{-H} options. Please note that it is |
123 | -possible for the file to be deleted after @code{locate} has checked | |
124 | -that it exists, but before you use it. | |
6a9f8a7c JB |
125 | - |
126 | -@item --non-existing | |
127 | -@itemx -E | |
128 | -Only print out such names which currently do not exist (instead of | |
129 | -such names which existed when the database was created). Note that | |
130 | -this may slow down the program a lot, if there are many matches in the | |
131 | -database. The way in which broken symbolic links are treated is | |
5bd4a84c JB |
132 | -affected by the @samp{-L}, @samp{-P} and @samp{-H} options. Please |
133 | -note that @code{locate} checks that the file does not exist, but a | |
134 | -file of the same name might be created after @code{locate}'s check but | |
135 | -before you read @code{locate}'s output. | |
6a9f8a7c JB |
136 | - |
137 | -@item --follow | |
138 | -@itemx -L | |
139 | -If testing for the existence of files (with the @samp{-e} or @samp{-E} | |
140 | -options), consider broken symbolic links to be non-existing. This is | |
5bd4a84c | 141 | -the default behaviour. |
6a9f8a7c JB |
142 | - |
143 | -@item --nofollow | |
144 | -@itemx -P | |
145 | -@itemx -H | |
146 | -If testing for the existence of files (with the @samp{-e} or @samp{-E} | |
147 | -options), treat broken symbolic links as if they were existing files. | |
148 | -The @samp{-H} form of this option is provided purely for similarity | |
149 | -with @code{find}; the use of @samp{-P} is recommended over @samp{-H}. | |
150 | - | |
151 | -@item --ignore-case | |
152 | -@itemx -i | |
153 | -Ignore case distinctions in both the pattern and the file names. | |
154 | - | |
155 | -@item --limit=N | |
156 | -@itemx -l N | |
157 | -Limit the number of results printed to N. When used with the | |
158 | -@samp{--count} option, the value printed will never be larger than | |
159 | -this limit. | |
160 | - | |
161 | -@item --mmap | |
162 | -@itemx -m | |
163 | -Accepted but does nothing. The option is supported only to provide | |
164 | -compatibility with BSD's @code{locate}. | |
165 | - | |
166 | -@item --null | |
167 | -@itemx -0 | |
168 | -Results are separated with the ASCII NUL character rather than the | |
169 | -newline character. To get the full benefit of the use of this option, | |
170 | -use the new @code{locate} database format (that is the default | |
171 | -anyway). | |
172 | - | |
173 | -@item --print | |
174 | -@itemx -p | |
175 | -Print search results when they normally would not, because of the | |
176 | -presence of @samp{--statistics} (@samp{-S}) or @samp{--count} | |
177 | -(@samp{-c}). | |
178 | - | |
179 | -@item --wholename | |
180 | -@itemx -w | |
181 | -The specified pattern is matched against the whole name of the file in | |
182 | -the @code{locate} database. If the pattern contains metacharacters, | |
183 | -it must match exactly. If not, it must match part of the whole file | |
184 | -name. This is the default behaviour. | |
185 | - | |
186 | -@item --regex | |
187 | -@itemx -r | |
188 | -Instead of using substring or shell glob matching, the pattern | |
189 | -specified on the command line is understood to be a regular | |
190 | -expression. GNU Emacs-style regular expressions are assumed unless | |
191 | -the @samp{--regextype} option is also given. File names from the | |
192 | -@code{locate} database are matched using the specified regular | |
193 | -expression. If the @samp{-i} flag is also given, matching is | |
194 | -case-insensitive. Matches are performed against the whole path name, | |
195 | -and so by default a pathname will be matched if any part of it matches | |
196 | -the specified regular expression. The regular expression may use | |
197 | -@samp{^} or @samp{$} to anchor a match at the beginning or end of a | |
198 | -pathname. | |
199 | - | |
200 | -@item --regextype | |
6a9f8a7c JB |
201 | -This option changes the regular expression syntax and behaviour used |
202 | -by the @samp{--regex} option. @ref{Regular Expressions} for more | |
203 | -information on the regular expression dialects understood by GNU | |
204 | -findutils. | |
205 | - | |
206 | -@item --stdio | |
207 | -@itemx -s | |
208 | -Accepted but does nothing. The option is supported only to provide | |
209 | -compatibility with BSD's @code{locate}. | |
210 | - | |
211 | -@item --statistics | |
212 | -@itemx -S | |
213 | -Print some summary information for each @code{locate} database. No | |
69b40b10 JB |
214 | -search is performed unless non-option arguments are given. Although |
215 | -the BSD version of locate also has this option, the format of the | |
216 | -output is different. | |
6a9f8a7c JB |
217 | - |
218 | -@item --help | |
219 | -Print a summary of the command line usage for @code{locate} and exit. | |
220 | - | |
221 | -@item --version | |
222 | -Print the version number of @code{locate} and exit. | |
223 | -@end table | |
224 | - | |
225 | -@node Invoking updatedb, Invoking xargs, Invoking locate, Reference | |
226 | -@section Invoking @code{updatedb} | |
227 | - | |
228 | -@example | |
229 | -updatedb @r{[}@var{option}@dots{}@r{]} | |
230 | -@end example | |
231 | - | |
232 | -@code{updatedb} creates and updates the database of file names used by | |
233 | -@code{locate}. @code{updatedb} generates a list of files similar to | |
234 | -the output of @code{find} and then uses utilities for optimizing the | |
235 | -database for performance. @code{updatedb} is often run periodically | |
236 | -as a @code{cron} job and configured with environment variables or | |
237 | -command options. Typically, operating systems have a shell script | |
238 | -that ``exports'' configurations for variable definitions and uses | |
c980cf18 | 239 | -another shell script that ``sources'' the configuration file into the |
6a9f8a7c JB |
240 | -environment and then executes @code{updatedb} in the environment. |
241 | - | |
242 | -@code{updatedb} creates and updates the database of file names used by | |
243 | -@code{locate}. @code{updatedb} generates a list of files similar to | |
244 | -the output of @code{find} and then uses utilities for optimizing the | |
245 | -database for performance. @code{updatedb} is often run periodically | |
246 | -as a @code{cron} job and configured with environment variables or | |
247 | -command options. Typically, operating systems have a shell script | |
248 | -that ``exports'' configurations for variable definitions and uses | |
c980cf18 | 249 | -another shell script that ``sources'' the configuration file into the |
6a9f8a7c JB |
250 | -environment and then executes @code{updatedb} in the environment. |
251 | - | |
252 | -@table @code | |
253 | -@item --findoptions='@var{OPTION}@dots{}' | |
254 | -Global options to pass on to @code{find}. | |
255 | -The environment variable @code{FINDOPTIONS} also sets this value. | |
256 | -Default is none. | |
257 | - | |
258 | -@item --localpaths='@var{path}@dots{}' | |
259 | -Non-network directories to put in the database. | |
260 | -Default is @file{/}. | |
261 | - | |
262 | -@item --netpaths='@var{path}@dots{}' | |
263 | -Network (NFS, AFS, RFS, etc.) directories to put in the database. | |
264 | -The environment variable @code{NETPATHS} also sets this value. | |
265 | -Default is none. | |
266 | - | |
267 | -@item --prunepaths='@var{path}@dots{}' | |
268 | -Directories to omit from the database, which would otherwise be | |
269 | -included. The environment variable @code{PRUNEPATHS} also sets this | |
270 | -value. Default is @file{/tmp /usr/tmp /var/tmp /afs}. The paths are | |
271 | -used as regular expressions (with @code{find ... -regex}, so you need | |
272 | -to specify these paths in the same way that @code{find} will encounter | |
273 | -them. This means for example that the paths must not include trailing | |
274 | -slashes. | |
275 | - | |
276 | -@item --prunefs='@var{path}@dots{}' | |
277 | -Filesystems to omit from the database, which would otherwise be | |
278 | -included. Note that files are pruned when a filesystem is reached; | |
279 | -Any filesystem mounted under an undesired filesystem will be ignored. | |
280 | -The environment variable @code{PRUNEFS} also sets this value. Default | |
281 | -is @file{nfs NFS proc}. | |
282 | - | |
283 | -@item --output=@var{dbfile} | |
284 | -The database file to build. Default is system-dependent, but | |
285 | -typically @file{/usr/local/var/locatedb}. | |
286 | - | |
287 | -@item --localuser=@var{user} | |
288 | -The user to search the non-network directories as, using @code{su}. | |
289 | -Default is to search the non-network directories as the current user. | |
290 | -You can also use the environment variable @code{LOCALUSER} to set this user. | |
291 | - | |
292 | -@item --netuser=@var{user} | |
293 | -The user to search network directories as, using @code{su}. Default | |
294 | -@code{user} is @code{daemon}. You can also use the environment variable | |
295 | -@code{NETUSER} to set this user. | |
296 | - | |
297 | -@item --old-format | |
298 | -Generate a @code{locate} database in the old format, for compatibility | |
299 | -with versions of @code{locate} other than GNU @code{locate}. Using | |
300 | -this option means that @code{locate} will not be able to properly | |
301 | -handle non-ASCII characters in file names (that is, file names | |
302 | -containing characters which have the eighth bit set, such as many of | |
303 | -the characters from the ISO-8859-1 character set). | |
304 | -@item --help | |
305 | -Print a summary of the command line usage and exit. | |
306 | -@item --version | |
307 | -Print the version number of @code{updatedb} and exit. | |
308 | -@end table | |
309 | - | |
310 | -@node Invoking xargs, Regular Expressions, Invoking updatedb, Reference | |
311 | +@node xargs, Regular Expressions, find, Reference | |
312 | @section Invoking @code{xargs} | |
313 | ||
314 | @example | |
69b40b10 | 315 | @@ -3097,7 +2843,7 @@ |
6a9f8a7c JB |
316 | @end table |
317 | ||
318 | ||
5bd4a84c JB |
319 | -@node Regular Expressions, Environment Variables, Invoking xargs, Reference |
320 | +@node Regular Expressions, Environment Variables, xargs, Reference | |
6a9f8a7c JB |
321 | @section Regular Expressions |
322 | ||
323 | The @samp{-regex} and @samp{-iregex} tests of @code{find} allow |