Documentation/lei-rm.pod

   1 =head1 NAME
   2
   3 lei-rm - unindex a message in lei/store
   4
   5 =head1 SYNOPSIS
   6
   7 lei rm [OPTIONS] (-|--stdin)
   8
   9 lei rm [OPTIONS] LOCATION
  10
  11 =head1 DESCRIPTION
  12
  13 Removes message(s) and associated private metadata from lei/store
  14 indices.  It does not affect messages stored in externals, so it's
  15 still possible to get "removed" messages from externals in L<lei-q>
  16 search results.
  17
  18 This does not remove the message from underlying git storage nor
  19 does it remove messages from Maildir/mbox/IMAP/etc. sources.
  20
  21 =head1 OPTIONS
  22
  23 =over
  24
  25 =item -
  26
  27 =item --stdin
  28
  29 Read input from standard input.  This is the default if standard
  30 input is a pipe or regular file and there are no arguments on
  31 the command-line.
  32
  33 =item -F MAIL_FORMAT
  34
  35 =item --in-format=MAIL_FORMAT
  36
  37 Message input format: C<eml>, C<mboxrd>, C<mboxcl2>, C<mboxcl>, or C<mboxo>
  38 when reading from stdin or using one of the mbox variants.
  39
  40 Not necessary when using an IMAP URL, NNTP URL or Maildir.
  41
  42 Default: C<eml> when reading from stdin or if the file suffix
  43 ends in C<.patch> or C<.eml>.
  44
  45 =item --lock=METHOD
  46
  47 L<mbox(5)> locking method(s) to use: C<dotlock>, C<fcntl>, C<flock> or
  48 C<none>.
  49
  50 Default: fcntl,dotlock
  51
  52 =item -q
  53
  54 =item --quiet
  55
  56 Suppress feedback messages.
  57
  58 =back
  59
  60 =head1 CONTACT
  61
  62 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
  63
  64 The mail archives are hosted at L<https://public-inbox.org/meta/> and
  65 L<http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/>
  66
  67 =head1 COPYRIGHT
  68
  69 Copyright all contributors L<mailto:meta@public-inbox.org>
  70
  71 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
  72
  73 =head1 SEE ALSO
  74
  75 L<lei-store-format(5)>