Martin Peřina has uploaded a new change for review. Change subject: tools: Sync engine-config man pages and help ......................................................................
tools: Sync engine-config man pages and help Synchronizes content of engine-config man page with information displayed by execution 'engine-config -h'. Change-Id: I16e16973cb24e7e6e3209d229e0cdabfd3ffbc84 Bug-Url: https://bugzilla.redhat.com/1074299 Signed-off-by: Martin Perina <mper...@redhat.com> --- M packaging/bin/engine-config.sh M packaging/man/man8/engine-config.8 2 files changed, 106 insertions(+), 61 deletions(-) git pull ssh://gerrit.ovirt.org:29418/ovirt-engine refs/changes/82/25682/1 diff --git a/packaging/bin/engine-config.sh b/packaging/bin/engine-config.sh index eb4bb7d..56ea1d1 100755 --- a/packaging/bin/engine-config.sh +++ b/packaging/bin/engine-config.sh @@ -9,38 +9,48 @@ usage () { cat << __EOF__ -engine-config: get/set/list configuration -USAGE: - engine-config ACTION [--cver=version] [-p | --properties=/path/to/alternate/property/file] [-c | --config=/path/to/alternate/config/file] -Where: - ACTION action to perform, see details below - version relevant configuration version to use. - -p, --properties= (optional) use the given alternate properties file. - -c, --config= (optional) use the given alternate configuration file. +Usage: engine-config <action> [<args>] - Available actions: - -l, --list - list available configuration keys. - -a, --all - get all available configuration values. - -g key, --get=key [--cver=version] - get the value of the given key for the given version. If a version is not given, the values of all existing versions are returned. - -s key=val [--cver=version], --set key=val [--cver=version] - set the value of the given key for the given version. The cver version is required for this action only when the version is not 'general'. - -h, --help - display this help and exit. +AVAILABLE ACTIONS + -l, --list + List available configuration keys. -### Notes: -### 1. Passwords: password can be set in interactive mode ie: -### engine-config -s PasswordEntry=interactive -### or via file with one of the following options: -### engine-config -s PasswordEntry --admin-pass-file=/tmp/mypass -### engine-config -s PasswordEntry=/tmp/mypass -### PasswordEntry varies between the different password options -### See engine-config -h <OptionName> for more specific details -### 2. In order for your change(s) to take effect, -### restart the oVirt engine service (using: 'service ovirt-engine restart'). -################################################################################ + -a, --all + Get all available configuration values. + + -g KEY, --get=KEY + Get the value of the given key for the given version. If a version is not given, the values of all existing versions are returned. + + -s KEY=VALUE, --set KEY=VALUE + Set the value of the given key for the given version. The version is required for this action only when the version is not 'general'. + + -h, --help + Show this help message and exit. + +OPTIONS + --cver=VERSION + Relevant configuration version to use. + + -p PROP_FILE, --properties=PROP_FILE + Use the given alternate properties file. + + -c CFG_FILE, --config=CFG_FILE + Use the given alternate configuration file. + +SETTING PASSWORDS + Passwords can be set in interactive mode: + + engine-config -s PasswordEntry=interactive + + or via file with one of the following options: + + engine-config -s PasswordEntry --admin-pass-file=/tmp/mypass + engine-config -s PasswordEntry=/tmp/mypass + + PasswordEntry varies between the different password options. + +NOTE + In order for your change(s) to take effect, restart the oVirt engine. __EOF__ return 0 } diff --git a/packaging/man/man8/engine-config.8 b/packaging/man/man8/engine-config.8 index ab38a27..ff0de96 100644 --- a/packaging/man/man8/engine-config.8 +++ b/packaging/man/man8/engine-config.8 @@ -1,39 +1,74 @@ .TH engine-config 8 "May 9, 2013" "" "" .SH NAME -engine-config \- Engine management settings tool +engine-config \- Engine configuration management tool .SH SYNOPSIS -.B engine-config ACTION [--cver=version] [-p | --properties=/path/to/alternate/property/fie] [-c | --config=/path/to/alternate/config/file] - -Where: - ACTION action to perform, \f see details below - version relevant configuration version to use. - -p, --properties= (optional) use the given alternate properties file. - -c, --config= (optional) use the given alternate configuration file. - -Available actions: - \fB\-l\fR, \fB\-\-list\fR - list available configuration keys. - - \fB\-a\fR, \fB\-\-all\fR - get all available configuration values. - - \fB\-g key\fR, \fB\-\-get\fR=key [--cversion=version] - get the value of the given key for the given version. If a version is not given, the values of all existing -versions are returned. - - \fB\-s\fR key=val --cver=version, \fB\-\-set\fR key=val --cver=version - set the value of the given key for the given version. The cver version is mandatory for this action - - \fB\-h\fR, \fB\-\-help\fR - list available configuration keys. - display this help and exit. - -.B NOTE: - In order for your change(s) to take effect, restart the oVirt engine - For more info about the engine-config keys: http://www.ovirt.org/Engine_config_options +.B engine-config <action> [<args>] +.SH AVAILABLE ACTIONS +.PP +\fB\-l\fR, \fB\-\-list\fR +.RS 4 +List available configuration keys. +.RE +.PP +\fB\-a\fR, \fB\-\-all\fR +.RS 4 +Get all available configuration values. +.RE +.PP +\fB\-g\fR \fIKEY\fR, \fB\-\-get\fR=\fIKEY\fR +.RS 4 +Get the value of the given key for the given version. If a version is not given, the values of all existing versions are returned. +.RE +.PP +\fB\-s\fR \fIKEY\fR=\fIVALUE\fR, \fB\-\-set\fR \fIKEY\fR=\fIVALUE\fR +.RS 4 +Set the value of the given key for the given version. The version is required for this action only when the version is not 'general'. +.RE +.PP +\fB\-h\fR, \fB\-\-help\fR +.RS 4 +Show this help message and exit. +.RE +.SH OPTIONS +.PP +\fB\-\-cver\fR=\fIVERSION\fR +.RS 4 +Relevant configuration version to use. +.RE +.PP +\fB\-p\fR \fIPROP_FILE\fR, \fB\-\-properties\fR=\fIPROP_FILE\fR +.RS 4 +Use the given alternate properties file. +.RE +.PP +\fB\-c\fR \fICFG_FILE\fR, \fB\-\-config\fR=\fICFG_FILE\fR +.RS 4 +Use the given alternate configuration file. +.RE +.SH SETTING PASSWORDS +Passwords can be set in interactive mode: +.RS 4 +.BR +.nf +engine-config -s PasswordEntry=interactive +.fi +.BR +.RE +or via file with one of the following options: +.RS 4 +.BR +.nf +engine-config -s PasswordEntry --admin-pass-file=/tmp/mypass +engine-config -s PasswordEntry=/tmp/mypass +.fi +.BR +.RE +PasswordEntry varies between the different password options. +.SH NOTE +In order for your change(s) to take effect, restart the oVirt engine. .SH BUGS Report bugs to <http://bugzilla.redhat.com> .SH COPYRIGHT -Copyright 2010-2013 Red Hat, Inc. +Copyright 2010-2014 Red Hat, Inc. -- To view, visit http://gerrit.ovirt.org/25682 To unsubscribe, visit http://gerrit.ovirt.org/settings Gerrit-MessageType: newchange Gerrit-Change-Id: I16e16973cb24e7e6e3209d229e0cdabfd3ffbc84 Gerrit-PatchSet: 1 Gerrit-Project: ovirt-engine Gerrit-Branch: master Gerrit-Owner: Martin Peřina <mper...@redhat.com> _______________________________________________ Engine-patches mailing list Engine-patches@ovirt.org http://lists.ovirt.org/mailman/listinfo/engine-patches
