intro

Introduction to the reference pages for HCL VersionVault and HCL VersionVault MultiSite

Applicability

Product

Command type

VersionVault

general information

MultiSite

general information

Platform

UNIX®

Linux®

Windows®

Description

This reference page provides a general orientation to the contents of this manual.

cleartool subcommands

The majority of VersionVault commands are cleartool subcommands; see the cleartool reference page.

Information of general interest

The following reference pages are of interest to all users, as the information they contain is useful in various contexts:

cleartool

Object selector syntax, escaping characters, quoting command arguments, object naming rules and restrictions

env_ccase

Environment variables

events_ccase

VOB event records

fmt_ccase

Command output formatting directives

pathnames_ccase

Pathname interpretation and resolution

permissions

Summary of permissions checking for cleartool

query_language

VOB query language

version_selector

Version selector syntax

wildcards_ccase

Wildcards

Object-type independent commands

The majority of commands manipulate specific object types, and it is easy to think of the commands in those narrow terms. However, it is useful to remember that some commands can operate on various object types:

checkvob

Checks hyperlinks to objects

chevent

Changes object event records

chmaster

Transfers mastership of objects to other VOB replicas

cleardescribe

Describes objects

describe

Describes objects

lock

Locks objects

lshistory

Lists the histories (event records) of objects

lslock

Lists locks on objects

mkattr

Attaches attributes to objects

protect

Changes ownership or permissions of objects

rename

Renames objects

rmattr

Removes attributes from objects

unlock

Unlocks objects

UNIX® and Linux® graphical user interfaces

The reference pages listed below describe how to start the graphical user interfaces on Linux® and the UNIX® system. Also see the schemes reference page, which describes X Window System resources for these GUIs.

cleardescribe

Displays objects

cleardiffbl

Compares UCM baselines

clearhistory

Displays histories of VOB objects

clearjoinproj

Enables you to join UCM projects

clearmrgman

Merges element versions

clearprojexp

UCM project browser

clearviewupdate

Updates snapshot views

xclearcase

Primary GUI

xcleardiff

Compares/merges element versions

UCM commands

Following is a summary of UCM commands:

chactivity

Modifies an activity

chbl

Changes a baseline

chfolder

Modifies a folder

chproject

Modifies a project

chstream

Modifies a stream

cleardiffbl

Starts the diffbl browser

clearjoinproj

Starts the Join Project Wizard

clearprojexp

Starts the Project Explorer

crmregister

Creates or changes HCL Compass user database connection information used by UCM operations originating on the local host

deliver

Delivers development stream changes to the integration stream

diffbl

Compares the contents of baselines or streams

lsactivity

Lists information about activities

lsbl

Lists information about baselines

lscomp

Lists information about components

lsfolder

Lists information about folders

lsproject

Lists information about projects

lsstream

Lists information about streams

mkactivity

Creates an activity

mkbl

Creates baselines

mkcomp

Creates a component

mkfolder

Creates folders

mkproject

Creates a project

mkstream

Creates a stream

rebase

Changes the configuration of a stream

rmactivity

Removes an activity

rmbl

Removes a baseline

rmcomp

Removes a component

rmfolder

Removes a folder

rmproject

Removes a project

rmstream

Removes a stream

setactivity

Specifies the current activity for your view

setplevel

Changes the list of promotion levels in a project VOB

Deployment management commands

Following is a summary of deployment management commands:

du_tool

Create and manage deployment units

Reference pages by user role

This section lists reference pages by user role: developer, software builder, project manager, and administrator.

Developer reference pages

apropos

catcs

cc.icon, default.icon

cc.magic, default.magic

cd

chactivity

chbl

checkin

checkout

chfolder

chproject

chstream

chview

clearbug

cleardescribe

cleardiff

clearhistory

clearjoinproj

clearmrgman

clearprojexp

clearprompt

cleartool

clearviewupdate

comments

config_spec

cptype

deliver

describe

diff

edcs

endview

env_ccase

file

find

fmt_ccase

get

getcache

help

ln

login

logout

ls

lsactivity

lsbl

lscheckout

lscomp

lsfolder

lshistory

lslock

lsprivate

lsproject

lsstream

lsview

lsvtree

man

merge

mkattr

mkdir

mkelem

mkhlink

mklabel

mkview

move

pathnames_ccase

profile_ccase

pwd

pwv

query_language

rebase

recoverview

reserve

rmattr

rmfolder

rmhlink

rmlabel

rmmerge

rmname

rmview

schemes

setactivity

setcs

setview

shell

startview

uncheckout

unreserve

update

version_selector

wildcards_ccase

xclearcase

xcleardiff

xmldiffmrg

Build-related reference pages

ant_ccase

catcr

clearaudit

clearmake

clearmake.options

diffcr

lsdo

makefile_ccase

makefile_gnu

makefile_sun

omake

rmdo

winkin

Project manager reference pages

annotate

chevent

chtype

cleardiffbl

diffbl

findmerge

mkactivity

mkattype

mkbl

mkbranch

mkbrtype

mkcomp

mkeltype

mkfolder

mkhltype

mklbtype

mkproject

mkstream

mktrigger

mktrtype

rmactivity

rmbl

rmbranch

rmcomp

rmelem

rmproject

rmstream

rmtrigger

rmtype

rmver

setplevel

type_manager

Administrator reference pages

checkvob

chflevel

chpolicy

chpool

chrolemap

clearexport_ccase

clearexport_cvs

clearexport_pvcs

clearexport_rcs

clearexport_sccs

clearexport_ssafe

clearfsimport

clearimport

clearlicense

config_ccase

cppolicy

cprolemap

credmap

creds

dospace

events_ccase

export_mvfs

exports_ccase

getlog

hostinfo

init_ccase

lock

lsclients

lspolicy

lspool

lsregion

lsrolemap

lssite

lsstgloc

lstype

lsvob

mkpolicy

mkpool

mkregion

mkrolemap

mkstgloc

mktag

mkvob

mount

mount_ccase

msdostext_mode

mvfsstorage

mvfsversion

permissions

promote_server

protect

protectvob

reformatview

reformatvob

register

relocate

rename

rgy_backup

rgy_check

rgy_passwd

rgy_switchover

rmpolicy

rmpool

rmregion

rmrolemap

rmstgloc

rmtag

rmvob

schedule

scrubber

setcache

setrgysvrtype

setsite

snapshot.conf

space

umount

unlock

unregister

view_scrubber

vob_sidwalk, vob_siddump

vob_restore

vob_scrubber

vob_snapshot

vob_snapshot_setup