help

Displays help on command usage

APPLICABILITY

ProductCommand type
ClearCasecleartool subcommand
ClearCase LTcleartool subcommand
MultiSitemultitool subcommand

Platform
UNIX
Windows

SYNOPSIS

  • h·elp [ command-name ]
  • command-name –h·elp

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

Specifying a Subcommand

Default
Displays syntax summaries for all cleartool or multitool subcommands, grouped by function (not alphabetically).

command-name –h·elp , h·elp command-name
Displays the syntax summary for one cleartool or multitool subcommand.

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 ...

  • (ClearCase and ClearCase LT on UNIX) 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, multitool



Copyright© 2003 Rational Software. All Rights Reserved.