diff options
| author | Alyssa Ross <hi@alyssa.is> | 2019-10-09 13:21:14 +0000 |
|---|---|---|
| committer | Eric Wong <e@80x24.org> | 2019-10-10 08:46:24 +0000 |
| commit | 8d3e3bd820f8177557281554470e9fbbc3a7487b (patch) | |
| tree | e8f809f0b9b948fc9dcfbd8a1d85bbdf1622cbf4 | |
| parent | 2968a77518b7c7cae5df702233dc83e4a559c3a9 (diff) | |
| download | public-inbox-8d3e3bd820f8177557281554470e9fbbc3a7487b.tar.gz | |
doc: explain publicinbox.<name>.watchheader
It wasn't clear to me exactly what this does -- in particular, what happens if it isn't specified? Does it support multiple values? A very brief explanation can answer both of these questions without making somebody look at the code.
| -rw-r--r-- | Documentation/public-inbox-config.pod | 3 | ||||
| -rw-r--r-- | Documentation/public-inbox-watch.pod | 4 |
2 files changed, 7 insertions, 0 deletions
diff --git a/Documentation/public-inbox-config.pod b/Documentation/public-inbox-config.pod index 4e8ba4da..8d545f7a 100644 --- a/Documentation/public-inbox-config.pod +++ b/Documentation/public-inbox-config.pod @@ -80,6 +80,9 @@ Default: none; only for L<public-inbox-watch(1)> users [publicinbox "test"] 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. + Default: none; only for L<public-inbox-watch(1)> users =item publicinbox.<name>.nntpmirror diff --git a/Documentation/public-inbox-watch.pod b/Documentation/public-inbox-watch.pod index 3f282f0f..198c170a 100644 --- a/Documentation/public-inbox-watch.pod +++ b/Documentation/public-inbox-watch.pod @@ -15,7 +15,11 @@ In ~/.public-inbox/config: mainrepo = /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] |