The ClearCase remote client command-line interface (rcleartool)

Answer

About rcleartool 8.0.0.3

rcleartool is the command-line interface to the IBM Rational ClearCase remote client (CCRC). This interface, first released as a separate download for compatibility with V7.1.2.x and later releases, is delivered in V8.0.0.3 with the changes that are described in this document.

New commands
The rcleartool commands described in this section are new in V8.0.0.3. All have cleartool counterparts except for the lsserver and set commands.

lsserver
Synopsis

lss/erver [ –l/ong | –s/hort] [ pname ]

Description

Lists web servers. Server names that are annotated with the characters "*" are connected.

Options and arguments

–l/ong
Lists server names, connection state and last login times.
–s/hort
Lists server names only.
pname
Lists the server that system would use for the specified pathname.

mkactivity
Synopsis

mkact/ivity [ –c/omment comment | –nc | –cq | –cqe ]
[–hea/dline headline] [ –in stream-selector] [ –nse/t ] [ –f/orce ] [ activity-selector ...]

Options and arguments

See the reference page.

mkdir
Synopsis

mkdir [ –nco] [ –c/omment comment | –cq | –cqe | –nc ] dir-pname...

Options and arguments

See the reference page.

set
Synopsis

set [ –pref/erence preference–key –val/ue key–value ]

Description

Sets server preferences. Default: lists the current settings and the pathname of the preference file.

Options and arguments

–pref/erence preference–key –val/ue key–value
The preference key that is to be set and the value that it is to assume, as follows:

SERVER_URL (Default: Not set)
The URL of the preferred server.

CLEARCASE_PRIMARY_GROUP (Default: Not set)
The ClearCase primary group. See the env_ccase reference page.

CLEARCASE_GROUP_LIST (Default: Not set)
The ClearCase group list. CLEARCASE_GROUP_LIST is similar to CLEARCASE_GROUPS, but takes a comma-separated list instead of a semicolon-separated list.

PROXY_HOST (Default: Not set)
The URL of the proxy host.

PROXY_PORT (Default: Not set)
The port of the proxy host.

PERSIST_SESSION_STATE (Default: TRUE)
The persistence of the credentials state. TRUE specifies that a session cookie is stored on disk to allow command execution to proceed for the length of the session. FALSE specifies that no session cookie is stored; therefore, you must supply your credentials for every command that you issue.

NON_LATEST_CHECKOUT (Default: PROMPT)
Can assume the values PROMPT, LOADED, or LATEST. PROMPT specifies that a warning is to be issued when a non-latest version is checked out. LOADED specifies that the current loaded version is to be checked out, even if the loaded version is not selected by the view configuration specification. LATEST specifies that the version selected by the view configuration specification is to be checked out; if that version is not loaded, load it before checking it out.

setactivity
Synopsis

setact/ivity [ –none | activity-selector ]

Options and arguments

See the reference page.

setcs
Synopsis

setcs [ –force] [ –ove/rwrite | –ren/ame] pname

Options and arguments

See the reference page.

---

Changed commands

The rcleartool commands listed in this section have changed since V7.1.2.x.

checkin
Synopsis

checkin | ci [ –c/omment comment | –cq | –cqe | –nc ]
[ –kee/p | –rm ] [ –fro/m source–pname ]
[ –ide/ntical ] { –cac/t | activity–selector ... | [ –ato/mic ] pname ... }

Options and arguments

See the reference page.

checkout
Synopsis

checkout | co [–res/erved ] [ –unr/eserved [ –nma/ster ] ]
[ –c comment | –cq | –cqe | –nc ] [ –use/hijack ] pname ...

Options and arguments

See the reference page.

describe
Synopsis

des/cribe [ –l/ong | –s/hort | –fmt fmt-string]
[ –ala/bel {label-type-selector[,...] | –all} ]
[ –aat/tr {attr-type-selector[,...] | –all} ]
[ –ahl/ink {hlink-type-selector[,...] | –all} ]
{ [ –cvi/ew ] [ –pre/decessor ] pname ... | –type type-selector ... | –cact
| object-selector ...}

Options and arguments

See the reference page.

Limitations

• View Storage reports show incomplete information. For example, when outputting checkedout version only instead of displaying "(C:/<path to web view>)" the output contains "(server:/.)", where server is the hostname of your system.
• All object selectors must be specified in their full format, for example:
  describe stream:myStream@\myPvob instead of:
  describe stream:myStream
• Describe provides no information about view-private files.
• vob-selector is limited to file system objects that are loaded in the web view.

edcs
Synopsis

edcs [ –ove/rwrite | –ren/ame] [file]

Options and arguments

See the reference page.

NOTE: Comments are not supported in web view config specs.

help
Synopsis

h/elp command-name | command-name –help

Options and arguments

See the reference page.

login
Synopsis

login [ –lna/me login-name] [ –serv/er server–url] [ –pas/sword password]
[ –proxy_lna/me proxy–login–name] [ –proxy_pas/sword password]

Options and arguments

–lna/me login–name
The user identity for logging into the specified server.
–serv/er server–url
The server URL and port.
–pas/sword password
The password corresponding to login–name.
–proxy_lna/me proxy-login-name
The identity of the proxy principal.
–proxy_pas/sword password
The password corresponding to proxy-login-name.

logoff
Synopsis

logoff | logout [ –serv/er server–url]

Options and arguments

–serv/er server–url
The server URL and port.

ls
Synopsis

ls [ –r/ecurse | –d/irectory ] [ –s/hort | –l/ong ] [ –vob/_only | –view/_only ] [ –nxn/ame ] [ –vis/ible ]
[ pname... ]

Options and arguments

See the reference page.

lscheckout
Synopsis

lscheckout | lsco [ –l/ong | –s/hort ] [ –brt/ype branch–type–selector ] [ –cvi/ew ]
[ –me | –use/r login–name ] [ –r/ecurse | –d/irectory ] [ pname... ]

Options and arguments

See the reference page.

lsview
Synopsis

lsview [ –s/hort | –l/ong ] [ –pro/perties [ –ful/l | –text_mode ] | –age ]
[ –cview | view-tag ... | –cop/yarea copyarea ... | –uuid view–uuid ]

Options and arguments

See the reference page.

mkelem
Synopsis

mkelem [ –elt/ype elem–type–name] [ –nco | –ci] [ –mkp/ath] [ –c/omment comment | –cq | –cqe | –nc] element-pname ...

Options and arguments

See the reference page.

mkstream
Synopsis

mkstream –integration –in project–selector [ –target stream–selector]
[ –c/omment comment | –cq | –cqe | –nc] [stream–selector]
mkstream –in {project–selector | stream–selector}
[ –c/omment comment | –cq | –cqe | –nc] [ –readonly] [stream–selector ...]

Options and arguments

See the reference page.

mkview
Synopsis

mkview [ –tag web–view–tag ] [ –tmo/de { insert_cr | transparent | strip_cr } ]
[ –str/eam stream–selector ] copyarea

Options and arguments
copyarea

A local directory for storing ClearCase resources. (See the reference page for descriptions of unchanged options and arguments.)

rmelem
Synopsis

rmelem [ –f/orce] [ –c/omment comment | –cq | –cqe | –nc ] pname...

Options and arguments

See the reference page.

rmname
Synopsis

rmname | rm [ –c/omment comment | –cq | –cqe | –nc] pname...

Options and arguments

See the reference page.

uncheckout
Synopsis

uncheck/out | unco [ –kee/p | –rm ] { –cact [ pname ... ] | pname ... }

Options and arguments

See the reference page.

---

Unchanged commands

The following rcleartool commands are unchanged since V7.1.2.x:

• catcs
• cd
• lsvob
• pwd
• reserve
• rmview
• unreserve
• update

---

Changes introduced in 8.0.0.4

This section describes rcleartool changes that were introduced in 8.0.0.4.

New and changed commands

The following rcleartool commands are new in 8.0.0.4:

• rmactivity
• rmtype
• update

There are no changes to existing commands.

Documentation updates

At this release, ClearCase reference pages have been updated with all rcleartool 8.0.0.3 changes (refer to http://publib.boulder.ibm.com/infocenter/cchelp/v8r0m0/index.jsp). The following 8.0.0.4 rcleartool commands were introduced in 8.0.0.4 but are not documented in the Information Center:

• rm/activity [ –force ] activity-selector ...
• rmtype [ –ign/ore ] [ –c/omment comment | –cq/uery | –cqe/ach | –nc/omment ] type-selector ...

The meanings of the options and arguments is the same as those for cleartool.

Also new in this release is a reference page for rcleartool.