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 checkouts of an element


ProductCommand type
ClearCasecleartool subcommand
ClearCase LTcleartool subcommand



  • List checkouts:
    lsc·heckout | lsco [ –l·ong | –s·hort | –fmt format-string ]
    [ –cvi·ew ]
    [ –brt·ype branch-type-selector ]
    [ –me | –use·r login-name ]
    [ -r·ecurse | -d·irectory | -a·ll | -avo·bs ] [ -are·plicas ]
    [ pname ... ]

  • On Windows, list checkouts graphically:
    lsc·heckout –g·raphical pname


The lscheckout command lists the checkout records (the checkouts) for one or more elements. There are many controls for specifying the scope: which elements, directories, or VOBs; which user; which view; and so on.




Listing Checkouts Graphically

Lists checkouts in the command window.

Displays checkouts in a GUI.

Report Format

The listing of a checkout event record looks like this:

31-Aug.20:19 drp checkout version "ct+lscheckout.1" from /main/4 (reserved) 
  “delete extra spaces” 

Expands the listing to include the view to which the element is checked out.

Restricts the listing to the pathnames of checked-out elements.

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

Selecting Checkout Records to List

The listing includes all checkouts for the specified elements, including checkouts made in any view by any user.

Restricts the listing to your own checkouts.

–use·r login-name
Restricts the listing to checkouts made by the specified user.

Restricts the listing to checkouts made in the current view. On UNIX systems, if there is a working directory view, lscheckout lists its checkouts; otherwise, it lists the checkouts in the set view.

–brt·ype branch-type-selector
Restricts the listing to checkouts on branches of the specified type. Specify branch-type-selector in the form [brtype:]type-name[@vob-selector]
type-name Name of the branch type
vob-selector VOB specifier.

Specify vob-selector in the form [vob:]pname-in-vob

 pname-in-vob Pathname of the VOB tag (whether or not the VOB is mounted) or of any file system object within the VOB (if the VOB is mounted)

Specifying the Elements

The listing includes all checkouts for the specified elements, including checkouts made in any view by any user. The current working directory (equivalent to specifying a dot ( . ) as the pname argument). If you don't specify any options, lscheckout lists all checkouts of elements in the current directory, to any view. If the current directory is itself checked out, this is also indicated.

pname ...
One or more pathnames, specifying file elements and/or versions of directory elements. (A Windows pathname or a UNIX standard or view-extended pathname to a directory specifies the version in the view.)
  • For each pname that specifies a file element, the listing includes that element's checkout event records.

  • For each pname that specifies a version of a directory element, the listing includes checkout event records of elements cataloged in that directory version, but not checkout records for the pname directory itself.

The following options modify the processing of the pname arguments.

Lists the checkouts of elements in the entire subtree below any directory encountered in the current view. VOB symbolic links are not traversed during the recursive descent.

Lists the checkouts (if any) of a directory itself, rather than the checkouts of elements cataloged in it.

Lists all the checkouts in the VOB containing pname. If you don't specify any pname arguments, lists all checkouts in the VOB that contains the current working directory.

Note: A file element can have several names, by virtue of one or more VOB hard links. Checking out such an element under one name causes all the names to be listed as checked out. However, the –all option lists the checked-out element only once.

Lists checkouts of the element specified by pname in all replicas of the VOB that contains pname. If you don't specify any pname arguments, lists all checkouts in all replicas of the VOB that contains the current working directory.

The following option is mutually exclusive with pname arguments:

Similar to –all, but includes checkouts in 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.) This option depends on the MVFS, and so has no meaning for snapshot-view-only hosts.

Note: A view context is required when using this option.


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 checkouts in the current working directory.

    cmd-context lscheckout 
    08-Dec.12:17 jackson checkout version "hello.c" from /main/4 (reserved)
    08-Dec.12:17 jackson checkout version "hello.h" from /main/1 (unreserved)
     "modify local defines"
    08-Dec.12:17 jackson checkout version "msg.c" from /main/rel2_bugfix/0 (reserved) 

  • List only the names of elements checked out to the current view.

    cmd-context  lscheckout –short –cview 

  • List the checkouts in all directories at or below the current directory.

    cmd-context lscheckout –recurse 
    08-Dec.12:17 jackson checkout version "hello.c" from \main\4 (reserved)
    08-Dec.12:17 jackson checkout version "hello.h" from \main\1 (unreserved) 
        "modify local defines"
    08-Dec.12:17 jackson checkout version "msg.c" from \main\rel2_bugfix\0 
    08-Dec.12:17 jackson checkout directory version "subd" from \main\1 
    08-Dec.12:17 jackson checkout version ".\subd\util.h" from \main\0 

  • List elements checked out by the user in all mounted VOBs.

    cmd-context  lscheckout –avobs –me 
    08-Dec.12:17 jackson checkout version "/usr/hw/src/hello.c" from /main/4 
    08-Dec.12:17 jackson checkout version "/usr/hw/src/hello.h"from /main/1 
        "modify local defines"
    08-Dec.12:17 jackson checkout directory version "/usr/hw/release" from 
    /main/0 (reserved)
    08-Dec.12:17 jackson checkout version "/usr/hw/src/msg.c" from 
    /main/rel2_bugfix/0 (reserved)
    08-Dec.12:17 jackson checkout version "/usr/hw/src/util.h" from 
    /main/0 (reserved) 

  • For all checkouts in the current directory, list the checkout date, user name, element name, predecessor version, host, checkout status, and element type. (The command line, including the quoted format string, constitutes a single input line. The input line below is broken to improve readability. Spaces are significant.)

    cmd-context lsco –fmt "%d\t%Lu\t%En\n\tPredecessor: %[version_predecessor]p\n\tHost: %h\n\tStatus: %Rf\n\tElement type: %[type]p\n" 
    16-Jun-99.15:23:15     lee.user        files.txt
    Predecessor: \main\96
    Host: neon
    Status: unreserved
    Element type: text_file
    09-Jun-99.15:39:09     susan.user      mkfile.fm
    Predecessor: \main\27
    Host: pluto
    Status: reserved
    Element type: frame_document
    16-Jun-99.12:23:11     cheryl.user     mktype.fm
    Predecessor: \main\115
    Host: troy
    Status: reserved
    Element type: frame_document
    10-Jun-99.12:29:30     john.user       files.txt
    Predecessor: \main\26
    Host: marcellus
    Status: reserved
    Element type: text_file



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