X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=Documentation%2Flei-up.pod;h=ac644a9693fc9883ce5df359b5e613de33cdf091;hb=9b0c238f887475d920a8589b492ec15c63770152;hp=cea0f61924ebffe9968fe5ede416259192ee987c;hpb=e3dd5c16289892f216ab14ed5217bd261a4c1717;p=public-inbox.git diff --git a/Documentation/lei-up.pod b/Documentation/lei-up.pod index cea0f619..ac644a96 100644 --- a/Documentation/lei-up.pod +++ b/Documentation/lei-up.pod @@ -6,26 +6,68 @@ lei-up - update a saved search lei up [OPTIONS] OUTPUT -lei up [OPTIONS] --all=TYPE +lei up [OPTIONS] --all[=] =head1 DESCRIPTION -Update the saved search at C or all saved searches of C -(currently C is the only supported value). +Update the saved search at C or all saved searches. =head1 OPTIONS -The following options, described in L, are supported. - =over +=item --all[=] + +C<--all> updates all saved searches (listed in L). +C<--all=local> only updates local mailboxes, C<--all=remote> only +updates remote mailboxes (currently C and C). + +=item --remote-fudge-time=INTERVAL + +Look for mail older than the time of the last successful query. +Using a small interval will reduce bandwidth use. A larger +interval reduces the likelihood of missing a result due to MTA +delays or downtime. + +The time(s) of the last successful queries are the C +values visible from L. + +Date formats understood by L may be used. +e.g C<1.hour> or C<3.days> + +Default: 2.days + +=item --no-external + +=item --no-local + +=item --no-remote + +These disable the use of all externals, local externals, or +remote externals respectively. They are useful during +temporary network or mount-point outages. + +Unlike C, these switches override the original C +options saved as C. + +The combination C<--all=remote --no-remote> is supported for +offline use in case a user is updating an IMAP folder on localhost. + +=item --exclude=LOCATION + +As with L, but may also exclude externals originally +specified via C. + =item --lock=METHOD =item --alert=CMD =item --mua=CMD -This option is incompatible with C<--all>. +C<--lock>, C<--alert>, and C<--mua> are all supported and +documented in L. + +C<--mua> is incompatible with C<--all>. =back @@ -34,11 +76,11 @@ This option is incompatible with C<--all>. Feedback welcome via plain-text mail to L The mail archives are hosted at L -and L +and L =head1 COPYRIGHT -Copyright 2021 all contributors L +Copyright all contributors L License: AGPL-3.0+ L