Browse Source

[Minor] Update help/man pages

tags/1.7.9
Vsevolod Stakhov 5 years ago
parent
commit
c80fe6eab1
3 changed files with 26 additions and 21 deletions
  1. 24
    19
      doc/rspamc.1
  2. 1
    1
      doc/rspamc.1.md
  3. 1
    1
      src/client/rspamc.c

+ 24
- 19
doc/rspamc.1 View File

.\" Automatically generated by Pandoc 1.17.2
.\" Automatically generated by Pandoc 2.2.2.1
.\" .\"
.TH "RSPAMC" "1" "" "Rspamd User Manual" "" .TH "RSPAMC" "1" "" "Rspamd User Manual" ""
.hy .hy
\f[C]rspamc\f[] \- rspamd command line client \f[C]rspamc\f[] \- rspamd command line client
.SH SYNOPSIS .SH SYNOPSIS
.PP .PP
rspamc [\f[I]options\f[]] [\f[I]command\f[]] [\f[I]input\-file\f[]]...
rspamc [\f[I]options\f[]] [\f[I]command\f[]] [\f[I]input\-file\f[]]\&...
.PP .PP
rspamc \-\-help
rspamc \[en]help
.SH DESCRIPTION .SH DESCRIPTION
.PP .PP
\f[C]rspamc\f[] is a simple client for checking messages using rspamd or
for learning rspamd by messages.
\f[C]rspamc\f[] is a simple rspamd client, primarily for classifying or
learning messages.
\f[C]rspamc\f[] supports the following commands: \f[C]rspamc\f[] supports the following commands:
.IP \[bu] 2 .IP \[bu] 2
Scan commands: Scan commands:
\f[C]add_action\f[]: add or modify action settings \f[C]add_action\f[]: add or modify action settings
.RE .RE
.PP .PP
Control commands that modifies rspamd state are considered as privileged
and basically requires a password to be specified with \f[C]\-P\f[]
option (see \f[B]OPTIONS\f[], below, for details).
This depends on a controller\[aq]s settings and is discussed in
\f[C]rspamd\-workers\f[] page.
Control commands that modify rspamd state are considered privileged and
require a password to be specified with the \f[C]\-P\f[] option (see
\f[B]OPTIONS\f[], below, for details).
.PD 0
.P
.PD
This depends on a controller's settings and is discussed in the
\f[C]rspamd\-workers\f[] page (see \f[B]SEE ALSO\f[], below, for
details).
.PP .PP
\f[C]Input\ files\f[] may be either regular file(s) or a directory to \f[C]Input\ files\f[] may be either regular file(s) or a directory to
scan. scan.
If no files are specified \f[C]rspamc\f[] reads from the standard input. If no files are specified \f[C]rspamc\f[] reads from the standard input.
Controller commands usually does not accept any input, however learn*
and fuzzy* commands requires input.
Controller commands usually do not accept any input, however learn* and
fuzzy* commands requires input.
.SH OPTIONS .SH OPTIONS
.TP .TP
.B \-h \f[I]host[:port]\f[], \-\-connect=\f[I]host[:port]\f[] .B \-h \f[I]host[:port]\f[], \-\-connect=\f[I]host[:port]\f[]
.RE .RE
.TP .TP
.B \-d \f[I]user\@domain\f[], \-\-deliver=\f[I]user\@domain\f[] .B \-d \f[I]user\@domain\f[], \-\-deliver=\f[I]user\@domain\f[]
Emulate that message is delivered to specified user (for LDA/statistics)
Emulate that message was delivered to specified user (for
LDA/statistics)
.RS .RS
.RE .RE
.TP .TP
.RE .RE
.TP .TP
.B \-t \f[I]seconds\f[], \-\-timeout=\f[I]seconds\f[] .B \-t \f[I]seconds\f[], \-\-timeout=\f[I]seconds\f[]
Timeout for waiting for a reply (can be floating point number, e.g.
0.1)
Timeout for waiting for a reply (can be floating point number,
e.g.\ 0.1)
.RS .RS
.RE .RE
.TP .TP
.B \-\-sort=\f[I]type\f[] .B \-\-sort=\f[I]type\f[]
Sort output according to a specific field. Sort output according to a specific field.
For \f[C]counters\f[] command the allowed values for this key are For \f[C]counters\f[] command the allowed values for this key are
\f[C]name\f[], \f[C]weight\f[], \f[C]frequency\f[] and \f[C]time\f[].
\f[C]name\f[], \f[C]weight\f[], \f[C]frequency\f[] and \f[C]hits\f[].
Appending \f[C]:desc\f[] to any of these types inverts sorting order. Appending \f[C]:desc\f[] to any of these types inverts sorting order.
.RS .RS
.RE .RE
\f[] \f[]
.fi .fi
.PP .PP
Add custom rule\[aq]s weight:
Add custom rule's weight:
.IP .IP
.nf .nf
\f[C] \f[C]
\f[] \f[]
.fi .fi
.PP .PP
Add custom action\[aq]s weight:
Add custom action's weight:
.IP .IP
.nf .nf
\f[C] \f[C]
.fi .fi
.SH SEE ALSO .SH SEE ALSO
.PP .PP
Rspamd documentation and source codes may be downloaded from
Rspamd documentation and source code may be downloaded from
<https://rspamd.com/>. <https://rspamd.com/>.

+ 1
- 1
doc/rspamc.1.md View File

: Add custom HTTP header for a request. You may specify header in format `name=value` or just `name` for an empty header. This option can be repeated multiple times. : Add custom HTTP header for a request. You may specify header in format `name=value` or just `name` for an empty header. This option can be repeated multiple times.


\--sort=*type* \--sort=*type*
: Sort output according to a specific field. For `counters` command the allowed values for this key are `name`, `weight`, `frequency` and `time`. Appending `:desc` to any of these types inverts sorting order.
: Sort output according to a specific field. For `counters` command the allowed values for this key are `name`, `weight`, `frequency` and `hits`. Appending `:desc` to any of these types inverts sorting order.


\--commands \--commands
: List available commands : List available commands

+ 1
- 1
src/client/rspamc.c View File

{"exclude", 0, 0, G_OPTION_ARG_STRING_ARRAY, &exclude_patterns, {"exclude", 0, 0, G_OPTION_ARG_STRING_ARRAY, &exclude_patterns,
"Exclude specific glob patterns in file names (can be repeated)", NULL}, "Exclude specific glob patterns in file names (can be repeated)", NULL},
{"sort", 0, 0, G_OPTION_ARG_STRING, &sort, {"sort", 0, 0, G_OPTION_ARG_STRING, &sort,
"Sort output in a specific order (name, weight, time)", NULL},
"Sort output in a specific order (name, weight, frequency, hits)", NULL},
{ "empty", 'E', 0, G_OPTION_ARG_NONE, &empty_input, { "empty", 'E', 0, G_OPTION_ARG_NONE, &empty_input,
"Allow empty input instead of reading from stdin", NULL }, "Allow empty input instead of reading from stdin", NULL },
{ "fuzzy-symbol", 'S', 0, G_OPTION_ARG_STRING, &fuzzy_symbol, { "fuzzy-symbol", 'S', 0, G_OPTION_ARG_STRING, &fuzzy_symbol,

Loading…
Cancel
Save