File: dbclean.html

package info (click to toggle)
dcc 1.2.74-2
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 3,552 kB
  • ctags: 4,041
  • sloc: ansic: 41,034; perl: 2,310; sh: 2,186; makefile: 224
file content (185 lines) | stat: -rw-r--r-- 10,268 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN">
<HTML>
<HEAD>
    <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1">
    <TITLE>dbclean.8</TITLE>
    <META http-equiv="Content-Style-Type" content="text/css">
    <STYLE type="text/css">
        BODY {background-color:white; color:black}
    </STYLE>
</HEAD>
<BODY>
<PRE>
<!-- Manpage converted by man2html 3.0.1 -->
<B><A HREF="dbclean.html">dbclean(8)</A></B>            Distributed Checksum Clearinghouse            <B><A HREF="dbclean.html">dbclean(8)</A></B>


</PRE>
<H2><A NAME="NAME">NAME</A></H2><PRE>
     <B>dbclean</B> -- Clean Distributed Checksum Clearinghouse Database


</PRE>
<H2><A NAME="SYNOPSIS">SYNOPSIS</A></H2><PRE>
     <B>dbclean</B> [<B>-dDfFNRPSVq</B>] [<B>-i</B> <I>id</I>] [<B>-a</B> [<I>server-addr</I>][<I>,port</I>]] [<B>-h</B> <I>homedir</I>]
             [<B>-G</B> <I>on</I>] [<B>-s</B> <I>hash-size</I>] [<B>-e</B> <I>seconds</I>] [<B>-E</B> <I>spamsecs</I>]
             [<B>-t</B> <I>type,allsecs,threshold,bulksecs</I>] [<B>-L</B> <I>ltype,facility.level</I>]


</PRE>
<H2><A NAME="DESCRIPTION">DESCRIPTION</A></H2><PRE>
     <B>Dbclean</B> creates empty, rebuilds corrupted, and deletes or expires old
     reports of checksums from DCC databases.  It should be installed where it
     will be found with the path given the DCC server daemon when the daemon
     needs to expand the hash table.  See <B><A HREF="dccd.html">dccd(8)</A></B>.  It should also be run by
     <B>cron(8)</B> approximately daily.

     If the hash table in the database has been damaged, <B>dbclean</B> tries to
     repair the database.

     The contents of the <I>whitelist</I> file are built into the DCC server's data-
     base.  Changes to the whitelist are not effective until dbclean is run to
     expire reports.  White or blacklists can also be used by DCC clients, and
     generally work better there.

   <A NAME="OPTIONS"><B>OPTIONS</B></A>
     The following options are available:

     <A NAME="OPTION-d"><B>-d</B></A>   enables debugging output.  Additional <B>-d</B> options increase the number
          of messages.

     <A NAME="OPTION-D"><B>-D</B></A>   indicates that <B><A HREF="dccd.html">dccd(8)</A></B> started <B>dbclean</B>.

     <A NAME="OPTION-F"><B>-F</B></A>   uses read() and write() instead of mmap() in some cases to access
          the DCC database.  This works better on some versions of Solaris
          provided the entire DCC database fits in RAM and provided the file
          system has not been tuned for the large, random accesses of a DCC
          database.  It is the default on Solaris.

     <A NAME="OPTION-f"><B>-f</B></A>   turns off <B>-F</B>.

     <A NAME="OPTION-N"><B>-N</B></A>   creates a new, empty database.  There must not be an existing data-
          base and the DCC server, <B><A HREF="dccd.html">dccd(8)</A></B>, must not be running.

     <A NAME="OPTION-R"><B>-R</B></A>   repairs a database.

     <A NAME="OPTION-P"><B>-P</B></A>   expires old checksums from a database using the <B>-e</B>, <B>-E</B>, and <B>-t</B> val-
          ues from the preceding use of <B>dbclean</B>.  <B>-P</B> cannot be used with <B>-e</B>,
          <B>-E</B>, or <B>-t</B>.  Note also that using <B>-P</B> differs from not using <B>-e -E</B> or
          <B>-t</B>, because in the absence of all four, their default values are
          used.

     <A NAME="OPTION-S"><B>-S</B></A>   says that the DCC server, <B><A HREF="dccd.html">dccd(8)</A></B>, is not running and so <B>dbclean</B>
          should run stand-alone and not try to tell the DCC server about
          changes to the database.  <B>-i</B> is not needed when <B>-S</B> is present.

     <A NAME="OPTION-V"><B>-V</B></A>   displays the version of the DCC database cleaner.

     <A NAME="OPTION-q"><B>-q</B></A>   quiets the announcement of results at the end.

     <A NAME="OPTION-i"><B>-i</B></A> <I>id</I>
          specifies the DCC ID recognized by the local DCC server as its own.
          This ID allows the DCC server to recognize commands from <B>dbclean</B> to
          stop using the database while it is being cleaned.

     <A NAME="OPTION-a"><B>-a</B></A> [<I>server-addr</I>][<I>,port</I>]
          is commonly used to specify a UDP port or IP address of the local
          server other than the default.

     <A NAME="OPTION-h"><B>-h</B></A> <I>homedir</I>
          overrides the default DCC home directory, which is often /var/dcc.

     <A NAME="OPTION-G"><B>-G</B></A> <I>on</I>
          cleans a greylist database.

     <A NAME="OPTION-s"><B>-s</B></A> <I>hash-size</I>
          specifies a size for the hash table.  By default the hash table is
          rebuilt to be approximately 80% full based on an estimate of the
          number of distinct checksums in the main file.

     <A NAME="OPTION-e"><B>-e</B></A> <I>seconds</I>
          specifies that reports older than <I>seconds</I> and with totals below
          their <B>-t</B> thresholds should be deleted.  Reports older than <I>seconds</I>
          of checksums that have been reported more recently are summarized in
          the database.  The default value is 2 days or the value of <B>-E</B>,
          whichever is smaller.  The 2 day default is reduced if the system
          does not appear to have enough RAM to hold the database.  The mini-
          mum is 1 hour.  <I>Seconds</I> can also be <I>NEVER</I> or a number of hours,
          days, or weeks followed by <I>HOURS</I>, <I>H</I>, <I>DAYS</I>, <I>D</I>, <I>WEEKS</I> or <I>W</I>.

          DCC servers that are not very busy and are isolated or do not
          receive "floods" of checksums from busy servers should use longer
          values to increase their chances of recognizing bulk mail.

     <A NAME="OPTION-E"><B>-E</B></A> <I>spamsecs</I>
          changes the expiration of checksums exceding <B>-t</B> thresholds from the
          default of 30 days or the explicit value of <B>-e</B>, whichever is larger.
          The 30 day default is reduced if the system does not have enough RAM
          to hold the database.  <I>Spamsecs</I> can also be <I>NEVER</I> or a number of
          hours, days, or weeks followed by <I>HOURS</I>, <I>H</I>, <I>DAYS</I>, <I>D</I>, <I>WEEKS</I> or <I>W</I>.

     <A NAME="OPTION-t"><B>-t</B></A> <I>type,allsecs</I>[<I>,threshold,bulksecs</I>]
          overrides the global <B>-e</B> setting and specifies that reports of check-
          sums of <I>type</I> with total counts of at least <I>threshold</I> should be kept
          for <I>bulksecs</I> seconds.  All reports should be kept for the shorter
          duration, <I>allsecs</I> seconds.  The threshold is either a number or the
          string <I>MANY</I> indicating millions of targets.  By default <B>dbclean</B> acts
          as if given <B>-t</B> <I>Fuz1,seconds,20,spamsecs</I> <B>-t</B> <I>Fuz2,seconds,20,spamsecs</I>,
          where <I>seconds</I> is the value for <B>-e</B> and <I>spamsecs</I> is the value for <B>-E</B>.
          All other checksum types act as if <B>-t</B> <I>type,seconds</I> were specified.
          <I>Allsecs</I> and <I>bulksecs</I> can also be <I>NEVER</I> or a number of hours, days,
          or weeks followed by <I>HOURS</I>, <I>H</I>, <I>DAYS</I>, <I>D</I>, <I>WEEKS</I> or <I>W</I>.

     <A NAME="OPTION-L"><B>-L</B></A> <I>ltype,facility.level</I>
          specifies how messages should be logged.  <I>Ltype</I> must be <I>error</I> or
          <I>info</I> to indicate which of the two types of messages are being con-
          trolled.  <I>Level</I> must be a <B>syslog(3)</B> level among <I>EMERG</I>, <I>ALERT</I>,
          <I>CRIT</I>, <I>ERR</I>, <I>WARNING</I>, <I>NOTICE</I>, <I>INFO</I>, and <I>DEBUG</I>.  <I>Facility</I> must be among
          <I>AUTH</I>, <I>AUTHPRIV</I>, <I>CRON</I>, <I>DAEMON</I>, <I>FTP</I>, <I>KERN</I>, <I>LPR</I>, <I>MAIL</I>, <I>NEWS</I>, <I>USER</I>,
          <I>UUCP</I>, and <I>LOCAL0</I> through <I>LOCAL7</I>.  The default is equivalent to

                -L info,MAIL.NOTICE -L error,MAIL.ERR

     <B>dbclean</B> exits 0 on success, and &gt; 0 if an error occurs.


</PRE>
<H2><A NAME="FILES">FILES</A></H2><PRE>
     <A NAME="FILE-/var/dcc">/var/dcc</A>      is the DCC home directory containing data and control
                   files.
     <A NAME="FILE-dcc_db">dcc_db</A>        is the main file containing mail checksums.
     <A NAME="FILE-dcc_db.hash">dcc_db.hash</A>   mail checksum database hash table.
     <A NAME="FILE-grey_db">grey_db</A>       is the database of greylist checksums.
     <A NAME="FILE-grey_db.hash">grey_db.hash</A>  is the greylist database hash table.
     <A NAME="FILE-dcc_db">dcc_db</A>-new, dcc_db-new.hash, grey_db-new, grey_db-new.hash
                   new database and hash files until they are renamed.
     <A NAME="FILE-dcc_db">dcc_db</A>-old, grey_db-old
                   previous database files.
     <A NAME="FILE-ids">ids</A>           list of IDs and passwords, as described in <B><A HREF="dccd.html">dccd(8)</A></B>.
     <A NAME="FILE-whitelist">whitelist</A>     contains the DCC server whitelist in the format described
                   in <B><A HREF="dcc.html">dcc(8)</A></B>.
     <A NAME="FILE-grey_whitelist">grey_whitelist</A>
                   contains the greylist server whitelist.


</PRE>
<H2><A NAME="SEE-ALSO">SEE ALSO</A></H2><PRE>
     <B><A HREF="cdcc.html">cdcc(8)</A></B>, <B>cron(8)</B>, <B><A HREF="dcc.html">dcc(8)</A></B>, <B><A HREF="dccd.html">dccd(8)</A></B>, <B><A HREF="dblist.html">dblist(8)</A></B>, <B><A HREF="dccifd.html">dccifd(8)</A></B>, <B><A HREF="dccm.html">dccm(8)</A></B>,
     <B><A HREF="dccproc.html">dccproc(8)</A></B>.


</PRE>
<H2><A NAME="HISTORY">HISTORY</A></H2><PRE>
     <A NAME="FILE-Implementation">Implementation</A> of <B>dbclean</B> was started at <A HREF="http://www.rhyolite.com/">Rhyolite Software</A> in 2000.  This
     <A NAME="FILE-describes">describes</A> version 1.2.74.

FreeBSD 4.9                     March 20, 2005                     FreeBSD 4.9
</PRE>
<HR>
<ADDRESS>
Man(1) output converted with
<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
modified for the DCC $Date 2001/04/29 03:22:18 $
</ADDRESS>
</BODY>
</HTML>