diff options
Diffstat (limited to 'Documentation/lei-overview.pod')
-rw-r--r-- | Documentation/lei-overview.pod | 50 |
1 files changed, 37 insertions, 13 deletions
diff --git a/Documentation/lei-overview.pod b/Documentation/lei-overview.pod index e80cb094..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 @@ -33,7 +33,7 @@ Show message with the git blob OID of 59ec517f9. If a message with that OID isn't found, check if the current git repository has the blob, trying to reconstruct it from a message if needed. -=item $ lei blob 59ec517f9 | lei tag - -F eml +kw:flagged +L:next +=item $ lei blob 59ec517f9 | lei tag -F eml +kw:flagged +L:next Set the "flagged" keyword and "next" label on the message with the blob OID of 59ec517f9. @@ -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 @@ -92,18 +97,18 @@ and written. Search for all flagged messages that also have a "next" label. -=item $ lei p2q HEAD | lei q --stdin -tt -o /tmp/mdir +=item $ lei p2q HEAD | lei q -tt -o /tmp/mdir Search for messages that have post-image git blob IDs that match those of the current repository's HEAD commit, writing them to the Maildir directory "mdir" and flagging the messages that were an exact match. -=item $ git show -s HEAD | lei lcat - +=item $ git show -s HEAD | lei lcat Display a local message for the public-inbox link contained in a commit message. -=item $ lei q -f text m:MID | lei rediff -U5 - +=item $ lei q -f text m:MESSAGE-ID | lei rediff -U5 Feed a message containing a diff to L<lei-rediff(1)> to regenerate its diff with five context lines. Unless C<--git-dir> is specified, this @@ -114,13 +119,17 @@ code repository. =head1 PERFORMANCE NOTES -L<Inline::C> is recommended for performance. To enable it, create -C<~/.cache/public-inbox/inline-c/>. +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. -If Socket::MsgHdr is installed (libsocket-msghdr-perl in Debian), the -first invocation of lei starts a daemon, reducing the startup cost of -for future invocations (which is particularly important for Bash -completion). +L<Socket::MsgHdr> is optional (libsocket-msghdr-perl in Debian), +and further improves startup performance. Its effect is most felt +when using shell completion. =head1 BASH COMPLETION @@ -129,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> @@ -138,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)> |