nntp: resolve inboxes immediately on group listings

[public-inbox.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index e1aa2c0e92d6f99c6086cf38cb4180a4de38f175..0974028d0f73014bd8eb2e7c345441c0df3d6e28 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -6,7 +6,7 @@ Clients should use normal git-clone/git-fetch, IMAP or NNTP clients
 if they want to import mail into their personal inboxes.
 
 As of 2021, public-inbox is packaged by several OS distributions,
-listed in alphabetical order: Debian, NixOS, and Void Linux.
+listed in alphabetical order: Debian, GNU Guix, NixOS, and Void Linux.
 
 public-inbox is developed on Debian GNU/Linux systems and will
 never depend on packages outside of the "main" component of
@@ -36,9 +36,9 @@ To accept incoming mail into a public inbox, you'll likely want:
 * MTA - postfix is recommended (for public-inbox-mda)
 * SpamAssassin (spamc/spamd)   (for public-inbox-watch/public-inbox-mda)
 
-Beyond that, there is one non-standard Perl module required:
+Beyond that, there is one non-standard Perl package required:
 
-* URI::Escape                      deb: liburi-perl
+* URI                              deb: liburi-perl
                                    pkg: p5-URI
                                    rpm: perl-URI
                                    (for HTML/Atom generation)
@@ -72,13 +72,6 @@ Numerous optional modules are likely to be useful as well:
                                    rpm: perl-Search-Xapian
                                    (HTTP and IMAP search)
 
-- Net::Server                      deb: libnet-server-perl
-                                   pkg: pkg-Net-Server
-                                   rpm: perl-Net-Server
-                                   (for HTTP/IMAP/NNTP background daemons,
-                                    not needed as systemd services or
-                                    foreground servers)
-
 - Inline::C                        deb: libinline-c-perl
                                    pkg: pkg-Inline-C
                                    rpm: perl-Inline (or perl-Inline-C)
@@ -96,6 +89,11 @@ Numerous optional modules are likely to be useful as well:
                                    rpm: perl-ParseRecDescent
                                    (optional, for public-inbox-imapd(1))
 
+- Mail::IMAPClient                 deb: libmail-imapclient-perl
+                                   pkg: p5-Mail-IMAPClient
+                                   rpm: perl-Mail-IMAPClient
+                                   (optional for lei and public-inbox-watch)
+
 - BSD::Resource                    deb: libbsd-resource-perl
                                    pkg: p5-BSD-Resource
                                    rpm: perl-BSD-Resource
@@ -116,9 +114,24 @@ Numerous optional modules are likely to be useful as well:
                                    rpm: xapian-core
                                    (optional, for public-inbox-compact(1))
 
+* curl (tool)                      deb, pkg, rpm: curl
+                                   (for HTTP(S) externals with curl)
+
 - Linux::Inotify2                  deb: liblinux-inotify2-perl
                                    rpm: perl-Linux-Inotify2
-                                   (for public-inbox-watch and -imapd on Linux)
+                                   (for lei, public-inbox-watch and -imapd
+                                    on Linux)
+
+- IO::KQueue                       pkg: p5-IO-KQueue
+                                   (for lei, public-inbox-watch and -imapd
+                                    on *BSDs)
+
+- Net::Server                      deb: libnet-server-perl
+                                   pkg: pkg-Net-Server
+                                   rpm: perl-Net-Server
+                                   (for HTTP/IMAP/NNTP background daemons,
+                                    not needed as systemd services or
+                                    foreground servers)
 
 The following module is typically pulled in by dependencies listed
 above, so there is no need to explicitly install them:
@@ -174,9 +187,10 @@ Other installation notes
 Debian 8.x (jessie) users, use Debian 8.5 or later if using Xapian:
         https://bugs.debian.org/808610
 
-public-inbox will never store unregeneratable data in Xapian
-or any other search database we might use; Xapian corruption
-will not destroy critical data.
+public-inbox-* commands will never store unregeneratable data in
+Xapian nor any other search database we might use; Xapian
+corruption will not destroy critical data.  Note: `lei' DOES store
+unregeneratable data in Xapian and SQLite.
 
 See the public-inbox-overview(7) man page for the next steps once
 the installation is complete.