IPnom Home • Manuals • ClearCase

 Rational ClearCase Commands Reference

ClearCase Stuff:ClearCase LinksClearCase BooksClearCase Commands ReferenceClearCase ForumsClearCase News
Keyword Live Search (10 results max):
 Type in part of a ClearCase command in the search box.
Commands Index:


Displays an online reference page


ProductCommand type
ClearCasecleartool subcommand
ClearCase LTcleartool subcommand
MultiSitemultitool subcommand

multiutil subcommand



  • Display a reference page (UNIX):
    man [ –g·raphical ] [ command_name ]

  • Display the table of contents (UNIX):
    man contents

  • Display the product tutorial (UNIX):
    man tutorial

  • Display a reference page (Windows):
    man [ command_name ]


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.

Displaying Reference Pages

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 lscheckoutAbbreviation
cmd-context man lschFull command name
cmd-context man lscoAlias

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:

setenv MANPATH /usr/catman:/usr/man:/opt/rational/doc/man

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+syncreplicaCorrect
% man clearmake Correct (not a cleartool subcommand)
% man describeIncorrect (cleartool subcommand)

UNIX—Displaying the Table of Contents or Tutorial

To display a table of contents or the product tutorial, use the keywords contents or tutorial instead of the name of a reference page.

UNIX—Changing the Default HTML Browser

To change the default HTML browser, use the environment variables CCASE_WEBSCRIPT, CCASE_NETSCAPE, and CCASE_NETSCAPE_OPT. For more information, see xcleardiff.




Format of Reference Page Display

ASCII (UNIX); HTML (Windows).

Starts an HTML browser to display the reference page.

Specifying the Reference Page

The overview reference page for the product.

The name (or abbreviation or alias) of a cleartool, multitool or multiutil subcommand; or the name of any other product reference page.

Displaying the Table of Contents or Tutorial


Displays the HTML table of contents for the online documentation.

Displays the HTML product tutorial (ClearCase and ClearCase LT only).


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.

  • Display the reference page for the mkview command.

    cmd-context man mkview 

  • Display the reference page for the lstype command as HTML on a UNIX system.

    cmd-context man –graphical lstype


help, man(1), xcleardiff



ClearCase Links • ClearCase Books • ClearCase Commands Reference • ClearCase Forums • ClearCase News