123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134 |
- .\" Automatically generated by Pandoc 1.17.2
- .\"
- .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[]]...
- .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 \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
- Show help message
- .RS
- .RE
- .TP
- .B \-v, \-\-verbose
- Enable verbose output
- .RS
- .RE
- .TP
- .B \-l, \-\-list\-commands
- List available commands
- .RS
- .RE
- .TP
- .B \-\-version
- Show version
- .RS
- .RE
- .TP
- .B \-\-var=\f[I]value\f[]
- Redefine ucl variable in format \f[C]VARIABLE=VALUE\f[]
- .RS
- .RE
- .SH RETURN VALUE
- .PP
- 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:
- .IP
- .nf
- \f[C]
- rspamadm\ help\ pw
- rspamadm\ pw\ \-\-help
- \f[]
- .fi
- .PP
- Encrypt controller\[aq]s password:
- .IP
- .nf
- \f[C]
- rspamadm\ pw\ encrypt
- \f[]
- .fi
- .PP
- Merge fuzzy databases:
- .IP
- .nf
- \f[C]
- rspamadm\ fuzzy_merge\ \-s\ data1.sqlite\ \-s\ data2.sqlite\ \-t\ dest.sqlite
- \f[]
- .fi
- .PP
- Perform configuration test:
- .IP
- .nf
- \f[C]
- rspamadm\ configtest\ \-c\ rspamd.conf
- \f[]
- .fi
- .PP
- Test configuration strictly and redefine some ucl vars:
- .IP
- .nf
- \f[C]
- rspamadm\ \-\-var=DBDIR=/tmp\ configtest\ \-c\ ./rspamd.conf\ \-s
- \f[]
- .fi
- .PP
- Dump the processed configuration:
- .IP
- .nf
- \f[C]
- rspamadm\ configdump
- \f[]
- .fi
- .PP
- Dump the processed configuration as JSON string:
- .IP
- .nf
- \f[C]
- rspamadm\ configdump\ \-j
- \f[]
- .fi
- .PP
- Generate a keypair to use for HTTPCrypt encryption:
- .IP
- .nf
- \f[C]
- rspamadm\ keypair
- \f[]
- .fi
- .SH SEE ALSO
- .PP
- Rspamd documentation and source codes may be downloaded from
- <https://rspamd.com/>.
|