man

Displays an online reference page

Applicability

Product Command type
MultiSite

multitool subcommand

multiutil subcommand
Platform
UNIX

Synopsis

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

Description

This command displays a reference page. 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 ASCII format. For multiutil subcommands, you can use any valid command abbreviation or alias. For example:

cmd-context man lsreplica

Full command name

cmd-context man lsrep

Abbreviation

cmd-context man lsrp

Alias

UNIX: Using MANPATH

Reference pages are stored in subdirectories of cquest-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.

However, if you want to use UNIX man directly, without going through multitool, include cquest-home-dir/doc/man in your MANPATH. For example:

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

With UNIX man, you must match the reference page file name. The file names of multiutil subcommands have mu_ prefixes.

% man mu+describe

Correct

% man describe

Incorrect (cleartool subcommand)

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.

Restrictions

None.

Options and arguments

Format of reference page display

Default
ASCII
–g/raphical
Starts an HTML browser to display the reference page.

Specifying the reference page

Default
The overview reference page for the product.
command_name
The name (or abbreviation or alias) of a multiutil subcommand; or the name of any other product reference page.

Examples

  • Display the reference page for the mkreplica command.

    cmd-context man mkreplica

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

    cmd-context man –graphical describe