multitool

• Single-command mode:

  multitool

  subcommand [ options/args ]

• Interactive mode:

  multitool

  [ –e ]

  multitool> subcommand [ options/args ] . . .

  multitool> quit

• Status mode:

  multitool

  –status

  multitool 1> subcommand [ options/args ] . . .

  multitool 5> quit

• Display version information for multitool (and on Linux® and the UNIX® system, HCL VersionVault MultiSite):

  multitool

  –ver/sion

• Display version information for multitool and the libraries used by multitool (and on Linux® and the UNIX® system, HCL VersionVault MultiSite):

  multitool

  –VerAll

multitool is the principal program in HCL VersionVault MultiSite. Typically, you also use HCL VersionVault MultiSite extensions incorporated into cleartool subcommands in HCL VersionVault.

The different multitool subcommands are described in Help.

With –e, multitool enters interactive mode. multitool exits if an error is returned by a command.

With –status, multitool enters interactive mode and returns the status (0 or 1) of each multitool subcommand executed.

If you exit multitool by entering a quit command in interactive mode, the exit status is 0. The exit status from single-command mode depends on whether the command succeeded (zero exit status) or generated an error message (nonzero exit status).

In multitool commands, you specify non-file system VOB objects (types, pools, hyperlinks, and replicas) with object selectors.

Object selectors identify these VOB objects with a single string:

[prefix:]name[@vob-selector]

where

prefix

The kind of object. The prefix is optional if the context of the command implies the kind of object. For example, multitool lsreplica replica:buenosaires is equivalent to multitool lsreplica buenosaires.

If a context does not imply any particular kind of object, multitool assumes that a name argument with no prefix is a pathname. For example, the command multitool describe buenosaires describes a file system object named buenosaires, while multitool describe replica:buenosaires describes the buenosaires replica object.

name

The name of the object. See the Object names section for the rules about composing names.

vob-selector

VOB pathname. If you omit vob-selector, the default is the current working directory unless the reference page specifies otherwise. Specify vob-selector in the form [vob:]pname-in-vob (for some commands, the vob: prefix is required)

pname-in-vob

Pathname of the VOB tag (whether or not the VOB is mounted) or of any file system object within the VOB (if the VOB is mounted)

Each change to a VOB is recorded in an event record in the VOB database. Many multitool commands include options you can use to include a comment string in the event record created by the command. Commands that display event record information (describe, lsepoch, lspacket, lsreplica, lstype) show the comments. See the fmt_ccase reference page in the VersionVault Command Reference for a description of the report-writing facility built in to these commands.

Commands that accept comment strings recognize one or more of the following options:

–c/omment comment

Specifies a comment for all event records created by the command. The comment string must be a single command-line token; typically, you must enclose it in double quotation marks.

–cfi/le comment-file-pname

Specifies a text file whose contents are to be placed in all event records created by the command.

Note: A final line terminator in this file is included in the comment.

–cq/uery

Prompts for one comment, to be placed in all the event records created by the command.

–cqe/ach

For each object processed by the command, prompts for a comment to be placed in the corresponding event record.

–nc/omment

For each object processed by this command, creates an event record with no comment string.

A –cq or –cqe comment string can span several lines. To end a comment, enter an EOF character at the beginning of a line, by typing a period character ( . ) and pressing ENTER, by typing CTRL+D on Linux® and the UNIX® system, or by typing CTRL+Z+ENTER on Windows®. For example:

cleartool checkout main.c


Checkout comments for "main.c": This is my comment; the following line
terminates the comment..Checked out "main.c" from version "\main\3"

The cleartool chevent command revises the comment string in an existing event record. For more information about event records, see the events_ccase reference page in the VersionVault Command Reference.