Mercurial > notdcc

comparison dbclean.8.in @ 0:c7f6b056b673

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
First import of vendor version
author Peter Gervai <grin@grin.hu>
date Tue, 10 Mar 2009 13:49:58 +0100
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:c7f6b056b673
1 .\" Copyright (c) 2008 by Rhyolite Software, LLC
2 .\"
3 .\" This agreement is not applicable to any entity which sells anti-spam
4 .\" solutions to others or provides an anti-spam solution as part of a
5 .\" security solution sold to other entities, or to a private network
6 .\" which employs the DCC or uses data provided by operation of the DCC
7 .\" but does not provide corresponding data to other users.
8 .\"
9 .\" Permission to use, copy, modify, and distribute this software without
10 .\" changes for any purpose with or without fee is hereby granted, provided
11 .\" that the above copyright notice and this permission notice appear in all
12 .\" copies and any distributed versions or copies are either unchanged
13 .\" or not called anything similar to "DCC" or "Distributed Checksum
14 .\" Clearinghouse".
15 .\"
16 .\" Parties not eligible to receive a license under this agreement can
17 .\" obtain a commercial license to use DCC by contacting Rhyolite Software
18 .\" at sales@rhyolite.com.
19 .\"
20 .\" A commercial license would be for Distributed Checksum and Reputation
21 .\" Clearinghouse software. That software includes additional features. This
22 .\" free license for Distributed ChecksumClearinghouse Software does not in any
23 .\" way grant permision to use Distributed Checksum and Reputation Clearinghouse
24 .\" software
25 .\"
26 .\" THE SOFTWARE IS PROVIDED "AS IS" AND RHYOLITE SOFTWARE, LLC DISCLAIMS ALL
27 .\" WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES
28 .\" OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL RHYOLITE SOFTWARE, LLC
29 .\" BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES
30 .\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
31 .\" WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
32 .\" ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
33 .\" SOFTWARE.
34 .\"
35 .\" Rhyolite Software DCC 1.3.103-1.58 $Revision$
36 .\"
37 .Dd February 26, 2009
38 .ds volume-ds-DCC Distributed Checksum Clearinghouse
39 .Dt dbclean 8 DCC
40 .Os " "
41 .Sh NAME
42 .Nm dbclean
43 .Nd Clean Distributed Checksum Clearinghouse Database
44 .Sh SYNOPSIS
45 .Bk -words
46 .Nm dbclean
47 .Op Fl dfFNPSVq
48 .Op Fl i Ar id
49 .Oo
50 .Fl a Xo
51 .Sm off
52 .Op Ar server-addr
53 .Op Ar ,port
54 .Xc
55 .Sm on
56 .Oc
57 .Op Fl h Ar homedir
58 .br
59 .Op Fl G Ar on
60 .Op Fl R Ar mode
61 .Op Fl s Ar hash-size
62 .Op Fl e Ar seconds
63 .Op Fl E Ar spamsecs
64 .br
65 .Op Fl L Ar ltype,facility.level
66 .Ek
67 .Sh DESCRIPTION
68 .Nm Dbclean
69 creates empty, rebuilds corrupted, and deletes or expires old reports
70 of checksums from DCC databases.
71 It should be installed where it will be found with the path
72 given the DCC server daemon when the daemon needs to expand the hash table.
73 See
74 .Xr dccd 8 .
75 It should also be run by
76 .Xr cron 8
77 approximately daily.
78 .Pp
79 If the hash table in the database has been damaged,
80 .Nm
81 tries to repair the database.
82 .Pp
83 The contents of the
84 .Pa whitelist
85 file are built into the DCC server's database.
86 Changes to the whitelist are not effective until dbclean is run
87 to expire reports.
88 White or blacklists can also be used by DCC clients,
89 and generally work better there.
90 .Ss OPTIONS
91 The following options are available:
92 .Bl -tag -width xxx
93 .It Fl d
94 enables debugging output.
95 Additional
96 .Fl d
97 options increase the number of messages.
98 .It Fl F
99 uses write() instead of mmap() in some cases to modify the DCC
100 database.
101 This works better on some versions of Solaris provided the entire DCC
102 database fits in RAM and provided the file system has not been tuned
103 for the large, random accesses of a DCC database.
104 It is the default on Solaris.
105 .It Fl f
106 turns off
107 .Fl F .
108 .It Fl N
109 creates a new, empty database.
110 There must not be an existing database and the DCC server,
111 .Xr dccd 8 ,
112 must not be running.
113 .It Fl P
114 expires old checksums from a database using the
115 .Fl e and
116 .Fl E
117 values from the preceding use of
118 .Nm dbclean .
119 .Fl P
120 cannot be used with
121 .Fl e
122 or
123 .Fl E .
124 Note also that using
125 .Fl P
126 differs from not using
127 .Fl e
128 or
129 .Fl E ,
130 because in the absence of all four, their default values are used.
131 .It Fl S
132 says that
133 the DCC server,
134 .Xr dccd 8 ,
135 is not running and so
136 .Nm
137 should run stand-alone and not try to tell the DCC server about
138 changes to the database.
139 .Fl i
140 is not needed when
141 .Fl S
142 is present.
143 .It Fl V
144 displays the version of the DCC database cleaner.
145 .It Fl q
146 quiets the announcement of results at the end.
147 .It Fl i Ar id
148 specifies the DCC ID recognized by the local DCC server as its own.
149 This ID allows the DCC server to recognize commands from
150 .Nm
151 to stop using the database while it is being cleaned.
152 .It Fl a Xo
153 .Sm off
154 .Op Ar server-addr
155 .Op Ar ,port
156 .Xc
157 .Sm on
158 is commonly used to specify a UDP port or IP address of the local
159 server other than the default.
160 .It Fl h Ar homedir
161 overrides the default DCC home directory,
162 .Pa @prefix@ .
163 .It Fl G Ar on
164 cleans a greylist database.
165 .It Fl R Ar mode
166 repairs a database or does a quick cleaning.
167 .Ar Mode
168 must be one of the following:
169 .Bl -tag -width quick -compact
170 .It Em bad
171 to repair a broken database.
172 .It Em quick
173 for a quick, superficial cleaning during the day.
174 .It Em hash
175 to rebuild a hash not sent to disk before the system was recently restarted.
176 .It Em cron
177 for the nightly cleaning by the
178 .Xr cron 8
179 job
180 .Pa @libexecdir@/cron-dccd
181 .It Em del
182 to finish processing a delete command received by
183 .Xr dccd 8 .
184 .El
185 .It Fl s Ar hash-size
186 specifies a size for the hash table.
187 By default the hash table is rebuilt to be approximately 80% full based
188 on an estimate of the number of distinct checksums in the main file.
189 .It Fl e Ar seconds
190 specifies that reports older than
191 .Ar seconds
192 and with totals below 10 targets should be deleted.
193 Reports older than
194 .Ar seconds
195 of checksums that have been reported more recently
196 are summarized in the database.
197 The default value is 1DAY or the value of
198 .Fl E ,
199 whichever is smaller.
200 The 1 day default is reduced if the system does not appear to have
201 enough RAM to hold the database.
202 The minimum is 1 hour.
203 .Ar Seconds
204 can also be
205 .Ar NEVER
206 or a number of hours, days, or weeks followed by
207 .Ar HOURS ,
208 .Ar H ,
209 .Ar DAYS ,
210 .Ar D ,
211 .Ar WEEKS
212 or
213 .Ar W .
214 .Pp
215 DCC servers that are not very busy and are
216 isolated or do not receive "floods" of checksums
217 from busy servers should use longer values
218 to increase their chances of recognizing bulk mail.
219 .It Fl E Ar spamsecs
220 changes the expiration of checksums with more than 10 targets
221 from the default of 30DAYS or the explicit value of
222 .Fl e ,
223 whichever is larger.
224 The default is reduced if the system does not have enough RAM
225 to hold the database.
226 .Ar Spamsecs
227 can also be
228 .Ar NEVER
229 or a number of hours, days, or weeks followed by
230 .Ar HOURS ,
231 .Ar H ,
232 .Ar DAYS ,
233 .Ar D ,
234 .Ar WEEKS
235 or
236 .Ar W .
237 .It Fl L Ar ltype,facility.level
238 specifies how messages should be logged.
239 .Ar Ltype
240 must be
241 .Ar error ,
242 .Ar info ,
243 or
244 .Ar off
245 to indicate which of the two types of messages are being controlled or
246 to turn off all
247 .Xr syslog 3
248 messages from
249 .Nm .
250 .Ar Level
251 must be a
252 .Xr syslog 3
253 level among
254 .Ar EMERG ,
255 .Ar ALERT ,
256 .Ar CRIT , ERR ,
257 .Ar WARNING ,
258 .Ar NOTICE ,
259 .Ar INFO ,
260 and
261 .Ar DEBUG .
262 .Ar Facility
263 must be among
264 .Ar AUTH ,
265 .Ar AUTHPRIV ,
266 .Ar CRON ,
267 .Ar DAEMON ,
268 .Ar FTP ,
269 .Ar KERN ,
270 .Ar LPR ,
271 .Ar MAIL ,
272 .Ar NEWS ,
273 .Ar USER ,
274 .Ar UUCP ,
275 and
276 .Ar LOCAL0
277 through
278 .Ar LOCAL7 .
279 The default is equivalent to
280 .Dl Fl L Ar info,MAIL.NOTICE Fl L Ar error,MAIL.ERR
281 .El
282 .Pp
283 .Nm
284 exits 0 on success,
285 and > 0 if an error occurs.
286 .Sh FILES
287 .Bl -tag -width grey_db.hash -compact
288 .It Pa @prefix@
289 is the DCC home directory containing data and control files.
290 .It Pa dcc_db
291 is the main file containing mail checksums.
292 .It Pa dcc_db.hash
293 mail checksum database hash table.
294 .It Pa grey_db
295 is the database of greylist checksums.
296 .It Pa grey_db.hash
297 is the greylist database hash table.
298 .It Pa dcc_db-new , dcc_db-new.hash , grey_db-new , grey_db-new.hash
299 new database and hash files until they are renamed.
300 .It Pa dcc_db-old , grey_db-old
301 previous database files.
302 .It Pa ids
303 list of IDs and passwords, as described in
304 .Xr dccd 8 .
305 .It Pa whitelist
306 contains the DCC server whitelist in
307 the format described in
308 .Xr dcc 8 .
309 .It Pa grey_whitelist
310 contains the greylist server whitelist.
311 .El
312 .Sh SEE ALSO
313 .Xr cdcc 8 ,
314 .Xr cron 8 ,
315 .Xr dcc 8 ,
316 .Xr dccd 8 ,
317 .Xr dblist 8 ,
318 .Xr dccifd 8 ,
319 .Xr dccm 8 ,
320 .Xr dccproc 8 .
321 .Sh HISTORY
322 Implementation of
323 .Nm
324 was started at Rhyolite Software, in 2000.
325 This document describes version 1.3.103.