]> git.sesse.net Git - plocate/blobdiff - plocate-build.8
Release plocate 1.1.22.
[plocate] / plocate-build.8
index f92def5b5ea4b4530b1cc76f9c0ff24e9db2a95b..00e3899f21847d1b72503f8f0b9ee9fd3e1142e6 100644 (file)
@@ -1,6 +1,6 @@
-.TH plocate-build 8 "Oct 2020" plocate-build
+.TH plocate\-build 8 "Oct 2020" plocate\-build
 .SH NAME
-plocate-build \- generate index for plocate
+plocate\-build \- generate index for plocate
 
 .SH SYNOPSIS
 .B plocate-build
@@ -9,16 +9,18 @@ plocate-build \- generate index for plocate
 .I "PLOCATE_DB"
 
 .SH DESCRIPTION
-.B plocate-build
+.B plocate\-build
 creates an index from 
 .BR plocate (1)
 from an index earlier generated by
-.BR updatedb (1)
+.BR updatedb (8)
 from the
 .BR mlocate (1)
-package. This is currently the only way to build such an index.
+package. Most users would rather want to use plocate's own
+.BR updatedb (8),
+which is more direct.
 If
-.I MLOCATE_DB
+.I PLOCATE_DB
 already exists, it will be overwritten (non-atomically). The file is
 created such that it is not world-readable, as the final access check
 is done by
@@ -47,6 +49,13 @@ Setting it to 1 makes one (compressed) block per filename.
 Treat the input as plain text, with entries delimited by newlines,
 instead of an mlocate database.
 
+.TP
+\fB\-l\fR, \fB\-\-require\-visibility\fR \fIFLAG\fR
+Set the \*(lqrequire file visibility before reporting it\*(rq flag in the
+generated database to \fIFLAG\fR. The default is yes, even for an mlocate
+database with the flag originally set to no (although the latter may
+change in the future).
+
 .TP
 .B \-\-help
 Print out usage information, then exit successfully.
@@ -61,4 +70,4 @@ Steinar H. Gunderson <steinar+plocate@gunderson.no>
 .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)