diff options
Diffstat (limited to 'Documentation/lei-overview.pod')
| -rw-r--r-- | Documentation/lei-overview.pod | 38 |
1 files changed, 30 insertions, 8 deletions
diff --git a/Documentation/lei-overview.pod b/Documentation/lei-overview.pod index 40a7b0aa..e9a97d64 100644 --- a/Documentation/lei-overview.pod +++ b/Documentation/lei-overview.pod @@ -4,8 +4,8 @@ lei - an overview of lei =head1 DESCRIPTION -L<lei(1)> is a local email interface for public-inbox. This document -provides some basic examples. +L<lei(1)> is a local email interface for public-inbox and personal mail. +This document provides some basic examples. =head1 LEI STORE @@ -49,6 +49,11 @@ For existing local paths, the external needs to be indexed with L<public-inbox-index(1)> (in the case of a regular inbox) or L<public-inbox-extindex(1)> (in the case of an external index). +=head1 SYNCHRONIZATION + +lei currently has primitive mail synchronization abilities; +see L<lei-mail-sync-overview(7)> for more details. + =head2 EXAMPLES =over @@ -114,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 @@ -131,6 +138,17 @@ C<contrib/completion/>. Contributions adding support for other shells, as well as improvements to the existing Bash completion, are welcome. +=head1 UPGRADING + +Since lei runs as a daemon, L<lei-daemon-kill(1)> is required to kill +the daemon so it can load new code. It will be restarted with the +next invocation of any lei command. + +=head1 CAVEATS + +IMAP and NNTP client performance is poor on high-latency connections. +It will hopefully be fixed in 2022. + =head1 CONTACT Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org> @@ -140,6 +158,10 @@ L<http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/> =head1 COPYRIGHT -Copyright 2021 all contributors L<mailto:meta@public-inbox.org> +Copyright all contributors L<mailto:meta@public-inbox.org> License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt> + +=head1 SEE ALSO + +L<lei-mail-sync-overview(7)> |