help

List the scm subcommands and provide detailed help for each command.

Purpose

The scm help command lists the scm subcommands and provides a brief description of each. It can also provide detailed information on any or all scm subcommands.

Synopsis

scm help [ --all | subcommand ]

Options and arguments

Default
List the scm subcommands and provide summary help for each command.
--all
Display full help for all scm subcommands
subcommand
Display help for the named scm subcommand

Example

To get help for the scm list subcommand:

C:\local-workspaces\HelloJazz>scm help list
Help on list
List items. Different items can be listed, as specified by subcommands.

Aliases: ls

Usage: scm list <workspaces|projectareas|teamareas|streams|contributors|components|remotefiles> [subcommand-args]

Subcommands:
  workspaces - List remote workspaces.
  projectareas - List project areas.
  teamareas - List team areas.
  streams - List streams for the team areas of a contributor.
  contributors - List contributors.
  components - List components in a workspace or stream.
  remotefiles - Show the file tree of a remote workspace.

To find out more about a subcommand, run 'scm help list <subcommand>'

To get help for scm list streams:

C:\local-workspaces\HelloJazz>scm help list streams
Help on list streams
Provide a listing of available streams in the repository.

Aliases: stream, s

Usage: scm list streams [options]

Options:
  -r [--repository-uri] arg  - URI specifying the location of repository.
  -u [--username] arg        - Username for repository.
  -P [--password] arg        - Password for repository.
  -v [--verbose]             - Increase verbosity of output.
  -c [--contrib] arg         - Contributor to query about.


Feedback

Did this help? You can provide feedback at Jazz.net (registration required): Comment in the forums or submit a bug