watchmaildir: support multiple watchheader values

[public-inbox.git] / Documentation / public-inbox-config.pod

diff --git a/Documentation/public-inbox-config.pod b/Documentation/public-inbox-config.pod
index 1c5ba015e60c7f6cef4762e8e8d4aa575df4f876..708a785f76b046f78972f3f77a6cb4190b59b666 100644 (file)
--- a/Documentation/public-inbox-config.pod
+++ b/Documentation/public-inbox-config.pod
@@ -88,7 +88,8 @@ Default: none; only for L<public-inbox-watch(1)> users
                watchheader = List-Id:<test.example.com>
 
 If specified, L<public-inbox-watch(1)> will only process mail matching
-the given header.  Multiple values are not currently supported.
+the given header.  If specified multiple times, mail will be processed
+if it matches any of the values.
 
 Default: none; only for L<public-inbox-watch(1)> users
 
@@ -99,7 +100,7 @@ angle brackets for L<public-inbox-mda(1)> deliveries and
 L<public-inbox-watch(1)>.
 
 For public-inbox-watch users, this is a shortcut for specifying
-C<publicinbox.$NAME.watchheader=List-Id:<foo.example.com>>
+C<publicinbox.$NAME.watchheader=List-Id:E<lt>foo.example.comE<gt>>
 
 For public-inbox-mda users, this may be used to avoid recipient
 matching via C<ORIGINAL_RECIPIENT> environment variable.
@@ -115,7 +116,7 @@ Default: none
 This may be the full NNTP URL of an independently-run mirror.
 For example, the https://public-inbox.org/meta/ inbox is
 mirrored by Gmane at
-C<nntp://news.gmane.org/gmane.mail.public-inbox.general>
+C<nntp://news.gmane.io/gmane.mail.public-inbox.general>
 
 Default: none
 
@@ -167,7 +168,7 @@ interface are displayed.
 
 A list of comma-delimited email addresses may be specified.
 This can be useful for dedicated inboxes for bot emails, but
-discussion happens on a seperate mailing list/inbox.
+discussion happens on a separate mailing list/inbox.
 
 Mirrors of existing centralized mailing lists may use ":list"
 here to redirect mail only to the configured inbox address.
@@ -202,26 +203,30 @@ L<spamc(1)> for filtering spam before it is imported into git
 history.  Other spam filtering backends may be supported in
 the future.
 
+This requires L<public-inbox-watch(1)>, but affects all configured
+public-inboxes in PI_CONFIG.
+
 Default: none
 
 =item publicinboxwatch.watchspam
 
-This may be set to C<spamc> to enable the use of SpamAssassin
-L<spamc(1)> for filtering spam before it is imported into git
-history.  Other spam filtering backends may be supported in
-the future.  This requires L<public-inbox-watch(1)>, but affects
-all configured public-inboxes in PI_CONFIG.
+A Maildir to watch for confirmed spam messages to appear in.
+Messages which appear in this folder with the (S)een Maildir flag
+will be hidden from all configured inboxes based on Message-ID
+and content matching.
 
-Default: none
+Messages without the (S)een Maildir flag are not considered for hiding.
+
+Default: none; only for L<public-inbox-watch(1)> users
 
 =item publicinbox.nntpserver
 
-Set this to point to the address of the L<public-inbox-nntpd(1)>
+Set this to point to the hostname of the L<public-inbox-nntpd(1)>
 instance.  This is used to advertise the existence of the NNTP
-presnce in the L<PublicInbox::WWW> HTML interface.
+endpoint in the L<PublicInbox::WWW> HTML interface.
 
-Multiple values are allowed for servers with multiple
-addresses or mirrors.
+Multiple values are allowed for instances with multiple hostnames
+or mirrors.
 
 Default: none
 
@@ -425,7 +430,7 @@ and L<http://hjrcffqmbrq6wope.onion/meta/>
 
 =head1 COPYRIGHT
 
-Copyright 2016-2019 all contributors L<mailto:meta@public-inbox.org>
+Copyright 2016-2020 all contributors L<mailto:meta@public-inbox.org>
 
 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>