.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "PUBLIC-INBOX-WATCH 1" .TH PUBLIC-INBOX-WATCH 1 "1993-10-02" "public-inbox.git" "public-inbox user manual" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" public\-inbox\-watch \- mailbox watcher for public\-inbox .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& public\-inbox\-watch .Ve .PP In ~/.public\-inbox/config: .PP .Vb 5 \& [publicinbox "test"] \& ; generic public\-inbox\-config keys: \& address = test@example.com \& url = http://example.com/test \& 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\*(Aqt have a header matching \& ; value will be skipped \& watchheader = List\-Id: \& \& [publicinboxwatch] \& ; optional, enable use of spamc(1) for checking: \& spamcheck = spamc \& \& ; optional, emails marked as read which appear \& ; here will be trained as spam and deleted from \& ; 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 .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" public-inbox-watch allows watching a mailbox or newsgroup for the arrival of new messages and automatically 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 \&\fBpublic\-inbox\-mda\fR\|(1) on a server. Unlike public-inbox-mda which is invoked once per-message, public-inbox-watch is a persistent process, making it faster for after-the-fact imports of large Maildirs. .PP Upon startup, it scans the mailbox for new messages to be imported while it was not running. .PP As of public-inbox 1.6.0, Maildirs, \s-1IMAP\s0 folders, and \s-1NNTP\s0 newsgroups are supported. Previous versions of public-inbox only supported Maildirs. .PP public-inbox-watch should be run inside a \fBscreen\fR\|(1) session or as a \fBsystemd\fR\|(1) service. Errors are emitted to stderr. .SH "OPTIONS" .IX Header "OPTIONS" public-inbox-watch takes no command-line options. .SH "CONFIGURATION" .IX Header "CONFIGURATION" These configuration knobs should be used in the \&\fBpublic\-inbox\-config\fR\|(5) file .IP "publicinbox..watch" 8 .IX Item "publicinbox..watch" A location to watch. public-inbox 1.5.0 and earlier only supported \&\f(CW\*(C`maildir:\*(C'\fR paths: .Sp .Vb 2 \& [publicinbox "test"] \& watch = maildir:/path/to/maildirs/.INBOX.test/ .Ve .Sp public-inbox 1.6.0 supports \f(CW\*(C`nntp://\*(C'\fR, \f(CW\*(C`nntps://\*(C'\fR, \&\f(CW\*(C`imap://\*(C'\fR and \f(CW\*(C`imaps://\*(C'\fR URLs: .Sp .Vb 2 \& watch = nntp://news.example.com/inbox.test.group \& watch = imaps://user@mail.example.com/INBOX.test .Ve .Sp This may be specified multiple times to combine several mailboxes into a single public-inbox. URLs requiring authentication will require \fBnetrc\fR\|(5) and/or \fBgit\-credential\fR\|(1) (preferred) to fill in the username and password. .Sp Default: none .IP "publicinbox..watchheader" 8 .IX Item "publicinbox..watchheader" .Vb 2 \& [publicinbox "test"] \& watchheader = List\-Id: .Ve .Sp If specified, \fBpublic\-inbox\-watch\fR\|(1) will only process mail matching the given header. If specified multiple times in public-inbox 1.5 or later, mail will be processed if it matches any of the values. Only the last value was used in public-inbox 1.4 and earlier. .Sp Default: none .IP "publicinboxwatch.spamcheck" 8 .IX Item "publicinboxwatch.spamcheck" This may be set to \f(CW\*(C`spamc\*(C'\fR to enable the use of SpamAssassin \&\fBspamc\fR\|(1) for filtering spam before it is imported into git history. Other spam filtering backends may be supported in the future. .Sp Default: none .IP "publicinboxwatch.watchspam" 8 .IX Item "publicinboxwatch.watchspam" A Maildir to watch for confirmed spam messages to appear in. Messages which appear in this folder with the (S)een flag will be hidden from all configured inboxes based on Message-ID and content matching. .Sp Messages without the (S)een flag are not considered for hiding. This hiding affects all configured public-inboxes in \s-1PI_CONFIG.\s0 .Sp As with \f(CW\*(C`publicinbox.$NAME.watch\*(C'\fR, \f(CW\*(C`imap://\*(C'\fR and \f(CW\*(C`imaps://\*(C'\fR URLs are supported in public-inbox 1.6.0+. .Sp Default: none; only for \fBpublic\-inbox\-watch\fR\|(1) users .IP "imap.Starttls / imap.$URL.Starttls" 8 .IX Item "imap.Starttls / imap.$URL.Starttls" Whether or not to use \f(CW\*(C`STARTTLS\*(C'\fR on plain \f(CW\*(C`imap://\*(C'\fR connections. .Sp May be specified for certain URLs via \*(L"\-\-get\-urlmatch\*(R" in \fBgit\-config\fR\|(1) in \f(CWgit(1)\fR 1.8.5+. .Sp Default: \f(CW\*(C`true\*(C'\fR .IP "imap.Compress / imap.$URL.Compress" 8 .IX Item "imap.Compress / imap.$URL.Compress" Whether or not to use the \s-1IMAP COMPRESS\s0 (\s-1RFC4978\s0) extension to save bandwidth. This is not supported by all \s-1IMAP\s0 servers and some advertising this feature may not implement it correctly. .Sp May be specified only for certain URLs if \fBgit\fR\|(1) 1.8.5+ is installed to use \*(L"\-\-get\-urlmatch\*(R" in \fBgit\-config\fR\|(1) .Sp Default: \f(CW\*(C`false\*(C'\fR .IP "nntp.Starttls / nntp.$URL.Starttls" 8 .IX Item "nntp.Starttls / nntp.$URL.Starttls" Whether or not to use \f(CW\*(C`STARTTLS\*(C'\fR on plain \f(CW\*(C`nntp://\*(C'\fR connections. .Sp May be specified for certain URLs via \*(L"\-\-get\-urlmatch\*(R" in \fBgit\-config\fR\|(1) in \f(CWgit(1)\fR 1.8.5+. .Sp Default: \f(CW\*(C`false\*(C'\fR if the hostname is a Tor \f(CW\*(C`.onion\*(C'\fR, \f(CW\*(C`true\*(C'\fR otherwise .SH "SIGNALS" .IX Header "SIGNALS" .IP "\s-1SIGHUP\s0" 8 .IX Item "SIGHUP" Reload the config file (default: ~/.public\-inbox/config) .IP "\s-1SIGUSR1\s0" 8 .IX Item "SIGUSR1" Rescan all watched mailboxes. This is done automatically after startup. .IP "\s-1SIGQUIT / SIGTERM / SIGINT\s0" 8 .IX Item "SIGQUIT / SIGTERM / SIGINT" Gracefully shut down. In-flight messages will be stored and indexed. .SH "ENVIRONMENT" .IX Header "ENVIRONMENT" .IP "\s-1PI_CONFIG\s0" 8 .IX Item "PI_CONFIG" config file. default: ~/.public\-inbox/config See \fBpublic\-inbox\-config\fR\|(5) .IP "\s-1PERL_INLINE_DIRECTORY\s0" 8 .IX Item "PERL_INLINE_DIRECTORY" This may affect any public-inbox processes, but is intended for long-lived ones such as \f(CW\*(C`public\-inbox\-watch\*(C'\fR or network daemons. See \fBpublic\-inbox\-daemon\fR\|(8). .SH "CONTACT" .IX Header "CONTACT" Feedback welcome via plain-text mail to .PP The mail archives are hosted at and .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright 2016\-2021 all contributors .PP License: \s-1AGPL\-3.0+\s0 .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBpublic\-inbox\-config\fR\|(5)