From 4c2a6e952da0f61b076275f1a0fdcfc9559651cf Mon Sep 17 00:00:00 2001 From: Vsevolod Stakhov Date: Mon, 28 Sep 2015 16:45:01 +0100 Subject: Add preliminary documentation for rspamadm. --- doc/rspamc.1.md | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) (limited to 'doc/rspamc.1.md') diff --git a/doc/rspamc.1.md b/doc/rspamc.1.md index 4e723fe51..f4d089bc1 100644 --- a/doc/rspamc.1.md +++ b/doc/rspamc.1.md @@ -2,7 +2,7 @@ # NAME -rspamc - rspamd command line client +`rspamc` - rspamd command line client # SYNOPSIS @@ -12,28 +12,28 @@ rspamc --help # DESCRIPTION -Rspamc is a simple client for checking messages using rspamd or for learning rspamd by messages. -Rspamc supports the following commands: +`rspamc` is a simple client for checking messages using rspamd or for learning rspamd by messages. +`rspamc` supports the following commands: * Scan commands: - * *symbols*: scan message and show symbols (default command) + * `symbols`: scan message and show symbols (default command) * Control commands - * *learn_spam*: learn message as spam - * *learn_ham*: learn message as ham - * *fuzzy_add*: add message to fuzzy storage (check `-f` and `-w` options for this command) - * *fuzzy_del*: delete message from fuzzy storage (check `-f` option for this command) - * *stat*: show rspamd statistics - * *stat_reset*: show and reset rspamd statistics (useful for graphs) - * *counters*: display rspamd symbols statistics - * *uptime*: show rspamd uptime - * *add_symbol*: add or modify symbol settings in rspamd - * *add_action*: add or modify action settings + * `learn_spam`: learn message as spam + * `learn_ham`: learn message as ham + * `fuzzy_add`: add message to fuzzy storage (check `-f` and `-w` options for this command) + * `fuzzy_del`: delete message from fuzzy storage (check `-f` option for this command) + * `stat`: show rspamd statistics + * `stat_reset`: show and reset rspamd statistics (useful for graphs) + * `counters`: display rspamd symbols statistics + * `uptime`: show rspamd uptime + * `add_symbol`: add or modify symbol settings in rspamd + * `add_action`: add or modify action settings Control commands that modifies rspamd state are considered as privileged and basically requires a password to be specified with `-P` option (see **OPTIONS**, below, for details). This depends on a controller's settings and is discussed in `rspamd-workers` page. -`Input files` may be either regular file(s) or a directory to scan. If no files are specified rspamc reads +`Input files` may be either regular file(s) or a directory to scan. If no files are specified `rspamc` reads from the standard input. Controller commands usually does not accept any input, however learn* and fuzzy* commands requires input. @@ -116,7 +116,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 successfull and an error code otherwise. # EXAMPLES -- cgit v1.2.3