Documentation/lei.pod

   1 =head1 NAME
   2
   3 lei - local email interface for public-inbox
   4
   5 =head1 SYNOPSIS
   6
   7 lei [OPTIONS] COMMAND
   8
   9 =head1 DESCRIPTION
  10
  11 Unlike the C10K-oriented L<public-inbox-daemon(8)>, lei is designed
  12 exclusively to handle trusted local clients with read/write access to
  13 the file system, using as many system resources as the local user has
  14 access to.  lei supports a local, writable store built on top of
  15 L<public-inbox-v2-format(5)> and L<public-inbox-extindex(1)>.
  16 L<lei-q(1)> provides an interface for querying messages across the lei
  17 store and read-only local and remote "externals" (inboxes and external
  18 indices).
  19
  20 Available in public-inbox 1.7.0+.
  21
  22 =head1 OPTIONS
  23
  24 =over
  25
  26 =item -C DIR
  27
  28 Change current working directory to the specified directory before
  29 running the command.  This option can be given before or after
  30 C<COMMAND> and is accepted by all lei subcommands except
  31 L<lei-daemon-kill(1)>.
  32
  33 =back
  34
  35 =head1 COMMANDS
  36
  37 Subcommands for initializing and managing local, writable storage:
  38
  39 =over
  40
  41 =item * L<lei-init(1)>
  42
  43 =item * L<lei-import(1)>
  44
  45 =back
  46
  47 The following subcommands can be used to manage and inspect external
  48 locations:
  49
  50 =over
  51
  52 =item * L<lei-add-external(1)>
  53
  54 =item * L<lei-forget-external(1)>
  55
  56 =item * L<lei-ls-external(1)>
  57
  58 =back
  59
  60 Subcommands related to searching and inspecting messages from the lei
  61 store and configured externals are
  62
  63 =over
  64
  65 =item * L<lei-q(1)>
  66
  67 =back
  68
  69 TODO: Add lei-show (and perhaps others) once implemented.
  70
  71 Other subcommands include
  72
  73 =over
  74
  75 =item * L<lei-config(1)>
  76
  77 =item * L<lei-daemon-kill(1)>
  78
  79 =item * L<lei-daemon-pid(1)>
  80
  81 =back
  82
  83 =head1 FILES
  84
  85 By default storage is located at C<$XDG_DATA_HOME/lei/store>.  The
  86 configuration for lei resides at C<$XDG_CONFIG_HOME/lei/config>.
  87
  88 =head1 CONTACT
  89
  90 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
  91
  92 The mail archives are hosted at L<https://public-inbox.org/meta/>
  93 and L<http://hjrcffqmbrq6wope.onion/meta/>
  94
  95 =head1 COPYRIGHT
  96
  97 Copyright 2021 all contributors L<mailto:meta@public-inbox.org>
  98
  99 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
 100
 101 =head1 SEE ALSO
 102
 103 L<lei-overview(7)>