Cf. https://lwn.net/Articles/947941/, not escaping - will change
e.g. “plocate-build” to “plocate(Unicode dash)build”, which breaks
cut-and-paste. We had this right most places, but not all.
-.TH plocate-build 8 "Oct 2020" plocate-build
+.TH plocate\-build 8 "Oct 2020" plocate\-build
-plocate-build \- generate index for plocate
+plocate\-build \- generate index for plocate
.SH SYNOPSIS
.B plocate-build
.SH SYNOPSIS
.B plocate-build
.I "PLOCATE_DB"
.SH DESCRIPTION
.I "PLOCATE_DB"
.SH DESCRIPTION
creates an index from
.BR plocate (1)
from an index earlier generated by
creates an index from
.BR plocate (1)
from an index earlier generated by
.SH SEE ALSO
\fBplocate\fP(1),
\fB/etc/cron.daily/plocate\fR (which is called
.SH SEE ALSO
\fBplocate\fP(1),
\fB/etc/cron.daily/plocate\fR (which is called
-\fBupdate-plocate.sh\fR in the source distribution)
+\fBupdate\-plocate.sh\fR in the source distribution)
an index made by
.BR updatedb (8)
or (less commonly) converted from another index by
an index made by
.BR updatedb (8)
or (less commonly) converted from another index by
plocate is largely argument-compatible with
.BR mlocate (1),
plocate is largely argument-compatible with
.BR mlocate (1),
If at least one non-escaped globbing metacharacter (*, ? or []) is given,
that pattern is instead taken to be a glob pattern (which means it needs
to start and end in * for a substring match). If
If at least one non-escaped globbing metacharacter (*, ? or []) is given,
that pattern is instead taken to be a glob pattern (which means it needs
to start and end in * for a substring match). If
is given, patterns are instead taken to be (non-anchored) POSIX basic
regular expressions, and if
is given, patterns are instead taken to be (non-anchored) POSIX basic
regular expressions, and if
is given, patterns are taken to be POSIX extended regular expressions.
All of this matches
.BR mlocate (1)
is given, patterns are taken to be POSIX extended regular expressions.
All of this matches
.BR mlocate (1)
.SH EXIT STATUS
.B plocate
exits with 0 to indicate that a match was found or that
.SH EXIT STATUS
.B plocate
exits with 0 to indicate that a match was found or that
were passed. Otherwise,
.B plocate
exits with status code 1, indicating that an error occurred or that no matches were found.
were passed. Otherwise,
.B plocate
exits with status code 1, indicating that an error occurred or that no matches were found.
.B plocate
will escape special characters in filenames, so that they are safe for
consumption by typical shells (similar to the GNU coreutils
.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.
quoting style), unless printing to a pipe, but this options will
turn off such quoting.
.TP
\fB\-w\fR, \fB\-\-wholename\fR
Match against the entire path name. This is the default,
.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
+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).
anything. This option thus exists only as compatibility with
.BR mlocate (1).
Steinar H. Gunderson <steinar+plocate@gunderson.no>
.SH SEE ALSO
Steinar H. Gunderson <steinar+plocate@gunderson.no>
.SH SEE ALSO
+\fBplocate\-build\fP(8),
\fBmlocate\fP(1),
\fBupdatedb\fP(8)
\fBmlocate\fP(1),
\fBupdatedb\fP(8)