X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=plocate.1;h=cc0e8430b4a6889c990e26e3dde60e79a399cc2d;hb=3250b908875f7d8893719f0d3f9c615d381ec93f;hp=e58ad580f06fc34f2b5ee5dfa0e59e77cb711406;hpb=c4d3a7eb75a36921310731ca6e85fe2a5d65c0fa;p=plocate

diff --git a/plocate.1 b/plocate.1
index e58ad58..cc0e843 100644
--- a/plocate.1
+++ b/plocate.1
@@ -49,7 +49,8 @@ All of this matches
 behavior.
 
 Like
-.BR mlocate(1),
+.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,13 @@ bit set to access the index (which is built as root), but by
 testing visibility as the calling user.
 
 .SH OPTIONS
+.TP
+\fB\-b\fR, \fB\-\-basename\fR
+Match only against the file name portion of the path name,
+ie., the directory names will be excluded from the match
+(but still printed). This does not speed up the search,
+but can suppress uninteresting matches.
+
 .TP
 \fB\-c\fR, \fB\-\-count\fR
 Do not print each match. Instead, count them, and print out a total
@@ -64,10 +72,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
@@ -99,7 +117,7 @@ allowed to contain embedded newlines.
 \fB\-r\fR, \fB\-\-regexp\fR
 Patterns are taken to be POSIX basic regular expressions.
 See
-.BR regex(7)
+.BR regex (7)
 for more information. Note that this forces a linear scan
 through the entire database, which is slow.
 
@@ -110,6 +128,13 @@ be POSIX
 .I extended
 regular expressions.
 
+.TP
+\fB\-w\fR, \fB\-\-wholename\fR
+Match against the entire path name. This is the default,
+so unless \fB-b\fR is given first (see above), it will not do
+anything. This option thus exists only as compatibility with
+.BR mlocate (1).
+
 .TP
 .B \-\-help
 Print out usage information, then exit successfully.
@@ -118,6 +143,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>