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

@@ -1,4 +1,4 @@
.\" Automatically generated by Pandoc 1.17.2
.\" Automatically generated by Pandoc 2.2.2.1
.\"
.TH "RSPAMC" "1" "" "Rspamd User Manual" ""
.hy
@@ -7,13 +7,13 @@
\f[C]rspamc\f[] \- rspamd command line client
.SH SYNOPSIS
.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
rspamc \-\-help
rspamc \[en]help
.SH DESCRIPTION
.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:
.IP \[bu] 2
Scan commands:
@@ -49,17 +49,21 @@ graphs)
\f[C]add_action\f[]: add or modify action settings
.RE
.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
\f[C]Input\ files\f[] may be either regular file(s) or a directory to
scan.
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
.TP
.B \-h \f[I]host[:port]\f[], \-\-connect=\f[I]host[:port]\f[]
@@ -108,7 +112,8 @@ Emulate that message was received from specified authenticated user
.RE
.TP
.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
.RE
.TP
@@ -134,8 +139,8 @@ MTA)
.RE
.TP
.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
.RE
.TP
@@ -197,7 +202,7 @@ This option can be repeated multiple times.
.B \-\-sort=\f[I]type\f[]
Sort output according to a specific field.
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.
.RS
.RE
@@ -268,7 +273,7 @@ rspamc\ uptime
\f[]
.fi
.PP
Add custom rule\[aq]s weight:
Add custom rule's weight:
.IP
.nf
\f[C]
@@ -276,7 +281,7 @@ rspamc\ add_symbol\ test\ 1.5
\f[]
.fi
.PP
Add custom action\[aq]s weight:
Add custom action's weight:
.IP
.nf
\f[C]
@@ -285,5 +290,5 @@ rspamc\ add_action\ reject\ 7.1
.fi
.SH SEE ALSO
.PP
Rspamd documentation and source codes may be downloaded from
Rspamd documentation and source code may be downloaded from
<https://rspamd.com/>.

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

@@ -114,7 +114,7 @@ requires input.
: 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 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
: List available commands

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

@@ -141,7 +141,7 @@ static GOptionEntry entries[] =
{"exclude", 0, 0, G_OPTION_ARG_STRING_ARRAY, &exclude_patterns,
"Exclude specific glob patterns in file names (can be repeated)", NULL},
{"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,
"Allow empty input instead of reading from stdin", NULL },
{ "fuzzy-symbol", 'S', 0, G_OPTION_ARG_STRING, &fuzzy_symbol,

Loading…
Cancel
Save