Documentation/lei-index.pod

   1 =head1 NAME
   2
   3 lei-index - index messages without importing them into lei/store
   4
   5 =head1 SYNOPSIS
   6
   7 lei index [OPTIONS] FOLDER
   8
   9 =head1 DESCRIPTION
  10
  11 Similar to L<lei-import(1)>, but does not store a copy of
  12 messages into C<lei/store>.
  13
  14 This command only makes sense for messages stored in Maildir
  15 folders.  Other folder types may be supported in the future
  16 (they can all be indexed, but the message isn't automatically
  17 retrieved by L<lei-q(1)> or L<lei-lcat(1)>).
  18
  19 Combined with L<lei-q(1)>, C<lei index> allows Maildir users to
  20 have similar functionality to L<mairix(1)> by not duplicating
  21 messages into C<lei/store>.
  22
  23 Occasional invocations of C<lei-refresh-mail-sync --all=local>
  24 are recommended to keep indexed messages retrievable.
  25
  26 =head1 OPTIONS
  27
  28 =over
  29
  30 =item -F MAIL_FORMAT
  31
  32 =item --in-format=MAIL_FORMAT
  33
  34 There is currently no need for this option.  It will support C<mh>,
  35 eventually.  For now, the default (and only supported) format is
  36 C<maildir>.  When IMAP and NNTP support are fleshed out, those
  37 formats will be inferred from their URLs.
  38
  39 Default: C<maildir>
  40
  41 =item -q
  42
  43 =item --quiet
  44
  45 Suppress feedback messages.
  46
  47 =back
  48
  49 =head1 CONTACT
  50
  51 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
  52
  53 The mail archives are hosted at L<https://public-inbox.org/meta/> and
  54 L<http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/>
  55
  56 =head1 COPYRIGHT
  57
  58 Copyright all contributors L<mailto:meta@public-inbox.org>
  59
  60 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
  61
  62 =head1 SEE ALSO
  63
  64 L<lei-refresh-mail-sync(1)>, L<lei-store-format(5)>, L<lei-import(1)>