* 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.

1 files changed, 41 insertions, 11 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.