env_ccase

ClearCase and Attache environment variables

APPLICABILITY

ClearCase (general information), Attache (general information)

DESCRIPTION

This reference page describes the environment variables (EVs) used by ClearCase and Attache commands, programs, utilities, and software installation scripts. It includes both ClearCase and Attache EVs. .

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

ATRIAHOME (environment variable)

ClearCase installation directory; 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.

NOTE: You can create ATRIAHOME as a user or system environment variable, but the albd_server will overwrite it when it runs a schedule request.

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

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 TMP environment variable. 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: None.

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). See clearmake SLEEP for more information.

CCASE_BLD_VOBS

A list of VOB-tags (separated with a space, tab (\t), semicolon (;), or comma (,)) to be checked for lock status during a build. If a VOB on this list is locked, clearmake goes into a sleep-check cycle. See clearmake SLEEP for more information.

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 CACHING UNAVAILABLE VIEWS in the clearmake reference page or CACHING UNAVAILABLE VIEWS in the omake reference page.

Default: 60 minutes.

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.

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.

clearmake uses either CCASE_MAKEFLAGS or MAKEFLAGS, but not both. If CCASE_MAKEFLAGS is set, clearmake uses it. If CCASE_MAKEFLAGS is not set, clearmake looks for MAKEFLAGS.

NOTE: CCASE_MAKEFLAGS is useful if you use multiple make programs. In this case, putting options that are specific to clearmake in the MAKEFLAGS environment variable causes problems for the other make programs.

Default: None.

CCASE_OPTS_SPECS (or CLEARCASE_BLD_OPTIONS_SPECS)

A semicolon-separated list of pathnames, 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: 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_VERBOSITY (or CLEARCASE_BLD_VERBOSITY)

An integer that specifies the clearmake message logging level, as follows:

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

Default: 0

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, \windows\system32\cmd.exe or \users\anne\bin\myscript.

Default: clearaudit runs the program specified by the SHELL environment variable or, if SHELL 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 semicolons, commas, or white-space characters.

Default: None.

CLEARCASE_CMNT_PN

The pathname of the file in which cleartool caches the most recent user-supplied comment. Defining/removing this EV enables/disables comment caching.

CLEARCASE_OBSO_SYN

Detects instances of the obsolete option-argument style of specifying an object (see Non-File-System VOB Objects in 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_PRIMARY_GROUP

Overrides a user's Windows primary group assignment. This environment variable must be a per-user variable (not a system variable) and can be set only to a group that already appears in the user's group list.

CLEARCASE_PROFILE

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

Default: .clearcase_profile in your home directory (in Attache, on your helper host)

CLEARCASE_TAB_SIZE

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

Default: 8

CLEARCASE_TRACE_TRIGGERS

A flag variable: if defined with 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.

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 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, you enclose the pathname in quotes. For example:

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

Default: notepad

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 clearexport_ffile 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

User's home directory; must be set for ClearCase to work correctly. ClearCase uses HOME 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 legal 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 semicolon-separated list of directories to be searched for magic files. Various ClearCase programs consult magic files to perform file-typing on file system objects. See the cc.magic reference page.

Default: 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.

PATH

The standard executable program search path. The ClearCase 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 software. This value is stored in the Windows registry key HKEY_LOCAL_MACHINE\SOFTWARE\Atria\ClearCase\CurrentVersion.

Default: C:\Program Files\Rational\ClearCase

SHELL

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

Default: Not set by most Windows shells; some shells that are ported from UNIX (for example, Hamilton csh, MKS korn sh, etc.) 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, ClearCase uses the TZ time rather than the system time. In this case, file creation and change dates can be in error, and config specs do not work as expected.

SEE ALSO

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