From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on dcvr.yhbt.net X-Spam-Level: X-Spam-Status: No, score=-4.0 required=3.0 tests=ALL_TRUSTED,BAYES_00 shortcircuit=no autolearn=ham autolearn_force=no version=3.4.2 Received: from localhost (dcvr.yhbt.net [127.0.0.1]) by dcvr.yhbt.net (Postfix) with ESMTP id 5A1131FA18 for ; Thu, 27 Aug 2020 12:17:08 +0000 (UTC) From: Eric Wong To: meta@public-inbox.org Subject: [PATCH 8/8] doc: watch: expand on NNTP and IMAP-specific knobs Date: Thu, 27 Aug 2020 12:17:06 +0000 Message-Id: <20200827121706.4545-9-e@yhbt.net> In-Reply-To: <20200827121706.4545-1-e@yhbt.net> References: <20200827121706.4545-1-e@yhbt.net> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit List-Id: There's a few more, but maybe they're too esoteric to be worth documenting at the moment (batch sizes, timeouts, etc). --- Documentation/public-inbox-watch.pod | 36 +++++++++++++++++++++++++++- 1 file changed, 35 insertions(+), 1 deletion(-) diff --git a/Documentation/public-inbox-watch.pod b/Documentation/public-inbox-watch.pod index b07d0fb5..39b8ac06 100644 --- a/Documentation/public-inbox-watch.pod +++ b/Documentation/public-inbox-watch.pod @@ -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.foo + +This may be specified multiple times to combine several mailboxes +into a single public-inbox. URLs requiring authentication +will require L and/or L to fill +in the username and password. Default: none @@ -119,6 +124,35 @@ 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