← Back to branch summary

~ubuntu-branches/ubuntu/precise/dspam/precise

« back to all changes in this revision

Viewing changes to man/libdspam.3

  • Committer: Bazaar Package Importer
  • Author(s): Julien Valroff, Julien Valroff, Thomas Preud'homme
  • Date: 2011-05-08 13:43:52 UTC
  • mfrom: (1.2.1 upstream) (8.2.2 experimental)
  • mto: This revision was merged to the branch mainline in revision 23.
  • Revision ID: james.westby@ubuntu.com-20110508134352-dxjx9m6tx1cbzlhq
Tags: 3.9.1~rc1+git20110419.29261fb+dfsg-1
http://bugs.debian.org/394443
[ Julien Valroff ]
* New git snapshot
* Install all dspam_* tools setgid so that they can be used by standard
  users
* Add symbols file for libdspam7
* Upload to unstable

[ Thomas Preud'homme ]
* Fix permissions on dspam_stats and missing opt-{in,out} directories
  (Closes: #394443)

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/libdspam.3
1
 
.\" $Id: libdspam.3,v 1.6 2006/05/14 15:37:30 jonz Exp $
 
1
.\" $Id: libdspam.3,v 1.12 2010/04/17 00:21:43 sbajic Exp $
2
2
.\"  -*- nroff -*-
3
3
.\"
4
 
.\" dspam3.2
5
 
.\"
6
 
.\" Authors:    Jonathan A. Zdziarski <jonathan@nuclearelephant.com>
7
 
.\"
8
 
.\" Copyright (c) 2002-2006 Jonathan A. Zdziarski
 
4
.\" dspam3.9
 
5
.\"
 
6
.\" Authors:    Jonathan A. Zdziarski <jonathan@nuclearelephant.com>
 
7
.\"             Stevan Bajic <stevan@bajic.ch>
 
8
.\"
 
9
.\" Copyright (c) 2002-2010 DSPAM Project
9
10
.\" All rights reserved
10
11
.\"
11
 
.TH libdspam 1  "Sep 29, 2004" "libdspam" "libdspam"
 
12
.TH libdspam 3  "Apr 17, 2010" "libdspam" "libdspam"
12
13
 
13
14
.SH NAME
14
 
libdspam, dspam_init, dspam_create, dspam_addattribute, dspam_attach, dspam_process, dspam_getsource, dspam_detach, dspam_clearattributes, dspam_destroy 
 
15
libdspam - Core message processing and classification library for DSPAM
15
16
.PP
16
 
DSPAM Core Analyis Engine Functions
 
17
\fBDSPAM\fP Core Analyis Engine Functions
17
18
 
18
19
.SH SYNOPSIS
19
20
.nf
20
21
.B #include <libdspam.h>
21
22
.sp
22
 
.BI "DSPAM_CTX *dspam_init(const char *" user ", const char *" group ", " 
23
 
.BI "  const char *" home ", int " mode ", u_int32_t " flags ");"
24
 
.sp
25
 
.BI "DSPAM_CTX *dspam_create(const char *" user ", const char *" group ", "
26
 
.BI "  const char *" home ", int " mode ", u_int32_t " flags ");"
27
 
.sp
28
 
.BI "int dspam_addattribute(DSPAM_CTX *" CTX ", const char *" name ", "
 
23
.BI "DSPAM_CTX *dspam_init(const char *" username ", const char *" group ", "
 
24
.BI "  const char *" home ", int " operating_mode ", u_int32_t " flags ");"
 
25
.sp
 
26
.BI "DSPAM_CTX *dspam_create(const char *" username ", const char *" group ", "
 
27
.BI "  const char *" home ", int " operating_mode ", u_int32_t " flags ");"
 
28
.sp
 
29
.BI "int dspam_addattribute(DSPAM_CTX *" CTX ", const char *" key ", "
29
30
.BI "  const char *" value ");"
30
31
.sp
31
32
.BI "int dspam_clearattributes(DSPAM_CTX *" CTX ");"
52
53
base directory specified. The \fBmode\fP specifies the operating mode to
53
54
initialize the classification context with and may be one of:
54
55
.PP
55
 
 \fBDSM_PROCESS\fP   Process the message and return a result
56
 
 \fBDSM_CLASSIFY\fP  Classify message only, no learning
 
56
 \fBDSM_PROCESS\fP   Classify and learn the supplied message using whatever training mode is specified
 
57
 \fBDSM_CLASSIFY\fP  Classify the supplied message only; do not learn or update any counters.
57
58
 \fBDSM_TOOLS\fP     No processing, attach to storage only
58
59
.PP
59
60
The \fBflags\fP provided further tune the classification context for a specific
60
61
function. Multiple flags may be OR'd together.
61
62
.PP
62
 
 \fBDSF_CHAINED\fP   Use a Chained (Multi-Word) Tokenizer  
63
 
 \fBDSF_SBPH\fP      Use Sparse Binary Polynomial Hashing Tokenizer
 
63
 \fBDSF_UNLEARN\fP   Unlearn the message
 
64
 \fBDSF_BIAS\fP      Assign processor bias to unknown tokens
64
65
 \fBDSF_SIGNATURE\fP A binary signature is requested/provided
65
66
 \fBDSF_NOISE\fP     Apply Bayesian Noise Reduction logic
66
67
 \fBDSF_WHITELIST\fP Use automatic whitelisting logic
138
139
the connection is closed and all data is flushed and written. If a 
139
140
handle was attached, the handle will remain open.
140
141
.PP 
141
 
.SH AUTHORS
142
 
.LP
143
 
 
144
 
Jonathan A. Zdziarski
145
 
 
146
 
For more information, see http://www.nuclearelephant.com.
 
142
.SH COPYRIGHT
 
143
Copyright \(co 2002\-2010 DSPAM Project
 
144
.br
 
145
All rights reserved.
 
146
.br
 
147
 
 
148
For more information, see http://dspam.sourceforge.net.
147
149
 
148
150
.SH "SEE ALSO"
149
 
.BR dspam_stats (1),
150
 
.BR dspam_train (1),
 
151
.BR dspam (1),
 
152
.BR dspam_admin (1),
151
153
.BR dspam_clean (1),
 
154
.BR dspam_crc (1),
152
155
.BR dspam_dump (1),
153
 
.BR dspam_merge (1)
154
 
 
 
156
.BR dspam_logrotate (1),
 
157
.BR dspam_merge (1),
 
158
.BR dspam_stats (1),
 
159
.BR dspam_train (1)