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 =head2 EXAMPLES
  16
  17 =over
  18
  19 =item $ lei import --format=mboxrd t.mbox
  20
  21 Import the messages from an mbox into the local storage.
  22
  23 =back
  24
  25 =head1 EXTERNALS
  26
  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).
  33
  34 =head2 EXAMPLES
  35
  36 =over
  37
  38 =item $ lei add-external https://public-inbox.org/meta/
  39
  40 Add a remote external for public-inbox's inbox.
  41
  42 =item $ lei add-external --mirror https://public-inbox.org/meta/ path
  43
  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.
  46
  47 =back
  48
  49 =head1 SEARCHING
  50
  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)>.
  53
  54 =head2 EXAMPLES
  55
  56 =over
  57
  58 =item $ lei q s:lei s:skeleton
  59
  60 Search for messages whose subject includes "lei" and "skeleton".
  61
  62 =item $ lei q -t s:lei s:skeleton
  63
  64 Do the same, but also report unmatched messages that are in the same
  65 thread as a matched message.
  66
  67 =item $ lei q -t -o t.mbox -f mboxcl2 --mua=mutt s:lei s:skeleton
  68
  69 Write mboxcl2-formatted results to t.mbox and enter mutt to view the
  70 file by invoking C<mutt -f %f>.
  71
  72 =back
  73
  74 =head1 CONTACT
  75
  76 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
  77
  78 The mail archives are hosted at L<https://public-inbox.org/meta/>
  79 and L<http://hjrcffqmbrq6wope.onion/meta/>
  80
  81 =head1 COPYRIGHT
  82
  83 Copyright 2021 all contributors L<mailto:meta@public-inbox.org>
  84
  85 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>