Jazz Forum Welcome to the Jazz Community Forum Connect and collaborate with IBM Engineering experts and users

Detailed help or man-pages of scm sub-commands

Questions
Tags
Users
Badges
p m n
(27●1●9●13) edited
Nov 25 '13, 7:10 p.m.
Is there a way to get the detailed help for any SCM command. Currently when I try "scm help" all I get is command synopsis *without* any examples. Is there a -verbose/-all option I'm missing to use? Example given below. 

pmn@rhel-vt> scm help workspace delete
Help on workspace delete
Deletes a workspace or stream.
Aliases: del, d
Usage: scm workspace delete [options] <workspace>
  workspace - The workspace or stream to delete. To specify the workspace or stream, use its name, alias or UUID.
Options:
  --certificate arg            - The file that contains the user's login certificate.
  --smartCard                  - Uses the connected smart card for authentication.
  -b [--backup-workspace] arg  - The workspace or stream to associate with the backup snaphsot. To specify this workspace or stream, use its name[@repo], alias, or UUID[@repo].
  -P [--password] arg          - The password for the repository.
  -r [--repository-uri] arg    - The URI that specifies the location of the repository.
  -u [--username] arg          - The username for the repository.
pmn@rhel-vt>
As you can see, there are no examples of how to use this command. 

0 votes

3 answers
5,367 views
0 votes

Accepted answer

Permanent link
Shashikant Padur
JAZZ DEVELOPER (4.3k●2●7) Nov 25 '13, 10:40 p.m.
No, the command help does not have examples but you could find some examples in the infocenter help.
p m n selected this answer as the correct answer

0 votes

Comments
p m n
Nov 26 '13, 5:56 p.m.
Thanks, Shashikant. BTW, I use V4.0 (Build Id: RTC-I20120612-0919) and corresponding CLI version (from scm -v) "com.ibm.team.filesystem.cli.client, version 3.1.0.v20120519_2357". How do I find the detailed examples for this version?  The set of subcommands and their options in this version vary quite a bit from the list given in the URL. 

BTW, is there a plan to add detailed examples right into the command help? This IMHO is needed because 
1. With the various versions of RTC that are out there in use, users will have a definitive place to look to for help. 
2. The help becomes self-contained. 
3. It is the norm in UNIX-like systems to have all the details of commands contained in their man pages. 

Just my two cents... 

2 other answers

Permanent link
p m n
(27●1●9●13) Nov 26 '13, 5:54 p.m.
Thanks, Shashikant. BTW, I use V4.0 (Build Id: RTC-I20120612-0919) and corresponding CLI version (from scm -v) "com.ibm.team.filesystem.cli.client, version 3.1.0.v20120519_2357". How do I find the detailed examples for this version?  The set of subcommands and their options in this version vary quite a bit from the list given in the URL. 

BTW, is there a plan to add detailed examples right into the command help? This IMHO is needed because 
1. With the various versions of RTC that are out there in use, users will have a definitive place to look to for help. 
2. The help becomes self-contained. 
3. It is the norm in UNIX-like systems to have all the details of commands contained in their man pages. 

Just my two cents...



0 votes

Comments
Shashikant Padur
JAZZ DEVELOPER Nov 28 '13, 5:43 a.m.

The 4.0 help can be found here...  http://pic.dhe.ibm.com/infocenter/clmhelp/v4r0/index.jsp?re=1&topic=/com.ibm.team.scm.doc/topics/m_cli_usecases.html&scope=null


Yes, adding more information to the command help such as examples, status codes etc is in our backlog ...  https://jazz.net/jazz/web/projects/Rational%20Team%20Concert#action=com.ibm.team.workitem.viewWorkItem&id=231617

p m n
Nov 30 '13, 7:31 p.m.

Thanks for point that out, Shashikant.

BTW, this workitem was logged in Sep 2012 - more than an year ago. Do you know if this work is going to be targeted for an upcoming release? IMHO, fixing this will actually reduce the amount of trivial command-usage type questions that are being currently submitted to this forum and will help you guys focus on more important enhancements and bug-fixes. Again, just my two cents :)

Permanent link
p m n
(27●1●9●13) Nov 30 '13, 7:30 p.m.

Thanks for point that out, Shashikant.

BTW, this workitem was logged in Sep 2012 - more than an year ago. Do you know if this work is going to be targeted for an upcoming release? IMHO, fixing this will actually reduce the amount of trivial command-usage type questions that are being currently submitted to this forum and will help you guys focus on more important enhancements and bug-fixes. Again, just my two cents :)

0 votes

Comments
Shashikant Padur
JAZZ DEVELOPER Dec 01 '13, 9:29 p.m.

Yes, we have it in our radar but cannot confirm when or in which release this will be implemented. You can track the status of this workitem by subscribing to it.

Your answer

Register or log in to post your answer.

Dashboards and work items are no longer publicly available, so some links may be invalid. We now provide similar information through other means. Learn more here.

Ask a question
Guidelines
FAQ
Search context
Follow this question

By Email: 

Once you sign in you will be able to subscribe for any updates here.

By RSS:

Answers
Answers and Comments
Question details
× 12,022

Question asked: Nov 25 '13, 7:07 p.m.

Question was seen: 5,367 times

Last updated: Dec 01 '13, 9:29 p.m.

Confirmation Cancel Confirm