doc: document graceful shutdown signals

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

diff --git a/Documentation/public-inbox-watch.pod b/Documentation/public-inbox-watch.pod
index 3f282f0f1bbdc1310ebee9788ab8be5138eb6056..34e8c4f2946faca8e6549ea7fd25791dceb0cef2 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
                ; 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:
 
                ; config keys specific to public-inbox-watch:

+

                watch = maildir:/path/to/maildirs/.INBOX.test/
                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]
                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
 
                ; 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
                ; configured for watch.
                ; This is global for all publicinbox.* sections
                watchspam = maildir:/path/to/maildirs/.INBOX.spam


@@ -33,7 +37,7 @@ In ~/.public-inbox/config:
 
 public-inbox-watch allows watching a mailbox (currently only
 Maildir) for the arrival of new messages and automatically
 
 public-inbox-watch allows watching a mailbox (currently only
 Maildir) for the arrival of new messages and automatically

-importing them into a public-inbox (git) repository.
+importing them into public-inbox git repositories and indices.

 public-inbox-watch is useful in situations when a user wishes to
 mirror an existing mailing list, but has no access to run
 L<public-inbox-mda(1)> on a server.  Unlike public-inbox-mda
 public-inbox-watch is useful in situations when a user wishes to
 mirror an existing mailing list, but has no access to run
 L<public-inbox-mda(1)> on a server.  Unlike public-inbox-mda


@@ -44,8 +48,7 @@ of large Maildirs.
 Upon startup, it scans the mailbox for new messages to be
 imported while it was not running.
 
 Upon startup, it scans the mailbox for new messages to be
 imported while it was not running.
 

-Currently, only Maildirs are supported and the
-L<Filesys::Notify::Simple> Perl module is required.
+Currently, only Maildirs are supported.

 
 For now, IMAP users should use tools such as L<mbsync(1)>
 or L<offlineimap(1)> to bidirectionally sync their IMAP
 
 For now, IMAP users should use tools such as L<mbsync(1)>
 or L<offlineimap(1)> to bidirectionally sync their IMAP


@@ -90,6 +93,11 @@ Reload the config file (default: ~/.public-inbox/config)
 Rescan all watched mailboxes.  This is done automatically after
 startup.
 
 Rescan all watched mailboxes.  This is done automatically after
 startup.
 

+=item SIGQUIT / SIGTERM / SIGINT
+
+Gracefully shut down.  In-flight messages will be stored
+and indexed.
+

 =back
 
 =head1 ENVIRONMENT
 =back
 
 =head1 ENVIRONMENT


@@ -118,7 +126,7 @@ and L<http://hjrcffqmbrq6wope.onion/meta/>
 
 =head1 COPYRIGHT
 
 
 =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>
 
 
 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>