X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=plocate.1;h=b5d04ddda54b9c226064d2b24d86d2be4c027456;hb=df2c52d164aaf03fd74fe72cdb8a47c59d2c11a7;hp=090fdb9694da0bfb1269297ec5d9ea74f8e3cada;hpb=3f086da52c281f81cb2290dad17cfb0f1d659810;p=plocate diff --git a/plocate.1 b/plocate.1 index 090fdb9..b5d04dd 100644 --- 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, @@ -58,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, @@ -78,6 +83,15 @@ 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 Do a case-insensitive match as given by the current locale @@ -97,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