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 =head1 OPTIONS
  24
  25 =over
  26
  27 =item -F MAIL_FORMAT
  28
  29 =item --in-format=MAIL_FORMAT
  30
  31 There is currently no need for this option.  It will support C<mh>,
  32 eventually.  For now, the default (and only supported) format is
  33 C<maildir>.  When IMAP and NNTP support are fleshed out, those
  34 formats will be inferred from their URLs.
  35
  36 Default: C<maildir>
  37
  38 =item -q
  39
  40 =item --quiet
  41
  42 Suppress feedback messages.
  43
  44 =back
  45
  46 =head1 CONTACT
  47
  48 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
  49
  50 The mail archives are hosted at L<https://public-inbox.org/meta/> and
  51 L<http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/>
  52
  53 =head1 COPYRIGHT
  54
  55 Copyright all contributors L<mailto:meta@public-inbox.org>
  56
  57 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
  58
  59 =head1 SEE ALSO
  60
  61 L<lei-store-format(5)>, L<lei-import(1)>