diff options
| -rw-r--r-- | Documentation/lei-overview.pod | 12 | ||||
| -rw-r--r-- | INSTALL | 11 |
2 files changed, 13 insertions, 10 deletions
diff --git a/Documentation/lei-overview.pod b/Documentation/lei-overview.pod index 7095b504..e9a97d64 100644 --- a/Documentation/lei-overview.pod +++ b/Documentation/lei-overview.pod @@ -119,11 +119,13 @@ code repository. =head1 PERFORMANCE NOTES -L<Inline::C> is required, lei runs as a background daemon to reduce -startup costs and can provide real-time L<kqueue(2)>/L<inotify(7)> -Maildir monitoring. L<IO::KQueue> (p5-IO-KQueue on FreeBSD) and -L<Linux::Inotify2> (liblinux-inotify2-perl and perl-Linux-Inotify2 in -.deb and .rpm-based distros, respectively) are recommended. +L<Inline::C> is required on BSDs and can speed things up on Linux. + +lei runs as a background daemon to reduce startup costs and can +provide real-time L<kqueue(2)>/L<inotify(7)> Maildir monitoring. +L<IO::KQueue> (p5-IO-KQueue on FreeBSD) and L<Linux::Inotify2> +(liblinux-inotify2-perl and perl-Linux-Inotify2 in .deb and .rpm-based +distros, respectively) are recommended. L<Socket::MsgHdr> is optional (libsocket-msghdr-perl in Debian), and further improves startup performance. Its effect is most felt @@ -76,7 +76,8 @@ Numerous optional modules are likely to be useful as well: - Inline::C deb: libinline-c-perl pkg: p5-Inline-C rpm: perl-Inline (or perl-Inline-C) - (speeds up process spawning on Linux, + (required for lei on *BSD; + speeds up process spawning on Linux, see public-inbox-daemon(8)) - Email::Address::XS deb: libemail-address-xs-perl @@ -88,17 +89,17 @@ Numerous optional modules are likely to be useful as well: - Parse::RecDescent deb: libparse-recdescent-perl pkg: p5-Parse-RecDescent rpm: perl-ParseRecDescent - (optional, for public-inbox-imapd(1)) + (only 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) + (only for lei and public-inbox-watch) - BSD::Resource deb: libbsd-resource-perl pkg: p5-BSD-Resource rpm: perl-BSD-Resource - (optional, for PSGI limiters + (only for PSGI limiters, see public-inbox-config(5)) - Plack::Middleware::ReverseProxy deb: libplack-middleware-reverseproxy-perl @@ -113,7 +114,7 @@ Numerous optional modules are likely to be useful as well: * xapian-compact (tool) deb: xapian-tools pkg: xapian-core rpm: xapian-core - (optional, for public-inbox-compact(1)) + (only for public-inbox-compact(1)) * curl (tool) deb, pkg, rpm: curl (for HTTP(S) externals with curl) |