public-inbox.git  about / heads / tags
an "archives first" approach to mailing lists
blob f8ff69509dcf73d6dd0af5fb6d3d2f0b3ebf0b93 1599 bytes (raw)
$ git show HEAD:Documentation/lei-index.pod	# shows this blob on the CLI

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
=head1 NAME

lei-index - index messages without importing them into lei/store

=head1 SYNOPSIS

lei index [OPTIONS] FOLDER

=head1 DESCRIPTION

Similar to L<lei-import(1)>, but does not store a copy of
messages into C<lei/store>.

This command only makes sense for messages stored in Maildir
folders.  Other folder types may be supported in the future
(they can all be indexed, but the message isn't automatically
retrieved by L<lei-q(1)> or L<lei-lcat(1)>).

Combined with L<lei-q(1)>, C<lei index> allows Maildir users to
have similar functionality to L<mairix(1)> by not duplicating
messages into C<lei/store>.

Occasional invocations of C<lei-refresh-mail-sync --all=local>
are recommended to keep indexed messages retrievable.

=head1 OPTIONS

=over

=item -F MAIL_FORMAT

=item --in-format=MAIL_FORMAT

There is currently no need for this option.  It will support C<mh>,
eventually.  For now, the default (and only supported) format is
C<maildir>.  When IMAP and NNTP support are fleshed out, those
formats will be inferred from their URLs.

Default: C<maildir>

=item -q

=item --quiet

Suppress feedback messages.

=back

=head1 CONTACT

Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>

The mail archives are hosted at L<https://public-inbox.org/meta/> and
L<http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/>

=head1 COPYRIGHT

Copyright all contributors L<mailto:meta@public-inbox.org>

License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>

=head1 SEE ALSO

L<lei-refresh-mail-sync(1)>, L<lei-store-format(5)>, L<lei-import(1)>

git clone https://public-inbox.org/public-inbox.git
git clone http://7fh6tueqddpjyxjmgtdiueylzoqt6pt7hec3pukyptlmohoowvhde4yd.onion/public-inbox.git