Home
Reference
Review reference information for the product.
HCL VersionVault command reference
HCL VersionVault and HCL VersionVault MultiSite provide a command-line interface that enables access to all product functions. The command line processor supports interactive use, and can also be driven by various scripting languages.
Alphabetical list of all commands
All commands, listed alphabetically.
apropos
Displays command summary information

Reference
Review reference information for the product.
- HCL VersionVault command reference
  HCL VersionVault and HCL VersionVault MultiSite provide a command-line interface that enables access to all product functions. The command line processor supports interactive use, and can also be driven by various scripting languages.
  - Commands for developing software
    These commands are used by software developers and others who work with resources that are under HCL VersionVault control. Most of the cleartool commands used by developers who use the VersionVault local client are also available as rcleartool commands for users of the VersionVault remote client.
  - Commands for building software (base VersionVault and UCM)
    These commands are useful for building software, especially in a dynamic view.
  - Administrator Commands (base VersionVault and UCM)
    These commands are used by VersionVault administrators or any user who performs administrative tasks.
  - Commands for managing software development projects (base VersionVault and UCM)
    These commands are used by VersionVault project managers, who establish the development policies for software projects.
  - Alphabetical list of all commands
    All commands, listed alphabetically.
    - intro
      Introduction to the reference pages for HCL VersionVault and HCL VersionVault MultiSite
    - annotate
      Annotates lines of text file / time stamps, user names, and so on
    - ant_ccase
      Using HCL VersionVault to audit Jakarta Ant build processes
    - apropos
      Displays command summary information
    - catcr
      Displays configuration record created by clearmake, omake (Windows® only), or clearaudit
    - catcs
      Displays the config spec of a view
    - cc.icon, default.icon
      File type to icon mapping rules (graphical interface)
    - cc.magic, default.magic
      File-typing rules
    - cd
      Changes the current working directory
    - chactivity
      Changes an activity
    - chbl
      Changes a baseline
    - checkin
      Creates a permanent new version of an element
    - checkout
      Creates a modifiable copy of a version
    - checkvob
      Finds and fixes inconsistencies within and between VOBs
    - chevent
      Changes the comment string in an event record
    - chflevel
      Raises the feature level of a VOB
    - chfolder
      Modifies a UCM folder
    - chmaster
      Transfers mastership of an object
    - chpolicy
      Changes the definition of a policy
    - chpool
      Changes the storage pool to which an element is assigned
    - chproject
      Modifies a UCM project or project template
    - chrolemap
      Changes the contents of a rolemap
    - chstream
      Modifies a UCM stream
    - chtask
      Changes the tasks that are associated with a version (base VersionVault).
    - chtype
      Changes the type of an element or renames a branch
    - chview
      Changes properties of a view
    - clearaudit
      Non-clearmake build and shell command auditing facility for dynamic views
    - clearbug
      Creates problem report for HCL Customer Support
    - cleardescribe
      Lists or changes the properties of an object graphically
    - cleardiff
      Compares or merges text files
    - cleardiffbl
      Starts the diffbl browser
    - clearexport_ccase
      Copies VersionVault data to a different VOB
    - clearexport_cvs
      Converts CVS files to elements
    - clearexport_pvcs
      Converts PVCS files to elements
    - clearexport_rcs
      Converts RCS files to elements
    - clearexport_sccs
      Converts SCCS files to elements
    - clearexport_ssafe
      Converts SourceSafe files to elements
    - clearfsimport
      Converts file system objects to element versions
    - clearhistory
      Shows event records for VOB database objects graphically
    - clearimport
      Reads data files created by clearexport tools and imports elements into a VOB
    - clearjoinproj
      Starts the UCM Join Project wizard
    - clearlicense
      Monitors and controls the product license database
    - clearmake
      VersionVault build utility
    - clearmake.options
      clearmake build options specification (BOS) file
    - clearmrgman
      Manages the merging of versions graphically
    - clearprojexp
      Starts the UCM Project Explorer
    - clearprompt
      Prompts for user input
    - cleartool
      VersionVault user-level commands (command-line interface)
    - clearviewupdate
      Updates elements in a snapshot view
    - clmutil
      CMI administration tool
    - cmi_migrate.pl
      Generate a file of element versions that require CMI task associations
    - cmiregister
      Manages task-provider user credentials
    - comments
      Event records and comments
    - config_ccase
      VersionVault configuration
    - config_spec
      Rules for selecting versions of elements to appear in a view
    - cppolicy
      Copies a policy
    - cprolemap
      Copies a rolemap
    - cptype
      Makes a copy of an existing type object.
    - credmap
      Displays username/UID and group name/GID on Windows®, UNIX®, and Linux®
    - creds
      Displays user and group information
    - crmregister
      Create, change, or list HCL Compass user database connection information used by UCM operations that originate on the local host.
    - deliver
      Delivers changes in a source stream to the target stream within or across projects
    - describe
      Describes an object
    - diff
      Compares versions of a text-file element or a directory.
    - diffbl
      Compares the contents of baselines or streams
    - diffcr
      Compares configuration records created by clearmake, omake, or clearaudit
    - disconnect
      Disconnect an HCL VersionVault Remote Client interactive session from the VersionVault WAN server.
    - dospace
      Reports on VOB disk space used for shared derived objects
    - du_tool
      Create and manage deployment units
    - edcs
      Edits the config spec of a view
    - endview
      Deactivates a view
    - env_ccase
      Environment variables
    - events_ccase
      Operations and event records
    - export_mvfs
      Exports and unexports VOBs to NFS clients (non-VersionVault access)
    - exports_ccase
      List of VOBs to be accessed by non-VersionVault hosts
    - file
      Displays the element type that VersionVault would use for a file
    - find
      Uses a pattern, query, or expression to search for objects
    - findmerge
      Searches for versions that require a merge; optionally, performs merge
    - fmt_ccase
      Format strings for command output
    - gdmcancel
      Cancels checkouts
    - gdmci
      Checks in files and registers unmanaged files
    - gdmco
      Checks out files
    - gdmdelete
      Removes the name of an element from a directory version
    - gdmexport
      Exports the contents of a cell view to a directory
    - gdmhistory
      Lists the history of an element
    - gdmsetdefver
      Rolls back element versions
    - gdmstatus
      Returns the status of files
    - get
      Copies a file
    - getcache
      Displays cache information
    - getlog
      Displays UNIX® and Linux® log files or Windows® log entries
    - help
      Displays help on command usage
    - hijack
      Hijacks file elements
    - hostinfo
      Displays configuration data for one or more hosts
    - init_ccase
      Startup and shutdown script
    - ln
      Creates VOB hard link or VOB symbolic link
    - login
      Logs on to the VersionVault Remote Client.
    - logout
      Log out from a VersionVault Remote Client interactive session.
    - lock
      Locks an object
    - ls
      Lists VOB-resident objects, elements loaded into a snapshot view, and view-private objects in a directory
    - lsactivity
      Lists information about UCM activities
    - lsbl
      Lists information about a baseline
    - lscheckout
      Lists checkouts of an element
    - lsclients
      Displays the client host list for a VersionVault license or registry server host
    - lscomp
      Lists information about a component
    - lsdo
      Lists derived objects created by clearmake, omake, or clearaudit (dynamic views only)
    - lsfolder
      Lists information about folders
    - lshistory
      Lists event records for VOB database objects
    - lslock
      Lists locks on objects
    - lsmaster
      Lists objects mastered by a replica
    - lspolicy
      Lists policies
    - lspool
      Lists VOB storage pools
    - lsprivate
      Lists objects in a dynamic view's private storage area
    - lsproject
      Lists information about a project
    - lsprovider
      Lists change management providers
    - lsregion
      Lists VersionVault network regions
    - lsreplica
      Lists VOB replicas
    - lsrolemap
      Lists rolemaps
    - lsserver
      Lists VersionVault WAN servers
    - lssite
      Lists site-wide default properties
    - lsstgloc
      Lists view and VOB server storage locations
    - lsstream
      Lists information about one or more streams
    - lstask
      Lists the default tasks that are associated with a view (base VersionVault).
    - lstype
      Lists a VOB's type objects.
    - lsview
      Lists view registry entries
    - lsvob
      Lists VOB registry entries
    - lsvtree
      Lists version tree of an element
    - makefile_ccase
      makefiles processed by clearmake
    - makefile_gnu
      clearmake compatibility with GNU make
    - makefile_sun
      clearmake compatibility with SunOS 5.x (Solaris) make
    - man
      Displays an online reference page
    - mecleardiffmerge
      Compares or merges text files that are in different character encodings
    - merge
      Merges versions of a text-file element or a directory
    - mkactivity
      Creates an activity
    - mkattr
      Attaches attributes to objects
    - mkattype
      Creates or updates an attribute type object
    - mkbl
      Creates a baseline or set of baselines
    - mkbranch
      Creates a new branch in the version tree of an element
    - mkbrtype
      Creates/updates a branch type object
    - mkcmprovider
      Configures a change management task provider
    - mkcomp
      Creates a component object
    - mkdir
      Creates a directory element
    - mkelem
      Creates a file or directory element
    - mkeltype
      Creates or updates an element type object
    - mkfolder
      Creates a folder for a project
    - mkhlink
      Attaches a hyperlink to an object
    - mkhltype
      Creates or updates a hyperlink type object
    - mklabel
      Attaches version labels to versions of elements
    - mklbtype
      Creates or updates a label type object
    - mkpolicy
      Creates or updates a policy
    - mkpool
      Creates a VOB storage pool or modifies its scrubbing parameters
    - mkproject
      Creates a project or project template
    - mkregion
      Registers a new VersionVault network region
    - mkrolemap
      Creates or updates a rolemap object
    - mkstgloc
      Creates a server storage location for views or VOBs
    - mkstream
      Creates a stream or stream template for a project
    - mktag
      Creates a tag for a view or VOB
    - mktrigger
      Attaches a trigger to an element or UCM object
    - mktrtype
      Creates a trigger type object
    - mkview
      Creates and registers a view
    - mkvob
      Creates and registers a versioned object base (VOB)
    - mount
      Activates a VOB at its VOB tag directory
    - mount_ccase
      Mount and unmount commands for VOBs and the viewroot directory
    - msdostext_mode
      Enables or disables a VOB's interop text mode support
    - move
      Moves or renames an element or VOB link
    - mvfsstorage
      Lists data container path name for MVFS file
    - mvfsversion
      Displays MVFS version string
    - omake
      VersionVault build utility: Maintains, updates, and regenerates groups of programs
    - pathnames_ccase
      Path name resolution, dynamic view context, and extended namespace
    - permissions
      Identity checking
    - profile_ccase
      cleartool user profile: .versionvault_profile
    - promote_server
      Changes storage location of derived object data container
    - protect
      Changes permissions or ownership of a VOB object
    - protectvob
      Changes various properties of a VOB
    - pwd
      Prints working directory
    - pwv
      Prints the working view
    - query_language
      Selects objects by their metadata
    - quit
      Quits an interactive session
    - rcleartool
      VersionVault Remote Client user-level commands
    - rebase
      Changes the configuration of a stream
    - recoverview
      Recovers a dynamic view database
    - reformatview
      Updates the format of a view database
    - reformatvob
      Reformats a VOB database
    - register
      Creates an entry in the VOB or view object registry
    - relocate
      Moves elements and directory trees from one VOB to another
    - rename
      Assigns a new name to an existing object
    - reqmaster
      Sets access controls for mastership requests, or requests mastership of a branch or branch type
    - reserve
      Converts an unreserved checkout to reserved
    - rgy_backup
      Copies registry files and client list from primary registry server host to backup registry server host
    - rgy_check
      Check registry files for inconsistencies
    - rgy_passwd
      Creates or changes encrypted VOB tag registry password
    - rgy_switchover
      Makes a backup registry server host the primary registry server host
    - rmactivity
      Deletes an activity
    - rmattr
      Removes an attribute from an object
    - rmbl
      Removes a baseline
    - rmbranch
      Removes a branch from the version tree of an element
    - rmcomp
      Removes a component
    - rmdo
      Removes a derived object from a VOB
    - rmelem
      Removes an element or symbolic link from a VOB
    - rmfolder
      Remove a folder
    - rmhlink
      Removes a hyperlink object
    - rmlabel
      Removes a label from a version
    - rmmerge
      Removes a merge arrow from an element's version tree
    - rmname
      Removes the name of an element or VOB symbolic link from a directory version
    - rmpolicy
      Lists policies
    - rmpool
      Removes a VOB storage pool
    - rmproject
      Removes a project or project template
    - rmprovider
      Deletes change management providers
    - rmregion
      Unregisters a VersionVault network region
    - rmrolemap
      Removes rolemaps
    - rmstgloc
      Removes registry entries for server storage locations
    - rmstream
      Removes a stream
    - rmtag
      Removes a view tag or a VOB tag from the networkwide storage registry
    - rmtrigger
      Removes trigger from an element or UCM object
    - rmtype
      Removes a type object from a VOB
    - rmver
      Removes a version from the version tree of an element
    - rmview
      Removes a view or removes view-related records from a VOB
    - rmvob
      Removes a VOB storage directory
    - schedule
      Schedules and manages jobs to be run one or more times
    - schemes
      X Window System resources for VersionVault Graphical User Interfaces (GUIs)
    - scrubber
      Removes data containers from VOB storage pools and removes DOs from VOB database
    - set
      Sets VersionVault WAN server preferences
    - setactivity
      Sets or unsets the activity for a view
    - setcache
      Changes cache settings
    - setcs
      Sets the config spec of a view
    - setplevel
      Changes the list of promotion levels in a project VOB
    - setrgysvrtype
      Provides a simple mechanism to configure registry server type on a local host
    - setsite
      Sets or unsets site-wide properties in the site config registry
    - settask
      Associates change-management tasks with views (base VersionVault).
    - setview
      Creates a process that is set to a dynamic view
    - shell
      Creates a subprocess to run a shell or other program
    - snapshot.conf
      VOB snapshot configuration file
    - space
      Reports on disk space use for views, VOBs, or file-system files or directories
    - startview
      Starts or connects to the view_server process of a dynamic view or to the rview _agent of an automatic view
    - type_manager
      Manages contents of element versions
    - umount
      Deactivates a VOB
    - uncheckout
      Cancels a checkout of an element
    - unhijack
      Unhijacks file elements
    - unlock
      Unlocks an object
    - unregister
      Removes an entry from the vob_object or view_object registry
    - unreserve
      Changes a reserved checkout to unreserved
    - update
      Updates elements in a snapshot view, web view or automatic view
    - utfxxcleardiffmerge
      Compares or merges Unicode Transformation Format files
    - version_selector
      Version-selector syntax
    - view_scrubber
      Remove derived object data containers from dynamic view storage
    - vob_restore
      Restores a VOB from backup media
    - vob_scrubber
      Remove event records, oplog entries, or both from VOB database
    - vob_sidwalk, vob_siddump
      Reads or changes security identifiers in a schema version 54 or schema version 80 VOB database
    - vob_snapshot
      Copies the VOB databases of all local VOBs or replicas configured for database snapshot
    - vob_snapshot_setup
      Sets or displays VOB database snapshot parameters
    - wildcards_ccase
      Pattern-matching characters for VersionVault pathnames
    - winkin
      Accesses one or more derived objects (DOs) from a dynamic view, or converts a nonshareable derived object to a shareable (promoted) derived object
    - xclearcase
      Primary VersionVault graphical interface utility
    - xcleardiff
      Compares or merges text files graphically
    - xmldiffmrg
      Parses, compares, and merges XML file versions
- HCL VersionVault MultiSite command reference
  All commands for HCL VersionVault MultiSite, listed alphabetically.

apropos

Displays command summary information

Applicability


Product	Command type
VersionVault	cleartool subcommand
MultiSite	multitool subcommand


Platform
UNIX®
Linux®

Synopsis

Extract information from the whatis file:

apr/opos topic ...

Description

This command does not require a product license.

The apropos command extracts information from the product-specific whatis file in versionvault-home-dir/doc/man/. Use apropos as you use the UNIX® or Linux® whatis(1) or apropos(1) command.

Restrictions

None.

Options and arguments

Default: A lookup is performed in the whatis file.
topic ...: apropos makes a separate search for each topic character string in the standard whatis file. The string can occur anywhere within the line.

Examples

Search for lines with the string reserve in the whatis file.
cleartool apropos reserve
reserve Convert an unreserved checkout to reserved unreserve Change a reserved checkout to unreserved
Search for lines with the string epoch in the MultiSite whatis file.
multitool apropos epoch
chepoch change epoch information lsepoch display epoch information

Files

versionvault-home-dir/doc/man/cc_whatis
versionvault-home-dir/doc/man/ms_whatis

See also

Have feedback?
Google Analytics is used to store comments and ratings. To provide a comment or rating for a topic, click Accept All Cookies or Allow All in Cookie Preferences in the footer of this page.