diff options
Diffstat (limited to 'doc/rspamadm.1')
| -rw-r--r-- | doc/rspamadm.1 | 137 |
1 files changed, 51 insertions, 86 deletions
diff --git a/doc/rspamadm.1 b/doc/rspamadm.1 index bd3b02a2d..d56e29199 100644 --- a/doc/rspamadm.1 +++ b/doc/rspamadm.1 @@ -1,134 +1,99 @@ -.\" Automatically generated by Pandoc 1.17.2 +.\" Automatically generated by Pandoc 3.1.11.1 .\" .TH "RSPAMADM" "1" "" "Rspamd User Manual" "" -.hy .SH NAME -.PP rspamadm \- rspamd administration utility .SH SYNOPSIS -.PP -rspamadm [\f[I]global_options\f[]] [\f[I]command\f[]] -[\f[I]command_options\f[]]... +rspamadm [\f[I]global_options\f[R]] [\f[I]command\f[R]] +[\f[I]command_options\f[R]]\&... .SH DESCRIPTION -.PP -\f[C]rspamadm\f[] is a routine to manage rspamd spam filtering system. +\f[CR]rspamadm\f[R] 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 \f[B]commands\f[] by running +You can get a list of available \f[B]commands\f[R] by running .IP -.nf -\f[C] -rspamadm\ \-l -\f[] -.fi +.EX +rspamadm \-l +.EE .PP Also for each command you can check list of available -\f[B]command_options\f[] by running +\f[B]command_options\f[R] by running .IP -.nf -\f[C] -rspamadm\ help\ command -rspamadm\ command\ \-\-help -\f[] -.fi +.EX +rspamadm help command +rspamadm command \-\-help +.EE .SH OPTIONS .TP -.B \-h, \-\-help +\-h, \-\-help Show help message -.RS -.RE .TP -.B \-v, \-\-verbose +\-v, \-\-verbose Enable verbose output -.RS -.RE .TP -.B \-l, \-\-list\-commands +\-l, \-\-list\-commands List available commands -.RS -.RE .TP -.B \-\-version +\-\-version Show version -.RS -.RE .TP -.B \-\-var=\f[I]value\f[] -Redefine ucl variable in format \f[C]VARIABLE=VALUE\f[] -.RS -.RE +\-\-var=\f[I]value\f[R] +Redefine ucl variable in format \f[CR]VARIABLE=VALUE\f[R] .SH RETURN VALUE -.PP -On exit \f[C]rspamadm\f[] returns \f[C]0\f[] if operation was successful -and an error code otherwise. +On exit \f[CR]rspamadm\f[R] returns \f[CR]0\f[R] if operation was +successful and an error code otherwise. .SH EXAMPLES -.PP Get help for pw command: .IP -.nf -\f[C] -rspamadm\ help\ pw -rspamadm\ pw\ \-\-help -\f[] -.fi +.EX +rspamadm help pw +rspamadm pw \-\-help +.EE .PP -Encrypt controller\[aq]s password: +Encrypt controller\[cq]s password: .IP -.nf -\f[C] -rspamadm\ pw\ encrypt -\f[] -.fi +.EX +rspamadm pw encrypt +.EE .PP Merge fuzzy databases: .IP -.nf -\f[C] -rspamadm\ fuzzy_merge\ \-s\ data1.sqlite\ \-s\ data2.sqlite\ \-t\ dest.sqlite -\f[] -.fi +.EX +rspamadm fuzzy_merge \-s data1.sqlite \-s data2.sqlite \-t dest.sqlite +.EE .PP Perform configuration test: .IP -.nf -\f[C] -rspamadm\ configtest\ \-c\ rspamd.conf -\f[] -.fi +.EX +rspamadm configtest \-c rspamd.conf +.EE .PP Test configuration strictly and redefine some ucl vars: .IP -.nf -\f[C] -rspamadm\ \-\-var=DBDIR=/tmp\ configtest\ \-c\ ./rspamd.conf\ \-s -\f[] -.fi +.EX +rspamadm \-\-var=DBDIR=/tmp configtest \-c ./rspamd.conf \-s +.EE .PP Dump the processed configuration: .IP -.nf -\f[C] -rspamadm\ configdump -\f[] -.fi +.EX +rspamadm configdump +.EE .PP Dump the processed configuration as JSON string: .IP -.nf -\f[C] -rspamadm\ configdump\ \-j -\f[] -.fi +.EX +rspamadm configdump \-j +.EE .PP Generate a keypair to use for HTTPCrypt encryption: .IP -.nf -\f[C] -rspamadm\ keypair -\f[] -.fi +.EX +rspamadm keypair +.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 +\&. |