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 lei index [OPTIONS] --stdin
  10
  11 =head1 DESCRIPTION
  12
  13 Similar to L<lei-import(1)>, but does not store a copy of
  14 messages into C<lei/store>.
  15
  16 This command only makes sense for messages stored in Maildir
  17 folders.  Other folder types may be supported in the future
  18 (they can all be indexed, but the message isn't automatically
  19 retrieved by L<lei-q(1)> or L<lei-lcat(1)>).
  20
  21 Combined with L<lei-q(1)>, C<lei index> allows Maildir users to
  22 have similar functionality to L<mairix(1)> by not duplicating
  23 messages into C<lei/store>.
  24
  25 =head1 OPTIONS
  26
  27 =over
  28
  29 =item -
  30
  31 =item --stdin
  32
  33 Read input from standard input.  This is the default if standard
  34 input is a pipe or regular file and there are no arguments on
  35 the command-line.
  36
  37 =item -F MAIL_FORMAT
  38
  39 =item --in-format=MAIL_FORMAT
  40
  41 Message input format: C<eml>, C<maildir>, C<imap>, C<imaps>, C<nntp>,
  42 C<nntps>, C<mboxrd>, C<mboxcl2>, C<mboxcl>, or C<mboxo>.
  43
  44 Default: C<eml> when reading from stdin
  45
  46 =item -q
  47
  48 =item --quiet
  49
  50 Suppress feedback messages.
  51
  52 =back
  53
  54 =head1 CONTACT
  55
  56 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
  57
  58 The mail archives are hosted at L<https://public-inbox.org/meta/> and
  59 L<http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/>
  60
  61 =head1 COPYRIGHT
  62
  63 Copyright all contributors L<mailto:meta@public-inbox.org>
  64
  65 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
  66
  67 =head1 SEE ALSO
  68
  69 L<lei-store-format(5)>, L<lei-import(1)>