diff options
| -rw-r--r-- | Documentation/lei-overview.pod | 72 | ||||
| -rwxr-xr-x | Documentation/txt2pre | 1 | ||||
| -rw-r--r-- | MANIFEST | 1 | ||||
| -rw-r--r-- | Makefile.PL | 2 |
4 files changed, 75 insertions, 1 deletions
diff --git a/Documentation/lei-overview.pod b/Documentation/lei-overview.pod new file mode 100644 index 00000000..d1903045 --- /dev/null +++ b/Documentation/lei-overview.pod @@ -0,0 +1,72 @@ +=head1 NAME + +lei - an overview of lei + +=head1 DESCRIPTION + +L<lei(1)> is a local email interface for public-inbox. This document +provides some basic examples. + +=head1 LEI STORE + +L<lei-init(1)> initializes writable local storage based on +L<public-inbox-v2-format(5)>. + +TODO: Extend when lei-import and friends are added. + +=head1 EXTERNALS + +In addition to the above store, lei can make read-only queries to +"externals": inboxes and external indices. An external can be +registered by passing a URL or local path to L<lei-add-external(1)>. +For 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). + +=head2 EXAMPLES + +=over + +=item $ lei add-external https://public-inbox.org/meta/ + +Add a remote external for public-inbox's inbox. + +=back + +=head1 SEARCHING + +The L<lei-q(1)> command searches the local store and externals. The +search prefixes match those available via L<public-inbox-httpd(1)>. + +=head2 EXAMPLES + +=over + +=item $ lei q s:lei s:skeleton + +Search for messages whose subject includes "lei" and "skeleton". + +=item $ lei q -t s:lei s:skeleton + +Do the same, but also report unmatched messages that are in the same +thread as a matched message. + +=item $ lei q -t -o t.mbox -f mboxcl2 --mua=mutt s:lei s:skeleton + +Write mboxcl2-formatted results to t.mbox and enter mutt to view the +file by invoking C<mutt -f %f>. + +=back + +=head1 CONTACT + +Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org> + +The mail archives are hosted at L<https://public-inbox.org/meta/> +and L<http://hjrcffqmbrq6wope.onion/meta/> + +=head1 COPYRIGHT + +Copyright 2021 all contributors L<mailto:meta@public-inbox.org> + +License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt> diff --git a/Documentation/txt2pre b/Documentation/txt2pre index f69323e1..604490ef 100755 --- a/Documentation/txt2pre +++ b/Documentation/txt2pre @@ -18,6 +18,7 @@ for (qw[lei(1) lei-forget-external(1) lei-init(1) lei-ls-external(1) + lei-overview(7) lei-q(1) public-inbox.cgi(1) public-inbox-compact(1) @@ -28,6 +28,7 @@ Documentation/lei-daemon-pid.pod Documentation/lei-forget-external.pod Documentation/lei-init.pod Documentation/lei-ls-external.pod +Documentation/lei-overview.pod Documentation/lei-q.pod Documentation/lei.pod Documentation/marketing.txt diff --git a/Makefile.PL b/Makefile.PL index 7bfe1e4e..f1910c47 100644 --- a/Makefile.PL +++ b/Makefile.PL @@ -48,7 +48,7 @@ $v->{-m1} = [ map { lei-forget-external lei-init lei-ls-external lei-q)]; $v->{-m5} = [ qw(public-inbox-config public-inbox-v1-format public-inbox-v2-format public-inbox-extindex-format) ]; -$v->{-m7} = [ qw(public-inbox-overview public-inbox-tuning) ]; +$v->{-m7} = [ qw(lei-overview public-inbox-overview public-inbox-tuning) ]; $v->{-m8} = [ qw(public-inbox-daemon) ]; my @sections = (1, 5, 7, 8); $v->{check_80} = []; |