about summary refs log tree commit homepage
diff options
context:
space:
mode:
authorEric Wong <e@yhbt.net>2020-08-27 12:17:06 +0000
committerEric Wong <e@yhbt.net>2020-08-28 04:22:50 +0000
commit29c5f2a6fc3b86306a5dbeadfae061d06f2bc6dd (patch)
treec68ad845f1a05a6562cc9218e9fa4995c00cae63
parentf9b93b95ce1de27e0427e4bfeca0712ad681b064 (diff)
downloadpublic-inbox-29c5f2a6fc3b86306a5dbeadfae061d06f2bc6dd.tar.gz
There's a few more, but maybe they're too esoteric
to be worth documenting at the moment (batch sizes, timeouts, etc).
-rw-r--r--Documentation/public-inbox-watch.pod36
1 files changed, 35 insertions, 1 deletions
diff --git a/Documentation/public-inbox-watch.pod b/Documentation/public-inbox-watch.pod
index b07d0fb5..f3e622b0 100644
--- a/Documentation/public-inbox-watch.pod
+++ b/Documentation/public-inbox-watch.pod
@@ -78,7 +78,12 @@ public-inbox 1.6.0 supports C<nntp://>, C<nntps://>,
 C<imap://> and C<imaps://> 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<netrc(5)> and/or L<git-credential(1)> 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<public-inbox-watch(1)> users
 
+=item imap.Starttls / imap.$URL.Starttls
+
+Whether or not to use C<STARTTLS> on plain C<imap://> connections.
+
+May be specified for certain URLs via L<git-config(1)/--get-urlmatch>
+in C<git(1)> 1.8.5+.
+
+Default: C<true>
+
+=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<git(1)> 1.8.5+ is
+installed to use L<git-config(1)/--get-urlmatch>
+
+Default: C<false>
+
+=item nntp.Starttls / nntp.$URL.Starttls
+
+Whether or not to use C<STARTTLS> on plain C<nntp://> connections.
+
+May be specified for certain URLs via L<git-config(1)/--get-urlmatch>
+in C<git(1)> 1.8.5+.
+
+Default: C<false> if the hostname is a Tor C<.onion>, C<true> otherwise
+
 =back
 
 =head1 SIGNALS