1plocate-build(8)            System Manager's Manual           plocate-build(8)
2
3
4

NAME

6       plocate-build - generate index for plocate
7
8

SYNOPSIS

10       plocate-build [OPTION]...  MLOCATE_DB PLOCATE_DB
11
12

DESCRIPTION

14       plocate-build  creates  an  index from plocate(1) from an index earlier
15       generated by updatedb(8) from the mlocate(1) package. Most users  would
16       rather want to use plocate's own updatedb(8), which is more direct.  If
17       PLOCATE_DB already exists, it will be overwritten (non-atomically). The
18       file is created such that it is not world-readable, as the final access
19       check is done by plocate(1) during the search.
20
21

OPTIONS

23       -b, --block-size SIZE
24              Create blocks containing SIZE filenames each, compress them  to‐
25              gether, and treat them as the same element in the posting lists.
26              This makes the index smaller (because the compression  algorithm
27              gets more context to work with, and because there are fewer ele‐
28              ments in each posting list), but also makes posting  lists  less
29              precise,  moving  more work to weeding out false positives after
30              posting list intersection.
31
32              Making this number larger will make linear search (for  --regex,
33              or  very short patterns) faster, with diminishing returns around
34              256 filenames per block. However, making it too large will cause
35              more  false  positives, reducing overall performance for typical
36              queries. The default value is 32.  Setting it  to  1  makes  one
37              (compressed) block per filename.
38
39
40       -p, --plaintext
41              Treat  the  input  as plain text, with entries delimited by new‐
42              lines, instead of an mlocate database.
43
44
45       --help Print out usage information, then exit successfully.
46
47
48       --version
49              Print out version information, then exit successfully.
50
51

AUTHOR

53       Steinar H. Gunderson <steinar+plocate@gunderson.no>
54
55

SEE ALSO

57       plocate(1), /etc/cron.daily/plocate (which is called  update-plocate.sh
58       in the source distribution)
59
60
61
62plocate-build                      Oct 2020                   plocate-build(8)