env_ccase

Environment variables

APPLICABILITY

ProductCommand Type
ClearCasegeneral information
ClearCase LTgeneral information
MultiSitegeneral information

Platform
UNIX
Windows

DESCRIPTION

This reference page describes the environment variables (EVs) used by ClearCase, ClearCase LT, and MultiSite commands, programs, utilities, and software installation scripts. It also describes standard UNIX EVs that are particularly important for ClearCase, ClearCase LT, and MultiSite. Descriptions of the EVs are organized as follows:

  • EVs common to UNIX and Windows
  • EVs for UNIX only
  • EVs for Windows only

Note: This reference page does not describe all environment variables. Omitted are the EVs used by triggers and by the find commands; see the mktrtype, find, and findmerge reference pages for descriptions.

Environment Variables Common to UNIX and Windows

CCASE_ABE_START_TIMEOUT
Sets the maximum time allotted for starting the audited build executor (abe).

Default: 10 seconds.

CCASE_ABE_PN (or CLEARCASE_ABE_PN)
The full pathname with which clearmake invokes the audited build executor (abe) on a local or remote host during a parallel build. For more information about abe, see Building Software.

Default: ccase-home-dir/bin/abe

CCASE_AUDIT_TMPDIR (or CLEARCASE_BLD_AUDIT_TMPDIR)
Sets the directory where clearmake and clearaudit create temporary build audit files. If this variable is not set or is set to an empty value, clearmake creates these files in the directory specified by the TMPDIR (UNIX) or TMP (Windows) environment variable.

Note: On UNIX systems, clearmake creates these files in the /tmp directory if neither EV is set.

All temporary files are deleted when clearmake exits. If the value of CCASE_AUDIT_TMPDIR is a directory under a VOB tag, clearmake prints an error message and exits.

Note: Multiple build clients can use a common directory for audit files. Names of audit files are unique because clearmake names them using both the PID of the clearmake process and the host name of the machine on which the process is running.

Default for UNIX: /tmp

Default for Windows: None

CCASE_AUTO_DO_CI
Checks in DOs checked out by clearmake -c or omake -C unless the build of the corresponding target fails or the automatic checkout of the DO or a sibling DO fails. Checkout comments are preserved. The checkin is invoked with the -ptime option to preserve the DO's modification time.

Default: Undefined

CCASE_BLD_HOSTS
Specifies one or more build hosts on which clearmake must build targets. For more information, see Building Software.

Default: Undefined.

CCASE_BLD_NOWAIT
Turns off clearmake's sleep-check cycle during a build. When this environment variable is set, clearmake does not check for a VOB lock (or wait for the VOB to be unlocked).

CCASE_BLD_VOBS
A list of VOB tags—separated by a space, tab, comma, or colon (UNIX), or by a semicolon (Windows)—to be checked for lock status during a build. If a VOB on this list is locked, clearmake goes into a sleep-check cycle.

CCASE_CONC (or CLEARCASE_BLD_CONC)
Sets the concurrency level in a clearmake build. This EV takes the same values as the –J option. Specifying a –J option on the clearmake command line overrides the setting of this EV.

Default: None.

CCASE_DNVW_RETRY
Specifies time-out period, in minutes, for clearmake, omake, catcr, describe, or lsdo to wait before trying to contact an inaccessible view listed in its cache. To disable the cache, set CCASE_DNVW_RETRY to 0. For more information, see the clearmake or omake reference pages.

Default: 60 minutes.

CCASE_HOST_TYPE (or CLEARCASE_BLD_HOST_TYPE)
Determines the name of the build hosts file to be used during a parallel build (–J option): file .bldhost.$CCASE_HOST_TYPE in your home directory. (Your home directory is determined by examining the password database.) See the clearmake reference page. For information about bldhost, see Building Software.

Specifying a –B option on the command line overrides the setting of this EV.

C Shell Users: Set this EV in your .cshrc file, not in your .login file. The parallel build facility invokes a remote shell, which does not read the .login file.

CCASE_HOST_TYPE can also be coded as a make macro.

Default: None.

CCASE_MAKE_CFG_DIR (or CLEARCASE_MAKE_CONFIG_DIR)
In a makefile read by clearmake, expands to the full pathname of the clearmake configuration directory in the ClearCase installation area—typically ccase-home-dir/config/clearmake (UNIX) or ccase-home-dir\config\clearmake (Windows).

CCASE_MAKE_COMPAT (or CLEARCASE_MAKE_COMPAT)
Specifies one of clearmake's compatibility modes. This EV takes the same values as clearmake's –C option. Specifying –C on the command line overrides the setting of this EV.

Default: None.

CCASE_MAKEFLAGS
Provides an alternative or supplementary mechanism for specifying clearmake command options. CCASE_MAKEFLAGS can contain the same string of key letters used for command-line options, except that options that take arguments are not allowed. Options on the clearmake command line override the setting of this environment variable, if there is a conflict. For more information, see Building Software.

Default: None.

CCASE_OPTS_SPECS (or CLEARCASE_BLD_OPTIONS_SPECS)
A list of pathnames—separated by colons (UNIX) or semicolons (Windows)— each of which specifies a BOS file to be read by clearmake. You can use this EV instead of specifying BOS files on the clearmake command line with one or more –A options.

Default: Undefined.

CCASE_SHELL_FLAGS (or CLEARCASE_BLD_SHELL_FLAGS)
Specifies clearmake command options to be passed to the subshell program that executes a build script command.

Default for UNIX: –e

Default for Windows: None.

CCASE_SHELL_REQUIRED
Forces clearmake to execute build scripts in the shell program you specify with the SHELL macro. To make clearmake execute builds scripts in the shell program, set this EV to TRUE. To allow clearmake to execute build scripts directly, unset the EV.

Default: clearmake executes build scripts directly.

CCASE_USEPERL5
When set to any nonempty string, specifies that ClearCase Perl (UNIX) and ccperl (Windows) are to use Perl 5.0.

CCASE_VERBOSITY (or CLEARCASE_BLD_VERBOSITY)
An integer that specifies the clearmake message logging level, as follows:
1 Equivalent to –v on the command line
2 Equivalent to –d on the command line
0 or undefined Equivalent to standard message logging level

If you also specify –v or –d on the command line, the higher value prevails.

Default: 0

CCASE_WINKIN_VIEWS
A list of white-space-separated view tags. If this environment variable is set, clearmake winks in only derived objects that were built in one of the specified views.

CLEARAUDIT_SHELL
The program that clearaudit runs in an audited shell. You must set this environment variable to the program's full pathname. For example, on UNIX:

/bin/csh or /usr/home/myscript

On Windows:

\windows\system32\cmd.exe or \users\anne\bin\myscript

Default on UNIX: clearaudit runs the program specified by the SHELL environment variable or, if SHELL is undefined, a Bourne shell (/bin/sh).

Default on Windows: clearaudit runs the program specified by the COMSPEC environment variable or, if COMSPEC is undefined, cmd.exe.

See also: SHELL.

CLEARCASE_AVOBS
A list of VOBs to process when you use the –avobs option in the find, findmerge, lscheckout, lshistory, or rmview commands. If this EV is not set, specifying –avobs invokes the command on all VOBs mounted on the host. If there are many such VOBs, the command can take a long time to complete.

Specify CLEARCASE_AVOBS as a list of VOB tags separated by commas, white space, or colons (UNIX) or by semicolons (Windows).

Default: None.

CLEARCASE_CMNT_PN
The pathname of the file in which cleartool and multitool cache the most recent user-supplied comment. Defining or removing this EV enables or disables comment caching.

CLEARCASE_OBSO_SYN
Commented out at MCK per RATLC00688566; this will likely be revived in a post-MCK release.

Detects instances of the obsolete option-argument style of specifying an object (see the cleartool reference page).

If you set this environment variable to the value WARN, it issues warnings when it detects obsolete syntax. When set to SILENT, it silently accepts obsolete syntax. When set to FAIL, it issues errors when it detects obsolete syntax.

Default: FAIL.

CLEARCASE_PERLLIB
Set to non-zero to force ccperl to ignore the PERLLIB environment variable, if it is set.

Default: Undefined. The HTML type manager looks for Perl libraries in the directory specified by the PERLLIB environment variable, if it is set. This can cause conflicts if PERLLIB refers to Perl installations other than ClearCase Perl. To prevent such conflicts, set this environment variable to a non-zero value.

CLEARCASE_PROFILE
The file that contains your ClearCase or ClearCase LT user profile, which includes rules that determine the comment option default for one or more cleartool and multitool commands. This setting must be a full pathname.

Default: For ClearCase and ClearCase LT, .clearcase_profile in your home directory.

CLEARCASE_TAB_SIZE
Specifies the tab width for output produced by cleardiff, xcleardiff, and source lines listed by the annotate command.

Default: 8

CLEARCASE_TRACE_TRIGGERS
A flag variable. If defined as a nonzero value, it causes all triggers to behave when they fire as if they were defined with the –print option. See the mktrtype reference page.

Default: Undefined.

CLEARCASE_VOBLOCKWAIT
(MultiSite only) Specifies the number of minutes for syncreplica to keep retrying exports or imports when the VOB is locked. During that time, syncreplica retries the write operation every minute. If the time elapses and the VOB is still locked, syncreplica exits with an error. For more information, see the syncreplica reference page in the Administrator's Guide for Rational ClearCase MultiSite.

EXPORT_REPLACE_CHAR
A character used by the clearexport_* utilities to replace invalid characters in exported label and branch names.

Default: . (period character)

EXPORT_REPLACE_COMM
A character string used in the data file created by clearfsimport as the comment for create version event records.

Default: made from flat file.

EXPORT_REPLACE_STRING
A character string used by the clearexport_* utilities to replace an invalid string in exported labels and branch names. This environment variable is used if the exporter cannot replace invalid characters with the EXPORT_REPLACE_CHAR EV.

Default: REPLACED

HOME
UNIX systems—Not used. ClearCase and ClearCase LT programs determine your home directory by reading the password database, not by using this environment variable.

Windows systems—User's home directory; must be set for ClearCase and ClearCase LT to work correctly. HOME is used to search for various resources, including file-typing information (see also the cc.magic reference page). HOME must be a full pathname, including drive specification. For example, C:\users\anne is a valid value; \users\anne is not.

Note: Windows sets two variables, HOMEDRIVE and HOMEPATH, which combine to specify the current user's home directory as supplied by the Administrator when the user account was created. So, unless HOMEDRIVE and HOMEPATH have been reassigned, HOME can be set to %HOMEDRIVE%%HOMEPATH%.

MAGIC_PATH
A colon—separated (UNIX) or semicolon-separated(Windows) list of directories to be searched for magic files. Various ClearCase and ClearCase LT programs consult magic files to perform file-typing on file system objects. See the cc.magic reference page.

Default for UNIX: home-directory/.magic:$CLEARCASEHOME/config/magic

Default for Windows: home-directory\.magic;ccase-home-dir\config\magic\

MAKEFLAGS
Provides an alternative (or supplementary) mechanism for specifying clearmake command options. MAKEFLAGS can contain the same string of keyletters used for command-line options, except that options that take arguments are not allowed. Options on the clearmake command line override the setting of this environment variable if there is a conflict.

See also the description of the CCASE_MAKEFLAGS environment variable.

Default: None.

SHELL
The default shell program to be run by various commands and programs, including the shell and setview commands. On UNIX, the clearaudit utility uses the value of SHELL if the environment variable CLEARAUDIT_SHELL is undefined.

Default for UNIX: Set by your shell program.

Default for Windows: Not set by most Windows shells; some shells that are ported from UNIX (for example, Hamilton csh, MKS korn sh, and so on.) may set it.

TZ
Time zone for the host. If the TZ environment variable is set to a value different from the time maintained by the operating system, the TZ time, not the system time, is used. In this case, file creation and change dates can be in error, and config specs do not work as expected.

Environment Variables for UNIX Only

CCASE_ABE_STARTER_PN
Specifies the pathname of the abe_starter link, which is by default a path to rsh. However, in environments where starting a remote shell is not allowed or is undesirable, you could, for example set this environment variable to the path to ssh.

Default: /usr/ucb/rsh.

CLEARCASEHOME
Installation directory for ClearCase, ClearCase LT, and MultiSite software. Set this EV before running the install_release script to specify a nonstandard installation location. On such hosts, users' shell startup scripts must use $CLEARCASEHOME/bin to specify the pathname of the ClearCase, ClearCase LT, or MultiSite executables.

Default: /opt/rational

ATRIA_NO_BOLD
A flag variable: if defined with a nonzero value, it suppresses generation of bold characters in cleartool and clearmake output.

Default: Undefined.

BITMAP_PATH
Bitmap file search path. The icons that an xclearcase directory browser displays for file system objects are stored in bitmap files. It searches in directories on this colon-separated search path for such bitmap files. See the cc.icon reference page.

Default: home-directory/.bitmaps:$CLEARCASEHOME/config/ui/bitmaps See also ICON_PATH.

CCASE_BLD_UMASK (or CLEARCASE_BLD_UMASK)
Sets the umask(1) value to be used for files created from a clearmake build script. It may be advisable to have this EV be more permissive than your standard umask—for example, CCASE_BLD_UMASK = 2 where umask = 22. The reason to create DOs that are more accessible than other files is winkin: a winked-in file retains its original ownership and permissions. For example, when another user winks in a file that you originally built, the file is still owned by you, is still a member of your principal group, and still has the permissions with which you created it. You can use the standard chmod command to change the permissions of a DO after you create it, and these permissions remain in effect while the DO is unshared. However, for a shared DO, you may need to use the standard chmod and protect –chmod to set appropriate permissions.

If you are using a tool that ignores umask (and hence CCASE_BLD_UMASK) settings and you want winkins to work correctly, you have to use chmod on the file in your build script to give it write permissions if the tool creates the file without these permissions.

CLEARCASE_BLD_UMASK can also be coded as a make macro.

Note: If you want to use CCASE_BLD_UMASK, do not set your umask value in your shell startup file. If you set the umask value in your startup file, the umask value is reset to its original value when clearmake starts a shell to run the build script. Setting CCASE_BLD_UMASK in your startup file has no effect.

Default: Same as current umask.

CCASE_GPATH_HINTS
NFS mount points to try when attempting to construct pathnames to remote storage.

When you set this environment variable to a quoted set of colon-separated mount points, the first valid mount point is used when constructing the global pathnames required by the following commands:

  • mkstgloc ... stgloc-pname

  • mkview ... dynamic-view-storage-pname

  • mkview ... snapshot-view-pname

  • mkvob ... vob-storage-pname

For example, when you use mkvob, the first valid entry in CCASE_GPATH_HINTS is used as the mount point when constructing the global path to vob-storage-pname. However, if you specify pathname information using options such as –host, –hpath, and –gpath, this environment variable is disregarded.

When you set this environment variable to "", the argument specified as the storage pathname is treated literally.

Default: When undefined, or if all specified mount points are invalid (that is, they cannot be used to construct a global path to a directory that exists and has execute (x) permission) one of the following mount points is used: /net, /hosts, /nfs. The mount points are tried in the order indicated, with the first one that yields a valid path being used.

CLEARCASE_DBG_GRP
Set this variable to a nonzero value to force xclearcase to print debugging information when executing button and menu commands in the graphical interface.

Default: None.

CLEARCASE_MSG_PROTO
Enables one-way message forwarding between ClearCase or ClearCase LT and an interprogram messaging system. This feature enables ClearCase and ClearCase LT to notify the messaging system that an operation succeeded (for example, a checkout) without going through an encapsulator. One-way message forwarding succeeds only if all programs involved have the same value for the DISPLAY environment variable.

For more information, see the softbench_ccase reference page.

Default: None. Supported values: SoftBench. See also DISPLAY, WINEDITOR.

CLEARCASE_ROOT
(Set by the setview command; do not set this variable yourself.) The full pathname of the root directory of a set view process, which is a process created by the setview command. For example, the command setview bugfix creates a shell in which CLEARCASE_ROOT is set to/view/bugfix .

Default: Not set in a process that was not created by setview.

DISPLAY
The X Window System display to use for ClearCase and ClearCase LT GUI utilities (and all other X applications). If you are using an interprogram messaging system, all your tools must have the same DISPLAY value.

Default: Undefined.

EDITOR, VISUAL
The pathname of a text editor. The edcs subcommand invokes the editor specified by the environment variable WINEDITOR (first choice), VISUAL (second choice), or EDITOR (third choice). xclearcase invokes the editor specified by the environment variable WINEDITOR (first choice) or EDITOR (second choice). See also WINEDITOR.

Default: vi

GRP_PATH
A colon-separated list of files and directories to be searched for group files when you start xclearcase.

Default: home-directory/.grp:ccase-home-dir/config/ui/grp

ICON_PATH
A colon-separated list of directories to be searched for icon files. xclearcase directory browsers use the bitmap images in such files as icons for file system objects. See the cc.icon reference page.

Default: home-directory/.icon:$CLEARCASEHOME/config/ui/icon See also BITMAP_PATH.

MANPATH
A colon-separated list of directories in which the UNIX man(1) command searches for reference pages. (The cleartool man and multitool man commands do not use MANPATH, but always search in $CLEARCASEHOME/doc/man.)

Default: Varies with operating system.

PATH
The standard UNIX program search path. To access ClearCase or ClearCase LT executables, change your search path to include directory $CLEARCASEHOME/bin.

Default: Set by your shell program; typically modified in shell startup script.

Note: Do not specify an MVFS path as a value for PATH.

SCHEMESEARCHPATH
A colon-separated list of directories to be searched for scheme files, which contain X Window System resource settings. See the schemes reference page.

Default: /usr/lib/X11/%T/%N%:$CLEARCASEHOME/config/ui/%T/%N%S

TERM
The kind of terminal for which output is to be prepared. Certain cleartool commands produce output that use special terminal capabilities. For example, catcr uses a bold font to highlight information in a configuration record. To see bold characters in an xterm, set TERM to xterm, and provide a bold font with the X Toolkit option –fb or with the X resource xterm*boldFont. To prevent the control characters that enable bold from appearing in an emacs shell, set TERM to emacs in your emacs startup script, or set ATRIA_NO_BOLD.

Default: None; typically set in shell startup script.

WINEDITOR
An X Window System text editor application (for example, xedit(1)), which is invoked by xclearcase on a browser item. If WINEDITOR is undefined, xclearcase creates a terminal window, and runs the program specified by the EDITOR environment variable. If neither of these variables are defined, no editor is invoked.

Default: None.

Environment Variables for Windows Only

CLEARCASEHOME
Installation directory for ClearCase, ClearCase LT, and MultiSite; same as Windows Registry value HKEY_LOCAL_MACHINE\SOFTWARE \Atria\ClearCase\CurrentVersion\ProductHome. This EV is set by the albd_server when it runs a schedule request. For more information, see the schedule reference page. For information about albd_server, see the Administrator's Guide.

Note: You can create CLEARCASEHOME as a user or system environment variable, but the albd_server overwrites it when it runs a schedule request.

Default: Directory in which you installed ClearCase or ClearCase LT (the installation default is C:\Program Files\Rational\ClearCase)

CCASE_NO_ESC_PATT_CHARS
Overrides the \ escape character in clearmake GNU-compatible mode. For example, both clearmake –C gnu and GNU make assume that the string \% indicates the literal character, %, and do not treat the rule as a pattern rule. To prevent clearmake from using \ to indicate a literal character, set this environment variable to any non-null value.

CLEARCASE_PRIMARY_GROUP
Specifies which of the user's groups ClearCase should consider the primary group. Overrides the Windows primary group assignment for ClearCase operations. This environment variable must be a per-user variable (not a system variable) and must be set to a group that already appears in the user's group list.

CLEARCASE_GROUPS
Specifies a list of up to 32 groups that ClearCase considers first when determining or displaying which groups a user belongs to. Users who are members of more than 32 groups can set this environment variable to designate a subset of those groups that ClearCase considers when evaluating the user's group membership. The value of this variable is a semicolon-separated list of groups to which the user belongs. The list must not include the group that is specified in the environment variable CLEARCASE_PRIMARY_GROUP.

CMAKE_PNAME_SEP
Sets the pathname separator for pathnames constructed by clearmake. This variable can be set in the makefile, in a BOS file, on the command line, or as an environment variable.

Default: If this variable is not set or is set to any other value than a slash (/) or a backslash (\), clearmake uses a backslash (\) as the pathname separator.

COMSPEC
The default command shell program to be run by various ClearCase or ClearCase LT commands and programs, including the shell command, and the clearaudit utility (if the environment variable CLEARAUDIT_SHELL is undefined).

Default: Set by Windows to cmd.exe

EDITOR, VISUAL
The pathname of a text editor. The edcs subcommand invokes the editor specified by the environment variable VISUAL (first choice) or EDITOR (second choice). If the pathname contains spaces, enclose the pathname in quotes. For example:

"C:\Program Files\tools\editor.exe"

Default: Notepad.

PATH
The standard executable program search path. The Install Wizard adds the directory ccase-home-dir\bin to your search path.

Default: Set from the system and user path values in the Windows registry.

Note: Do not specify an MVFS path as a value for PATH.

ProductHome (Windows NT Registry key value)
Installation directory for ClearCase and ClearCase LT software. This value is stored in the Windows registry key HKEY_LOCAL_MACHINE\SOFTWARE\Atria\ClearCase\CurrentVersion.

Default: C:\Program Files\Rational\ClearCase

SEE ALSO

mktrtype find, and findmerge for information about other environment variables.


Copyright© 2003 Rational Software. All Rights Reserved.