IPnom Home • Manuals • ClearCase

 Rational ClearCase Commands Reference

ClearCase Stuff:ClearCase LinksClearCase BooksClearCase Commands ReferenceClearCase ForumsClearCase News
Keyword Live Search (10 results max):
 Type in part of a ClearCase command in the search box.
Commands Index:


Lists event records for VOB-database objects


ProductCommand type
ClearCasecleartool subcommand
ClearCase LTcleartool subcommand



  • ClearCase—Display event records graphically:
    lsh·istory –g·raphical [ –nop·references [ [ –min·or ] [ –nco ]
    [ –use·r login-name ] [ –bra·nch branch-type-selector ] ] ]
    [ [ –r·ecurse | –d·irectory | –a·ll | –avo·bs ]
    [ –pna·me ] pname ...
    | object-selector ...

  • ClearCase LT on Windows—Display event records graphically:
    lsh·istory –g·raphical [ –nop·references [ [ –min·or ] [ –nco ]
    [ –use·r login-name ] [ –bra·nch branch-type-selector ] ] ]
    [ [ –r·ecurse | –d·irectory | –a·ll | –avo·bs ]
    [ –pna·me ] pname ...
    | object-selector ...

  • Display event records in the command window:
    lsh·istory [ –l·ong | –s·hort | –fmt format-string ] [ –eve·ntid ]
    [ –min·or ] [ –nco ] [ –las·t [ num-events ] ] [ –sin·ce date-time ]
    [ –me | –use·r login-name ] [ –bra·nch branch-type-selector ]
    [ [ –r·ecurse | –d·irectory | –a·ll | –avo·bs | –local ]
    [ –pna·me ] pname ... | object-selector ... ]


The lshistory command lists event records in reverse-chronological order, describing operations that have affected a VOB's data. There are several kinds of listing:

  • File system data history. Lists events concerning elements, branches, versions, and VOB links. This includes records for creation and deletion of objects, and records for attaching and removal of annotations: version labels, attributes, and hyperlinks.
  • Hyperlink history. Lists events concerning hyperlink objects: creation, deletion, attaching/removal of attributes.
  • Type history. Lists events concerning type objects that have been defined in the VOB.
  • Storage pool history. Lists events concerning the VOB's storage pools.
  • VOB history. Lists events concerning the VOB object itself. This includes the deletion of type objects and elements from the VOB.
  • VOB replica history. Lists events concerning a VOB replica, including synchronization updates.




Default. If you don't specify any objects to be listed, lshistory displays events for the file system objects in the current working directory and events for the directory element itself. (This is equivalent to specifying “.” and “.@@” as the pname arguments.) The following sections describe how to produce a report on other file system objects, or on other kinds of objects.

Listing Event Records Graphically

Lists event records in the command window.

Starts a browser that displays event records.

Ignoring Preferences Settings

Displays the history browser with your saved settings for filtering.

Temporarily overrides filtering settings. When used alone, uses default settings (displays all events except minor events). When used in combination with one or more of –minor, –nco, –user, or –branch, overrides your current filtering settings.

Note: You cannot save your History Browser settings during a session that you invoked using the –nopreferences option.

Report Format

Default report format for an element:

02-Feb.10:51 scd create version "msg.c@@/main/rel2_bugfix/1"
 "Version for branch creation test"
02-Feb.10:51 scd create version "msg.c@@/main/rel2_bugfix/0"
02-Feb.10:51 scd create branch "msg.c@@/main/rel2_bugfix"
01-Feb.16:17 scd create file element "msg.c@@"

Default report format for a hyperlink:

08-Feb.11:25 scd create hyperlink "Merge@535@\tmp\scd_reach_hw"

Default report format for a storage pool:

01-Feb.16:05 scd create pool "cdft"
 "Predefined pool used to store cleartext versions."

Expands the listing to include other object-specific information.

Restricts the listing to names only: pathnames of file system objects, names of type objects, or names of storage pools.

–fmt format-string
Lists information using the specified format string. See the fmt_ccase reference page for details about using this report-writing facility.

Displays a numerical event ID on the line preceding each event record (even if you use –fmt). You can change the comment assigned to an arbitrary event record by supplying an event ID to the chevent –event command. Event IDs remain valid until the VOB is reformatted with reformatvob.

Selecting Events for the Specified Objects

The report includes all the major events in the entire histories of the selected objects.

Note: When using one or more of these options with lshistory –graphical, you must precede them with the –nopreferences option (the –branch option also has this requirement).

Includes less important events in the listing: attaching of attributes, version labels, and so on. For type objects and storage pools, minor events include rename operations and changes to pool parameters (mkpool –update).

Excludes checkout version events (the ones listed by the lscheckout command).

–las·t [ num-events ]
Lists the specified number of events, starting with the most recent. If num-events is not specified, lists the most recent event.

Note: This option is mutually exclusive with –recurse.

–sin·ce date-time
Lists events recorded since (that is, at or after) the specified date-time.

The date-time argument can have any of the following formats:

date.time | date | time | now


date :=day-of-week | long-date
time :=h[h]:m[m][:s[s]] [UTC [ [ + | - ]h[h][:m[m] ] ] ]
day-of-week :=today |yesterday |Sunday | ... |Saturday |Sun | ... |Sat
long-date :=d[d]month[[yy]yy]
month :=January |... |December |Jan |... |Dec

Specify time in 24-hour format, relative to the local time zone. If you omit the time, the default value is 00:00:00. If you omit date, the default is today. If you omit the century, year, or a specific date, the most recent one is used. Specify UTC if you want to resolve the time to the same moment in time regardless of time zone. Use the plus (+) or minus (-) operator to specify a positive or negative offset to the UTC time. If you specify UTC without hour or minute offsets, Greenwich Mean Time (GMT) is used. (Dates before January 1, 1970 Universal Coordinated Time (UTC) are invalid.)



Lists events recorded for commands entered by the current user.

–use·r login-name
Lists events recorded for commands entered by the specified user.

File System Data History

  Use the following to specify one or more file system objects for a history listing.

–bra·nch branch-type-selector
Restricts the report to events relating to branches of the specified type. If you use this option with –graphical, you must precede –branch with the –nopreferences option. Specify branch-type-selector in the form [brtype:]type-name
type-name Name of the branch type
Processes the entire subtree below any directory element encountered. VOB symbolic links are not traversed during the recursive descent.

Note: This option is mutually exclusive with –last.

Lists information on a directory element itself, rather than on its contents.

Reports on all objects in the VOB containing pname: file system objects, type objects, and storage pools. If you omit pname, this option uses the VOB that contains the current working directory. Specifying –all implicitly specifies –local.

Similar to –all, but includes all VOBs active (mounted) on the local host. (If environment variable CLEARCASE_AVOBS is set to a list of VOB tags, this set of VOBs is used instead.) If a VOB has multiple replicas, events from all the replicas are reported. Specifying –avobs implicitly specifies –local.

Reports on local copies of types specified with object-selector. By default, lshistory displays the history of the global type for the object selector you specify. For more information about global types, see the Administrator's Guide.

Indicates that pname is a file system object. Use this option when pname has the form of an object selector (for example, lbtype:V3.0).

pname ...
One or more pathnames, specifying elements and/or VOB symbolic links whose history is to be listed.

Note: You cannot use a pname argument like foo.c@@\main to restrict the report in this way.

object-selector ...
The object whose event records are to be displayed. The object must be in the VOB containing the current working directory, unless you use the @vob-selector suffix. Specify object-selector in one of the following forms:
vob-selector vob:pname-in-vob
  pname-in-vob can be the pathname of the VOB tag (whether or not the VOB is mounted) or of any file system objects within the VOB (if the VOB is mounted). It cannot be the pathname of the VOB storage directory.
attribute-type-selector attype:type-name[@vob-selector]
branch-type-selector brtype:type-name[@vob-selector]
element-type-selector eltype:type-name[@vob-selector]
hyperlink-type-selector hltype:type-name[@vob-selector]
label-type-selector lbtype:type-name[@vob-selector]
trigger-type-selector trtype:type-name[@vob-selector]
pool-selector pool:pool-name[@vob-selector]
hlink-selector hlink:hlink-id[@vob-selector]
oid-obj-selector oid:object-oid[@vob-selector]
The following object selector is valid only if you use MultiSite:
replica-selector replica:replica-name[@vob-selector]


The UNIX examples in this section are written for use in csh. If you use another shell, you may need to use different quoting and escaping conventions.

The Windows examples that include wildcards or quoting are written for use in cleartool interactive mode. If you use cleartool single-command mode, you may need to change the wildcards and quoting to make your command interpreter process the command appropriately.

In cleartool single-command mode, cmd-context represents the UNIX shell or Windows command interpreter prompt, followed by the cleartool command. In cleartool interactive mode, cmd-context represents the interactive cleartool prompt.

  • List the event history of an element.

    cmd-context  lshistory hello.c 
    08-Dec.12:05 jackson  import file element "hello.c@@"
    20-May.15:41 cory     create version "hello.c@@/main/3" (REL2)
     "include name, home dir, and time in message
     KNOWN BUG: extra NL at end of time message"
    07-May.08:34 akp      create version "hello.c@@/main/2" (REL1)
     "ANSI compatibility: declare return value type, make explicit 
    return value also: clean up wording for The Boss"
    04-May.13:35 akp      create version "hello.c@@/main/1"
     "first implementation"
    04-May.13:35 akp      create version "hello.c@@/main/0"
    04-May.13:35 akp      create branch "hello.c@@/main"
    04-May.13:35 akp      create file element "hello.c@@"

  • List the history of a label type, using the long format.

    cmd-context  lshistory –long lbtype:REL1 
    08-Jan-99.12:05:43 Chuck Jackson (test user) (jackson.dvt@oxygen)
     import label type "REL1"
    15-Apr-99.14:45:00 ross.devt@neptune
     create label type "REL1"
     "create label for Release 1 of "hello world" program"

  • For all elements in the current working directory, list events involving the rel2_bugfix branch.

    cmd-context  lshistory –branch rel2_bugfix 
    24-Mar.12:45 jackson      create version "msg.c@@/main/rel2_bugfix/0"
    24-Mar.12:45 jackson      create branch "msg.c@@/main/rel2_bugfix"
     "release 2 bugfixes"
    23-Mar.20:40 jackson      create version "util.c@@/main/rel2_bugfix/1"
     "fix bug: extra NL in time string"
    23-Mar.20:39 jackson      create version "util.c@@/main/rel2_bugfix/0"
    23-Mar.20:39 jackson      create branch "util.c@@/main/el2_bugfix"

  • List the latest event for every file element in or below the current directory.

    cleartool find . –type f –exec "cleartool lshistory –last %CLEARCASE_XPN%" 
    09-Jun.17:25   lee     create version ".\file.txt@@\main\1"
    07-Jun.15:33   cty     create version ".\tests.txt@@\main\33"
    17-May.23:44   ben     create version ".\dir1\comp.c@@\main\bugfix\45"

  • List the history of the VOB object itself for the current VOB.

    cmd-context  lsh vob:. 
    10-Dec.08:01 gomez      unlock versioned object base "/home/gomez/personal"
    09-Dec.15:48 gomez      lock versioned object base "/home/gomez/personal"
     "Locked for all users."
    02-Oct.19:46 gomez      create versioned object base "/home/gomez/personal"
     "gomez's personal vob"

  • Start a history browser, overriding the saved filtering settings and displaying events for the hello.c element that are related to the v4_test branch.

    cmd-context  lshistory –graphical –nopreferences –branch v4_test hello.c 



ClearCase Links • ClearCase Books • ClearCase Commands Reference • ClearCase Forums • ClearCase News