Browse Source

[Doc] Accent about `command options` help

[Minor] Correct rspamadm -v to display actual version intead of help
tags/1.3.0
Andrej Zverev 8 years ago
parent
commit
bc887dbaff
2 changed files with 8 additions and 10 deletions
  1. 7
    9
      doc/rspamadm.1.md
  2. 1
    1
      src/rspamadm/rspamadm.c

+ 7
- 9
doc/rspamadm.1.md View File

@@ -8,22 +8,20 @@ rspamadm - rspamd administration utility

rspamadm [*global_options*] [*command*] [*command_options*]...

rspamadm -l

rspamadm help

rspamadm help <command>

rspamadm --help

# DESCRIPTION

`rspamadm` 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 commands by running
signing configurations and so on. You can get a list of available **commands** by running

rspamadm -l

Also for each command you can check list of available **command_options** by running

rspamadm help command
rspamadm command --help

# OPTIONS

-h, \--help

+ 1
- 1
src/rspamadm/rspamadm.c View File

@@ -56,7 +56,7 @@ static GOptionEntry entries[] = {
"Redefine UCL variable", NULL},
{"help", 'h', 0, G_OPTION_ARG_NONE, &show_help,
"Show help", NULL},
{"version", 'h', 0, G_OPTION_ARG_NONE, &show_version,
{"version", 'v', 0, G_OPTION_ARG_NONE, &show_version,
"Show version", NULL},
{NULL, 0, 0, G_OPTION_ARG_NONE, NULL, NULL, NULL}
};

Loading…
Cancel
Save