Displays help on command usage, or (on Attache) a reference page
Product | Command Type |
---|---|
ClearCase | cleartool subcommand |
ClearCase LT | cleartool subcommand |
Attache | command |
MultiSite | multitool subcommand |
Platform |
---|
UNIX |
Windows |
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
When used as a command name, this command is a synonym for man.
help formats and displays the specified 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)
cmd-context help unco (alias - local or hybrid command or UNIX)
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 ...]
SPECIFYING A SUBCOMMAND. Default: Displays syntax summaries for all cleartool or multitool subcommands, grouped by function (not alphabetically).
SPECIFYING THE REFERENCE PAGE. Default: Displays the overview reference page for Attache.
GETTING USAGE INFORMATION. Default: None.
(Attache) Display the reference page for the checkout command.
cmd-context help checkout
(ClearCase, ClearCase LT, MultiSite) 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) Display the Attache overview reference page.
cmd-context help
(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
attache_command_line_interface, man
Feedback on the documentation in this site? We welcome any comments!
Copyright © 2001 by Rational Software Corporation. All rights reserved. |