X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=Documentation%2Fpublic-inbox-watch.pod;h=e8f97c8088c9548fd15a6df4305c18299c58d25b;hb=23af251dd607c4e75ab1e68063f2c885c48cc035;hp=b07d0fb5f1ba8dc7c368bde2e23165adb640e6d7;hpb=f9b93b95ce1de27e0427e4bfeca0712ad681b064;p=public-inbox.git diff --git a/Documentation/public-inbox-watch.pod b/Documentation/public-inbox-watch.pod index b07d0fb5..e8f97c80 100644 --- a/Documentation/public-inbox-watch.pod +++ b/Documentation/public-inbox-watch.pod @@ -4,7 +4,7 @@ public-inbox-watch - mailbox watcher for public-inbox =head1 SYNOPSIS -B + public-inbox-watch In ~/.public-inbox/config: @@ -78,7 +78,12 @@ public-inbox 1.6.0 supports C, C, C and C URLs: watch = nntp://news.example.com/inbox.test.group - watch = imaps://mail.example.com/INBOX.test.foo + watch = imaps://user@mail.example.com/INBOX.test + +This may be specified multiple times to combine several mailboxes +into a single public-inbox. URLs requiring authentication +will require L and/or L (preferred) to fill +in the username and password. Default: none @@ -115,10 +120,39 @@ Messages without the (S)een flag are not considered for hiding. This hiding affects all configured public-inboxes in PI_CONFIG. As with C, C and C URLs -are supported in public-inbox 1.6.0. +are supported in public-inbox 1.6.0+. Default: none; only for L users +=item imap.Starttls / imap.$URL.Starttls + +Whether or not to use C on plain C connections. + +May be specified for certain URLs via L +in C 1.8.5+. + +Default: C + +=item imap.Compress / imap.$URL.Compress + +Whether or not to use the IMAP COMPRESS (RFC4978) extension to +save bandwidth. This is not supported by all IMAP servers and +some advertising this feature may not implement it correctly. + +May be specified only for certain URLs if L 1.8.5+ is +installed to use L + +Default: C + +=item nntp.Starttls / nntp.$URL.Starttls + +Whether or not to use C on plain C connections. + +May be specified for certain URLs via L +in C 1.8.5+. + +Default: C if the hostname is a Tor C<.onion>, C otherwise + =back =head1 SIGNALS @@ -162,12 +196,12 @@ daemons. See L. Feedback welcome via plain-text mail to L -The mail archives are hosted at L -and L +The mail archives are hosted at L and +L =head1 COPYRIGHT -Copyright 2016-2020 all contributors L +Copyright 2016-2021 all contributors L License: AGPL-3.0+ L