]> Sergey Matveev's repositories - public-inbox.git/blob - Documentation/lei-rm.pod
doc: glossary: add a reference for "epoch"
[public-inbox.git] / 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<maildir>, C<imap>, C<imaps>, C<nntp>,
38 C<nntps>, C<mboxrd>, C<mboxcl2>, C<mboxcl>, or C<mboxo>.
39
40 Default: C<eml> when reading from stdin
41
42 =item --lock=METHOD
43
44 L<mbox(5)> locking method(s) to use: C<dotlock>, C<fcntl>, C<flock> or
45 C<none>.
46
47 Default: fcntl,dotlock
48
49 =item -q
50
51 =item --quiet
52
53 Suppress feedback messages.
54
55 =back
56
57 =head1 CONTACT
58
59 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
60
61 The mail archives are hosted at L<https://public-inbox.org/meta/> and
62 L<http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/>
63
64 =head1 COPYRIGHT
65
66 Copyright all contributors L<mailto:meta@public-inbox.org>
67
68 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
69
70 =head1 SEE ALSO
71
72 L<lei-store-format(5)>