# ClearCase(3)

[Home] [Commands] [Variables] [Macro-Dev] [Glossary]

## NAME

ClearCase - MicroEmacs ClearCase interface
cc-add - MicroEmacs ClearCase interface - add file
cc-checkout - MicroEmacs ClearCase interface - checkout files and directories
cc-checkin - MicroEmacs ClearCase interface - checkin changes
cc-delete - MicroEmacs ClearCase interface - delete file
cc-diff - MicroEmacs ClearCase interface - diff changes
cc-state - MicroEmacs ClearCase interface - list state of directory files
cc-update - MicroEmacs ClearCase interface - update directory files

## SYNOPSIS

ClearCase
cc-setup

cc-add
cc-checkout
cc-checkin
cc-delete
cc-diff
cc-state
cc-update

## DESCRIPTION

The ClearCase and sub-commands provide MicroEmacs with an interface to IBM Rational Software ClearCase(1). ClearCase is a version control system; using it, you can record the history of your source file modifications. ClearCase is licensed from IBM Rational and is widely used in a commercial environment, see the documentation provided with ClearCase for more information on its features and use.

The ClearCase directory should be defined to MicroEmacs using cc-setup(3) which enables extensions in the file-browser(3) with an additional "`*cc-console*`" window. The "`*files*`" window includes additional columns showing the ClearCase state, revision and repository date. The functionality of the file-browser is the same as a non-ClearCase folder with the exception that additional ClearCase item controls are located in the mouse context menu (opened by clicking the right mouse button in the `*files*` buffer). This menu item opens another sub-menu providing access to the items below. When selecting commands than a pop-up check-box may be displayed which allows options to be selected for the command.

Current State

Checks the state of selected file(s) or directory against the repository. Differences detected are shown in the `*cc-state*` window. This provides a quick method of determining the working directory state.

The `*cc-state*` buffer supports some of the same features as a directory listing, the files can be loaded (using `return` or left click on the file name), selected (using space or left mouse button on the left hand edge) and ClearCase commands executed from the window operate either on the selected files or the listed files if no files are selected.

Update Elements

Updates the currently selected files, files are selected by clicking the left button to the left of the required file name. Multiple files may be selected by 'dragging' a hilight region over the required files.

Clear CC console

Clears the *cc-console* buffer.

The following sections describe some of the ClearCase commands that are available, a full list of commands may be found using command-apropos(2) searching for cc which provides a full list of all of the ClearCase related commands.

The cc-add command adds the current buffer file to the repository.

The cc-checkout command checks out a file or directory from the repository into the current directory, the read-only status of the file is changed to read-write, the user is prompted for a comment which will be used on a subsequent check-in operation. The user specifies the file on the message line.

The cc-checkin command commits any changes made to the currently buffer's file (including additions) to the repository. The user is prompted for a commit log message, the file state will change to read-only.

The cc-diff command opens a *cc-diff* window displaying the differences between the current buffer's local file and repository version. If the current buffer is a directory list it will list all the differences found in all files within the directory.

The cc-delete command removes the current buffer's file from the repository.

The cc-state command opens a *cc-state* window listing the state of any file in the current directory which is not up-to-date. Note that unlike most ClearCase sub commands this command executes over all files in the current buffer's file directory.

The cc-update command updates all files in the current directory, the output being reported to a new *cc-update* window. Note that unlike most ClearCase sub commands this command executes over all files in the current buffer's file directory.

## Setup

cc-setup provides a dialog interface to configure the MicroEmacs ClearCase interface if required. The VOB view location in the file system should be added for each view that is to be access by MicroEmacs.

A Tools tab exists to configure each of the cleartool(1) options, these may be configured to suite the users preferences.

cc-setup may also be accessed from user-setup(3) from the Miscellaneous configuration.

## ClearCase File Browser

The ClearCase File Browser is an extension to the file-browser(3) and shows the state of ClearCase files in a directory listing.

## NOTES

ClearCase and sub-commands are macros defined in file `clearcs.emf`.

## SEE ALSO

cvs(3), file-browser(3).

(c) Copyright JASSPA 2009
Last Modified: 2009/08/29
Generated On: 2009/10/12

</HMTL>