Mercurial > notdcc

comparison dbclean.0 @ 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 dbclean(8) Distributed Checksum Clearinghouse dbclean(8)
2
3 NNAAMMEE
4 ddbbcclleeaann -- Clean Distributed Checksum Clearinghouse Database
5
6 SSYYNNOOPPSSIISS
7 ddbbcclleeaann [--ddffFFNNPPSSVVqq] [--ii _i_d] [--aa [_s_e_r_v_e_r_-_a_d_d_r][_,_p_o_r_t]] [--hh _h_o_m_e_d_i_r]
8 [--GG _o_n] [--RR _m_o_d_e] [--ss _h_a_s_h_-_s_i_z_e] [--ee _s_e_c_o_n_d_s] [--EE _s_p_a_m_s_e_c_s]
9 [--LL _l_t_y_p_e_,_f_a_c_i_l_i_t_y_._l_e_v_e_l]
10
11 DDEESSCCRRIIPPTTIIOONN
12 DDbbcclleeaann creates empty, rebuilds corrupted, and deletes or expires old
13 reports of checksums from DCC databases. It should be installed where it
14 will be found with the path given the DCC server daemon when the daemon
15 needs to expand the hash table. See dccd(8). It should also be run by
16 cron(8) approximately daily.
17
18 If the hash table in the database has been damaged, ddbbcclleeaann tries to
19 repair the database.
20
21 The contents of the _w_h_i_t_e_l_i_s_t file are built into the DCC server's data-
22 base. Changes to the whitelist are not effective until dbclean is run to
23 expire reports. White or blacklists can also be used by DCC clients, and
24 generally work better there.
25
26 OOPPTTIIOONNSS
27 The following options are available:
28
29 --dd enables debugging output. Additional --dd options increase the number
30 of messages.
31
32 --FF uses write() instead of mmap() in some cases to modify the DCC data-
33 base. This works better on some versions of Solaris provided the
34 entire DCC database fits in RAM and provided the file system has not
35 been tuned for the large, random accesses of a DCC database. It is
36 the default on Solaris.
37
38 --ff turns off --FF.
39
40 --NN creates a new, empty database. There must not be an existing data-
41 base and the DCC server, dccd(8), must not be running.
42
43 --PP expires old checksums from a database using the --ee --aanndd --EE values
44 from the preceding use of ddbbcclleeaann. --PP cannot be used with --ee or --EE.
45 Note also that using --PP differs from not using --ee or --EE, because in
46 the absence of all four, their default values are used.
47
48 --SS says that the DCC server, dccd(8), is not running and so ddbbcclleeaann
49 should run stand-alone and not try to tell the DCC server about
50 changes to the database. --ii is not needed when --SS is present.
51
52 --VV displays the version of the DCC database cleaner.
53
54 --qq quiets the announcement of results at the end.
55
56 --ii _i_d
57 specifies the DCC ID recognized by the local DCC server as its own.
58 This ID allows the DCC server to recognize commands from ddbbcclleeaann to
59 stop using the database while it is being cleaned.
60
61 --aa [_s_e_r_v_e_r_-_a_d_d_r][_,_p_o_r_t]
62 is commonly used to specify a UDP port or IP address of the local
63 server other than the default.
64
65 --hh _h_o_m_e_d_i_r
66 overrides the default DCC home directory, _/_v_a_r_/_d_c_c.
67
68 --GG _o_n
69 cleans a greylist database.
70
71 --RR _m_o_d_e
72 repairs a database or does a quick cleaning. _M_o_d_e must be one of
73 the following:
74 _b_a_d to repair a broken database.
75 _q_u_i_c_k for a quick, superficial cleaning during the day.
76 _h_a_s_h to rebuild a hash not sent to disk before the system was
77 recently restarted.
78 _c_r_o_n for the nightly cleaning by the cron(8) job
79 _/_v_a_r_/_d_c_c_/_l_i_b_e_x_e_c_/_c_r_o_n_-_d_c_c_d
80 _d_e_l to finish processing a delete command received by dccd(8).
81
82 --ss _h_a_s_h_-_s_i_z_e
83 specifies a size for the hash table. By default the hash table is
84 rebuilt to be approximately 80% full based on an estimate of the
85 number of distinct checksums in the main file.
86
87 --ee _s_e_c_o_n_d_s
88 specifies that reports older than _s_e_c_o_n_d_s and with totals below 10
89 targets should be deleted. Reports older than _s_e_c_o_n_d_s of checksums
90 that have been reported more recently are summarized in the data-
91 base. The default value is 1DAY or the value of --EE, whichever is
92 smaller. The 1 day default is reduced if the system does not appear
93 to have enough RAM to hold the database. The minimum is 1 hour.
94 _S_e_c_o_n_d_s can also be _N_E_V_E_R or a number of hours, days, or weeks fol-
95 lowed by _H_O_U_R_S, _H, _D_A_Y_S, _D, _W_E_E_K_S or _W.
96
97 DCC servers that are not very busy and are isolated or do not
98 receive "floods" of checksums from busy servers should use longer
99 values to increase their chances of recognizing bulk mail.
100
101 --EE _s_p_a_m_s_e_c_s
102 changes the expiration of checksums with more than 10 targets from
103 the default of 30DAYS or the explicit value of --ee, whichever is
104 larger. The default is reduced if the system does not have enough
105 RAM to hold the database. _S_p_a_m_s_e_c_s can also be _N_E_V_E_R or a number of
106 hours, days, or weeks followed by _H_O_U_R_S, _H, _D_A_Y_S, _D, _W_E_E_K_S or _W.
107
108 --LL _l_t_y_p_e_,_f_a_c_i_l_i_t_y_._l_e_v_e_l
109 specifies how messages should be logged. _L_t_y_p_e must be _e_r_r_o_r, _i_n_f_o,
110 or _o_f_f to indicate which of the two types of messages are being con-
111 trolled or to turn off all syslog(3) messages from ddbbcclleeaann. _L_e_v_e_l
112 must be a syslog(3) level among _E_M_E_R_G, _A_L_E_R_T, _C_R_I_T, _E_R_R, _W_A_R_N_I_N_G,
113 _N_O_T_I_C_E, _I_N_F_O, and _D_E_B_U_G. _F_a_c_i_l_i_t_y must be among _A_U_T_H, _A_U_T_H_P_R_I_V,
114 _C_R_O_N, _D_A_E_M_O_N, _F_T_P, _K_E_R_N, _L_P_R, _M_A_I_L, _N_E_W_S, _U_S_E_R, _U_U_C_P, and _L_O_C_A_L_0
115 through _L_O_C_A_L_7. The default is equivalent to
116 --LL _i_n_f_o_,_M_A_I_L_._N_O_T_I_C_E --LL _e_r_r_o_r_,_M_A_I_L_._E_R_R
117
118 ddbbcclleeaann exits 0 on success, and > 0 if an error occurs.
119
120 FFIILLEESS
121 /var/dcc is the DCC home directory containing data and control
122 files.
123 dcc_db is the main file containing mail checksums.
124 dcc_db.hash mail checksum database hash table.
125 grey_db is the database of greylist checksums.
126 grey_db.hash is the greylist database hash table.
127 dcc_db-new, dcc_db-new.hash, grey_db-new, grey_db-new.hash
128 new database and hash files until they are renamed.
129 dcc_db-old, grey_db-old
130 previous database files.
131 ids list of IDs and passwords, as described in dccd(8).
132 whitelist contains the DCC server whitelist in the format described
133 in dcc(8).
134 grey_whitelist
135 contains the greylist server whitelist.
136
137 SSEEEE AALLSSOO
138 cdcc(8), cron(8), dcc(8), dccd(8), dblist(8), dccifd(8), dccm(8),
139 dccproc(8).
140
141 HHIISSTTOORRYY
142 Implementation of ddbbcclleeaann was started at Rhyolite Software, in 2000.
143 This document describes version 1.3.103.
144
145 February 26, 2009