.\" 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 "SPAMDBA 8"
.TH SPAMDBA 8 "2015-02-02" "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"
spamdba \- pf spamd database assistant
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBspamdba\fR [\-hv] (add|delete|dump|load) [\-l] (\-stw) [\-p pattern] [\-f \fIfile\fR]
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBspamdba\fR assists postmasters to routinely manipulate the \fIspamd\fR\|(8) database.
This tool is a wrapper for \fIspamdb\fR\|(8), simplifying common tasks, such as:\-
.IP "\(bu" 4
Adding/deleting of all, or a pattern matched subset of entries.
.IP "\(bu" 4
Dumping & loading \- for \s-1OS\s0 upgrades, database format changes,
sharing data between different architecture/OS machines, etc.
.SH "OPTIONS"
.IX Header "OPTIONS"
.SS "\-h, \-?"
.IX Subsection "-h, -?"
Show a help summary of options and exit.
.SS "\-v"
.IX Subsection "-v"
Show version and exit.
.SS "add"
.IX Subsection "add"
Add entries via \fIspamdb\fR\|(8).
.SS "delete"
.IX Subsection "delete"
Delete entries via \fIspamdb\fR\|(8).
.SS "dump"
.IX Subsection "dump"
Dump (export) the \fIspamdb\fR\|(8) database.
.SS "load"
.IX Subsection "load"
Load (import) entries from a \fBdump\fRed \fIspamdb\fR\|(8) database.
.SS "\-l"
.IX Subsection "-l"
Generate a log file.
.SS "\-s"
.IX Subsection "-s"
Add or delete \fI\s-1SPAMTRAP\s0\fR entries.
.SS "\-t"
.IX Subsection "-t"
Add or delete \fI\s-1TRAPPED\s0\fR entries.
.SS "\-w"
.IX Subsection "-w"
Add or delete \fI\s-1WHITE\s0\fR entries.
.SS "\-p"
.IX Subsection "-p"
Pattern to match with \fIgrep\fR\|(1)
.SS "\-f \fIfile\fP"
.IX Subsection "-f file"
A \fIfile\fR containing a list of single \s-1IP\s0 addresses \fIor\fR email addresses to
add or delete. Blank and comment lines beginning with \f(CW\*(C`#\*(C'\fR are ignored.
.SH "FILES"
.IX Header "FILES"
\&\fI/etc/mail/spamd.trap\-addresses\fR optional default trap address list
.SH "SECURITY"
.IX Header "SECURITY"
Suggestions for unprivileged, non-root usage:
.IP "\(bu" 4
add a group, such as \f(CW\*(C`postmasters\*(C'\fR or \f(CW\*(C`mailadmins\*(C'\fR
.IP "\(bu" 4
add suitable members to that group
.IP "\(bu" 4
make \fI/var/db/spamd\fR writable by that group
.PP
\&\fIExample\fR commands could include:
.PP
.Vb 10
\&        you$ ls \-l /var/db/spamd
\&        you$ sudo cp \-p /var/db/spamd /var/db/spamd~
\&        you$ sudo groupadd postmasters
\&        you$ sudo usermod \-G postmasters you
\&        you$ sudo chgrp postmasters /var/db/spamd
\&        you$ sudo chmod g+w /var/db/spamd
\&        you$ sudo chmod o\-r /var/db/spamd
\&        you$ ls \-l /var/db/spamd*
\&        \-rw\-rw\-\-\-\-  1 _spamd  postmasters  212992 Mar 31 15:07 /var/db/spamd
\&        \-rw\-r\-\-r\-\-  1 _spamd  _spamd       212992 Mar 31 15:07 /var/db/spamd~
.Ve
.PP
You may also want to grant the same group write
privileges to \fI/etc/mail/spamd.trap\-addresses\fR, e.g:
.PP
.Vb 1
\&        \-rw\-rw\-\-\-\-  1 postmaster  postmasters  16955 Mar 28 20:11 /etc/mail/spamd.trap\-addresses
.Ve
.SH "EXAMPLES"
.IX Header "EXAMPLES"
Delete spam trap addresses, limiting to a pattern, and with logging:
.PP
.Vb 3
\&        you$ spamdba delete \-l \-s \-p \*(Aq@britvault.co.uk$\*(Aq
\&        Processed: 257
\&        Log: /tmp/spamdba_delete_SPAMTRAP.log.53YIYA6
.Ve
.PP
Add spam trap addresses not already loaded,
from the default file \fI/etc/mail/spamd.trap\-addresses\fR:
.PP
.Vb 2
\&        you$ spamdba add \-s
\&        Processed: 257
.Ve
.PP
Runs to delete all spam trap addresses,
and then add in those matching a pattern:
.PP
.Vb 5
\&        you$ spamdba delete \-s
\&        Processed: 515
\&        you$ spamdba add \-l \-s \-p jun\-2006
\&        Processed: 470
\&        Log: /tmp/spamdba_add_SPAMTRAP.log.Phpqt3Z
.Ve
.PP
Delete whitelisted hosts in a net block pattern:
.PP
.Vb 3
\&        you$ spamdba delete \-l \-w \-p \*(Aq^157.55.\*(Aq
\&        Processed: 14
\&        Log: /tmp/spamdba_delete_WHITE.log.Ou7QbA7
.Ve
.PP
Whoops! Re-whitelist those hosts again:
.PP
.Vb 2
\&        you$ spamdba add \-w \-f /tmp/spamdba_delete_WHITE.log.Ou7QbA7
\&        Processed: 14
.Ve
.PP
Dump on one host & load on another of a different architecture:
.PP
.Vb 2
\&        you@primary\-mx sparc64$ spamdba dump
\&        Dump: /tmp/spamdba.dump.a26SCL9
\&
\&        you@mx\-backup i386$ spamdba load \-f ~/spamdba.dump
\&        Processed: 515
\&        Log: /tmp/spamdba_add_SPAMTRAP.log.JsieTX8
\&        Processed: 1100
\&        Log: /tmp/spamdba_add_TRAPPED.log.ej7gp1B
\&        Processed: 241
\&        Log: /tmp/spamdba_add_WHITE.log.Ru65NEp
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIspamdb\fR\|(8), \fIspamd\fR\|(8)
.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/spamdba/>
.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 "VERSION"
.IX Header "VERSION"
This page documents \fBspamdba\fR version \fI1.0.3\fR
.SH "LICENCE"
.IX Header "LICENCE"
\&\fBspamdba\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 spamdba, mostly in 2013\-2014.
He packaged it for OpenBSD in 2014. The \fIChangeLog\fR file in
the source distribution contains more information.