980848 – Duplicate use of parameter -h in virt-viewer/remote-viewer manual

RHEL Engineering is moving the tracking of its product development work on RHEL 6 through RHEL 9 to Red Hat Jira (issues.redhat.com). If you're a Red Hat customer, please continue to file support cases via the Red Hat customer portal. If you're not, please head to the "RHEL project" in Red Hat Jira and file new tickets here. Individual Bugzilla bugs in the statuses "NEW", "ASSIGNED", and "POST" are being migrated throughout September 2023. Bugs of Red Hat partners with an assigned Engineering Partner Manager (EPM) are migrated in late September as per pre-agreed dates. Bugs against components "kernel", "kernel-rt", and "kpatch" are only migrated if still in "NEW" or "ASSIGNED". If you cannot log in to RH Jira, please consult article #7032570. That failing, please send an e-mail to the RH Jira admins at rh-issues@redhat.com to troubleshoot your issue as a user management inquiry. The email creates a ServiceNow ticket with Red Hat. Individual Bugzilla bugs that are migrated will be moved to status "CLOSED", resolution "MIGRATED", and set with "MigratedToJIRA" in "Keywords". The link to the successor Jira issue will be found under "Links", have a little "two-footprint" icon next to it, and direct you to the "RHEL project" in Red Hat Jira (issue links are of type "https://issues.redhat.com/browse/RHEL-XXXX", where "X" is a digit). This same link will be available in a blue banner at the top of the page informing you that that bug has been migrated.

Bug 980848 - Duplicate use of parameter -h in virt-viewer/remote-viewer manual

Summary: Duplicate use of parameter -h in virt-viewer/remote-viewer manual

Keywords:
Status:	CLOSED CURRENTRELEASE
Alias:	None
Product:	Red Hat Enterprise Linux 7
Classification:	Red Hat
Component:	virt-viewer
Sub Component:
Version:	7.0
Hardware:	Unspecified
OS:	Unspecified
Priority:	medium
Severity:	medium
Target Milestone:	rc
Target Release:	---
Assignee:	Daniel Berrangé
QA Contact:	Virtualization Bugs
Docs Contact:
URL:
Whiteboard:
Depends On:	980846
Blocks:
TreeView+	depends on / blocked

Reported:	2013-07-03 10:53 UTC by tingting zheng
Modified:	2014-06-18 04:29 UTC (History)
CC List:	8 users (show)
Fixed In Version:	virt-viewer-0.5.7-1.el7.x86_64
Doc Type:	Bug Fix
Doc Text:
Clone Of:	980846
Environment:
Last Closed:	2014-06-13 10:15:42 UTC
Target Upstream Version:
Embargoed:

Attachments	(Terms of Use)

Description tingting zheng 2013-07-03 10:53:17 UTC

The bug also can be reproduced on:
virt-viewer-0.5.6-1.el7.x86_64

+++ This bug was initially created as a clone of Bug #980846 +++

Description
Duplicate use of parameter -h in virt-viewer/remote-viewer manual

Version:
virt-viewer-0.5.6-1.el6.x86_64

How reproducible:
100%

Steps to Reproduce:
# 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.

# virt-viewer -h
Missing argument for -h
Run 'virt-viewer --help' to see a full list of available command line options


# remote-viewer -h
Missing argument for -h
Run 'remote-viewer --help' to see a full list of available command line 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:

Comment 1 CongDong 2013-07-03 11:13:47 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
...

Comment 3 luxin 2013-07-30 07:36:28 UTC

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:

Comment 4 Christophe Fergeau 2013-08-02 07:53:05 UTC

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

Comment 6 CongDong 2013-10-10 03:42:34 UTC

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.

Comment 8 Ludek Smid 2014-06-13 10:15:42 UTC

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.

Note You need to log in before you can comment on or make changes to this bug.