help

Displays help on command usage

Applicability

Product

Command type

VersionVault

cleartool subcommand

MultiSite

multitool subcommand

VersionVault Remote Client

rcleartool subcommand

Platform

UNIX®

Linux®

Windows®

Synopsis

  • VersionVault, MultiSite, and VersionVault Remote Client—Display all usage messages:
    h/elp
  • VersionVault, MultiSite, and VersionVault Remote Client—Display the usage message for a command:
    h/elp command-name | command-name -help
  • VersionVault and MultiSite—Display the product documentation:
    h/elp –g/raphical

Description

This command does not require a product license.

The help command displays a usage message for all cleartool or multitool subcommands, or for one particular subcommand. You can also use help as a command option. For example:

cmd-context lsco –help

Restrictions

None.

Options and arguments

–g/raphical
Invokes the product documentation (that is, the help system).

Examples

  • Display a usage message for the checkout command.

    cmd-context help checkout
    Usage: checkout | co [-reserved | -unreserved] [-out dest-pname | -ndata]
                   [-branch branch-pname | -version]
                   [-c comment | -cfile pname | -cq | -cqe | -nc] pname ...

  • Display a usage message for the checkout command using the –help option.

    cmd-context checkout -help
    Usage: checkout | co [-reserved | -unreserved] [-out dest-pname | -ndata]
                    [-branch branch-pname | -version]
                    [-c comment | -cfile pname | -cq | -cqe | -nc] pname ...

  • (VersionVault on UNIX® or Linux®) Display a usage message for all cleartool commands, and redirect the output to a file for future reference.

    cmd-context help > cleartool_cmd_summary

See also

cleartool, man, and in the MultiSite command reference, the multitool command.