diff options
| author | Andrew Lewis <nerf@judo.za.org> | 2014-01-01 18:00:55 +0200 |
|---|---|---|
| committer | Andrew Lewis <nerf@judo.za.org> | 2014-01-01 18:00:55 +0200 |
| commit | b9a65473e352d23485377ca9f895e2716cd624fe (patch) | |
| tree | 35dc4e2973153eb00b5979098de17631b7d6495b /doc/rspamd.pod | |
| parent | 932f68cf1607335a4cd820b781466b8545b1a084 (diff) | |
| parent | 3d97b8ca01fea56ba9371cb3992a9cb2c791030e (diff) | |
| download | rspamd-b9a65473e352d23485377ca9f895e2716cd624fe.tar.gz rspamd-b9a65473e352d23485377ca9f895e2716cd624fe.zip | |
Merge remote-tracking branch 'upstream/master'
Diffstat (limited to 'doc/rspamd.pod')
| -rw-r--r-- | doc/rspamd.pod | 79 |
1 files changed, 0 insertions, 79 deletions
diff --git a/doc/rspamd.pod b/doc/rspamd.pod deleted file mode 100644 index 0e03d5c82..000000000 --- a/doc/rspamd.pod +++ /dev/null @@ -1,79 +0,0 @@ -=head1 NAME - -rspamd - main daemon for rspamd spam filtering system - -=head1 SYNOPSIS - -rspamd [B<-c> I<config_file>] [B<-f>] -[B<-u> I<user>] [B<-g> I<group>] [B<-p> I<pidfile>] -[B<-t>] [B<-d>] - -rspamd [B<--help>] - -rspamd [B<-t>] - -rspamd [B<-C>] - -=head1 DESCRIPTION - -B<Rspamd> filtering system is designed to be fast, modular and easily extendable system. -B<Rspamd> core is written in C language using event driven paradigma. -Plugins for B<rspamd> can be written in lua. -B<Rspamd> is designed to process connections completely asynchronous and do not block anywhere in code. - -=head1 OPTIONS - -=over 4 - -=item B<-c> I<config_file>, B<--config> I<config_file> - -Specify the path where rspamd config is placed. Default is rspamd.xml. - -=item B<-u> I<user>, B<--user> I<user> - -Specify user rspamd run as. It is possible only when rspamd is launched by super-user as it -calls setuid(2) after spawning workers. - -=item B<-g> I<group>, B<--group> I<group> - -Specify group rspamd run as. - -=item B<-p> I<pidfile>, B<--pidfile> I<pidfile> - -Path to pid file where rspamd pid would be stored. Directory containing pidfile must be -writeable by B<rspamd>. - -=item B<-f>, B<--no-fork> - -Do not daemonize after launch. Usable for debugging purposes. - -=item B<-t>, B<--config-test> - -Just perform test of configuration. Return zero exit code when configuration is OK. - -=item B<-C>, B<--counters> - -Show counters for all symbols. Usable when symbols cache is saved. - -=item B<-d>, B<--debug> - -Turn on debugging mode in logging. - -=back - -=head1 RETURN VALUE - -On exit B<rspamd> returns 0 if operation was successfull and error code otherwise. - -=head1 AUTHOR - -Vsevolod Stakhov <vsevolod@highsecure.ru> - -=head1 COPYRIGHT AND LICENSE - -Copyright 2011 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. - -=cut
\ No newline at end of file |