]> git.sesse.net Git - plocate/blobdiff - plocate-build.8
Correct the plocate-build man page around --require-visibility.
[plocate] / plocate-build.8
index f92def5b5ea4b4530b1cc76f9c0ff24e9db2a95b..58bf473724df8c63bb271d0949f8af7ca0f674d5 100644 (file)
@@ -13,12 +13,14 @@ plocate-build \- generate index for plocate
 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
-.BR updatedb (1)
+.BR updatedb (8)
 from the
 .BR mlocate (1)
 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
 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
 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.
 
 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.
 .TP
 .B \-\-help
 Print out usage information, then exit successfully.