3 lei - an overview of lei
7 L<lei(1)> is a local email interface for public-inbox. This document
8 provides some basic examples.
12 L<lei-init(1)> initializes writable local storage based on
13 L<public-inbox-v2-format(5)>.
19 =item $ lei import mboxrd:t.mbox
21 Import the messages from an mbox into the local storage.
27 In addition to the above store, lei can make read-only queries to
28 "externals": inboxes and external indices. An external can be
29 registered by passing a URL or local path to L<lei-add-external(1)>.
30 For existing local paths, the external needs to be indexed with
31 L<public-inbox-index(1)> (in the case of a regular inbox) or
32 L<public-inbox-extindex(1)> (in the case of an external index).
38 =item $ lei add-external https://public-inbox.org/meta/
40 Add a remote external for public-inbox's inbox.
42 =item $ lei add-external --mirror https://public-inbox.org/meta/ path
44 Clone L<https://public-inbox.org/meta/> to C<path>, index it with
45 L<public-inbox-index(1)>, and add it as a local external.
51 The L<lei-q(1)> command searches the local store and externals. The
52 search prefixes match those available via L<public-inbox-httpd(1)>.
58 =item $ lei q s:lei s:skeleton
60 Search for messages whose subject includes "lei" and "skeleton".
62 =item $ lei q -t s:lei s:skeleton
64 Do the same, but also report unmatched messages that are in the same
65 thread as a matched message.
67 =item $ lei q -t -o mboxcl2:t.mbox --mua=mutt s:lei s:skeleton
69 Write mboxcl2-formatted results to t.mbox and enter mutt to view the
70 file by invoking C<mutt -f %f>.
74 =head1 PERFORMANCE NOTES
76 L<Inline::C> is recommended for performance. To enable it, create
77 C<~/.cache/public-inbox/inline-c/>.
79 If Socket::MsgHdr is installed (libsocket-msghdr-perl in Debian), the
80 first invocation of lei starts a daemon, reducing the startup cost of
81 for future invocations (which is particularly important for Bash
84 =head1 BASH COMPLETION
86 Preliminary Bash completion for lei is provided in
87 C<contrib/completion/>. Contributions adding support for other
88 shells, as well as improvements to the existing Bash completion, are
93 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
95 The mail archives are hosted at L<https://public-inbox.org/meta/>
96 and L<http://hjrcffqmbrq6wope.onion/meta/>
100 Copyright 2021 all contributors L<mailto:meta@public-inbox.org>
102 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>