diff options
| author | Sebastien Badia <seb@sebian.fr> | 2017-05-13 17:20:00 +0200 |
|---|---|---|
| committer | Sebastien Badia <seb@sebian.fr> | 2017-05-13 17:20:13 +0200 |
| commit | a65506d45b4f7ea35369c28cce8e544f4e8a7058 (patch) | |
| tree | 2f087e7d85873b45514848e7f233be1adec69403 /doc | |
| parent | ea076aafdbf0162a5a86e837d0efbed984adb027 (diff) | |
| download | rspamd-a65506d45b4f7ea35369c28cce8e544f4e8a7058.tar.gz rspamd-a65506d45b4f7ea35369c28cce8e544f4e8a7058.zip | |
[Minor] doc: Fix spelling errors
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/rspamadm.1 | 27 | ||||
| -rw-r--r-- | doc/rspamadm.1.md | 4 | ||||
| -rw-r--r-- | doc/rspamc.1 | 5 | ||||
| -rw-r--r-- | doc/rspamc.1.md | 2 |
4 files changed, 23 insertions, 15 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: diff --git a/doc/rspamadm.1.md b/doc/rspamadm.1.md index efe091da8..83c6c3e27 100644 --- a/doc/rspamadm.1.md +++ b/doc/rspamadm.1.md @@ -41,7 +41,7 @@ Also for each command you can check list of available **command_options** by run # RETURN VALUE -On exit `rspamadm` returns `0` if operation was successfull and an error code otherwise. +On exit `rspamadm` returns `0` if operation was successful and an error code otherwise. # EXAMPLES @@ -82,4 +82,4 @@ Generate a keypair to use for HTTPCrypt encryption: # SEE ALSO Rspamd documentation and source codes may be downloaded from -<https://rspamd.com/>.
\ No newline at end of file +<https://rspamd.com/>. diff --git a/doc/rspamc.1 b/doc/rspamc.1 index 331bdada8..0100cb41b 100644 --- a/doc/rspamc.1 +++ b/doc/rspamc.1 @@ -1,4 +1,7 @@ +.\" Automatically generated by Pandoc 1.17.2 +.\" .TH "RSPAMC" "1" "" "Rspamd User Manual" "" +.hy .SH NAME .PP \f[C]rspamc\f[] \- rspamd command line client @@ -205,7 +208,7 @@ List available commands .RE .SH RETURN VALUE .PP -On exit \f[C]rspamc\f[] returns \f[C]0\f[] if operation was successfull +On exit \f[C]rspamc\f[] returns \f[C]0\f[] if operation was successful and an error code otherwise. .SH EXAMPLES .PP diff --git a/doc/rspamc.1.md b/doc/rspamc.1.md index fb0fa58c8..4966e64cb 100644 --- a/doc/rspamc.1.md +++ b/doc/rspamc.1.md @@ -122,7 +122,7 @@ requires input. # RETURN VALUE -On exit `rspamc` returns `0` if operation was successfull and an error code otherwise. +On exit `rspamc` returns `0` if operation was successful and an error code otherwise. # EXAMPLES |