Bug 980848
| Summary: | Duplicate use of parameter -h in virt-viewer/remote-viewer manual | ||
|---|---|---|---|
| Product: | Red Hat Enterprise Linux 7 | Reporter: | tingting zheng <tzheng> |
| Component: | virt-viewer | Assignee: | Daniel Berrangé <berrange> |
| Status: | CLOSED CURRENTRELEASE | QA Contact: | Virtualization Bugs <virt-bugs> |
| Severity: | medium | Docs Contact: | |
| Priority: | medium | ||
| Version: | 7.0 | CC: | acathrow, cfergeau, codong, dallan, dblechte, dyuan, lcui, mzhan |
| Target Milestone: | rc | ||
| Target Release: | --- | ||
| Hardware: | Unspecified | ||
| OS: | Unspecified | ||
| Whiteboard: | |||
| Fixed In Version: | virt-viewer-0.5.7-1.el7.x86_64 | Doc Type: | Bug Fix |
| Doc Text: | Story Points: | --- | |
| Clone Of: | 980846 | Environment: | |
| Last Closed: | 2014-06-13 10:15:42 UTC | Type: | Bug |
| Regression: | --- | Mount Type: | --- |
| Documentation: | --- | CRM: | |
| Verified Versions: | Category: | --- | |
| oVirt Team: | --- | RHEL 7.3 requirements from Atomic Host: | |
| Cloudforms Team: | --- | Target Upstream Version: | |
| Embargoed: | |||
| Bug Depends On: | 980846 | ||
| Bug Blocks: | |||
|
Description
tingting zheng
2013-07-03 10:53:17 UTC
The content in man page and help message are different about the help option:
It's "-?" in "--help" message, but it's "-h" in man page
# virt-viewer --help
...
Help Options:
-?, --help Show help options
...
# remote-viewer --help
...
Help Options:
-?, --help Show help options
...
# man virt-viewer
...
OPTIONS
The following options are accepted when running "virt-viewer":
-h, --help
Display command line help summary
...
# man remote-viewer
...
OPTIONS
The following options are accepted when running "remote-viewer":
-h, --help
Display command line help summary
...
I can reproduce this bug
Version:
virt-viewer-0.5.6-1.el6.x86_64
Steps to Reproduce:
1. # man virt-viewer
OPTIONS
The following options are accepted when running "virt-viewer":
-h, --help
Display command line help summary
-h HOTKEYS, --hotkeys HOTKEYS
Override the default hotkey bindings with HOTKEYS. Where HOTKEYS is
<action1>=<key1>[+<key2>][,<action2>=<key3>[+<key4>]]. Key-names are case-insensitive,
valid actions are: toggle-fullscreen, release-cursor, smartcard-insert and smartcard-
remove. Examples:
--hotkeys=toggle-fullscreen=shift+f11,release-cursor=shift+f12
--hotkeys=release-cursor=ctrl+alt
Note that hotkeys for which no binding is given are disabled, specifying an empty string
disables all hotkeys.
2. # man remote-viewer
OPTIONS
The following options are accepted when running "remote-viewer":
-h, --help
Display command line help summary
-h HOTKEYS, --hotkeys HOTKEYS
Override the default hotkey bindings with HOTKEYS. Where HOTKEYS is
<action1>=<key1>[+<key2>][,<action2>=<key3>[+<key4>]]. Key-names are case-insensitive,
valid actions are: toggle-fullscreen, release-cursor, smartcard-insert and smartcard-
remove. Examples:
--hotkeys=toggle-fullscreen=shift+f11,release-cursor=shift+f12
--hotkeys=release-cursor=ctrl+alt
Note that hotkeys for which no binding is given are disabled, specifying an empty string
disables all hotkeys.
3. # virt-viewer -h
Missing argument for -h
Run 'virt-viewer --help' to see a full list of available command line options
4. # remote-viewer -h
Missing argument for -h
Run 'remote-viewer --help' to see a full list of available command line options
5. # virt-viewer --help
Usage:
virt-viewer [OPTION...] DOMAIN-NAME|ID|UUID - Virtual machine graphical console
Help Options:
...
6. # remote-viewer --help
Usage:
remote-viewer [OPTION...] URI - Remote viewer client
Help Options:
...
Actual results:
Duplicate parameter -h in virt-viewer/remote-viewer manual
Expected results:
Only one use for parameter -h in virt-viewer/remote-viewer manual
Additional info:
Should be fixed by https://git.fedorahosted.org/cgit/virt-viewer.git/commit/?id=9ca68938da40517b6a8723619104edc3799f0c15 which is in virt-viewer 0.5.7 but not 0.5.6 I can reproduce this with:
virt-viewer-0.5.6-1.el7.x86_64
Steps:
As the steps in description.
Result:
Same with the result in description.
Verify with:
virt-viewer-0.5.7-1.el7.x86_64
Steps:
1. # man virt-viewer
OPTIONS
The following options are accepted when running
"virt-viewer":
-h, --help
Display command line help summary
...
-H HOTKEYS, --hotkeys HOTKEYS
Override the default hotkey bindings with HOTKEYS. Where
HOTKEYS is
<action1>=<key1>[+<key2>][,<action2>=<key3>[+<key4>]].
Key-names are case-insensitive, valid actions are:
toggle-fullscreen, release-cursor, smartcard-insert and
smartcard-remove. Examples:
--hotkeys=toggle-fullscreen=shift+f11,release-cursor=shift+f12
--hotkeys=release-cursor=ctrl+alt
Note that hotkeys for which no binding is given are
disabled, specifying an empty string disables all
hotkeys.
# man remote-viewer
OPTIONS
The following options are accepted when running
"remote-viewer":
-h, --help
Display command line help summary
...
-H HOTKEYS, --hotkeys HOTKEYS
Override the default hotkey bindings with HOTKEYS. Where
HOTKEYS is
<action1>=<key1>[+<key2>][,<action2>=<key3>[+<key4>]].
Key-names are case-insensitive, valid actions are:
toggle-fullscreen, release-cursor, smartcard-insert and
smartcard-remove. Examples:
--hotkeys=toggle-fullscreen=shift+f11,release-cursor=shift+f12
--hotkeys=release-cursor=ctrl+alt
Note that hotkeys for which no binding is given are
disabled, specifying an empty string disables all
hotkeys.
2.
# virt-viewer -h
Usage:
virt-viewer [OPTION...] -- DOMAIN-NAME|ID|UUID - Virtual machine graphical console
Help Options:
-h, --help
...
pen in full screen mode
-H, --hotkeys
#remote-viewer -h
Usage:
remote-viewer [OPTION...] -- URI - Remote viewer client
Help Options:
-h, --help
...
pen connection using Spice controller communication
-H, --hotkeys Customise hotkeys
--display=DISPLAY X display to use
As the result, set VERIFIED.
This request was resolved in Red Hat Enterprise Linux 7.0. Contact your manager or support representative in case you have further questions about the request. |