Mercurial > notdcc

comparison dccsight.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.28 $Revision$
36 .\"
37 .Dd February 26, 2009
38 .ds volume-ds-DCC Distributed Checksum Clearinghouse
39 .Dt dccsight 8 DCC
40 .Os " "
41 .Sh NAME
42 .Nm dccsight
43 .Nd Distributed Checksum Clearinghouse raw checksum interface
44 .Sh SYNOPSIS
45 .Nm dccsight
46 .Bk -words
47 .Op Fl VdQC
48 .Op Fl h Ar homedir
49 .Op Fl m Ar map
50 .Op Fl w Ar whiteclnt
51 .Op Fl t Ar targets
52 .Op Fl i Ar infile
53 .Op Fl L Ar ltype,facility.level
54 .Ek
55 .Sh DESCRIPTION
56 .Nm Dccsight
57 reads one or more lines containing DCC checksums,
58 reports them to a DCC server,
59 and writes a X-DCC header line.
60 It can be used to report checksums obtained from
61 .Xr dccproc 8
62 using
63 .Fl C .
64 .Ss OPTIONS
65 The following options are available:
66 .Bl -tag -width 3n
67 .It Fl V
68 displays the version of the DCC raw checksum interface.
69 .It Fl d
70 enables debugging output from the DCC client software.
71 Additional
72 .Fl d
73 options increase the number of messages.
74 .It Fl Q
75 only queries the DCC server about the checksums
76 instead of reporting and then querying.
77 This is useful when
78 .Nm
79 is used to filter mail that has already been reported to a DCC
80 server by another DCC client such as
81 .Xr dccm 8 .
82 This can also be useful when applying a private white or black list to
83 mail that has already been reported to a DCC server.
84 No single mail message should be reported to a DCC
85 server more than once per recipient, such as would happen if
86 .Nm
87 is not given
88 .Fl Q
89 when processing a stream of mail that has already been seen by a DCC client.
90 Additional reports of a message
91 increase its apparent "bulkness."
92 .It Fl C
93 outputs the checksums for the message as well as the X-DCC header.
94 .It Fl h Ar homedir
95 overrides the default DCC home directory,
96 .Pa @prefix@ .
97 .It Fl m Ar map
98 specifies a name or path of the memory mapped parameter file instead
99 of the default
100 .Pa map
101 in the DCC home directory.
102 It should be created with the
103 .Xr cdcc 8
104 command.
105 .It Fl w Ar whiteclnt
106 specifies an optional file containing SMTP client IP addresses and
107 SMTP headers
108 of mail that do not need X-DCC headers and whose checksums should not
109 be reported to the DCC server.
110 It can also contain checksums of spam.
111 If the pathname is not absolute, it is relative to the DCC home directory.
112 Thus, individual users with private whitelists usually specify them
113 with absolute paths.
114 It is useful to
115 .Ar include
116 a common or system-wide whitelist in private lists.
117 .Pp
118 The format of the
119 .Nm
120 whiteclnt file is the same as the
121 .Pa whitelist
122 file required by
123 .Xr dbclean 8
124 and
125 .Xr dccsight 8 .
126 Because this list is used frequently, a companion file is used.
127 It has the same pathname but with an added suffix of
128 .Ar .dccw .
129 After being created empty,
130 it will contain an automatic memory mapped hash table of the main file.
131 .It Fl t Ar targets
132 specifies the number of addressees of the message if other than 1.
133 The string
134 .Ar many
135 instead of a number asserts that there were too many addressees
136 and that the message is unsolicited bulk email.
137 .It Fl i Ar infile
138 specifies an input file
139 instead of standard input.
140 If not absolute, the pathname is interpreted relative to the
141 directory in which
142 .Nm
143 was started.
144 .It Fl L Ar ltype,facility.level
145 specifies how messages should be logged.
146 .Ar Ltype
147 must be
148 .Ar error ,
149 .Ar info ,
150 or
151 .Ar off
152 to indicate which of the two types of messages are being controlled or
153 to turn off all
154 .Xr syslog 3
155 messages from
156 .Nm .
157 .Ar Level
158 must be a
159 .Xr syslog 3
160 level among
161 .Ar EMERG ,
162 .Ar ALERT ,
163 .Ar CRIT , ERR ,
164 .Ar WARNING ,
165 .Ar NOTICE ,
166 .Ar INFO ,
167 and
168 .Ar DEBUG .
169 .Ar Facility
170 must be among
171 .Ar AUTH ,
172 .Ar AUTHPRIV ,
173 .Ar CRON ,
174 .Ar DAEMON ,
175 .Ar FTP ,
176 .Ar KERN ,
177 .Ar LPR ,
178 .Ar MAIL ,
179 .Ar NEWS ,
180 .Ar USER ,
181 .Ar UUCP ,
182 and
183 .Ar LOCAL0
184 through
185 .Ar LOCAL7 .
186 The default is equivalent to
187 .Dl Fl L Ar info,MAIL.NOTICE Fl L Ar error,MAIL.ERR
188 .El
189 .Pp
190 .Nm
191 exits 0 on success, and >0 if an error occurs.
192 .Sh FILES
193 .Bl -tag -width whiteclnt -compact
194 .It Pa @prefix@
195 DCC home directory in which other files are found.
196 .It Pa map
197 memory mapped file in the DCC home directory
198 of information concerning DCC servers.
199 .It Pa whiteclnt
200 contains the client whitelist in
201 the format described in
202 .Xr dcc 8 .
203 .It Pa whiteclnt.dccw
204 memory mapped hash table of the
205 .Pa whiteclnt
206 file.
207 .El
208 .Sh SEE ALSO
209 .Xr cdcc 8 ,
210 .Xr dcc 8 ,
211 .Xr dbclean 8 ,
212 .Xr dccd 8 ,
213 .Xr dblist 8 ,
214 .Xr dccproc 8 ,
215 .Xr dccm 8 ,
216 .Xr dccifd 8 ,
217 .Xr mail 1 ,
218 .Xr procmail 1 .
219 .Sh HISTORY
220 Implementation of
221 .Nm
222 was started at Rhyolite Software in 2000.
223 This document describes version 1.3.103.