env_ccase

Environment variables

Applicability


Product	Command Type
VersionVault	general information
MultiSite	general information


Platform
UNIX®
Linux®
Windows®

Description

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

EVs common to UNIX, Linux, and Windows
EVs for UNIX and Linux 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, Linux, and Windows

CCASE_ABE_INIT_TIMEOUT

Specifies the maximum number of minutes that clearmake waits for a new audited build executor (abe) to request an initial build context.

Default: 3 minutes.

CCASE_ABE_PN (or CLEARCASE_ABE_PN)

The full path name 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 the VersionVault Guide to Building Software.

Default:

Windows: versionvault-home-dir\bin\abe

UNIX/Linux: versionvault-home-dir/etc/abe

CCASE_ABE_START_TIMEOUT

Sets the maximum time allotted for starting the abe.

Default: 30 seconds.

CCASE_ABE_TIMEOUT

Specifies the maximum number of minutes that the abe should wait for clearmake to reply after the abe requests a target build.

Default: 180 minutes.

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 and Linux) or TMP (Windows) environment variable.

Note: On Linux and the UNIX system 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 ID of the clearmake process and the host name of the machine on which the process is running.

Default for UNIX and Linux: /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 command is invoked with the -ptime option to preserve the DO's modification time.

Default: Undefined

CCASE_AUTO_SAVE_AUDIT_FILES

Specifies that clearmake save any audit files that generate a warning after being processed. clearmake prints the path name of each audit file that it saves.

CCASE_BLD_HOSTS

Specifies one or more build hosts on which clearmake must build targets. For more information, see the VersionVault Guide to Building Software.

Default: Undefined.

CCASE_BLD_NOWAIT

Disables 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 (on Linux and the UNIX system), or by a semicolon (on Windows)—to be checked for lock status during a build. If a VOB on this list is locked, clearmake enters a sleep-check cycle.

CCASE_BLD_WAIT_NUSERS

Specifies that when checking for a VOB lock, clearmake must determine whether the current user is excluded from the lock. The type of checking that this EV enables has a negative impact on performance.

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_CONC_V6_OBSOLETE

In VersionVault versions older than V7.1, clearmake passes the value of the -J option recursively to sub-makes, which can sometimes cause excessive audited build executor (abe) processes to be spawned. This behavior was changed in V7, such that the value of -J is not passed automatically. However, you can enable pre-V7.1 behavior by setting this environment variable.

Default: None.

CCASE_DIR_IGNORED_REUSE

Prevents clearmake from considering directory versions as significant when evaluating a DO for reuse or winkin. By default, clearmake treats directory versions as significant only if they are listed in the makefiles as a declared target dependency.

A related makefile special target, .DIRECTORY_IGNORED_FOR_REUSE, has the same effect as this EV but can also be used to apply only to specified targets. Another makefile special target, .DIRECTORY_AFFECTS_REUSE, overrides both this EV and the .DIRECTORY_IGNORED_FOR_REUSE special target.

CCASE_DNVW_RETRY

Specifies a 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 the VersionVault Guide to 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_ISO_DATE_FMT

When set to a value of 1, forces date and time information intended for interpretation by programs or scripts to be formatted as specified by the ISO 8601 standard. (Dates and times intended to be interpreted only by users are always displayed in the format defined by the operating system, controlled by the user's locale and preferences.) Set to a value of 0 to format dates and times using the defaults from previous VersionVault releases. The following table shows how the setting of CCASE_ISO_DATE_FMT affects the formatting of date and time display.


CCASE_ISO_DATE_FMT=0	CCASE_ISO_DATE_FMT=1
dd-mmm-yy.hh:mm:ss	yyyy-mm-ddThh:mm:ss±hh
dd-mmm-yy.hh.mm.ss	yyyy-mm-ddThhmmss±hh
dd-mmm-yy.hh:mm:ssUTC	yyyy-mm-ddThh:mm:ssZ
dd-mmm-yy	yyyy-mm-dd
dd-mmm-yyyy	yyyy-mm-dd
dd-mmm.hh:mm	--mm-ddThh:mm±hh

Default: 1

CCASE_MAKE_CFG_DIR (or CLEARCASE_MAKE_CONFIG_DIR)

In a makefile read by clearmake, expands to the full path name of the clearmake configuration directory in the VersionVault installation area—typically versionvault-home-dir/config/clearmake (UNIX and Linux) or versionvault-home-dir\config\clearmake (Windows).

CCASE_MAKE_COMPAT (or CLEARCASE_MAKE_COMPAT)

Specifies a clearmake compatibility mode. 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 the VersionVault Guide to Building Software.

Default: None.

CCASE_MAKEFLAGS_V6_OBSOLETE

Beginning with V7.1, the macro value of MAKEFLAGS included macros that are defined by the command line, by default. A clearmake build that is run with GNU make emulation may produce unexpected results if the command-line make macros are reset in the build script for a child make. For example, if you run

clearmake -C gnu TARGET=ppc

and the makefile calls a target that starts a child make such as

$(MAKE) $(MAKEFLAGS) TARGET=Win32

then the line expands to

clearmake -- TARGET=ppc TARGET=Win32

The first macro definition overrides the second one, which can cause makes to run with an unexpected macro definition. This behavior can lead to incorrect build results. To prevent this behavior, set this environment variable.

CCASE_MAX_OPLOG_TRIM_ENTRIES

When set to an integer value between 1 and 100, specifies the maximum number of oplog entries that the vob_scrubber removes in a single transaction. If set to a value greater than 100 or smaller than 1, the vob_scrubber behaves as though this EV had been set to 100.

CCASE_NAME_SEP

Specifies a name conflict separator that is used to ensure unique names in case a name collision should occur during VOB synchonization. The separator is a string that can consist of the following characters:

Alphanumeric characters (aA-zZ, 0-9)
,
@
_
-
,
=

Strings that are longer than 16 characters are truncated to 16 characters.

Default: _

CCASE_NO_LOG

Suppresses log creation for the update command and other commands (catcs, edcs, and so on.) that initiates the update operation.

Default: Undefined.

CCASE_NO_WINKIN_VIEWS

A list of white space-separated view tags. This is the opposite of CCASE_WINKIN_VIEWS. When this environment variable is set (and when CCASE_WINKIN_VIEWS is unset), it excludes the specified views from the list of views from which clearmake winks in derived objects.

CCASE_OPTS_SPECS (or CLEARCASE_BLD_OPTIONS_SPECS)

A list of path names, separated by colons (UNIX and Linux) 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 and Linux: –e

Default for Windows: None.

CCASE_SHELL_REQUIRED

Forces clearmake to execute build scripts in the shell program that 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_VIEW_IDLE_THRESH

Specifies the time interval of inactivity after which view server processes become idle and their resources are freed. Set this EV on the view server host.

Default: 7800 seconds (two hours and 10 minutes)

CCASE_USE_GUI

When set to CTE (case-insensitive), specifies that the VersionVault Explorer GUI is to be displayed when commands are issued with the -graphical option.

Default: Native-client GUIs are displayed.

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 path name. For example, on UNIX and Linux:

/bin/csh or /usr/home/myscript

On Windows:

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

Default on UNIX and Linux: 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 and Linux) or by semicolons (Windows).

Default: None.

CLEARCASE_CMNT_PN

The path name 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_EDA

The electronic design automation tool integration. The setting, CLEARCASE_EDA=Cadence Virtuoso can be used to trigger VOB operations in a VOB containing Cadence library objects to ensure that users are using the integration, and not attempting VersionVault operations outside of the integration (such as using cleartool). The setting is effective for any operation performed in the Virtuoso Library Manager, the VersionVault Work Area Manager (WAM), the VersionVault Hierarchy Manager (HM), and all Generic Data Management operations (see gdm* commands).

CLEARCASE_OBSO_SYN

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 nonzero 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 VersionVault Perl. To prevent such conflicts, set this environment variable to a nonzero value.

CLEARCASE_PROFILE

The file that contains your VersionVault user profile, which includes rules that determine the option defaults for cleartool and multitool commands. This setting must be a full path name.

Default: The default is .versionvault_profile in your home directory.

CLEARCASE_RGY_QUICK

Causes lsview –host and lsvob –host to use the –quick functionality by default. This provides faster lookup for the –host option by listing views and VOBs as currently stored in the registry. One use of this EV is to change the run-time behavior of a script that uses the –host option, without modifying the script.

CLEARCASE_RGY_QUICK has no effect on the lsview or lsvob command if the –region option is also used and the region is specified with a wildcard.

Default: Undefined. The command examines the file system to list views and VOBs.

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 Help.

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 and Linux systems: Not used. VersionVault 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 VersionVault to work correctly. The shell constant CSIDL_PROFILE is used to search for various resources, including file-typing information (see also the cc.magic reference page).

MAGIC_PATH

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

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

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

MAKEFLAGS

One or more flags to be passed to make. clearmake reads the contents of MAKEFLAGS at startup and amends it to include any flags not specific to VersionVault passed at the command line. Any flags specific to VersionVault are passed through CCASE_MAKEFLAGS and if clearmake detects these flags in MAKEFLAGS, it moves them to CCASE_MAKEFLAGS.

Flags passed through MAKEFLAGS:

-I, -p, -N, -w, -e, -r, -i, -k, -n, -q, -s

Flags passed through CCASE_MAKEFLAGS:

-A, -B, -N, -b, -v, -C, -U, -M, -V, -O, -T, -F, -R, -c, -u, -d

Default: None.

SHELL

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

Default for UNIX and Linux: Set by your shell program.

Default for Windows: Not set by most Windows shells; some shells that are ported from UNIX and Linux (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 and Linux 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.

CCASE_CDS_CANCEL_WITH_KEEP

When set to TRUE, gdmcancel operations create .keep files by default.

CLEARCASE_MKELEM_USE_GRPLIST

When set to true, enables the primary group intersection algorithm during element creation. For a description of the algorithm, see the mkelem reference page.

CLEARCASEHOME

Installation directory for VersionVault and MultiSite software. Set this EV before installing the product. On hosts with nondefault installation locations, users' shell startup scripts must use $CLEARCASEHOME/bin to specify the path name of the VersionVault or MultiSite executables.

Default: /opt/hcl/ccm/versionvault

CCASE_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 xversionvault 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 (UNIX) 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 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.

Environment variables for Windows only

CCASE_WIN2K_MIXED_PATH_SEPS: Set to a non-null value to allow makefiles to use "\" and "/" interchangeably in the first whitespace-separated word of a command in a build script. This works around a limitation unique to the Windows 2000 command shell. It is ignored on other Windows platforms.
CLEARCASEHOME: Installation directory for VersionVault and MultiSite; same as Windows Registry value HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\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 Help.
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 VersionVault (the installation default is C:\HCL\CCM\VersionVault)
CCASE_NO_ESC_PATT_CHARS: Build EV
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 VersionVault should consider the primary group. Overrides the Windows primary group assignment for VersionVault 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 VersionVault 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 VersionVault 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. Some VersionVault operations cannot evaluate group membership information for more than 32 groups per user. If the user is a member of more than 32 groups, the creds command lists only the 32 groups that are used by all VersionVault operations.

CMAKE_PNAME_SEP

Sets the path name separator for path names 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 path name separator.

COMSPEC

The default command shell program to be run by various VersionVault 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 path name of a text editor. The edcs subcommand invokes the editor specified by the environment variable VISUAL (first choice) or EDITOR (second choice). If the path name contains spaces, enclose the path name 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 versionvault-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 Registry key value)

Installation directory for VersionVault software. This value is stored in the Windows registry key HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Atria\ClearCase\CurrentVersion.

Default: C:\Program Files\VersionVault