.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
.\"
.\" 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 turned on, 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 "UNGREY-ROBINS 8"
.TH UNGREY-ROBINS 8 "2017-05-25" "perl v5.18.2" "Postmaster's 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"
ungrey\-robins \- pf spamd auto\-whitelister of round\-robin SMTP clients
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBungrey-robins\fR [\fB\-d\fR] [\fB\-g\fR \fIgrace threshold\fR]
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBungrey-robins\fR assists postmasters by automatically whitelisting round robin
\&\s-1SMTP\s0 clients (which often fail to pass greylisting), without resorting to manual
maintenance of whitelists.
.SS "Normal Usage"
.IX Subsection "Normal Usage"
Running \fBungrey-robins\fR at the same frequency as \fIspamd\fR\|(8)'s \fB\-G\fR \fIgreyexp\fR
period (4 hours by default) is entirely adequate. There is no benefit in
consuming \s-1CPU, I/O &\s0 network resources in running it more often.
.SS "Scheduling"
.IX Subsection "Scheduling"
Intermittent runs of the lightweight \fIkorn\fR\|(1) shell script via \fIcron\fR\|(8) has proved
to be effective simplicity.
.SH "OPTIONS"
.IX Header "OPTIONS"
.SS "\-d"
.IX Subsection "-d"
Run in debug mode.
.SS "\-g \fIgrace threshold\fP"
.IX Subsection "-g grace threshold"
The threshold at which grace is granted to whitelist a \fIspamdb\fR\|(8) greylisted \s-1IP\s0
address, which defaults to 7.
.SH "ENVIRONMENT"
.IX Header "ENVIRONMENT"
.IP "\s-1DEBUG\s0" 4
.IX Item "DEBUG"
Enable debugging when set to anything.
.IP "\s-1TMPDIR\s0" 4
.IX Item "TMPDIR"
Directory in which to place temporary files made with \fImktemp\fR\|(1).
If unset, \fI/tmp\fR is used.
.SH "FILES"
.IX Header "FILES"
\&\fI/etc/mail/ungrey\-robins.ptrn\fR mandatory domains pattern file.
.SH "SECURITY"
.IX Header "SECURITY"
For unprivileged, non-root usage:
.PP
To both read and write to \fIspamd\fR\|(8)'s database file \fI/var/db/spamd\fR
via the \fIspamdb\fR\|(8) tool, it is suggested to run \fBungrey-robins\fR from the
\&\f(CW\*(C`_spamd\*(C'\fR user's \fIcrontab\fR\|(5).
.PP
The source code distribution contains an example \fIcrontab\fR file.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIungrey\-robins.ptrn\fR\|(5), \fIspamd\fR\|(8), \fIspamdb\fR\|(8), \fIcrontab\fR\|(5), \fIcrontab\fR\|(1), \fImktemp\fR\|(1)
.SH "AVAILABILITY"
.IX Header "AVAILABILITY"
For your convenience, the project offers:
.IP "\(bu" 4
anonymous \s-1CVS\s0 source code access
.IP "\(bu" 4
anonymous \s-1HTTP\s0 access from <http://web.Britvault.Co.UK/products/ungrey\-robins/>
.IP "\(bu" 4
a mailing list for discussion & diffs
.PP
The source code distribution \fI\s-1README\s0\fR file contains specifics.
.PP
While designed specifically for OpenBSD, it might function on Unix-like
pf spamd enabled OSs, such as NetBSD, FreeBSD, DragonFly \s-1BSD,\s0 etc.
.SH "LICENCE"
.IX Header "LICENCE"
\&\fBungrey-robins\fR has an \s-1ISC,\s0 or 'two\-term \s-1BSD\s0' styled open source copyright.
Refer to the \fI\s-1LICENCE\s0\fR file within the source distribution.
.SH "HISTORY"
.IX Header "HISTORY"
Craig Skinner developed \fBungrey-robins\fR, mostly in 2016.
The \fIChangeLog\fR file in the source distribution contains more information.