]> git.sesse.net Git - plocate/blob - plocate-build.8
Import the updatedb and updatedb.conf man pages from mlocate.
[plocate] / 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 (1)
17 from the
18 .BR mlocate (1)
19 package. This is currently the only way to build such an index.
20 If
21 .I PLOCATE_DB
22 already exists, it will be overwritten (non-atomically). The file is
23 created such that it is not world-readable, as the final access check
24 is done by
25 .BR plocate (1)
26 during the search.
27
28 .SH OPTIONS
29 .TP
30 \fB\-b\fR, \fB\-\-block\-size\fR \fISIZE\fR
31 Create blocks containing
32 .I SIZE
33 filenames each, compress them together, and treat them as the same element
34 in the posting lists. This makes the index smaller (because the compression
35 algorithm gets more context to work with, and because there are fewer elements
36 in each posting list), but also makes posting lists less precise, moving more
37 work to weeding out false positives after posting list intersection.
38
39 Making this number larger will make linear search (for \fB\-\-regex\fR,
40 or very short patterns) faster, with diminishing returns around 256 filenames
41 per block. However, making it too large will cause more false positives,
42 reducing overall performance for typical queries. The default value is 32.
43 Setting it to 1 makes one (compressed) block per filename.
44
45 .TP
46 \fB\-p\fR, \fB\-\-plaintext\fR
47 Treat the input as plain text, with entries delimited by newlines,
48 instead of an mlocate database.
49
50 .TP
51 .B \-\-help
52 Print out usage information, then exit successfully.
53
54 .TP
55 .B \-\-version
56 Print out version information, then exit successfully.
57
58 .SH AUTHOR
59 Steinar H. Gunderson <steinar+plocate@gunderson.no>
60
61 .SH SEE ALSO
62 \fBplocate\fP(1),
63 \fB/etc/cron.daily/plocate\fR (which is called
64 \fBupdate-plocate.sh\fR in the source distribution)