xref: /openbsd/libexec/spamd-setup/spamd-setup.8 (revision 76d0caae)
1.\"	$OpenBSD: spamd-setup.8,v 1.21 2016/03/31 15:54:17 schwarze Exp $
2.\"
3.\" Copyright (c) 2003 Jason L. Wright (jason@thought.net)
4.\" All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
17.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18.\" DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
19.\" INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
20.\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
21.\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
23.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
24.\" POSSIBILITY OF SUCH DAMAGE.
25.\"
26.Dd $Mdocdate: March 31 2016 $
27.Dt SPAMD-SETUP 8
28.Os
29.Sh NAME
30.Nm spamd-setup
31.Nd parse and load file of spammer addresses
32.Sh SYNOPSIS
33.Nm spamd-setup
34.Op Fl bDdn
35.Sh DESCRIPTION
36The
37.Nm
38utility sends blacklist data to
39.Xr spamd 8 ,
40as well as configuring mail rejection messages for
41blacklist entries.
42.Pp
43When
44.Nm
45is run in blacklist only mode,
46it also sends blacklist data to the
47.Xr pf 4
48table
49.Pf < Ar spamd Ns > .
50The
51.Pf < Ar spamd Ns >
52table must then be used in conjunction with a
53.Xr pf 4
54redirection rule to selectively redirect mail connections
55to
56.Xr spamd 8 .
57.Pp
58The options are as follows:
59.Bl -tag -width Ds
60.It Fl b
61Blacklisting only mode.
62Blacklist data is normally stored only in
63.Xr spamd 8 .
64With this flag, data is stored in both
65.Xr spamd 8
66and
67.Xr pf 4 .
68Use this flag if
69.Xr spamd 8
70is running with the
71.Fl b
72flag too.
73.It Fl D
74Daemonize;
75run
76.Nm
77in the background.
78.It Fl d
79Debug mode reports a few pieces of information.
80.It Fl n
81Dry-run mode.
82No data is shipped.
83.El
84.Pp
85Lists are specified in the configuration file
86.Pa /etc/mail/spamd.conf
87and are processed in the order specified in the
88.Ar all
89tag.
90Output is concatenated and sent to a running
91.Xr spamd 8 .
92Addresses are sent
93along with the message spamd will give on mail rejection when a
94matching client connects.
95The configuration port for
96.Xr spamd 8
97is found from
98.Xr services 5 ,
99by looking for the named service
100.Em spamd-cfg .
101.Pp
102.Nm
103reads all configuration information from the
104.Xr spamd.conf 5
105file.
106.Sh FILES
107.Pa /etc/mail/spamd.conf
108.Sh SEE ALSO
109.Xr pf.conf 5 ,
110.Xr services 5 ,
111.Xr spamd.conf 5 ,
112.Xr spamd 8
113.Sh BUGS
114Blacklists removed from
115.Pa /etc/mail/spamd.conf
116are not automatically removed from the running
117.Xr spamd 8 .
118If an entry is removed from
119.Pa /etc/mail/spamd.conf
120that is currently in use, it is necessary to restart
121.Xr spamd 8 .
122This applies only to blacklists that are removed entirely, not those
123that are simply modified.
124