Mercurial > notdcc

comparison dccsight.html.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 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN">
2 <HTML>
3 <HEAD>
4 <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1">
5 <TITLE>dccsight.0.8</TITLE>
6 <META http-equiv="Content-Style-Type" content="text/css">
7 <STYLE type="text/css">
8 BODY {background-color:white; color:black}
9 ADDRESS {font-size:smaller}
10 IMG.logo {width:6em; vertical-align:middle}
11 </STYLE>
12 </HEAD>
13 <BODY>
14 <PRE>
15 <!-- Manpage converted by man2html 3.0.1 -->
16 <B><A HREF="dccsight.html">dccsight(8)</A></B> Distributed Checksum Clearinghouse <B><A HREF="dccsight.html">dccsight(8)</A></B>
17
18
19 </PRE>
20 <H2><A NAME="NAME">NAME</A></H2><PRE>
21 <B>dccsight</B> -- Distributed Checksum Clearinghouse raw checksum interface
22
23
24 </PRE>
25 <H2><A NAME="SYNOPSIS">SYNOPSIS</A></H2><PRE>
26 <B>dccsight</B> [<B>-VdQC</B>] [<B>-h</B> <I>homedir</I>] [<B>-m</B> <I>map</I>] [<B>-w</B> <I>whiteclnt</I>] [<B>-t</B> <I>targets</I>]
27 [<B>-i</B> <I>infile</I>] [<B>-L</B> <I>ltype,facility.level</I>]
28
29
30 </PRE>
31 <H2><A NAME="DESCRIPTION">DESCRIPTION</A></H2><PRE>
32 <B>Dccsight</B> reads one or more lines containing DCC checksums, reports them
33 to a DCC server, and writes a X-DCC header line. It can be used to
34 report checksums obtained from <B><A HREF="dccproc.html">dccproc(8)</A></B> using <B>-C</B>.
35
36 <A NAME="OPTIONS"><B>OPTIONS</B></A>
37 The following options are available:
38
39 <A NAME="OPTION-V"><B>-V</B></A> displays the version of the DCC raw checksum interface.
40
41 <A NAME="OPTION-d"><B>-d</B></A> enables debugging output from the DCC client software. Additional
42 <B>-d</B> options increase the number of messages.
43
44 <A NAME="OPTION-Q"><B>-Q</B></A> only queries the DCC server about the checksums instead of reporting
45 and then querying. This is useful when <B>dccsight</B> is used to filter
46 mail that has already been reported to a DCC server by another DCC
47 client such as <B><A HREF="dccm.html">dccm(8)</A></B>. This can also be useful when applying a
48 private white or black list to mail that has already been reported
49 to a DCC server. No single mail message should be reported to a DCC
50 server more than once per recipient, such as would happen if
51 <B>dccsight</B> is not given <B>-Q</B> when processing a stream of mail that has
52 already been seen by a DCC client. Additional reports of a message
53 increase its apparent "bulkness."
54
55 <A NAME="OPTION-C"><B>-C</B></A> outputs the checksums for the message as well as the X-DCC header.
56
57 <A NAME="OPTION-h"><B>-h</B></A> <I>homedir</I>
58 overrides the default DCC home directory, <I>@prefix@</I>.
59
60 <A NAME="OPTION-m"><B>-m</B></A> <I>map</I>
61 specifies a name or path of the memory mapped parameter file instead
62 of the default <I>map</I> in the DCC home directory. It should be created
63 with the <B><A HREF="cdcc.html">cdcc(8)</A></B> command.
64
65 <A NAME="OPTION-w"><B>-w</B></A> <I>whiteclnt</I>
66 specifies an optional file containing SMTP client IP addresses and
67 SMTP headers of mail that do not need X-DCC headers and whose check-
68 sums should not be reported to the DCC server. It can also contain
69 checksums of spam. If the pathname is not absolute, it is relative
70 to the DCC home directory. Thus, individual users with private
71 whitelists usually specify them with absolute paths. It is useful
72 to <I>include</I> a common or system-wide whitelist in private lists.
73
74 The format of the <B>dccsight</B> whiteclnt file is the same as the
75 <I>whitelist</I> file required by <B><A HREF="dbclean.html">dbclean(8)</A></B> and <B><A HREF="dccsight.html">dccsight(8)</A></B>. Because this
76 list is used frequently, a companion file is used. It has the same
77 pathname but with an added suffix of <I>.dccw</I>. After being created
78 empty, it will contain an automatic memory mapped hash table of the
79 main file.
80
81 <A NAME="OPTION-t"><B>-t</B></A> <I>targets</I>
82 specifies the number of addressees of the message if other than 1.
83 The string <I>many</I> instead of a number asserts that there were too many
84 addressees and that the message is unsolicited bulk email.
85
86 <A NAME="OPTION-i"><B>-i</B></A> <I>infile</I>
87 specifies an input file instead of standard input. If not absolute,
88 the pathname is interpreted relative to the directory in which
89 <B>dccsight</B> was started.
90
91 <A NAME="OPTION-L"><B>-L</B></A> <I>ltype,facility.level</I>
92 specifies how messages should be logged. <I>Ltype</I> must be <I>error</I>, <I>info</I>,
93 or <I>off</I> to indicate which of the two types of messages are being con-
94 trolled or to turn off all <B>syslog(3)</B> messages from <B>dccsight</B>. <I>Level</I>
95 must be a <B>syslog(3)</B> level among <I>EMERG</I>, <I>ALERT</I>, <I>CRIT</I>, <I>ERR</I>, <I>WARNING</I>,
96 <I>NOTICE</I>, <I>INFO</I>, and <I>DEBUG</I>. <I>Facility</I> must be among <I>AUTH</I>, <I>AUTHPRIV</I>,
97 <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>
98 through <I>LOCAL7</I>. The default is equivalent to
99 <B>-L</B> <I>info,MAIL.NOTICE</I> <B>-L</B> <I>error,MAIL.ERR</I>
100
101 <B>dccsight</B> exits 0 on success, and &gt;0 if an error occurs.
102
103
104 </PRE>
105 <H2><A NAME="FILES">FILES</A></H2><PRE>
106 <A NAME="FILE-@prefix@">@prefix@</A> DCC home directory in which other files are found.
107 <A NAME="FILE-map">map</A> memory mapped file in the DCC home directory of information
108 concerning DCC servers.
109 <A NAME="FILE-whiteclnt">whiteclnt</A> contains the client whitelist in the format described in
110 <B><A HREF="dcc.html">dcc(8)</A></B>.
111 <A NAME="FILE-whiteclnt.dccw">whiteclnt.dccw</A>
112 memory mapped hash table of the <I>whiteclnt</I> file.
113
114
115 </PRE>
116 <H2><A NAME="SEE-ALSO">SEE ALSO</A></H2><PRE>
117 <B><A HREF="cdcc.html">cdcc(8)</A></B>, <B><A HREF="dcc.html">dcc(8)</A></B>, <B><A HREF="dbclean.html">dbclean(8)</A></B>, <B><A HREF="dccd.html">dccd(8)</A></B>, <B><A HREF="dblist.html">dblist(8)</A></B>, <B><A HREF="dccproc.html">dccproc(8)</A></B>, <B><A HREF="dccm.html">dccm(8)</A></B>,
118 <B><A HREF="dccifd.html">dccifd(8)</A></B>, <B>mail(1)</B>, <B>procmail(1)</B>.
119
120
121 </PRE>
122 <H2><A NAME="HISTORY">HISTORY</A></H2><PRE>
123 Implementation of <B>dccsight</B> was started at Rhyolite Software in 2000.
124 This document describes version 1.3.103.
125
126 February 26, 2009
127 </PRE>
128 <HR>
129 <ADDRESS>
130 Man(1) output converted with
131 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
132 modified for the DCC $Date 2001/04/29 03:22:18 $
133 <BR>
134 <A HREF="http://www.dcc-servers.net/dcc/">
135 <IMG SRC="http://logos.dcc-servers.net/border.png"
136 class=logo ALT="DCC logo">
137 </A>
138 <A HREF="http://validator.w3.org/check?uri=referer">
139 <IMG class=logo ALT="Valid HTML 4.01 Strict"
140 SRC="http://www.w3.org/Icons/valid-html401">
141 </A>
142 </ADDRESS>
143 </BODY>
144 </HTML>