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

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