help

Displays help on command usage, or (on Attache only) a reference page

APPLICABILITY

ClearCase (cleartool subcommand), Attache (command), MultiSite (multitool subcommand)

SYNOPSIS

h·elp [ command-name ]

command-name -h·elp

DESCRIPTION

This command does not require a product license.

ClearCase, MultiSite only

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

Attache only

When used as a command name, this command is a synonym for man.

help formats and displays the specified ClearCase on-line reference page. For local and hybrid commands, or if your helper is running on a UNIX host, you can use any valid command abbreviation or alias. For example:

cmd-context help uncheckout (full command name)

cmd-context help uncheck (abbreviation - local or hybrid command or UNIX only)

cmd-context help unco (alias - local or hybrid command or UNIX only)

With no arguments, help displays the Attache overview reference page. man is a synonym for help.

When used as a -help command option, it displays a usage message for one particular command. You can use any valid command abbreviation or alias for any command. For example:

cmd-context lsco -help

Usage: lscheckout | lsco [-long | -short | -fmt format] [-cview]
[-brtype branch-type] [-me | -user login-name]
[-recurse | -directory | -all | -avobs ] [-areplicas]
[pname ...]

PERMISSIONS AND LOCKS

Permissions Checking: No special permissions required. Locks: No locks apply.

OPTIONS AND ARGUMENTS

ClearCase, MultiSite only

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.

Attache only

SPECIFYING THE REFERENCE PAGE.  Default: Displays the overview reference page for Attache.

command_name

The name (or abbreviation, or alias) of an Attache local or hybrid command; or the name of any other ClearCase reference page.

GETTING USAGE INFORMATION.  Default: None.

command-name -h·elp

Displays the syntax summary for one Attache command.

EXAMPLES

• (Attache only) Display the reference page for the checkout command.

cmd-context help checkout

• (ClearCase, MultiSite only) 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 ...

• (Attache only) Display the Attache overview reference page.

cmd-context help

SEE ALSO

attache_command_line_interface, man