man

Displays an online reference page

APPLICABILITY

SYNOPSIS

• ClearCase, ClearCase LT, and MultiSite on UNIX:

man [ -g·raphical ] [ command_name ]

• Attache on UNIX; ClearCase, ClearCase LT, and MultiSite onWindows:

man [ command_name ]

DESCRIPTION

This command does not require a product license.

The man command displays the specified online reference page in flat-ASCII format, Windows Help format, or in Windows-style UNIX help format in a separate help viewer. For cleartool and multitool subcommands, Attache local commands, and hybrid commands, or if your Attache helper is running on a UNIX host, you can use any valid command abbreviation or alias. For example:

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

CLEARCASE, CLEARCASE LT, AND MULTISITE ON UNIX-USE OF MANPATH

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, be sure to include ccase-home-dir/doc/man in your MANPATH. For example:

setenv MANPATH /usr/catman:/usr/man:/usr/atria/doc/man

Note that with UNIX man, you must match the reference page file name. File names of cleartool subcommands have a ct+ prefix; file names of multitool subcommands have a mt+ prefix.

RESTRICTIONS

None.

OPTIONS AND ARGUMENTS

DISPLAYING THE REFERENCE PAGE IN HELP FORMAT. Default: Displays the reference page in flat-ASCII format.

-g·raphical

Starts a help viewer to display the reference page.

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

command_name

The name (or abbreviation, or alias) of a cleartool or multitool subcommand, Attache local or hybrid command, or the name of any other ClearCase, ClearCase LT, or MultiSite reference page.

EXAMPLES

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. In Attache, cmd-context represents the workspace prompt.

• Display the reference page for the mkview command.

cmd-context man mkview

• Display the reference page for the lstype command in Windows-style help on a UNIX machine.

cmd-context man -graphical lstype

SEE ALSO

attache_command_line_interface, help, man(1)