man

Displays an online reference page

Applicability


Product	Command type
VersionVault	cleartool subcommand
VersionVault MultiSite	multitool subcommand multiutil subcommand


Platform
UNIX
Linux
Windows

Synopsis

Display a reference page (UNIX and Linux):

man [ –g/raphical ] [ command_name ]
Display the table of contents (UNIX and Linux):

man contents
Display the product tutorial (UNIX and Linux):

man tutorial
Display a reference page (Windows):

man [ command_name ]

Description

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 and Linux 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

UNIX and Linux: Using MANPATH

Reference pages are stored in subdirectories of versionvault-home-dir/doc/man. The man subcommand modifies the environment to include a MANPATH variable set to this directory. It then runs the UNIX and Linux 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 the UNIX and Linux man command without going through cleartool or multitool, include versionvault-home-dir/doc/man in your MANPATH. For example:

setenv MANPATH /usr/catman:/usr/man:/opt/hcl/ccm/versionvault/doc/man

With the UNIX and Linux man command, 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)

UNIX and Linux: 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 and Linux: 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 (UNIX and Linux); HTML (Windows).
–g/raphical: Starts an HTML browser to display the reference page.

Specifying the reference page

Default: he overview reference page for the product.
command_name: 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

Default: None.
contents: Displays the HTML table of contents for the online documentation.
tutorial: Displays the HTML product tutorial (VersionVault only).

Examples

The UNIX system and Linux examples in this section are written for use in csh. If you use another shell, you might 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 might 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 system and Linux shells 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 UNIX or Linux.
cmd-context man –graphical lstype

man