Product | Command type |
---|---|
ClearCase | cleartool subcommand |
ClearCase LT | cleartool subcommand |
MultiSite | multitool
subcommand multiutil subcommand |
This command displays a reference page, the table of contents for the online documentation, or the product tutorial. The documentation that is displayed depends on the command context.
This command does not require a product license.
The man command displays a specified online reference page in HTML or ASCII (UNIX only) formats. For cleartool and multitool subcommands, you can use any valid command abbreviation or alias. For example:
cmd-context man lscheckout | Abbreviation |
cmd-context man lsch | Full command name |
cmd-context man lsco | Alias |
Reference pages are stored in subdirectories of ccase-home-dir/doc/man. The man subcommand modifies the environment to include a MANPATH variable set to this directory. It then executes the UNIX man(1) command in a subprocess. Thus, the shell from which you invoke cleartool need not have MANPATH set.
If, however, you want to use UNIX man directly, without going through cleartool or multitool, include ccase-home-dir/doc/man in your MANPATH. For example:
With UNIX man, you must match the reference page file name. The file names of cleartool subcommands have a ct+ prefix. The file names of multitool and multiutil subcommands have mt+ and mu+ prefixes, respectively.
% man ct+describe | Correct |
% man mt+syncreplica | Correct |
% man clearmake | Correct (not a cleartool subcommand) |
% man describe | Incorrect (cleartool subcommand) |
The UNIX examples in this section are written for use in csh. If you use another shell, you may need to use different quoting and escaping conventions.
The Windows examples that include wildcards or quoting are written for use in cleartool interactive mode. If you use cleartool single-command mode, you may need to change the wildcards and quoting to make your command interpreter process the command appropriately.
In cleartool single-command mode, cmd-context represents the UNIX shell or Windows command interpreter prompt, followed by the cleartool command. In cleartool interactive mode, cmd-context represents the interactive cleartool prompt.
Copyright© 2003 Rational Software. All Rights Reserved.