]> git.sesse.net Git - plocate/blobdiff - plocate.1
Return 1 if no matches were found
[plocate] / plocate.1
index 53354dca5d2bc18fbb9f69f282ebb8249dc9f293..03ba56e6fa2b538e7159e2def6f35f8aa0750154 100644 (file)
--- a/plocate.1
+++ b/plocate.1
@@ -12,13 +12,13 @@ plocate \- find files by name, quickly
 finds all files on the system matching the given pattern (or all
 of the patterns if multiple are given). It does this by means of
 an index made by
-.BR plocate-build (8),
-which in turn reads the database made by 
-.BR updatedb (8).
+.BR updatedb (8)
+or (less commonly) converted from another index by
+.BR plocate-build (8).
 
-plocate is largely compatible with
+plocate is largely argument-compatible with
 .BR mlocate (1),
-and reuses its database to create its index, but is significantly
+but is significantly
 faster. In particular, it rarely needs to scan through its entire
 database, unless the pattern is very short (less than three bytes)
 or you want to search for a regular expression. It does not try to
@@ -33,7 +33,7 @@ will search for files that match
 of them. This is the main incompatibility with
 .BR mlocate (1),
 which searches for files that match one or more patterns, unless
-the \-a option is given.
+the \-A option is given.
 
 By default, patterns are taken to be substrings to search for.
 If at least one non-escaped globbing metacharacter (*, ? or []) is given,
@@ -57,6 +57,16 @@ and none that are not, by means of running with the setgid
 bit set to access the index (which is built as root), but by
 testing visibility as the calling user.
 
+.SH EXIT STATUS
+.B plocate
+exits with 0 to indicate that a match was found or that
+.B --help
+or
+.B --version
+were passed. Otherwise,
+.B plocate
+exits with status code 1, indicating that an error occurred or that no matches were found.
+
 .SH OPTIONS
 .TP
 \fB\-A\fR, \fB\-\-all\fR