X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=Documentation%2Fpublic-inbox-watch.pod;h=bf3c9bd4bb9a47cc475fff18131ffd203960e77b;hb=b2b1006759730507731fcd3fc3e0de68239e3b92;hp=3f282f0f1bbdc1310ebee9788ab8be5138eb6056;hpb=9bd675d33ad1e49bd2ebe12a1d216216e61380de;p=public-inbox.git diff --git a/Documentation/public-inbox-watch.pod b/Documentation/public-inbox-watch.pod index 3f282f0f..bf3c9bd4 100644 --- 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: [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 @@ -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 -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 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. -Currently, only Maildirs are supported and the -L Perl module is required. +Currently, only Maildirs are supported. For now, IMAP users should use tools such as L or L to bidirectionally sync their IMAP @@ -118,7 +121,7 @@ and L =head1 COPYRIGHT -Copyright 2016-2019 all contributors L +Copyright 2016-2020 all contributors L License: AGPL-3.0+ L