Lists VOB-resident objects, elements loaded into a snapshot view, and view-private objects in a directory
Product | Command Type |
---|---|
ClearCase | cleartool subcommand |
ClearCase LT | cleartool subcommand |
Attache | command |
Platform |
---|
UNIX |
Windows |
The ls command lists VOB-resident objects, elements loaded into a snapshot view, and view-private objects in a directory.
The default listing includes this information:
The name of each element cataloged in the current directory, with the version-ID of the particular version in the view. Also included is the version selector part of the config spec rule that selects this version. In a snapshot view, you see the message <rule info unavailable>
if ls encounters errors
The name of each view-private object in the current directory
In a dynamic view, the name of each derived object (DO) visible in the view, along with its unique DO-ID
The listing for an element or a derived object in a dynamic view may also include an annotation that indicates an unusual or noteworthy state. For example, the listing for an element that has been checked out to your view identifies the version that was checked out:
hello.c@@/main/CHECKEDOUT from /main/4 Rule: CHECKEDOUT
The following annotations may appear when you issue ls from any type of view:
eclipsed
ls -vob_only
shows the element to be eclipsed.eclipsed by checkout
checkedout but eclipsed
checkedout but removed
no version selected
error on reference
view-->vob hard link
The following annotations may appear when you issue ls from a dynamic view:
no config record
disputed checkout
removed with white out
The following annotations may appear when you issue ls from a snapshot view:
not loaded
loaded but missing
hijacked
overridden
special selection
nocheckout
deleted version
The listing includes elements selected with -none and -error config spec rules, and elements that are not selected by any config spec rule. UNIX commands, such as ls(1) and cat(1), return not found
errors when accessing such elements. You can specify such elements in commands that access the VOB database only, such as describe, lsvtree, and mklabel.
HANDLING OF DIRECTORY ARGUMENTS. Default: For each pname that specifies a directory element, ls lists the contents of that directory, but not the contents of any of its subdirectories.
NOTE: This includes directories in version-extended namespace, which represent elements and their branches. For example, specifying foo.c@@/main/bug403 as an argument lists the contents of that branch: all the versions on the branch.
REPORT FORMAT. Default: The default report format is described in the The default listing includes this information: section.
VOB/VIEW RESTRICTION. Default: The listing includes both objects in VOB storage and objects in view storage.
(and not -vob_only), regardless of whether they are (or ever have been) shared.SPECIFYING THE OBJECTS TO BE LISTED. Default: The current working directory (equivalent to specifying "." as the pname argument). If you don't specify any other options, all files and links in the current working directory are listed; all subdirectory entries are listed, but not the contents of these subdirectories.
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. In Attache, cmd-context represents the workspace prompt.
NOTE: In some examples, output is wrapped for clarity.
List the VOB-resident objects and view-private objects in the current working directory.
cmd-context ls
Makefile@@/main/3 Rule: /main/LATEST
bug.report
cm_add.c@@/main/0 Rule: /main/LATEST
cm_fill.c@@/main/0 Rule: /main/LATEST
convolution.c@@/main/CHECKEDOUT from /main/0 Rule: CHECKEDOUT
edge.sh
hello@@24-Mar.11:32.418
hello.c@@/main/CHECKEDOUT from /main/4 Rule: CHECKEDOUT
hello.h@@/main/CHECKEDOUT from /main/2 Rule: CHECKEDOUT
hello.o@@24-Mar.11:32.412
hw.c@@/main/4 Rule: /main/LATEST
include@@/main/CHECKEDOUT Rule: CHECKEDOUT
List the objects in the current working directory, with annotations.
cmd-context ls -long
version Makefile@@\main\3 Rule: element * \main\LATEST
view private object bug.report
version cm_add.c@@\main\0 Rule: element * \main\LATEST
derived object (unshared) hello@@24-Mar.11:32.418
version hello.h@@\main\CHECKEDOUT from \main\2
Rule: element * CHECKEDOUT
derived object (unshared) hello.o@@24-Mar.11:32.412
directory version include@@\main\CHECKEDOUT
Rule: element * CHECKEDOUT
symbolic link messages.c --> msg.c
version msg.c@@\main\1 Rule: element * \main\LATEST
view private object util.c.contrib
List only the view-private objects in the current working directory.
cmd-context ls -view_only
bug.report
hello@@24-Mar.11:32.418
hello.c@@/main/CHECKEDOUT from /main/4 Rule: CHECKEDOUT
hello.h@@/main/CHECKEDOUT from /main/2 Rule: CHECKEDOUT
hello.o@@24-Mar.11:32.412
msg.o@@23-Mar.20:42.379
util.c@@/main/CHECKEDOUT from /main/4 Rule: CHECKEDOUT
util.o@@24-Mar.11:32.415
List the contents of the directory in extended namespace that corresponds to the main branch of element util.c.
cmd-context ls util.c@@\main
util.c@@\main\0
util.c@@\main\1
util.c@@\main\2
util.c@@\main\3
util.c@@\main\CHECKEDOUT
util.c@@\main\LATEST
util.c@@\main\REL2
util.c@@\main\REL3
util.c@@\main\rel2_bugfix
view private object util.c.contrib
List the directory version that is visible in the current view:
cmd-context ls -directory -vob_only
.@@/main/CHECKEDOUT from /main/4 Rule: CHECKEDOUT
checkout, config_spec, lsprivate, lsvtree, pathnames_ccase, uncheckout
Feedback on the documentation in this site? We welcome any comments!
Copyright © 2001 by Rational Software Corporation. All rights reserved. |