]> Sergey Matveev's repositories - public-inbox.git/blob - Documentation/lei-up.pod
ac644a9693fc9883ce5df359b5e613de33cdf091
[public-inbox.git] / Documentation / lei-up.pod
1 =head1 NAME
2
3 lei-up - update a saved search
4
5 =head1 SYNOPSIS
6
7 lei up [OPTIONS] OUTPUT
8
9 lei up [OPTIONS] --all[=<local|remote>]
10
11 =head1 DESCRIPTION
12
13 Update the saved search at C<OUTPUT> or all saved searches.
14
15 =head1 OPTIONS
16
17 =over
18
19 =item --all[=<local|remote>]
20
21 C<--all> updates all saved searches (listed in L<lei-ls-search(1)>).
22 C<--all=local> only updates local mailboxes, C<--all=remote> only
23 updates remote mailboxes (currently C<imap://> and C<imaps://>).
24
25 =item --remote-fudge-time=INTERVAL
26
27 Look for mail older than the time of the last successful query.
28 Using a small interval will reduce bandwidth use.  A larger
29 interval reduces the likelihood of missing a result due to MTA
30 delays or downtime.
31
32 The time(s) of the last successful queries are the C<lastresult>
33 values visible from L<lei-edit-search(1)>.
34
35 Date formats understood by L<git-rev-parse(1)> may be used.
36 e.g C<1.hour> or C<3.days>
37
38 Default: 2.days
39
40 =item --no-external
41
42 =item --no-local
43
44 =item --no-remote
45
46 These disable the use of all externals, local externals, or
47 remote externals respectively.  They are useful during
48 temporary network or mount-point outages.
49
50 Unlike C<lei q>, these switches override the original C<lei q --only>
51 options saved as C<lei.q.only>.
52
53 The combination C<--all=remote --no-remote> is supported for
54 offline use in case a user is updating an IMAP folder on localhost.
55
56 =item --exclude=LOCATION
57
58 As with L<lei-q(1)>, but may also exclude externals originally
59 specified via C<lei q --only>.
60
61 =item --lock=METHOD
62
63 =item --alert=CMD
64
65 =item --mua=CMD
66
67 C<--lock>, C<--alert>, and C<--mua> are all supported and
68 documented in L<lei-q(1)>.
69
70 C<--mua> is incompatible with C<--all>.
71
72 =back
73
74 =head1 CONTACT
75
76 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
77
78 The mail archives are hosted at L<https://public-inbox.org/meta/>
79 and L<http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/>
80
81 =head1 COPYRIGHT
82
83 Copyright all contributors L<mailto:meta@public-inbox.org>
84
85 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
86
87 =head1 SEE ALSO
88
89 L<lei-q(1)>, L<lei-ls-search(1)>, L<lei-edit-search(1)>,
90 L<lei-forget-search(1)>