Add an option --add-single-prunepath.

[plocate] / plocate.1

diff --git a/plocate.1 b/plocate.1
index 1609b751b180ce03a536235f2dde3af23d48722a..53354dca5d2bc18fbb9f69f282ebb8249dc9f293 100644 (file)
--- a/plocate.1
+++ b/plocate.1
@@ -50,6 +50,7 @@ behavior.
 
 Like
 .BR mlocate (1),
+.B plocate
 shows all files visible to the calling user (by virtue of
 having read and execute permissions on all parent directories),
 and none that are not, by means of running with the setgid
@@ -57,6 +58,11 @@ bit set to access the index (which is built as root), but by
 testing visibility as the calling user.
 
 .SH OPTIONS
+.TP
+\fB\-A\fR, \fB\-\-all\fR
+Ignored for compatibility with
+.BR mlocate (1).
+
 .TP
 \fB\-b\fR, \fB\-\-basename\fR
 Match only against the file name portion of the path name,
@@ -71,10 +77,20 @@ number at the end.
 
 .TP
 \fB\-d\fR, \fB\-\-database\fR \fIDBPATH\fR
-Find matches in \fB/var/lib/mlocate/plocate.db\fR, instead of the given database.
-(
-.B plocate
-does not currently support multiple databases.)
+Find matches in the given database, instead of \fB/var/lib/plocate/plocate.db\fR.
+This argument can be given multiple times, to search multiple databases.
+It is also possible to give multiple databases in one argument, separated by 
+.BR : .
+(Any character, including : and \\, can be escaped by prepending a \\.)
+
+.TP
+\fB\-e\fR, \fB\-\-existing\fR
+Print only entries that refer to files existing at the time
+.B locate
+is run. Note that unlike
+.BR mlocate (1),
+symlinks are not followed by default (and indeed, there is no option
+to change this).
 
 .TP
 \fB\-i\fR, \fB\-\-ignore\-case\fR
@@ -95,6 +111,16 @@ matches have been found. If
 .B \-\-count
 is given, the number printed out will be at most \fILIMIT\fR.
 
+.TP
+\fB\-N\fR, \fB\-\-literal\fR
+Print entry names without quoting. Normally,
+.B plocate
+will escape special characters in filenames, so that they are safe for
+consumption by typical shells (similar to the GNU coreutils
+.I shell-escape-always
+quoting style), unless printing to a pipe, but this options will
+turn off such quoting.
+
 .TP
 \fB\-0\fR, \fB\-\-null\fR
 Instead of writing a newline after every match, write a NUL
@@ -132,6 +158,15 @@ Print out usage information, then exit successfully.
 .B \-\-version
 Print out version information, then exit successfully.
 
+.SH ENVIRONMENT
+
+.TP
+\fBLOCATE_PATH\fR
+If given, appended after the list of \fB\-\-database\fR paths
+(whether an explicit is given or the default is used).
+Colon-delimiting and character escaping follows the same rules
+as for \fB\-\-database\fR.
+
 .SH AUTHOR
 Steinar H. Gunderson <steinar+plocate@gunderson.no>