diff options
author | Vsevolod Stakhov <vsevolod@rambler-co.ru> | 2012-10-02 20:32:49 +0400 |
---|---|---|
committer | Vsevolod Stakhov <vsevolod@rambler-co.ru> | 2012-10-02 20:32:49 +0400 |
commit | 14e1129068d55bc8de0618832d4f7d33bb1b0f06 (patch) | |
tree | 787a2156ec9e2181a2c8b273ded9ddc2a1777ece /doc | |
parent | 5d1f19fc9988261e23f190c216eb17958f178904 (diff) | |
download | rspamd-14e1129068d55bc8de0618832d4f7d33bb1b0f06.tar.gz rspamd-14e1129068d55bc8de0618832d4f7d33bb1b0f06.zip |
* Add support for dynamic configuration to the client.
Cleanup client's code.
Update manual page for client.
Make 'bayes' as the default classifier for client learning operations.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/rspamc.1 | 52 | ||||
-rw-r--r-- | doc/rspamc.pod | 43 | ||||
-rw-r--r-- | doc/rspamd.8 | 6 |
3 files changed, 81 insertions, 20 deletions
diff --git a/doc/rspamc.1 b/doc/rspamc.1 index 63d301051..e8f38bf81 100644 --- a/doc/rspamc.1 +++ b/doc/rspamc.1 @@ -1,4 +1,4 @@ -.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.07) +.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16) .\" .\" Standard preamble: .\" ======================================================================== @@ -124,18 +124,19 @@ .\" ======================================================================== .\" .IX Title "rspamc 1" -.TH rspamc 1 "2011-03-15" "rspamd-0.3.8" "Rspamd documentation" +.TH rspamc 1 "2012-10-02" "rspamd-0.5.2" "Rspamd documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh -.SH "NAME" +.SH "RSPAMC" .IX Header "RSPAMC" rspamc \- a simple client for rspamd spam filtering system .SH "SYNOPSIS" .IX Header "SYNOPSIS" -rspamc [\fB\-h\fR \fIhost[:port]\fR] [\fB\-p\fR] [\fB\-v\fR] -[\fB\-i\fR \fIip\fR] [\fB\-s\fR \fIstatfile\fR] [\fB\-w\fR \fIweight\fR] +rspamc [\fB\-h\fR \fIhost[:port]\fR] [\fB\-p\fR] [\fB\-v\fR] [\fB\-b\fR \fIbind_address\fR] [\fB\-u\fR \fIuser\fR] +[\fB\-F\fR \fIfrom\fR] [\fB\-r\fR \fIrcpt\fR] [\fB\-d\fR \fIdeliver-to\fR] +[\fB\-i\fR \fIip\fR] [\fB\-c\fR \fIclassifier\fR] [\fB\-w\fR \fIweight\fR] [\fB\-P\fR \fIpassword\fR] [\fB\-f\fR \fIflag\fR] [\fB\-t\fR \fItimeout\fR] [command] [file [file ...]] .PP rspamc [\fB\-\-help\fR] @@ -148,7 +149,24 @@ rspamc [\fB\-\-help\fR] .IP "\fB\-h\fR \fIhost[:port]\fR, \fB\-\-connect\fR \fIhost[:port]\fR" 4 .IX Item "-h host[:port], --connect host[:port]" Specify host and port for connecting to rspamd server. Default host is \fIlocalhost\fR and -default port is \fI11333\fR for checking messages and \fI11334\fR for learning and statistic. +default port is \fI11333\fR for checking messages and \fI11334\fR for learning and statistic. +Also it is possible to specify a unix socket for all operations (for example: +\&\fBrspamc\fR \fB\-h\fR /path/to/soket) +.IP "\fB\-b\fR \fIlocal_ip\fR, \fB\-\-bind\fR \fIlocal_ip\fR" 4 +.IX Item "-b local_ip, --bind local_ip" +Specify explicit \s-1IP\s0 address to bind a client for operations. +.IP "\fB\-u\fR \fIuser\fR, \fB\-\-user\fR \fIuser\fR" 4 +.IX Item "-u user, --user user" +Specify username for connection with rspamd server. +.IP "\fB\-F\fR \fIfrom_addr\fR, \fB\-\-from\fR \fIfrom_addr\fR" 4 +.IX Item "-F from_addr, --from from_addr" +Specify \s-1SMTP\s0 \s-1FROM\s0 address for connection with rspamd server. +.IP "\fB\-r\fR \fIrcpt_addr\fR, \fB\-\-rcpt\fR \fIrcpt_addr\fR" 4 +.IX Item "-r rcpt_addr, --rcpt rcpt_addr" +Specify \s-1SMTP\s0 \s-1RCPT\s0 \s-1TO\s0 address for connection with rspamd server. +.IP "\fB\-d\fR \fIdeliver_addr\fR, \fB\-\-deliver\fR \fIdeliver_addr\fR" 4 +.IX Item "-d deliver_addr, --deliver deliver_addr" +Specify real delivery address for connection with rspamd server. .IP "\fB\-p\fR, \fB\-\-pass\-all\fR" 4 .IX Item "-p, --pass-all" Pass all filters when checking messages. Ignored in case of learning. @@ -158,9 +176,9 @@ Be more verbose while displaying results. For example show descriptions of symbo .IP "\fB\-P\fR \fIpassword\fR, \fB\-\-password\fR \fIpassword\fR" 4 .IX Item "-P password, --password password" Specify controller's password. Mandatory option for learning. -.IP "\fB\-s\fR \fIstatfile\fR, \fB\-\-statfile\fR \fIstatfile\fR" 4 -.IX Item "-s statfile, --statfile statfile" -Specify statfile's symbol to learn message. Mandatory option for learning. +.IP "\fB\-c\fR \fIclassifier\fR, \fB\-\-classifier\fR \fIclassifier\fR" 4 +.IX Item "-c classifier, --classifier classifier" +Specify classifier to learn message. Mandatory option for learning. Bayes classifier is used by default if this option is omitted. .IP "\fB\-i\fR \fIip\fR, \fB\-\-ip\fR \fIip\fR" 4 .IX Item "-i ip, --ip ip" Add \s-1IP\s0 header when scanning message. Useful for checking messages and emulating that client comes from @@ -194,7 +212,7 @@ Check files: Learn files: .PP .Vb 1 -\& rspamc \-P pass \-s BAYES_SPAM file1 file2 file3 +\& rspamc \-P pass learn_spam file1 file2 file3 .Ve .PP Add fuzzy hash to set 2: @@ -220,12 +238,24 @@ Get uptime: .Vb 1 \& rspamc uptime .Ve +.PP +Add custom rule's weight: +.PP +.Vb 1 +\& rspamc add_symbol test 1.5 +.Ve +.PP +Add custom action's weight: +.PP +.Vb 1 +\& rspamc add_action reject 7.1 +.Ve .SH "AUTHOR" .IX Header "AUTHOR" Vsevolod Stakhov <vsevolod@highsecure.ru> .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" -Copyright 2011 by Vsevolod Stakhov <vsevolod@highsecure.ru>. +Copyright 2011\-2012 by Vsevolod Stakhov <vsevolod@highsecure.ru>. .PP This program is free software; you may redistribute it and/or modify it under the terms of \s-1BSD\s0 license. diff --git a/doc/rspamc.pod b/doc/rspamc.pod index ebb452b4d..ddf5d81fb 100644 --- a/doc/rspamc.pod +++ b/doc/rspamc.pod @@ -4,8 +4,9 @@ rspamc - a simple client for rspamd spam filtering system =head1 SYNOPSIS -rspamc [B<-h> I<host[:port]>] [B<-p>] [B<-v>] -[B<-i> I<ip>] [B<-s> I<statfile>] [B<-w> I<weight>] +rspamc [B<-h> I<host[:port]>] [B<-p>] [B<-v>] [B<-b> I<bind_address>] [B<-u> I<user>] +[B<-F> I<from>] [B<-r> I<rcpt>] [B<-d> I<deliver-to>] +[B<-i> I<ip>] [B<-c> I<classifier>] [B<-w> I<weight>] [B<-P> I<password>] [B<-f> I<flag>] [B<-t> I<timeout>] [command] [file [file ...]] rspamc [B<--help>] @@ -23,6 +24,28 @@ B<Rspamc> has several mandatory options for learning: I<password> and I<statfile Specify host and port for connecting to rspamd server. Default host is I<localhost> and default port is I<11333> for checking messages and I<11334> for learning and statistic. +Also it is possible to specify a unix socket for all operations (for example: +B<rspamc> B<-h> /path/to/soket) + +=item B<-b> I<local_ip>, B<--bind> I<local_ip> + +Specify explicit IP address to bind a client for operations. + +=item B<-u> I<user>, B<--user> I<user> + +Specify username for connection with rspamd server. + +=item B<-F> I<from_addr>, B<--from> I<from_addr> + +Specify SMTP FROM address for connection with rspamd server. + +=item B<-r> I<rcpt_addr>, B<--rcpt> I<rcpt_addr> + +Specify SMTP RCPT TO address for connection with rspamd server. + +=item B<-d> I<deliver_addr>, B<--deliver> I<deliver_addr> + +Specify real delivery address for connection with rspamd server. =item B<-p>, B<--pass-all> @@ -36,9 +59,9 @@ Be more verbose while displaying results. For example show descriptions of symbo Specify controller's password. Mandatory option for learning. -=item B<-s> I<statfile>, B<--statfile> I<statfile> +=item B<-c> I<classifier>, B<--classifier> I<classifier> -Specify statfile's symbol to learn message. Mandatory option for learning. +Specify classifier to learn message. Mandatory option for learning. Bayes classifier is used by default if this option is omitted. =item B<-i> I<ip>, B<--ip> I<ip> @@ -75,7 +98,7 @@ Check files: Learn files: - rspamc -P pass -s BAYES_SPAM file1 file2 file3 + rspamc -P pass learn_spam file1 file2 file3 Add fuzzy hash to set 2: @@ -93,13 +116,21 @@ Get uptime: rspamc uptime +Add custom rule's weight: + + rspamc add_symbol test 1.5 + +Add custom action's weight: + + rspamc add_action reject 7.1 + =head1 AUTHOR Vsevolod Stakhov <vsevolod@highsecure.ru> =head1 COPYRIGHT AND LICENSE -Copyright 2011 by Vsevolod Stakhov <vsevolod@highsecure.ru>. +Copyright 2011-2012 by Vsevolod Stakhov <vsevolod@highsecure.ru>. This program is free software; you may redistribute it and/or modify it under the terms of BSD license. diff --git a/doc/rspamd.8 b/doc/rspamd.8 index 498784d73..68a004387 100644 --- a/doc/rspamd.8 +++ b/doc/rspamd.8 @@ -1,4 +1,4 @@ -.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.07) +.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16) .\" .\" Standard preamble: .\" ======================================================================== @@ -124,12 +124,12 @@ .\" ======================================================================== .\" .IX Title "rspamd 8" -.TH rspamd 8 "2011-03-15" "rspamd-0.3.8" "Rspamd documentation" +.TH rspamd 8 "2012-10-02" "rspamd-0.5.2" "Rspamd documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh -.SH "NAME" +.SH "RSPAMD" .IX Header "RSPAMD" rspamd \- main daemon for rspamd spam filtering system .SH "SYNOPSIS" |