unofficial mirror of meta@public-inbox.org
 help / color / mirror / Atom feed
From: Eric Wong <e@yhbt.net>
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> (raw)
In-Reply-To: <20200827121706.4545-1-e@yhbt.net>

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<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.foo
+
+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

  parent reply	other threads:[~2020-08-27 12:17 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-08-27 12:16 [PATCH 0/8] mostly watch-related odds and ends Eric Wong
2020-08-27 12:17 ` [PATCH 2/8] imaptracker: preserve WAL journal_mode if set by user Eric Wong
2020-08-27 12:17 ` [PATCH 3/8] overidx: inline create_ghost sub Eric Wong
2020-08-27 12:17 ` [PATCH 4/8] doc: document graceful shutdown signals Eric Wong
2020-08-27 12:17 ` [PATCH 5/8] doc: speling fickses Eric Wong
2020-08-27 12:17 ` [PATCH 6/8] watch: imap: only remove \Seen spam Eric Wong
2020-08-27 12:17 ` [PATCH 7/8] doc: move watch config docs to -watch manpage Eric Wong
2020-08-27 12:17 ` Eric Wong [this message]
2020-08-28  4:22   ` [PATCH 8/8] doc: watch: expand on NNTP and IMAP-specific knobs Eric Wong

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://public-inbox.org/README

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20200827121706.4545-9-e@yhbt.net \
    --to=e@yhbt.net \
    --cc=meta@public-inbox.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

unofficial mirror of meta@public-inbox.org

This inbox may be cloned and mirrored by anyone:

	git clone --mirror https://yhetil.org/meta

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V1 meta meta/ https://yhetil.org/meta \
		meta@public-inbox.org
	public-inbox-index meta

Example config snippet for mirrors.
Newsgroups are available over NNTP:
	nntp://news.yhetil.org/yhetil.mail.public-inbox.meta
	nntp://news.public-inbox.org/inbox.mail.public-inbox.meta
	nntp://news.gmane.io/gmane.mail.public-inbox.general


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git