git.sesse.net Git - plocate/blob - plocate-build.8

   1 .TH plocate-build 8 "Oct 2020" plocate-build
   2 .SH NAME
   3 plocate-build \- generate index for plocate
   4
   5 .SH SYNOPSIS
   6 .B plocate-build
   7 .I "[OPTION]..."
   8 .I "MLOCATE_DB"
   9 .I "PLOCATE_DB"
  10
  11 .SH DESCRIPTION
  12 .B plocate-build
  13 creates an index from
  14 .BR plocate (1)
  15 from an index earlier generated by
  16 .BR updatedb (8)
  17 from the
  18 .BR mlocate (1)
  19 package. Most users would rather want to use plocate's own
  20 .BR updatedb (8),
  21 which is more direct.
  22 If
  23 .I PLOCATE_DB
  24 already exists, it will be overwritten (non-atomically). The file is
  25 created such that it is not world-readable, as the final access check
  26 is done by
  27 .BR plocate (1)
  28 during the search.
  29
  30 .SH OPTIONS
  31 .TP
  32 \fB\-b\fR, \fB\-\-block\-size\fR \fISIZE\fR
  33 Create blocks containing
  34 .I SIZE
  35 filenames each, compress them together, and treat them as the same element
  36 in the posting lists. This makes the index smaller (because the compression
  37 algorithm gets more context to work with, and because there are fewer elements
  38 in each posting list), but also makes posting lists less precise, moving more
  39 work to weeding out false positives after posting list intersection.
  40
  41 Making this number larger will make linear search (for \fB\-\-regex\fR,
  42 or very short patterns) faster, with diminishing returns around 256 filenames
  43 per block. However, making it too large will cause more false positives,
  44 reducing overall performance for typical queries. The default value is 32.
  45 Setting it to 1 makes one (compressed) block per filename.
  46
  47 .TP
  48 \fB\-p\fR, \fB\-\-plaintext\fR
  49 Treat the input as plain text, with entries delimited by newlines,
  50 instead of an mlocate database.
  51
  52 .TP
  53 \fB\-l\fR, \fB\-\-require\-visibility\fR \fIFLAG\fR
  54 Set the \*(lqrequire file visibility before reporting it\*(rq flag in the
  55 generated database to \fIFLAG\fR. The default is yes, even for an mlocate
  56 database with the flag originally set to no (although the latter may
  57 change in the future).
  58
  59 .TP
  60 .B \-\-help
  61 Print out usage information, then exit successfully.
  62
  63 .TP
  64 .B \-\-version
  65 Print out version information, then exit successfully.
  66
  67 .SH AUTHOR
  68 Steinar H. Gunderson <steinar+plocate@gunderson.no>
  69
  70 .SH SEE ALSO
  71 \fBplocate\fP(1),
  72 \fB/etc/cron.daily/plocate\fR (which is called
  73 \fBupdate-plocate.sh\fR in the source distribution)