diff options
Diffstat (limited to 'doc/rspamd.8')
| -rw-r--r-- | doc/rspamd.8 | 68 |
1 files changed, 25 insertions, 43 deletions
diff --git a/doc/rspamd.8 b/doc/rspamd.8 index 325a50748..0ed8b0872 100644 --- a/doc/rspamd.8 +++ b/doc/rspamd.8 @@ -1,78 +1,60 @@ +.\" Automatically generated by Pandoc 3.1.11.1 +.\" .TH "RSPAMD" "8" "" "Rspamd User Manual" "" .SH NAME -.PP rspamd \- main daemon for rapid spam filtering system .SH SYNOPSIS +rspamd [\f[I]options\f[R]]\&... .PP -rspamd [\f[I]options\f[]]... -.PP -rspamd \-\-help +rspamd \[en]help .SH DESCRIPTION -.PP Rspamd filtering system is designed to be fast, modular and easily scalable system. -Rspamd core is written in \f[C]C\f[] language using event driven +Rspamd core is written in \f[CR]C\f[R] language using event driven processing model. -Plugins for rspamd can be written in \f[C]Lua\f[] programming language. +Plugins for rspamd can be written in \f[CR]Lua\f[R] programming +language. Rspamd is designed to process connections completely asynchronous and do not block anywhere in code. .SH OPTIONS .TP -.B \-f, \-\-no\-fork +\-f, \-\-no\-fork Do not daemonize main process -.RS -.RE .TP -.B \-c \f[I]path\f[], \-\-config=\f[I]path\f[] +\-c \f[I]path\f[R], \-\-config=\f[I]path\f[R] Specify config file(s) -.RS -.RE .TP -.B \-u \f[I]username\f[], \-\-user=\f[I]username\f[] +\-u \f[I]username\f[R], \-\-user=\f[I]username\f[R] User to run rspamd as -.RS -.RE .TP -.B \-g \f[I]groupname\f[], \-\-group=\f[I]groupname\f[] +\-g \f[I]groupname\f[R], \-\-group=\f[I]groupname\f[R] Group to run rspamd as -.RS -.RE .TP -.B \-p \f[I]path\f[], \-\-pid=\f[I]path\f[] +\-p \f[I]path\f[R], \-\-pid=\f[I]path\f[R] Path to pidfile -.RS -.RE .TP -.B \-i, \-\-insecure +\-i, \-\-insecure Ignore running workers as privileged users (insecure) -.RS -.RE .SH EXAMPLES -.PP Run rspamd daemon with default configuration: .IP -.nf -\f[C] +.EX rspamd -\f[] -.fi +.EE .PP Run rspamd in foreground with custom configuration: .IP -.nf -\f[C] -rspamd\ \-f\ \-c\ ~/rspamd.conf -\f[] -.fi +.EX +rspamd \-f \-c \[ti]/rspamd.conf +.EE .PP Run rspamd specifying user and group: .IP -.nf -\f[C] -rspamd\ \-u\ rspamd\ \-g\ rspamd\ \-c\ /etc/rspamd/rspamd.conf -\f[] -.fi +.EX +rspamd \-u rspamd \-g rspamd \-c /etc/rspamd/rspamd.conf +.EE .SH SEE ALSO -.PP -Rspamd documentation and source codes may be downloaded from -<https://rspamd.com/>. +Rspamd documentation and source codes may be downloaded from \c +.UR https://rspamd.com/ +.UE \c +\&. |