aboutsummaryrefslogtreecommitdiffstats
path: root/doc/rspamd.8
diff options
context:
space:
mode:
authorVsevolod Stakhov <vsevolod@highsecure.ru>2014-10-15 14:14:07 +0100
committerVsevolod Stakhov <vsevolod@highsecure.ru>2014-10-15 14:14:07 +0100
commitaa2f5832f8b282b176f52aca82553fd554326716 (patch)
tree6cb5729067ae429bca65a512a3f5d5a3e4fb7c48 /doc/rspamd.8
parent18e4a62adf6b0025666627e7679c1b5dfb634782 (diff)
downloadrspamd-aa2f5832f8b282b176f52aca82553fd554326716.tar.gz
rspamd-aa2f5832f8b282b176f52aca82553fd554326716.zip
Update manual pages.
Diffstat (limited to 'doc/rspamd.8')
-rw-r--r--doc/rspamd.854
1 files changed, 20 insertions, 34 deletions
diff --git a/doc/rspamd.8 b/doc/rspamd.8
index 37650ebaa..bd5491623 100644
--- a/doc/rspamd.8
+++ b/doc/rspamd.8
@@ -1,12 +1,12 @@
-.TH RSPAMD 8 "" "Rspamd User Manual"
+.TH "RSPAMD" "8" "" "Rspamd User Manual" ""
.SH NAME
.PP
-rspamd - main daemon for rapid spam filtering system
+rspamd \- main daemon for rapid spam filtering system
.SH SYNOPSIS
.PP
rspamd [\f[I]options\f[]]...
.PP
-rspamd --help
+rspamd \-\-help
.SH DESCRIPTION
.PP
Rspamd filtering system is designed to be fast, modular and easily
@@ -18,70 +18,65 @@ Rspamd is designed to process connections completely asynchronous and do
not block anywhere in code.
.SH OPTIONS
.TP
-.B -t, --config-test
+.B \-t, \-\-config\-test
Perform config test and exit
.RS
.RE
.TP
-.B -f, --no-fork
+.B \-f, \-\-no\-fork
Do not daemonize main process
.RS
.RE
.TP
-.B -c \f[I]path\f[], --config=\f[I]path\f[]
+.B \-c \f[I]path\f[], \-\-config=\f[I]path\f[]
Specify config file(s)
.RS
.RE
.TP
-.B -u \f[I]username\f[], --user=\f[I]username\f[]
+.B \-u \f[I]username\f[], \-\-user=\f[I]username\f[]
User to run rspamd as
.RS
.RE
.TP
-.B -g \f[I]groupname\f[], --group=\f[I]groupname\f[]
+.B \-g \f[I]groupname\f[], \-\-group=\f[I]groupname\f[]
Group to run rspamd as
.RS
.RE
.TP
-.B -p \f[I]path\f[], --pid=\f[I]path\f[]
+.B \-p \f[I]path\f[], \-\-pid=\f[I]path\f[]
Path to pidfile
.RS
.RE
.TP
-.B -C, --dump-cache
+.B \-C, \-\-dump\-cache
Dump symbols cache stats and exit
.RS
.RE
.TP
-.B -d, --debug
+.B \-d, \-\-debug
Force debug output
.RS
.RE
.TP
-.B -i, --insecure
+.B \-i, \-\-insecure
Ignore running workers as privileged users (insecure)
.RS
.RE
.TP
-.B --test-lua=\f[I]path\f[]
+.B \-\-test\-lua=\f[I]path\f[]
Specify lua file(s) to test
.RS
.RE
.TP
-.B --sign-config=\f[I]path\f[]
+.B \-\-sign\-config=\f[I]path\f[]
Specify config file(s) to sign
.RS
.RE
.TP
-.B --private-key=\f[I]path\f[]
+.B \-\-private\-key=\f[I]path\f[]
Specify private key to sign
.RS
.RE
-.TP
-.B --convert-config=\f[I]path\f[]
-Convert configuration to UCL
-.RS
-.RE
.SH EXAMPLES
.PP
Run rspamd daemon with default configuration:
@@ -96,7 +91,7 @@ Run rspamd in foreground with custom configuration:
.IP
.nf
\f[C]
-rspamd\ -f\ -c\ ~/rspamd.conf
+rspamd\ \-f\ \-c\ ~/rspamd.conf
\f[]
.fi
.PP
@@ -104,7 +99,7 @@ Run rspamd specifying user and group:
.IP
.nf
\f[C]
-rspamd\ -u\ rspamd\ -g\ rspamd\ -c\ /etc/rspamd/rspamd.conf
+rspamd\ \-u\ rspamd\ \-g\ rspamd\ \-c\ /etc/rspamd/rspamd.conf
\f[]
.fi
.PP
@@ -112,24 +107,15 @@ Test lua scripts using rspamd API:
.IP
.nf
\f[C]
-rspamd\ --test-lua=~/test1.lua\ --test-lua=~/test2.lua
-\f[]
-.fi
-.PP
-Sign config files for \f[C].includes\f[] macro:
-.IP
-.nf
-\f[C]
-rspamd\ --private-key=sign.key\ --sign-config=rspamd.conf
+rspamd\ \-\-test\-lua=~/test1.lua\ \-\-test\-lua=~/test2.lua
\f[]
.fi
.PP
-Convert old \f[C]XML\f[] config to the \f[C]UCL\f[] format (since
-0.6.0):
+Sign config files for \f[C]\&.includes\f[] macro:
.IP
.nf
\f[C]
-rspamd\ -c\ /etc/rspamd.xml\ --convert-config=/etc/rspamd/rspamd.conf
+rspamd\ \-\-private\-key=sign.key\ \-\-sign\-config=rspamd.conf
\f[]
.fi
.SH SEE ALSO