[Doc] Accent about command options help

[Minor] Correct rspamadm -v to display actual version intead of help
This commit is contained in:
Andrej Zverev 2016-06-17 12:40:52 +03:00
parent ccee4b3bee
commit bc887dbaff
2 changed files with 8 additions and 10 deletions

View File

@ -8,22 +8,20 @@ rspamadm - rspamd administration utility
rspamadm [*global_options*] [*command*] [*command_options*]... rspamadm [*global_options*] [*command*] [*command_options*]...
rspamadm -l
rspamadm help
rspamadm help <command>
rspamadm --help
# DESCRIPTION # DESCRIPTION
`rspamadm` is a routine to manage rspamd spam filtering system. It is intended to perform `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, 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 rspamadm -l
Also for each command you can check list of available **command_options** by running
rspamadm help command
rspamadm command --help
# OPTIONS # OPTIONS
-h, \--help -h, \--help

View File

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