Remove dependency on non-POSIX header error.h.

[plocate] / README

diff --git a/README b/README
index dcb60c827403d6817727a3323ea16e254561682e..f2c6cb862c4f962728e5e9afdfa0c0f0ef14ed7b 100644 (file)
--- a/README
+++ b/README
@@ -1,28 +1,31 @@
-plocate is a locate based on posting lists, consuming mlocate's database
-ahead-of-time and making a much faster (and smaller) index out of it.
-It supports most mlocate options; see --help or the man page (man -l plocate.1)
-for more information.
-
-plocate is in beta. The file format is stable, but may still change
-(if so, plocate will notify you itself that you need to rerun
-plocate-build). To build and install, you will need a C++17 compiler
-and a development package for Zstd (https://facebook.github.io/zstd/).
-liburing (https://github.com/axboe/liburing) and a kernel supporting
-io_uring (Linux 5.1 or newer) is optional, but strongly recommended
-for best performance, especially if you do not have an SSD. Installation
-is run as:
+plocate is a locate based on posting lists. Compared to mlocate,
+it is much faster, and its index is much smaller. updatedb speed
+is similar (or you can convert mlocate's index to plocate format
+using plocate-build). It supports most mlocate options;
+see --help or the man page (man -l plocate.1) for more information.
+
+The file format may still change (if so, plocate will notify you itself
+that you need to rerun plocate-build or updatedb). To build and install,
+you will need a C++17 compiler and a development package for Zstd
+(https://facebook.github.io/zstd/). liburing (https://github.com/axboe/liburing)
+and a kernel supporting io_uring (Linux 5.1 or newer) is optional,
+but strongly recommended for best performance, especially if you
+do not have an SSD. Installation is run as:

 
   meson obj
   cd obj
   ninja
 
   meson obj
   cd obj
   ninja

+  sudo addgroup --system plocate

   sudo ninja install
   sudo ninja install

+  sudo systemctl enable plocate-updatedb.timer

 
 To build the database for the first time after install, you can do
 
 
 To build the database for the first time after install, you can do
 

-  sudo /etc/cron.daily/plocate
+  sudo updatedb

 
 

-or equivalently, run the update-plocate.sh script from the source
-directory as root (it is the same file installed to /etc/cron.d).
+The initial run of updatedb needs to scan the entire filesystem.
+Subsequent runs of updatedb will be much faster, and create a slightly (~5%)
+smaller database.

 
 If you wish to run some tests of the TurboPFor implementation against
 the reference implementation, you can check it out and run as follows:
 
 If you wish to run some tests of the TurboPFor implementation against
 the reference implementation, you can check it out and run as follows:


@@ -33,6 +36,11 @@ the reference implementation, you can check it out and run as follows:
   ninja reconfigure
   ninja bench
 
   ninja reconfigure
   ninja bench
 

-Copyright 2020 Steinar H. Gunderson <steinar+plocate@gunderson.no>.
+plocate (except updatedb), and the plocate-specific changes to updatedb,
+is Copyright 2020 Steinar H. Gunderson <steinar+plocate@gunderson.no>.

 Licensed under the GNU General Public License, either version 2,
 or (at your option) any later version. See the included file COPYING.
 Licensed under the GNU General Public License, either version 2,
 or (at your option) any later version. See the included file COPYING.

+
+updatedb is Copyright (C) 2005, 2007 Red Hat, Inc. All rights reserved.
+Licensed under the GNU General Public License, version 2. See the
+included file COPYING.