Bug 771726 - man page for rhsm-compliance-icon should be re-authored to rhsm-icon
Summary: man page for rhsm-compliance-icon should be re-authored to rhsm-icon
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Red Hat Enterprise Linux 5
Classification: Red Hat
Component: subscription-manager
Version: 5.8
Hardware: Unspecified
OS: Unspecified
unspecified
medium
Target Milestone: rc
: 5.8
Assignee: Bryan Kearney
QA Contact: Entitlement Bugs
URL:
Whiteboard:
Depends On:
Blocks: 715031 784372
TreeView+ depends on / blocked
 
Reported: 2012-01-04 18:56 UTC by John Sefler
Modified: 2021-01-29 20:23 UTC (History)
4 users (show)

Fixed In Version: subscription-manager-0.98.12.el5
Doc Type: Bug Fix
Doc Text:
No description necessary
Clone Of:
Environment:
Last Closed: 2012-02-21 06:44:14 UTC
Target Upstream Version:


Attachments (Terms of Use)
rhsm-icon.8 (2.61 KB, text/plain)
2012-01-04 21:32 UTC, Deon Ballard
no flags Details
rhsm-icon.8 with --i (3.08 KB, text/plain)
2012-01-10 16:15 UTC, Deon Ballard
no flags Details


Links
System ID Private Priority Status Summary Last Updated
Red Hat Product Errata RHBA-2012:0154 0 normal SHIPPED_LIVE subscription-manager bug fix update 2012-02-20 15:06:04 UTC

Description John Sefler 2012-01-04 18:56:30 UTC
Description of problem:
When the rhsm-compliance-icon was renamed to rhsm-icon (during rhel57 cycle), we neglected to update the man page too.


Version-Release number of selected component (if applicable):
[root@jsefler-onprem-5server ~]# rpm -q subscription-manager-gnome
subscription-manager-gnome-0.98.10-1.git.0.5d83904.el5


How reproducible:


Steps to Reproduce:

[root@jsefler-onprem-5server ~]# man rhsm-icon
No manual entry for rhsm-icon

[root@jsefler-onprem-5server ~]# man -P cat rhsm-compliance-icon
rhsm-compliance-icon(8) Subscription Compliance Daemon rhsm-compliance-icon(8)



NAME
       rhsm-compliance-icon  -  Periodically checks installed products against
       active subscriptions to check for compliance.


SYNOPSIS
       rhsm-compliance-icon


DESCRIPTION
       Red Hat provides content updates and support by  issuing  subscriptions
       for   its  products.  These  subscriptions  are  allocated  to  systems
       (machines) and apply to the installed software products.


       On X systems (so, systems with a GUI interface),  a  compliance  daemon
       runs  every  4  hours to check the currently installed software against
       the allocated subscriptions. If software is installed with expired sub-
       scriptions  or  no  available subscription, then the daemon triggers an
       icon and warning message to display in the start menu bar.


       rhsm-compliance-icon
        only runs on X-based systems. Servers which do not have a  GUI  inter-
       face do not run or require the rhsm-compliance-icon daemon.


OPTIONS
       -c, --check-period
              Sets  the  interval  to  use  between checks for compliance. The
              value is in seconds.


       -f, --force-icon=TYPE
              Manually displays the given type of icon in the start menu.  The
              TYPE  can  be  warning  or expired and uses a different icon for
              each type of message.


       -d, --debug
              Shows debug messages for the daemon.


USAGE
       There are two reasons to invoke rhsm-compliance-icon manually:


              * To run the daemon on a new schedule  (immediately  or  with  a
              different frequency)


              *  To  view  the  compliance icons or messages regardless of the
              compliance state of the machine


       Since X runs the daemon automatically and on schedule, it is not neces-
       sary  normally  to run the compliance daemon. Administrators can run it
       to view any immediate changes to the  compliance  of  the  system.  For
       example:
       rhsm-compliance-icon --check-period 120


       If  you  just  want to know what the different compliance messages look
       like, then use the --force-icon option.

       rhsm-compliance-icon --force-icon=warning

       rhsm-compliance-icon --force-icon=expired


BUGS
       This process is part of the subscription management system for Red  Hat
       systems. To file bugs against this process, go to https://bugzilla.red-
       hat.com/ and select Red Hat > Red Hat Enterprise Linux  6  >  subscrip-
       tion-manager.



AUTHORS
       Deon   Lackey,  <dlackey>,  and  James  Bowes,  <jbowes@red-
       hat.com>. rhsm-compliance-icon was written by James Bowes.


COPYRIGHT
       Copyright (c) 2010 Red Hat, Inc. This is licensed under the GNU General
       Public  License, version 2 (GPLv2). A copy of this license is available
       at http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt.



version 1.0                    January 31, 2011        rhsm-compliance-icon(8)
[root@jsefler-onprem-5server ~]# 

  
Expected results:
All occurrences of "rhsm-compliance-icon" above should be updated to "rhsm-icon" 


Additional info:
[root@jsefler-onprem-5server ~]# rpm -ql subscription-manager-gnome | egrep "rhsm-icon|rhsm-compliance-icon"
/etc/xdg/autostart/rhsm-icon.desktop
/usr/bin/rhsm-icon
/usr/share/man/man8/rhsm-compliance-icon.8.gz
                    ^^^^^^^^^^^^^^^^^^^^
                    SHOULD BE rhsm-icon

Comment 1 Deon Ballard 2012-01-04 21:32:07 UTC
Created attachment 550765 [details]
rhsm-icon.8

I edited and renamed the man page. I don't have the permissions to change it in the subscription-manager git repo, so I'm attaching the file here.

I checked the other man pages, but I didn't find any references to rhsm-compliance-icon, so that's fine. I'll check the deployment guide next.

Comment 3 John Sefler 2012-01-06 22:16:23 UTC
Deon,
There is another rhsm-icon application option (-i, --check-immediately) that will check the subscription status immediately, otherwise the first check is delayed 4 minutes (this delay was the fix for bug 700547).

[root@jsefler-onprem-5server ~]# rhsm-icon --help
Usage:
  rhsm-icon [OPTION...] rhsm icon

Help Options:
  -?, --help                  Show help options
  --help-all                  Show all help options
  --help-gtk                  Show GTK+ Options

Application Options:
  -c, --check-period          How often to check for validity (in seconds)
  -d, --debug                 Show debug messages
  -f, --force-icon=TYPE       Force display of the icon (expired, partial or warning)
  -i, --check-immediately     Run the first status check right away
  --display=DISPLAY           X display to use

Comment 4 John Sefler 2012-01-06 22:25:20 UTC
Bryan,
Seems to me that the --display=DISPLAY option should not be shown with "rhsm-icon --help" since this is a "rhsm-icon --help-gtk" option as demonstrated below...


[root@jsefler-onprem-5server ~]# rhsm-icon --help
Usage:
  rhsm-icon [OPTION...] rhsm icon

Help Options:
  -?, --help                  Show help options
  --help-all                  Show all help options
  --help-gtk                  Show GTK+ Options

Application Options:
  -c, --check-period          How often to check for validity (in seconds)
  -d, --debug                 Show debug messages
  -f, --force-icon=TYPE       Force display of the icon (expired, partial or
warning)
  -i, --check-immediately     Run the first status check right away
  --display=DISPLAY           X display to use
  ^^^^^^^^^^^^^^^^^
  REMOVE HERE SINCE.....


[root@jsefler-onprem-5server ~]# rhsm-icon --help-gtk
Usage:
  rhsm-icon [OPTION...] rhsm icon

GTK+ Options
  --class=CLASS               Program class as used by the window manager
  --name=NAME                 Program name as used by the window manager
  --display=DISPLAY           X display to use
  --screen=SCREEN             X screen to use
  --sync                      Make X calls synchronous
  --gtk-module=MODULES        Load additional GTK+ modules
  --g-fatal-warnings          Make all warnings fatal

  ^^^^^^^^^^^^^^^^^^
  ....SINCE THE DISPLAY OPTION IS HERE

Comment 6 Deon Ballard 2012-01-10 16:15:40 UTC
Created attachment 551880 [details]
rhsm-icon.8 with --i

Adding --i/--check-immediately to the man page.

Comment 8 John Sefler 2012-01-12 17:15:18 UTC
Moved comment 4 to low severity bug 773711

Comment 9 William Poteat 2012-01-12 19:49:10 UTC
RHEL 5.8 commit

9c7da4cd3d6aac5ac85f02b2808e8bcef83a4cec

0.98.12+

Comment 10 William Poteat 2012-01-12 20:00:40 UTC
Wrong commit number, should be

b08c13b798ed3d98c099e6679726056e8d4b667f

Comment 11 William Poteat 2012-01-12 20:09:15 UTC
Commit to master

5c1a020b0053873bab3794cfe3fc09dbc9c3d593

Comment 12 John Sefler 2012-01-13 14:35:15 UTC
Verifying Version...
[root@jsefler-onprem-5server ~]# rpm -q subscription-manager-gnome
subscription-manager-gnome-0.98.11-1.git.3.b08c13b.el5

[root@jsefler-onprem-5server ~]# rpm -ql subscription-manager-gnome | egrep "rhsm-icon|rhsm-compliance-icon"
/etc/xdg/autostart/rhsm-icon.desktop
/usr/bin/rhsm-icon
/usr/share/man/man8/rhsm-icon.8.gz

^^^ VERIFIED rhsm-icon HAS REPLACED rhsm-compliance-icon

[root@jsefler-onprem-5server ~]# man -P cat rhsm-icon
rhsm-icon(8)              Subscription Status Daemon              rhsm-icon(8)



NAME
       rhsm-icon  - Periodically checks installed products against active sub-
       scriptions to check their status.


SYNOPSIS
       rhsm-icon


DESCRIPTION
       Red Hat provides content updates and support by  issuing  subscriptions
       for   its  products.  These  subscriptions  are  allocated  to  systems
       (machines) and apply to the installed software products.


       On X systems (so, systems with a GUI interface), a product status  dae-
       mon  runs  every  4  hours  to  check  the currently installed software
       against the allocated subscriptions.  If  software  is  installed  with
       expired  subscriptions  or  no  available subscription, then the daemon
       triggers an icon and warning message to display in the start menu  bar.


       rhsm-icon
        only  runs  on X-based systems. Servers which do not have a GUI inter-
       face do not run or require the rhsm-icon daemon.


OPTIONS
       -c, --check-period
              Sets the interval to use between checks  for  the  product  sub-
              scription status. The value is in seconds.


       -f, --force-icon=TYPE
              Manually  displays the given type of icon in the start menu. The
              TYPE can be warning or expired and uses  a  different  icon  for
              each type of message.


       --i, --check-immediately
              Runs  the  status  check process immediately when the command is
              invoked. Otherwise, there is a four (4) minute delay before run-
              ning the check.


       -d, --debug
              Shows debug messages for the daemon.


USAGE
       There are two reasons to invoke rhsm-icon manually:


              *  To  run  the  daemon on a new schedule (immediately or with a
              different frequency)


              * To view the status icons or messages regardless of  the  state
              of the machine


       Since X runs the daemon automatically and on schedule, it is not neces-
       sary normally to run the subscription status daemon. The rhsm-icon com-
       mand can change this schedule. For example:
       rhsm-icon --check-period 120


       Administrators  can also run rhsm-icon to view any immediate changes to
       the subscription status of the system.  Using  the  --check-immediately
       option  runs  the check at the time the command is run; otherwise, run-
       ning rhsm-icon has a four-minute delay before running the status check.

       rhsm-icon --check-immediately


       If  you  just  want to know what the different subscription status mes-
       sages look like, then use the --force-icon option.

       rhsm-icon --force-icon=warning

       rhsm-icon --force-icon=expired


BUGS
       This process is part of the subscription management system for Red  Hat
       systems. To file bugs against this process, go to https://bugzilla.red-
       hat.com/ and select Red Hat > Red Hat Enterprise Linux  6  >  subscrip-
       tion-manager.



AUTHORS
       Deon   Lackey,  <dlackey>,  and  James  Bowes,  <jbowes@red-
       hat.com>. rhsm-icon was written by James Bowes.


COPYRIGHT
       Copyright (c) 2010 Red Hat, Inc. This is licensed under the GNU General
       Public  License, version 2 (GPLv2). A copy of this license is available
       at http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt.



version 1.1                     January 4, 2011                   rhsm-icon(8)



^^^ ALSO VERIFIED THE --check-immediately OPTION WAS ADDED TO THE MAN PAGE

Moving to VERIFIED

Comment 13 William Poteat 2012-01-23 16:37:02 UTC
    Technical note added. If any revisions are required, please edit the "Technical Notes" field
    accordingly. All revisions will be proofread by the Engineering Content Services team.
    
    New Contents:
No description necessary

Comment 14 errata-xmlrpc 2012-02-21 06:44:14 UTC
Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory, and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

http://rhn.redhat.com/errata/RHBA-2012-0154.html


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