Modifying the search path for reference pages

The standard man and xman commands can locate reference page files in various locations. These programs can use (but do not require) a search path specified by the MANPATH environment variable. If you want to read HCL VersionVault reference pages using these programs, add the HCL VersionVault man directory to your reference pages search path.

Note: Read this section only if you plan to access HCL VersionVault online reference pages with the standard man or xman commands. You can skip this section if you intend to rely on the Help system built in to the HCL VersionVault graphical user interface or if you always use the cleartool man subcommand (which does not require a search path) to access reference pages.
Users of Linux or the UNIX system are accustomed to using the man(1) command to get online documentation. HCL VersionVault includes a comprehensive set of reference pages, accessible in several ways:
  • Through the standard man command (Linux and UNIX system command-line interface)
  • Through the standard xman command (X Window System graphical interface)
  • Through the man subcommand built in to the cleartool program

On some systems such as those that do not have a full VersionVault installation, the reference documentation might be installed on a remote HCL VersionVault server. Before defining the search path in these environments, mount the directory for the server where the documentation is hosted.

Table 1. Setting MANPATH to include the HCL VersionVault reference pages location
Shell environment Standard installation location (opt/hcl/ccm/versionvault) Alternate installation location (/opt/vvault)
.cshrc (C shell) 
setenv MANPATH ${MANPATH}:/opt/hcl/ccm/versionvault/doc/man
 
setenv MANPATH ${MANPATH}:$CLEARCASEHOME/doc/man
.profile (Bourne or Korn shell) 
MANPATH=${MANPATH}:/opt/hcl/ccm/versionvault/doc/man
export MANPATH
 
MANPATH=${MANPATH}:$CLEARCASEHOME/doc/man
export MANPATH
Note: The variable CLEARCASEHOME must be set if HCL VersionVault is installed at a location other than /opt/hcl/ccm/versionvault.

If your shell startup file does not set the MANPATH environment variable, see the reference page for the man command to determine your system default search path for man pages. Then, set MANPATH accordingly in your shell startup script, just before the commands shown in the previous table.

For example: 
# setenv MANPATH /usr/man:/usr/contrib/man:/usr/local/man

For Windows™, modifications to MANPATH are not required.