config: support "inboxdir" in addition to "mainrepo"

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

diff --git a/Documentation/public-inbox-watch.pod b/Documentation/public-inbox-watch.pod
index 404303e89c060be1f3bcb6f6132f072b55fb7c48..0934eaded070d1f7dfe32abcd771508b4957c145 100644 (file)
--- a/Documentation/public-inbox-watch.pod
+++ b/Documentation/public-inbox-watch.pod
@@ -12,10 +12,14 @@ In ~/.public-inbox/config:
                ; generic public-inbox-config keys:
                address = test@example.com
                url = http://example.com/test
-               mainrepo = /path/to/test.example.com.git
+               inboxdir = /path/to/test.example.com.git
 
                ; config keys specific to public-inbox-watch:
+
                watch = maildir:/path/to/maildirs/.INBOX.test/
+
+               ; optional, emails that don't have a header matching
+               ; value will be skipped
                watchheader = List-Id:<test.example.com>
 
        [publicinboxwatch]
@@ -24,7 +28,7 @@ In ~/.public-inbox/config:
 
                ; optional, emails marked as read which appear
                ; here will be trained as spam and deleted from
-               ; the mainrepos of any public-inboxes which are
+               ; the inboxdirs of any public-inboxes which are
                ; configured for watch.
                ; This is global for all publicinbox.* sections
                watchspam = maildir:/path/to/maildirs/.INBOX.spam
@@ -101,6 +105,12 @@ startup.
 config file. default: ~/.public-inbox/config
 See L<public-inbox-config(5)>
 
+=item PERL_INLINE_DIRECTORY
+
+This may affect any public-inbox processes, but is intended
+for long-lived ones such as C<public-inbox-watch> or network
+daemons.  See L<public-inbox-daemon(8)>.
+
 =back
 
 =head1 CONTACT
@@ -112,7 +122,7 @@ and L<http://hjrcffqmbrq6wope.onion/meta/>
 
 =head1 COPYRIGHT
 
-Copyright 2016 all contributors L<mailto:meta@public-inbox.org>
+Copyright 2016-2019 all contributors L<mailto:meta@public-inbox.org>
 
 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>