aboutsummaryrefslogtreecommitdiffstats
path: root/doc/rspamadm.1
diff options
context:
space:
mode:
authorSebastien Badia <seb@sebian.fr>2017-05-13 17:20:00 +0200
committerSebastien Badia <seb@sebian.fr>2017-05-13 17:20:13 +0200
commita65506d45b4f7ea35369c28cce8e544f4e8a7058 (patch)
tree2f087e7d85873b45514848e7f233be1adec69403 /doc/rspamadm.1
parentea076aafdbf0162a5a86e837d0efbed984adb027 (diff)
downloadrspamd-a65506d45b4f7ea35369c28cce8e544f4e8a7058.tar.gz
rspamd-a65506d45b4f7ea35369c28cce8e544f4e8a7058.zip
[Minor] doc: Fix spelling errors
Diffstat (limited to 'doc/rspamadm.1')
-rw-r--r--doc/rspamadm.127
1 files changed, 16 insertions, 11 deletions
diff --git a/doc/rspamadm.1 b/doc/rspamadm.1
index 22bcf4d91..bd3b02a2d 100644
--- a/doc/rspamadm.1
+++ b/doc/rspamadm.1
@@ -1,4 +1,7 @@
+.\" Automatically generated by Pandoc 1.17.2
+.\"
.TH "RSPAMADM" "1" "" "Rspamd User Manual" ""
+.hy
.SH NAME
.PP
rspamadm \- rspamd administration utility
@@ -6,27 +9,29 @@ rspamadm \- rspamd administration utility
.PP
rspamadm [\f[I]global_options\f[]] [\f[I]command\f[]]
[\f[I]command_options\f[]]...
-.PP
-rspamadm \-l
-.PP
-rspamadm help
-.PP
-rspamadm help
-.PP
-rspamadm \-\-help
.SH DESCRIPTION
.PP
\f[C]rspamadm\f[] is a routine to manage rspamd spam filtering system.
It is intended to perform such actions as merging databases, performing
configuration tests, encrypting passwords, signing configurations and so
on.
-You can get a list of available commands by running
+You can get a list of available \f[B]commands\f[] by running
.IP
.nf
\f[C]
rspamadm\ \-l
\f[]
.fi
+.PP
+Also for each command you can check list of available
+\f[B]command_options\f[] by running
+.IP
+.nf
+\f[C]
+rspamadm\ help\ command
+rspamadm\ command\ \-\-help
+\f[]
+.fi
.SH OPTIONS
.TP
.B \-h, \-\-help
@@ -55,8 +60,8 @@ Redefine ucl variable in format \f[C]VARIABLE=VALUE\f[]
.RE
.SH RETURN VALUE
.PP
-On exit \f[C]rspamadm\f[] returns \f[C]0\f[] if operation was
-successfull and an error code otherwise.
+On exit \f[C]rspamadm\f[] returns \f[C]0\f[] if operation was successful
+and an error code otherwise.
.SH EXAMPLES
.PP
Get help for pw command: