Preparing to Use CASEVision/ClearCase

This chapter is a “quick-start” guide, which will be useful if you've just joined a development group using ClearCase. Here are some assumptions we've made:

In this chapter, you will:

Verify ClearCase Installation

ClearCase must be explicitly installed on your “home host”. Check whether it has been installed at the standard location:

% ls -ld /usr/atria

Depending on installation options, /usr/atria may be an actual directory, located on your home host or on another host, or a symbolic link.

Installation at an Alternate Location

If there is no /usr/atria on your host, check with your system administrator to see if ClearCase was installed at an alternate location. If this is the case, make a note of the alternate installation pathname (for example, /opt/ccase); you'll need to use this pathname when you modify your shell startup script. If ClearCase is not installed at all on your host, consult with your system administrator or see the CASEVision/ClearCase Administration Guide for step-by-step instructions.

Modify Your Shell Startup Script

Access to ClearCase programs and on-line documentation (manual pages) depends on certain environment variable settings. The most reliable way to establish these settings is to edit your shell startup script:

Shell Program  

Startup Script in Home Directory

C shell 

.cshrc

Bourne shell 

profile

Korn shell 

profile


Note: We recommend that C shell users avoid placing ClearCase settings in file .login, which is executed only by “login shells”.


Search Path for Executables

First, add the ClearCase bin directory to your executables search path, as shown in Table In-1. The variable ATRIAHOME must be set if ClearCase is installed at a location other than /usr/atria.

Table 1. Setting the Search Path for Executables

 

.cshrc (C shell)

.profile (Bourne/Korn shell)

ClearCase installed at standard location, /usr/atria

set path=($path /usr/atria/bin)

PATH=${PATH}:/usr/atria/bin
export PATH

ClearCase installed at alternate location, /opt/ccase

setenv ATRIAHOME /opt/ccase
set path=($path $ATRIAHOME/bin)

ATRIAHOME=/opt/ccase
PATH=${PATH}:$ATRIAHOME/bin
export ATRIAHOME PATH


Search Path for Manual Pages

You can skip this section if you won't be using ClearCase on-line manual pages at all — for example, if you intend to rely on the help facility built into the ClearCase graphical user interface. You can also skip the rest of this section if you will always use the cleartool man subcommand to access manual pages — it doesn't require a search path.

Users of UNIX-based operating systems are accustomed to using the man(1) command to get on-line documentation. ClearCase includes a comprehensive set of manual pages, accessible in several ways:

  • through the standard man command (UNIX® command-line interface)

  • through the standard xman command (X Window System™ graphical interface)

  • through the man subcommand built into the cleartool program

The standard man and xman commands can locate manual page files in a variety of locations. These programs can use — but don't require — a search path specified by the environment variable MANPATH. If you wish to read ClearCase manual pages using these programs, add the ClearCase man directory to your manual pages search path, as shown in Table In-2.

Table 2. Setting the Search Path for Executables

 

.cshrc (C shell)

.profile (Bourne/Korn shell)

ClearCase installed at standard location, /usr/atria

setenv MANPATH \
${MANPATH}:/usr/atria/doc/man

MANPATH=\
${MANPATH}:/usr/atria/doc/man
export MANPATH

ClearCase installed at alternate location

setenv MANPATH \
${MANPATH}:$ATRIAHOME/doc/man

MANPATH=\
${MANPATH}:$ATRIAHOME/doc/man
export MANPATH



Note: If your shell startup file does not set the MANPATH environment variable, consult the manual page for the man command itself to determine your system's default search path for manual pages. Then, set MANPATH accordingly in your shell startup script, just before the command(s) that you've copied from Table In-2. For example:


% setenv MANPATH /usr/man:/usr/contrib/man:/usr/local/man

Other ClearCase Search Paths

ClearCase uses configuration files and environment variables to find various other resources that it may require during processing. In particular, some ClearCase utilities need a way to distinguish different file types (text and binary files, for example) or to find a text editor. The graphical tools, particularly xclearcase, also need access to file typing data, icons and bitmaps, X resource schemes, group files, and text editors.

Unlike the PATH and MANPATH variables, the configuration information for these additional resources is usually predefined, and you do not need to do anything. However, if you choose to customize these resources, or if ClearCase behavior leads you to suspect that some adjustment is required, use Table In-3 to find more information.

Table 3. Information on ClearCase Search Paths

Object or Resource

Where to Find More Information

File typing data

cc.magic manual page

Icons, bitmaps

cc.icon manual page, “Customizing the Graphical Interface” chapter in CASEVision/ClearCase User's Guide

X resource schemes

schemes manual page

group files

“Customizing the Graphical Interface” chapter in CASEVision/ClearCase User's Guide

text editor

env_ccase manual page (VISUAL, EDITOR, WINEDITOR environment variables)



Note: X resource schemes control the overall appearance of the ClearCase graphical interface.


Shell Command Prompt

You can skip this section if you intend to use ClearCase only through its graphical user interface (GUI).

When you are working with a UNIX shell program, the current working directory is a very important context. With ClearCase, your shell's view context is equally important. Different views can be configured to “see” your group's development data in different ways; moreover, each view has view-private files that are not visible through any other view.

Confusion and errors are the likely result of entering the right command in the wrong view. To minimize the chances of such an occurrence, modify your shell's prompt string to include the name of the current view, if any. Table In-4 shows code to include in your shell startup script. In a shell that is set to a view, the command prompt will begin with the shell's name (its view-tag), enclosed in square brackets.

Table 4. Setting the Shell Prompt

File

Setting

.cshrc(C Shell)

if ( $?prompt ) then
if ( $?CLEARCASE_ROOT ) then
set prompt = "[`basename $CLEARCASE_ROOT`] $prompt"
endif
endif

 

.profile

(Bourne
and Korn shells)

if [ "$PS1" != "" ] ; then
echo prompt set
if [ "$CLEARCASE_ROOT" ] ; then
PS1="[`basename $CLEARCASE_ROOT`] $PS1"
fi
fi


ClearCase Build Umask

The clearmake build program creates derived objects, which are typically shared by multiple users (who wink-in these objects, rather than rebuild them, whenever possible). To promote derived object sharing, you must guarantee adequate permissions (specifically, read and write for group) for derived objects created during clearmake builds. As an alternative to setting your umask value, set the environment variable CLEARCASE_BLD_UMASK:

.cshrc: 

setenv CLEARCASE_BLD_UMASK 2

.profile: 

CLEARCASE_BLD_UMASK = 2; export CLEARCASE_BLD_UMASK

You can also specify CLEARCASE_BLD_UMASK as a makefile macro. For more information, see CASEVision/ClearCase User's Guide.

Create Command Aliases

Skip this section if you intend to use ClearCase only through its graphical user interface (GUI). Otherwise, you may find it helpful to add command aliases like the following to your shell startup file:

% alias ct cleartool
% alias ctco cleartool checkout
% alias ctci cleartool checkin

Log In Again

After you've made all the modifications to your shell startup script, log out, then log in again. The procedures in the remainder of this chapter will test and verify the changes you've made.

Verify Connections with ClearCase Server Hosts

ClearCase is a distributed application: in addition to running client processes on your home host, it runs server processes on other hosts in the network. A network-wide data storage registry is located on one host, which must be globally accessible.

License Server Host

One particularly important host is the network-wide license server host. ClearCase programs refuse to work unless they can obtain an available license from this host; verify your connection with it by entering this command:

% clearlicense
License server on host "saturn".
Running since ...

If this fails because the program clearlicense cannot be found, you made an error in setting up your search path (“Search Path for Executables”). If clearlicense is invoked, but it does not display a message like the one above, see the “Licensing Errors” section of its manual page.

Registry Host

Each ClearCase host in the network has a registry directory: subdirectory rgy of /usr/adm/atria, the ClearCase administration directory. On one network host, the registry server host, the registry directory contains access-path information for all VOBs and views in the local area network. If the command cleartool lsvob lists one or more VOBs, you are properly connected to the registry server host.

If cleartool lsvob fails, display the one-line contents of file /usr/adm/atria/rgy/rgy_hosts.conf. Verify your connection to the named host using any of various OS utilities or their equivalents: ping, rlogin, rsh and so on. If you are still not confident of your connection to the registry server host, consult your system administrator.

Start Using ClearCase

You are now ready to start using ClearCase. We recommend that you work through the step-by-step instructions in the following chapters. When you have completed working in this tutorial's “practice” environment, see the CASEVision/ClearCase User's Guide for additional help in setting up your “real” work environment.

Set Up for Integration Products

ClearCase is designed to work well with other UNIX applications and software development tools. Interoperability with some third-party applications has been optimized through integration software. In some cases, this software is bundled with the base ClearCase product (for example, H-P® SoftBench). In other cases, it is available separately (for example, QualTrak DDTS).

Each of the integrations has its own documentation. Determine what integration software, if any, you'll be using. Consult the manual for each one for instructions on installation, and on adjusting your operating environment. SoftBench and ToolTalk users should read the respective chapters in the CASEVision/ClearCase User's Guide.