git.sesse.net Git - plocate/blob - README

   1 plocate is a locate based on posting lists, consuming mlocate's database
   2 ahead-of-time and making a much faster (and smaller) index out of it.
   3 It supports most mlocate options; see --help or the man page (man -l plocate.1)
   4 for more information.
   5
   6 plocate is in beta. The file format is stable, but may still change
   7 (if so, plocate will notify you itself that you need to rerun
   8 plocate-build). To build and install, you will need a C++17 compiler
   9 and a development package for Zstd (https://facebook.github.io/zstd/).
  10 liburing (https://github.com/axboe/liburing) and a kernel supporting
  11 io_uring (Linux 5.1 or newer) is optional, but strongly recommended
  12 for best performance, especially if you do not have an SSD. Installation
  13 is run as:
  14
  15   meson obj
  16   cd obj
  17   ninja
  18   sudo ninja install
  19
  20 To build the database for the first time after install, you can do
  21
  22   sudo /etc/cron.daily/plocate
  23
  24 or equivalently, run the update-plocate.sh script from the source
  25 directory as root (it is the same file installed to /etc/cron.d).
  26
  27 If you wish to run some tests of the TurboPFor implementation against
  28 the reference implementation, you can check it out and run as follows:
  29
  30   git clone https://github.com/powturbo/TurboPFor-Integer-Compression
  31   ( cd TurboPFor-Integer-Compression && make -j8 )
  32   cd obj
  33   ninja reconfigure
  34   ninja bench
  35
  36 plocate (except updatedb), and the plocate-specific changes to updatedb,
  37 is Copyright 2020 Steinar H. Gunderson <steinar+plocate@gunderson.no>.
  38 Licensed under the GNU General Public License, either version 2,
  39 or (at your option) any later version. See the included file COPYING.
  40
  41 updatedb is Copyright (C) 2005, 2007 Red Hat, Inc. All rights reserved.
  42 Licensed under the GNU General Public License, version 2. See the
  43 included file COPYING.