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.
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.
Cleartool subcommands for base VersionVault and UCM
These commands are used by developers working in both base VersionVault and UCM.
help
Displays help on command usage

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.
    - cleartool
      VersionVault user-level commands (command-line interface)
    - Cleartool subcommands for base VersionVault and UCM
      These commands are used by developers working in both base VersionVault and UCM.
      - annotate
        Annotates lines of text file / time stamps, user names, and so on
      - catcs
        Displays the config spec of a view
      - cd
        Changes the current working directory
      - checkin
        Creates a permanent new version of an element
      - checkout
        Creates a modifiable copy of a version
      - chevent
        Changes the comment string in an event record
      - chtype
        Changes the type of an element or renames a branch
      - chview
        Changes properties of a view
      - cptype
        Makes a copy of an existing type object.
      - describe
        Describes an object
      - diff
        Compares versions of a text-file element or a directory.
      - edcs
        Edits the config spec of a view
      - endview
        Deactivates a view
      - 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
      - get
        Copies a file
      - getcache
        Displays cache information
      - help
        Displays help on command usage
      - hostinfo
        Displays configuration data for one or more hosts
      - 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.
      - ls
        Lists VOB-resident objects, elements loaded into a snapshot view, and view-private objects in a directory
      - lscheckout
        Lists checkouts of an element
      - lshistory
        Lists event records for VOB database objects
      - lslock
        Lists locks on objects
      - lsprivate
        Lists objects in a dynamic view's private storage area
      - lsview
        Lists view registry entries
      - lsvtree
        Lists version tree of an element
      - man
        Displays an online reference page
      - merge
        Merges versions of a text-file element or a directory
      - mkattr
        Attaches attributes to objects
      - mkattype
        Creates or updates an attribute type object
      - mkbranch
        Creates a new branch in the version tree of an element
      - mkbrtype
        Creates/updates a branch type object
      - mkdir
        Creates a directory element
      - mkelem
        Creates a file or directory element
      - mkeltype
        Creates or updates an element type object
      - 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
      - mktrigger
        Attaches a trigger to an element or UCM object
      - mktrtype
        Creates a trigger type object
      - mkview
        Creates and registers a view
      - move
        Moves or renames an element or VOB link
      - pwd
        Prints working directory
      - pwv
        Prints the working view
      - quit
        Quits an interactive session
      - recoverview
        Recovers a dynamic view database
      - rename
        Assigns a new name to an existing object
      - reserve
        Converts an unreserved checkout to reserved
      - rmattr
        Removes an attribute from an object
      - rmbranch
        Removes a branch from the version tree of an element
      - rmelem
        Removes an element or symbolic link from a VOB
      - 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
      - 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
      - setcs
        Sets the config spec of a view
      - setplevel
        Changes the list of promotion levels in a project VOB
      - setview
        Creates a process that is set to a dynamic view
      - shell
        Creates a subprocess to run a shell or other program
      - startview
        Starts or connects to the view_server process of a dynamic view or to the rview _agent of an automatic view
      - uncheckout
        Cancels a checkout of an element
      - unreserve
        Changes a reserved checkout to unreserved
      - update
        Updates elements in a snapshot view, web view or automatic view
      - xclearcase
        Primary VersionVault graphical interface utility
      - xcleardiff
        Compares or merges text files graphically
      - xmldiffmrg
        Parses, compares, and merges XML file versions
    - Cleartool subcommands for UCM
      Use these cleartool subcommands when working on a UCM project.
    - Cleartool subcommands for accessing replicated VOBs
      On a host where HCL VersionVault MultiSite is installed, you can use these commands when working with replicated VOBs.
    - Graphical user interfaces
      VersionVault provides several graphical user interfaces that you can start from the command line or from a shortcut.
    - Other commands
      These utility commands can be executed from any shell.
    - General information
      These reference topics provide general information about various features of HCL VersionVault.
  - 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.
- HCL VersionVault MultiSite command reference
  All commands for HCL VersionVault MultiSite, listed alphabetically.

help

Displays help on command usage

Applicability


Product	Command type
VersionVault	cleartool subcommand
MultiSite	multitool subcommand
VersionVault Remote Client	rcleartool subcommand


Platform
UNIX®
Linux®
Windows®

Synopsis

VersionVault, MultiSite, and VersionVault Remote Client—Display all usage messages:

h/elp
VersionVault, MultiSite, and VersionVault Remote Client—Display the usage message for a command:

h/elp command-name | command-name -help
VersionVault and MultiSite—Display the product documentation:

h/elp –g/raphical

Description

This command does not require a product license.

The help command displays a usage message for all cleartool or multitool subcommands, or for one particular subcommand. You can also use help as a command option. For example:

cmd-context lsco –help

Restrictions

None.

Options and arguments

–g/raphical: Invokes the product documentation (that is, the help system).

Examples

Display a usage message for the checkout command.
cmd-context help checkout
Usage: checkout | co [-reserved | -unreserved] [-out dest-pname | -ndata] [-branch branch-pname | -version] [-c comment | -cfile pname | -cq | -cqe | -nc] pname ...
Display a usage message for the checkout command using the –help option.
cmd-context checkout -help
Usage: checkout | co [-reserved | -unreserved] [-out dest-pname | -ndata] [-branch branch-pname | -version] [-c comment | -cfile pname | -cq | -cqe | -nc] pname ...
(VersionVault on UNIX® or Linux®) Display a usage message for all cleartool commands, and redirect the output to a file for future reference.
cmd-context help > cleartool_cmd_summary

See also

cleartool, man, and in the MultiSite command reference, the multitool command.

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.