PVCS tools support readme file

General information

    This readme covers support for PVCS command line tools in Together.

    Support for PVCS tools is introduced in Together build 822 and is currently
    only available on Win32 platform.

    The latest version of script implementing support with PVCS tools was tested
    with PVCS VM 6.5 running on Windows NT 4.0 SP 5.

Known problems

    PVCS locks are not recognized. Together figures out if file is checked in or
    out ONLY based on its read-only status. That is, if a writable file is
    recognized as being under version control, it assumed to be checked out. On
    the other hand, a read-only file under version control is always assumed to
    be checked in. Recognition of locks will be added in further versions.

    At startup time the path to PVCS database is checked. If the directory does
    not exist, the script goes to uninitialized state and one has to restart
    Together in order to make it working. This is a known problem and will be
    fixed soon.

    Advanced options to PVCS tools must be set using Options dialog, though it
    is not very convenient. Further versions will include ability to specify
    additional options to most of version control commands.

Setting up Together to use PVCS tools

    The license must allow using Version Control.

    In Options dialog go to "Version Control" tab and select "PVCS Tools" from
    drop-down listbox "Use".

    Set path to your PVCS database directory in PVCS Database (visible after
    expanding "PVCS Tools" option). By default the value points to
    "c:\Program files\PVCS\VM\SampleDb" which is also default value for PVCS.

    The default archive suffix is set to "-arc", which may be changed, for
    example, if you are using "v" as default suffix.

    Further are the specifications for PVCS commands used by Together to operate
    with repository. You may want to add some options or specify the full path
    to all commands, in case your PVCS tools are not on PATH. By default it is
    assumed that all tools are on system PATH.

    These commands are used by Together for version control tasks:

        PUT - used for Add and CheckIn
        GET - used for Get and CheckOut (with -l parameter)
        VLOG - used to get History and Details
        VDIFF - used to get difference with latest revision in repository
        VDEL - used to remove file from repository
        VCS - used to test if PVCS tools are on PATH. It is executed at startUp
              time, and if command couldn't be executed, the script does not
              function.

Specifying PVCS project in Together Project Properties dialog

    When in Project Properties dialog - either with new project, or having
    already opened one - click on "Version Control project" checkbox to have
    PVCS project be associated with currently selected root. By default, the
    short name of root directory is used as proposed PVCS project.

    Press "Select" button to see the list of available projects in the
    repository. Please note, that Together internally adds "archive" suffix to
    the path entered in options dialog, so you don't have to specify it
    explicitly.

Using PVCS within Together project

    After Together has opened a project which contains roots associated with
    Version Control projects, a group of commands is added to each element's
    context menu.

    Short summary of commands:

        Add - adds file(s) to repository
        Get - get latest version of file(s) from repository
        CheckIn - put local file(s) to repository and optionally unlock
        CheckOut - get latest version from repository and lock
        System - displays dialog with further information about files

    Within System dialog additional operations are available:

        Diff - shows the result of VDIFF command with local file and latest
                version in repository
        History - shows the history of revisions, result of VLOG with -br parameter
        Details - detailed information about file: locks, revisions etc.
                The information is the output of command VLOG with -b parameter.
