.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)
.\"
.\" 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
.\" ========================================================================
.\"
.IX Title "SA-AWL 1p"
.TH SA-AWL 1p "2021-03-26" "perl v5.28.1" "User Contributed Perl Documentation"
.\" 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"
sa\-awl \- examine and manipulate SpamAssassin's auto\-whitelist db
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBsa-awl\fR [\-\-clean] [\-\-min n] [dbfile]
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Check or clean a SpamAssassin auto-whitelist (\s-1AWL\s0) database file.
.PP
The name of the file is specified after any options, as \f(CW\*(C`dbfile\*(C'\fR.
The default is \f(CW\*(C`$HOME/.spamassassin/auto\-whitelist\*(C'\fR.
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\-\-clean" 4
.IX Item "--clean"
Clean out infrequently-used \s-1AWL\s0 entries.  The \f(CW\*(C`\-\-min\*(C'\fR switch can be
used to select the threshold at which entries are kept or deleted.
.IP "\-\-min n" 4
.IX Item "--min n"
Select the threshold at which entries are kept or deleted when \f(CW\*(C`\-\-clean\*(C'\fR is
used.  The default is \f(CW2\fR, so entries that have only been seen once are
deleted.
.SH "OUTPUT"
.IX Header "OUTPUT"
The output looks like this:
.PP
.Vb 1
\&     AVG  (TOTSCORE/COUNT)  \-\-  EMAIL|ip=IPBASE
.Ve
.PP
For example:
.PP
.Vb 2
\&     0.0         (0.0/7)  \-\-  dawson@example.com|ip=208.192
\&    21.8        (43.7/2)  \-\-  mcdaniel_2s2000@example.com|ip=200.106
.Ve
.PP
\&\f(CW\*(C`AVG\*(C'\fR is the average score;  \f(CW\*(C`TOTSCORE\*(C'\fR is the total score of all mails seen
so far;  \f(CW\*(C`COUNT\*(C'\fR is the number of messages seen from that sender;  \f(CW\*(C`EMAIL\*(C'\fR is
the sender's email address, and \f(CW\*(C`IPBASE\*(C'\fR is the \fB\s-1AWL\s0 base \s-1IP\s0 address\fR.
.PP
\&\fB\s-1AWL\s0 base \s-1IP\s0 address\fR is a way to identify the sender's \s-1IP\s0 address they
frequently send from, in an approximate way, but remaining hard for spammers to
spoof.  The algorithm is as follows:
.PP
.Vb 2
\&  \- take the last Received header that contains a public IP address \-\- namely
\&    one which is not in private, unrouted IP space.
\&
\&  \- chop off the last two octets, assuming that the user may be in an ISP\*(Aqs
\&    dynamic address pool.
.Ve