Documentation/lei-overview.pod

   1 =head1 NAME
   2
   3 lei - an overview of lei
   4
   5 =head1 DESCRIPTION
   6
   7 L<lei(1)> is a local email interface for public-inbox.  This document
   8 provides some basic examples.
   9
  10 =head1 LEI STORE
  11
  12 L<lei-init(1)> initializes writable local storage based on
  13 L<public-inbox-v2-format(5)>.
  14
  15 TODO: Extend when lei-import and friends are added.
  16
  17 =head1 EXTERNALS
  18
  19 In addition to the above store, lei can make read-only queries to
  20 "externals": inboxes and external indices.  An external can be
  21 registered by passing a URL or local path to L<lei-add-external(1)>.
  22 For local paths, the external needs to be indexed with
  23 L<public-inbox-index(1)> (in the case of a regular inbox) or
  24 L<public-inbox-extindex(1)> (in the case of an external index).
  25
  26 =head2 EXAMPLES
  27
  28 =over
  29
  30 =item $ lei add-external https://public-inbox.org/meta/
  31
  32 Add a remote external for public-inbox's inbox.
  33
  34 =back
  35
  36 =head1 SEARCHING
  37
  38 The L<lei-q(1)> command searches the local store and externals.  The
  39 search prefixes match those available via L<public-inbox-httpd(1)>.
  40
  41 =head2 EXAMPLES
  42
  43 =over
  44
  45 =item $ lei q s:lei s:skeleton
  46
  47 Search for messages whose subject includes "lei" and "skeleton".
  48
  49 =item $ lei q -t s:lei s:skeleton
  50
  51 Do the same, but also report unmatched messages that are in the same
  52 thread as a matched message.
  53
  54 =item $ lei q -t -o t.mbox -f mboxcl2 --mua=mutt s:lei s:skeleton
  55
  56 Write mboxcl2-formatted results to t.mbox and enter mutt to view the
  57 file by invoking C<mutt -f %f>.
  58
  59 =back
  60
  61 =head1 CONTACT
  62
  63 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
  64
  65 The mail archives are hosted at L<https://public-inbox.org/meta/>
  66 and L<http://hjrcffqmbrq6wope.onion/meta/>
  67
  68 =head1 COPYRIGHT
  69
  70 Copyright 2021 all contributors L<mailto:meta@public-inbox.org>
  71
  72 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>