Migrate from pod to markdown+pandoc.

1 files changed, 132 insertions, 184 deletions

diff --git a/doc/rspamd.8 b/doc/rspamd.8
index c34e553fd..37650ebaa 100644
--- a/doc/rspamd.8
+++ b/doc/rspamd.8
@@ -1,190 +1,138 @@
-.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
-.\"
-.\" Standard preamble:
-.\" ========================================================================
-.de Sp \" Vertical space (when we can't use .PP)
-.if t .sp .5v
-.if n .sp
-..
-.de Vb \" Begin verbatim text
-.ft CW
+.TH RSPAMD 8 "" "Rspamd User Manual"
+.SH NAME
+.PP
+rspamd - main daemon for rapid spam filtering system
+.SH SYNOPSIS
+.PP
+rspamd [\f[I]options\f[]]...
+.PP
+rspamd --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
+processing model.
+Plugins for rspamd can be written in \f[C]Lua\f[] programming language.
+Rspamd is designed to process connections completely asynchronous and do
+not block anywhere in code.
+.SH OPTIONS
+.TP
+.B -t, --config-test
+Perform config test and exit
+.RS
+.RE
+.TP
+.B -f, --no-fork
+Do not daemonize main process
+.RS
+.RE
+.TP
+.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[]
+User to run rspamd as
+.RS
+.RE
+.TP
+.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[]
+Path to pidfile
+.RS
+.RE
+.TP
+.B -C, --dump-cache
+Dump symbols cache stats and exit
+.RS
+.RE
+.TP
+.B -d, --debug
+Force debug output
+.RS
+.RE
+.TP
+.B -i, --insecure
+Ignore running workers as privileged users (insecure)
+.RS
+.RE
+.TP
+.B --test-lua=\f[I]path\f[]
+Specify lua file(s) to test
+.RS
+.RE
+.TP
+.B --sign-config=\f[I]path\f[]
+Specify config file(s) to sign
+.RS
+.RE
+.TP
+.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:
+.IP
 .nf
-.ne \\$1
-..
-.de Ve \" End verbatim text
-.ft R
+\f[C]
+rspamd
+\f[]
 .fi
-..
-.\" Set up some character translations and predefined strings.  \*(-- will
-.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
-.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
-.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
-.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
-.\" nothing in troff, for use with C<>.
-.tr \(*W-
-.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
-.ie n \{\
-.    ds -- \(*W-
-.    ds PI pi
-.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
-.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
-.    ds L" ""
-.    ds R" ""
-.    ds C` ""
-.    ds C' ""
-'br\}
-.el\{\
-.    ds -- \|\(em\|
-.    ds PI \(*p
-.    ds L" ``
-.    ds R" ''
-'br\}
-.\"
-.\" Escape single quotes in literal strings from groff's Unicode transform.
-.ie \n(.g .ds Aq \(aq
-.el       .ds Aq '
-.\"
-.\" If the F register is turned on, we'll generate index entries on stderr for
-.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
-.\" entries marked with X<> in POD.  Of course, you'll have to process the
-.\" output yourself in some meaningful fashion.
-.ie \nF \{\
-.    de IX
-.    tm Index:\\$1\t\\n%\t"\\$2"
-..
-.    nr % 0
-.    rr F
-.\}
-.el \{\
-.    de IX
-..
-.\}
-.\"
-.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
-.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
-.    \" fudge factors for nroff and troff
-.if n \{\
-.    ds #H 0
-.    ds #V .8m
-.    ds #F .3m
-.    ds #[ \f1
-.    ds #] \fP
-.\}
-.if t \{\
-.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
-.    ds #V .6m
-.    ds #F 0
-.    ds #[ \&
-.    ds #] \&
-.\}
-.    \" simple accents for nroff and troff
-.if n \{\
-.    ds ' \&
-.    ds ` \&
-.    ds ^ \&
-.    ds , \&
-.    ds ~ ~
-.    ds /
-.\}
-.if t \{\
-.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
-.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
-.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
-.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
-.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
-.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
-.\}
-.    \" troff and (daisy-wheel) nroff accents
-.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
-.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
-.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
-.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
-.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
-.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
-.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
-.ds ae a\h'-(\w'a'u*4/10)'e
-.ds Ae A\h'-(\w'A'u*4/10)'E
-.    \" corrections for vroff
-.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
-.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
-.    \" for low resolution devices (crt and lpr)
-.if \n(.H>23 .if \n(.V>19 \
-\{\
-.    ds : e
-.    ds 8 ss
-.    ds o a
-.    ds d- d\h'-1'\(ga
-.    ds D- D\h'-1'\(hy
-.    ds th \o'bp'
-.    ds Th \o'LP'
-.    ds ae ae
-.    ds Ae AE
-.\}
-.rm #[ #] #H #V #F C
-.\" ========================================================================
-.\"
-.IX Title "rspamd 8"
-.TH rspamd 8 "2013-02-02" "rspamd-0.5.4" "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"
-rspamd \- main daemon for rspamd spam filtering system
-.SH "SYNOPSIS"
-.IX Header "SYNOPSIS"
-rspamd [\fB\-c\fR \fIconfig_file\fR] [\fB\-f\fR]
-[\fB\-u\fR \fIuser\fR] [\fB\-g\fR \fIgroup\fR] [\fB\-p\fR \fIpidfile\fR]
-[\fB\-t\fR] [\fB\-d\fR]
 .PP
-rspamd [\fB\-\-help\fR]
+Run rspamd in foreground with custom configuration:
+.IP
+.nf
+\f[C]
+rspamd\ -f\ -c\ ~/rspamd.conf
+\f[]
+.fi
 .PP
-rspamd [\fB\-t\fR]
+Run rspamd specifying user and group:
+.IP
+.nf
+\f[C]
+rspamd\ -u\ rspamd\ -g\ rspamd\ -c\ /etc/rspamd/rspamd.conf
+\f[]
+.fi
 .PP
-rspamd [\fB\-C\fR]
-.SH "DESCRIPTION"
-.IX Header "DESCRIPTION"
-\&\fBRspamd\fR filtering system is designed to be fast, modular and easily extendable system. 
-\&\fBRspamd\fR core is written in C language using event driven paradigma. 
-Plugins for \fBrspamd\fR can be written in lua.
-\&\fBRspamd\fR is designed to process connections completely asynchronous and do not block anywhere in code.
-.SH "OPTIONS"
-.IX Header "OPTIONS"
-.IP "\fB\-c\fR \fIconfig_file\fR, \fB\-\-config\fR \fIconfig_file\fR" 4
-.IX Item "-c config_file, --config config_file"
-Specify the path where rspamd config is placed. Default is rspamd.xml.
-.IP "\fB\-u\fR \fIuser\fR, \fB\-\-user\fR \fIuser\fR" 4
-.IX Item "-u user, --user user"
-Specify user rspamd run as. It is possible only when rspamd is launched by super-user as it
-calls \fIsetuid\fR\|(2) after spawning workers.
-.IP "\fB\-g\fR \fIgroup\fR, \fB\-\-group\fR \fIgroup\fR" 4
-.IX Item "-g group, --group group"
-Specify group rspamd run as.
-.IP "\fB\-p\fR \fIpidfile\fR, \fB\-\-pidfile\fR \fIpidfile\fR" 4
-.IX Item "-p pidfile, --pidfile pidfile"
-Path to pid file where rspamd pid would be stored. Directory containing pidfile must be 
-writeable by \fBrspamd\fR.
-.IP "\fB\-f\fR, \fB\-\-no\-fork\fR" 4
-.IX Item "-f, --no-fork"
-Do not daemonize after launch. Usable for debugging purposes.
-.IP "\fB\-t\fR, \fB\-\-config\-test\fR" 4
-.IX Item "-t, --config-test"
-Just perform test of configuration. Return zero exit code when configuration is \s-1OK\s0.
-.IP "\fB\-C\fR, \fB\-\-counters\fR" 4
-.IX Item "-C, --counters"
-Show counters for all symbols. Usable when symbols cache is saved.
-.IP "\fB\-d\fR, \fB\-\-debug\fR" 4
-.IX Item "-d, --debug"
-Turn on debugging mode in logging.
-.SH "RETURN VALUE"
-.IX Header "RETURN VALUE"
-On exit \fBrspamd\fR returns 0 if operation was successfull and error code otherwise.
-.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>.
+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
+\f[]
+.fi
+.PP
+Convert old \f[C]XML\f[] config to the \f[C]UCL\f[] format (since
+0.6.0):
+.IP
+.nf
+\f[C]
+rspamd\ -c\ /etc/rspamd.xml\ --convert-config=/etc/rspamd/rspamd.conf
+\f[]
+.fi
+.SH SEE ALSO
 .PP
-This program is free software; you may redistribute it and/or modify it
-under the terms of \s-1BSD\s0 license.
+Rspamd documentation and source codes may be downloaded from
+<https://rspamd.com/>.