Documentation/lei-overview.pod | 72 +++++++++++++++++++++++++++++++++++++++++++++++++++++ Documentation/txt2pre | 1 + MANIFEST | 1 + Makefile.PL | 2 +- diff --git a/Documentation/lei-overview.pod b/Documentation/lei-overview.pod new file mode 100644 index 0000000000000000000000000000000000000000..d190304569ec109682da526f64c2cc5705646eed --- /dev/null +++ b/Documentation/lei-overview.pod @@ -0,0 +1,72 @@ +=head1 NAME + +lei - an overview of lei + +=head1 DESCRIPTION + +L is a local email interface for public-inbox. This document +provides some basic examples. + +=head1 LEI STORE + +L initializes writable local storage based on +L. + +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. +For local paths, the external needs to be indexed with +L (in the case of a regular inbox) or +L (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 command searches the local store and externals. The +search prefixes match those available via L. + +=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. + +=back + +=head1 CONTACT + +Feedback welcome via plain-text mail to L + +The mail archives are hosted at L +and L + +=head1 COPYRIGHT + +Copyright 2021 all contributors L + +License: AGPL-3.0+ L diff --git a/Documentation/txt2pre b/Documentation/txt2pre index f69323e12ec10051b4335fef6bb36fbd911d45b2..604490ef2ee3d7d3219369faef060fd209e48c54 100755 --- a/Documentation/txt2pre +++ b/Documentation/txt2pre @@ -18,6 +18,7 @@ lei-daemon-pid(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) diff --git a/MANIFEST b/MANIFEST index 4d6f8b432f87975dc2d9807c974f32b8df576357..56fde540e54bec2c156e8fb1d1031dd52b5634d0 100644 --- a/MANIFEST +++ b/MANIFEST @@ -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 7bfe1e4e960634ba74ca9ffea212440fca3a910b..f1910c47297e0c4107322f17e0c1a79bc04a0369 100644 --- a/Makefile.PL +++ b/Makefile.PL @@ -48,7 +48,7 @@ lei-add-external lei-config lei-daemon-kill lei-daemon-pid 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} = [];