]> Sergey Matveev's repositories - public-inbox.git/blob - Documentation/lei-add-watch.pod
doc: lei-add-watch: add warning about unreliability
[public-inbox.git] / Documentation / lei-add-watch.pod
1 =head1 NAME
2
3 lei-add-watch - watch for new messages and flag changes
4
5 =head1 SYNOPSIS
6
7 lei add-watch [OPTIONS] LOCATION [LOCATION...]
8
9 =head1 DESCRIPTION
10
11 Tell lei to watch C<LOCATION> for new messages and flag changes.
12 Currently only Maildir locations are supported.
13
14 WARNING: watches are not always reliable, occasional use
15 of L<lei-index(1)> and L<lei-refresh-mail-sync(1)> is recommended
16 if L<lei-daemon(8)> crashes or needs to be restarted.  This will
17 be improved in the future.
18
19 =for comment
20 TODO: Document --state?  Believe valid values are pause, import-ro,
21
22 =head1 CONTACT
23
24 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
25
26 The mail archives are hosted at L<https://public-inbox.org/meta/> and
27 L<http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/>
28
29 =head1 COPYRIGHT
30
31 Copyright all contributors L<mailto:meta@public-inbox.org>
32
33 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
34
35 =head1 SEE ALSO
36
37 L<lei-ls-watch(1)>, L<lei-rm-watch(1)>