Bug 682331

The --ondate option of the list module is another new option that needs to get into the subscription-manager man page...

[root@jsefler-onprem03 ~]# subscription-manager list --help
Usage: subscription-manager list [OPTIONS]

list available or consumed Entitlement Pools for this system.

Options:
  -h, --help            show this help message and exit
  --debug=DEBUG         debug level
  --proxy=PROXY_URL     proxy url in the form of proxy_hostname:proxy_port
  --proxyuser=PROXY_USER
                        user for http proxy with basic authentication
  --proxypassword=PROXY_PASSWORD
                        password for http proxy with basic authentication
  --installed           installed
  --available           available
  --ondate=ON_DATE      date to search on, defaults to today's date, only used
                        with --available (example: 2011-03-04 )
  --consumed            consumed
  --all                 if supplied with --available then all subscriptions
                        are returned

Background for Comment #1 is: https://bugzilla.redhat.com/show_bug.cgi?id=672562

The --force option of the identity module is another new option that needs to get into the subscription-manager man page...

[root@jsefler-onprem03 ~]# subscription-manager identity --help
Usage: subscription-manager identity [OPTIONS]

request a new identity certficate for this machine

Options:
  -h, --help            show this help message and exit
  --debug=DEBUG         debug level
  --proxy=PROXY_URL     proxy url in the form of proxy_hostname:proxy_port
  --proxyuser=PROXY_USER
                        user for http proxy with basic authentication
  --proxypassword=PROXY_PASSWORD
                        password for http proxy with basic authentication
  --username=USERNAME   specify a username
  --password=PASSWORD   specify a password
  --regenerate          request a new certificate be generated
  --force               force certificate regeneration (requires username and
                        password)


Background: https://bugzilla.redhat.com/show_bug.cgi?id=678151

The --installed option of the list module is another new option that needs to get
into the subscription-manager man page...

[root@jsefler-onprem03 ~]# subscription-manager list --help
Usage: subscription-manager list [OPTIONS]

list available or consumed Entitlement Pools for this system.

Options:
  -h, --help            show this help message and exit
  --debug=DEBUG         debug level
  --proxy=PROXY_URL     proxy url in the form of proxy_hostname:proxy_port
  --proxyuser=PROXY_USER
                        user for http proxy with basic authentication
  --proxypassword=PROXY_PASSWORD
                        password for http proxy with basic authentication
  --installed           installed
  --available           available
  --ondate=ON_DATE      date to search on, defaults to today's date, only used
                        with --available (example: 2011-03-04 )
  --consumed            consumed
  --all                 if supplied with --available then all subscriptions
                        are returned

Background: https://bugzilla.redhat.com/show_bug.cgi?id=634254

Created attachment 482958 [details]
updated manpage

I think this adds everything in appropriately. I added the options in the top and then a couple of examples.

I also need to update the deployment guide; I'll post the link here when it's ready.

Deon,
I see something else that is also missing from the man page...  activate module


[root@jsefler-onprem04 tmp]# subscription-manager --help

Usage: subscription-manager [options] MODULENAME --help

Supported modules:


	activate       activate the registered user to a specified product
	clean          removes all local consumer data, does not effect the server
	facts          show information for facts
	identity       request a new identity certficate for this machine
	list           list available or consumer subscriptions for registered user
	refresh        pulls the latest entitlement data from the server
	register       register the client to RHN
	subscribe      subscribe the registered machine to a specified product
	unregister     unregister the client from RHN
	unsubscribe    unsubscribe the registered user from all or specific subscriptions

[root@jsefler-onprem04 tmp]# subscription-manager activate --help
Usage: subscription-manager activate [OPTIONS]

activate

Options:
  -h, --help            show this help message and exit
  --debug=DEBUG         debug level
  --proxy=PROXY_URL     proxy url in the form of proxy_hostname:proxy_port
  --proxyuser=PROXY_USER
                        user for http proxy with basic authentication
  --proxypassword=PROXY_PASSWORD
                        password for http proxy with basic authentication
  --email=EMAIL         optional email address to notify when token activation
                        is complete.
  --locale=LOCALE       optional language to use for email notification when
                        token activation is complete. Used with --email only.
                        Examples: en-us, de-de

       --auto Automatically subscribes this system to the best-matched compat-
              ible subscription.
                               ^ (s) might be better since multiple subscriptions could be automatically subscribed.

       --name=CONSUMERNAME
              Sets  the  name  of  the  consumer  (machine)  to register. This
              defaults to be the same as the username.

This defaults to the hostname of the system.
                     ^^^^^^^^ THIS IS NOW THE CORRECT DEFAULT

    REGISTER OPTIONS

      --force
              Registers the system even if it is already registered. Normally,
              any register operations will fail if the machine is already reg-
              istered. The existing consumer entry and its  subscriptions  are
              deleted.
              ^^^^^^^ THIS IS NOT TECHNICALLY CORRECT.  A BETTER STATEMENT COULD BE:

The existing consumer is unregistered thereby relinquishing his/her consumed subscriptions before initiating a new registration.

       If a machine has never been registered  (not  even  during  firstboot),
       then the register command will register the machine with whatever Enti-
       tlement Platform is configured in the  /etc/rhsm/rhsm.conf  file.  This
       command  requires,  at  a  minimum,  the  username  and password for an
       account to connect to the Entitlement Platform.

^^^ Due to new username/password prompting, the last sentence might better be written as:

This command  requires,  at  a  minimum,  the  username  and password for an account to connect to the Entitlement Platform; or if not supplied, subscription-manager will interactively prompt for these credentials.

       The  collected  facts can also be overridden by creating a JSON file in
       the /etc/rhsm/facts/ directory. These have simple formats that define a
       fact and value:

Can we add to this paragraph that the JSON file must have a suffix of ".facts".

   ENTITLEMENTS AND KICKSTART
       The subscription-manager tool can be run as a  post-install  script  as
       part  of  the  kickstart  installation process. This allows entitlement
       management (registration and subscription) to be automated  along  with
       installation. For example:
              %post --log=/root/ks-post.log
              /usr/sbin/subscription-manager register --username admin --password secret --autosubscribe


^^^^ In this example, I would personally add "--force" as an option to the register call.  Although it should not be needed during a kickstart, supplying it is an extra level of insurance since we really don't want a failure during kickstart.  I welcome a second opinion here whether or not this is a good idea since I am not a kickstart expert.

Created attachment 483031 [details]
even more updated manpage

I restored the activate stuff (which was stripped for the entitlements beta and I guess I didn't add back) and then the other edits.

This is also in my repo at https://svn.devel.redhat.com/repos/ecs/dlackey/rhel61-drafts/manpage.

Created attachment 483032 [details]
even more updated manpage

I have verified that all of the comments in this bug have been factored into attachment 483032 [details].

Fixed. You will see this in 0.95.5. Git hash: 
bb03d4e8622be513fe5791f9a605114a8513eb0e

Verified as tested in version:
subscription-manager-0.96.1-1.git.77.e7f7948.el6.x86_64