Welcome
Administering
Learn how to administer the product.
Administering Rational® ClearQuest® Multisite
Administering Rational® ClearQuest® Multisite
MultiSite command set
This section summarizes the commands for DevOps ClearCase® MultiSite and DevOps ClearCase that display DevOps Code ClearCase MultiSite information. There are a series of MultiSite commands and API functions that display or modify MultiSite information.
MultiSite reference pages
The MultiSite command set is vital to creating and administering a MultiSite environment.
man
Displays an online reference page

IBM ClearQuest 10.0.9
Overview
Learn general information about the product.
Installing
Learn how to install the product.
Upgrading and migrating
Learn how to upgrade and migrate data for the product.
Administering
Learn how to administer the product.
- Administering Rational® ClearQuest®
  Learn how to administer the Rational® ClearQuest®.
- Administering Rational® ClearQuest® Web
  This section discusses how to administer Rational® ClearQuest® Web.
- Administering Rational® ClearQuest® Multisite
  Administering Rational® ClearQuest® Multisite
  - Introduction
    and Rational® ClearQuest® MultiSite add a powerful capability to and Rational ClearQuest. With MultiSite, developers at different locations can use the same versioned object base (VOB) or Rational ClearQuest database set (a schema repository and its associated user databases). For Rational ClearQuest, each location has its own copies, or replicas, of the schema repository and user databases. At any time, changes made in one replica can be sent in update packets to other replicas. You can manage replicas by using the command-line tools.
  - Implementation planning
    Before you install and use DevOps Code ClearCase®DevOps ClearQuest® MultiSite, you need to plan your implementation.
  - Packet transportation methods and configuration
    The method you choose for transporting packets between replicas depends on connectivity. If your replicas do not have IP connectivity, you must use a file-based transport method. If your replicas have connectivity, you can use the store-and-forward facility.
  - Database replica creation
    Creating your database replicas requires careful planning and consideration part of which involves making decisions about mastership and methods of packet delivery.
  - Replica synchronization
    Replica synchronization uses the same export-transport-import procedure that is used during replica creation.
  - Database replicas administration
    Sustaining a smoothly functioning MultiSite environment requires dedicated administration. Many administrative processes can drastically change your environment and require careful consideration and planning.
  - Mastership management
    The management of mastership affects how database objects are accessed and manipulated by users in your MultiSite environment. Mastership management is an ongoing process as new objects are entered into the database and users' requirements change.
  - Troubleshoot MultiSite operations
    There are common situations in which running a Rational® ClearQuest® MultiSite command produces an unexpected result, sometimes accompanied by a warning or error message.
  - MultiSite command set
    This section summarizes the commands for DevOps ClearCase® MultiSite and DevOps ClearCase that display DevOps Code ClearCase MultiSite information. There are a series of MultiSite commands and API functions that display or modify MultiSite information.
    - multiutil command use
      You can use the multiutil command to perform operations on replicas.
    - Replica creation, synchronization, and management commands
      The commands in this topic create new replicas, change replica characteristics, and synchronize replicas, and display replica-related information.
    - Object mastership commands
      The commands in this topic are used to manage mastership.
    - Failure-recovery commands
      The commands in this topic are used to work with epoch numbers.
    - Additional MultiSite commands
      The MultiSite commands that are not multitool or multiutil subcommands are listed in this topic. These commands are located under the installation directory for DevOps ClearCase®.
    - MultiSite API functions
      You can use API functions in hooks and external applications to determine whether you are working with a replicated database and whether your current replica masters the record or object you want to modify.
    - MultiSite reference pages
      The MultiSite command set is vital to creating and administering a MultiSite environment.
      - activate
        Prepares a database set to be replicated
      - chepoch
        Changes epoch number estimates
      - chmaster
        Transfers mastership of an object
      - chreplica
        Changes the properties of replicas in a site
      - control_panel
        Sets the e-mail parameters for Rational® ClearQuest® Shipping Server e-mail notification on Windows™
      - deactivate
        Returns the last replica in a clan to a nonreplicated state
      - describe
        Lists the master replica of an object
      - dumpoplog
        Lists the contents of a replica's operation log
      - idblockinfo
        Lists information about the existing ID blocks for a replica family.
      - lsepoch
        Lists epoch information
      - lspacket
        Describes contents of a packet
      - lsreplica
        Lists database replicas
      - man
        Displays an online reference page
      - mkorder
        Creates a shipping order for use by the store-and-forward facility
      - mkreplica
        Creates a replica
      - MultiSite Control Panel
        Configures store-and-forward facility
      - multiutil
        MultiSite user-level commands
      - recoverpacket
        Resets epoch number matrix so that changes in lost packets are resent
      - renamesite
        Renames the site specified by oldsitename to newsitename
      - repair
        Displays or deletes entries from the ratl_uuid table of a replica
      - restorereplica
        Replaces missing operations in a replica that has been restored from backup
      - rmreplica
        Deletes a replica
      - scruboplog
        Deletes oplog entries for a replica
      - shipping.conf
        Store-and-forward configuration file
      - shipping_server
        Store-and-forward packet transport server
      - syncreplica
        Exports or imports update packets
Reporting
Learn how to generate reports for the product.
Developing
Learn how to develop schemas by using the Rational® ClearQuest® Designer.
Managing change and releases
Learn how to manage change and release in the product.
Integrating
You can integrate Rational® ClearQuest® with other software by adding packages to existing schema.
Extending product function
Learn how to extend the product.
Reference
Review reference information for the product.
Tutorials

man

Displays an online reference page

Applicability


Product	Command type
MultiSite	multitool subcommand multiutil subcommand


Platform
UNIX™

Synopsis

Display a reference page (UNIX™):

man [ –g/raphical ] [ command_name ]

Description

This command displays a reference page. The documentation that is displayed depends on the command context. This command does not require a product license.

Displaying reference pages

The man command displays a specified online reference page in ASCII format. For multiutil subcommands, you can use any valid command abbreviation or alias. For example:


`cmd-context` `man lsreplica`	Full command name
`cmd-context` `man lsrep`	Abbreviation
`cmd-context` `man lsrp`	Alias

UNIX™: Using MANPATH

Reference pages are stored in subdirectories of cquest-home-dir/doc/man. The man subcommand modifies the environment to include a MANPATH variable set to this directory. It then executes the UNIX™ man(1) command in a subprocess. Thus, the shell from which you invoke cleartool need not have MANPATH set.

However, if you want to use UNIX™ man directly, without going through multitool, include cquest-home-dir/doc/man in your MANPATH. For example:

setenv MANPATH /usr/catman:/usr/man:/opt/rational/clearquest/doc/man

With UNIX™ man, you must match the reference page file name. The file names of multiutil subcommands have mu_ prefixes.


`%` `man mu+describe`	Correct
`%` `man describe`	Incorrect (cleartool subcommand)

UNIX™: Changing the default HTML browser

To change the default HTML browser, use the environment variables CCASE_WEBSCRIPT, CCASE_NETSCAPE, and CCASE_NETSCAPE_OPT. For more information, see xcleardiff.

Restrictions

None.

Options and arguments

Format of reference page display

Default: ASCII
–g/raphical: Starts an HTML browser to display the reference page.

Specifying the reference page

Default: The overview reference page for the product.
command_name: The name (or abbreviation or alias) of a multiutil subcommand; or the name of any other product reference page.

Examples

Display the reference page for the mkreplica command.
cmd-context man mkreplica
Display the reference page for the describe command as HTML on a UNIX™ system.
cmd-context man –graphical describe