Documentation/lei.pod

   1 =head1 NAME
   2
   3 lei - local email interface
   4
   5 =head1 SYNOPSIS
   6
   7 lei [OPTIONS] COMMAND
   8
   9 =head1 DESCRIPTION
  10
  11 lei is a command-line tool for importing and searching email,
  12 regardless of whether it is from a personal mailbox or a public-inbox.
  13 lei supports a local, writable store built on top of
  14 L<public-inbox-v2-format(5)> and L<public-inbox-extindex(1)>.
  15 L<lei-q(1)> provides an interface for querying messages across the lei
  16 store and read-only local and remote "externals" (inboxes and external
  17 indices).
  18
  19 Warning: lei is still in its early stages and may destroy mail.
  20 Be sure to have backups of destinations lei writes to.
  21
  22 Available in public-inbox 1.7.0+.
  23
  24 =head1 OPTIONS
  25
  26 =over
  27
  28 =item -c NAME=VALUE
  29
  30 Override configuration C<NAME> to C<VALUE>.
  31
  32 =item -C DIR
  33
  34 Change current working directory to the specified directory before
  35 running the command.  This option can be given before or after
  36 C<COMMAND> and is accepted by all lei subcommands except
  37 L<lei-daemon-kill(1)>.
  38
  39 =back
  40
  41 =head1 COMMANDS
  42
  43 Subcommands for initializing and managing local, writable storage:
  44
  45 =over
  46
  47 =item * L<lei-init(1)>
  48
  49 =item * L<lei-import(1)>
  50
  51 =item * L<lei-tag(1)>
  52
  53 =back
  54
  55 The following subcommands can be used to manage and inspect external
  56 locations:
  57
  58 =over
  59
  60 =item * L<lei-add-external(1)>
  61
  62 =item * L<lei-forget-external(1)>
  63
  64 =item * L<lei-ls-external(1)>
  65
  66 =back
  67
  68 Subcommands related to searching and inspecting messages from the lei
  69 store and configured externals are
  70
  71 =over
  72
  73 =item * L<lei-blob(1)>
  74
  75 =item * L<lei-config(1)>
  76
  77 =item * L<lei-edit-search(1)>
  78
  79 =item * L<lei-forget-search(1)>
  80
  81 =item * L<lei-lcat(1)>
  82
  83 =item * L<lei-ls-search(1)>
  84
  85 =item * L<lei-p2q(1)>
  86
  87 =item * L<lei-q(1)>
  88
  89 =item * L<lei-rediff(1)>
  90
  91 =item * L<lei-up(1)>
  92
  93 =back
  94
  95 Other subcommands include
  96
  97 =over
  98
  99 =item * L<lei-add-watch(1)>
 100
 101 =item * L<lei-config(1)>
 102
 103 =item * L<lei-convert(1)>
 104
 105 =item * L<lei-daemon-kill(1)>
 106
 107 =item * L<lei-daemon-pid(1)>
 108
 109 =item * L<lei-forget-mail-sync(1)>
 110
 111 =item * L<lei-mail-diff(1)>
 112
 113 =item * L<lei-inspect(1)>
 114
 115 =item * L<lei-ls-label(1)>
 116
 117 =item * L<lei-ls-mail-source(1)>
 118
 119 =item * L<lei-ls-mail-sync(1)>
 120
 121 =item * L<lei-ls-watch(1)>
 122
 123 =item * L<lei-rm-watch(1)>
 124
 125 =back
 126
 127 =head1 FILES
 128
 129 By default storage is located at C<$XDG_DATA_HOME/lei/store>.  The
 130 configuration for lei resides at C<$XDG_CONFIG_HOME/lei/config>.
 131
 132 =head1 ERRORS
 133
 134 Errors and dianostics for interactive commands are reported to
 135 stderr.  Some errors for background tasks are emitted via
 136 L<syslog(3)> as L<lei-daemon(8)> for the top-level daemon,
 137 and C<lei/store> for the L<lei-store-format(5)> worker.
 138
 139 =head1 CONTACT
 140
 141 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
 142
 143 The mail archives are hosted at L<https://public-inbox.org/meta/> and
 144 L<http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/>
 145
 146 =head1 COPYRIGHT
 147
 148 Copyright all contributors L<mailto:meta@public-inbox.org>
 149
 150 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
 151
 152 =head1 SEE ALSO
 153
 154 L<lei-overview(7)>, L<lei-daemon(8)>