The following files are in this distribution archive:

README

  This file.

LICENSE

  The CCVS software license agreement.  Please read this before installing 
  the software.

CHANGES

  A list of the changes in the various versions of the software.

ccvs_install

  Run this program to install the software.  Please read the documentation
  before running this program.

setup.txt

  A worksheet which covers all the information required to configure CCVS. 

ccvs-3.2.tar

  This contains all the software that is installed as part of the CCVS
  base install.  It includes everything listed below:

--------------------------------------------

bin

  This subdirectory contains the user-level programs which communicate
  with CCVS.

cvcli

  (In the bin subdirectory.)
  This is the CLI version of CCVS.  Documentation for it is available
  in man/man1/cvcli.1, and in the main documentation.

cvbatch, cvlist, cvstatus, cvdelete, cvreport

  (In the bin subdirectory.)
  Other CLI utilities.

sbin

  This subdirectory contains administrative CCVS programs, including the
  CCVS daemon.

lib

  The lib subdirectory contains runtime libraries for CCVS and the various
  language interfaces (TCL, Python, etc)

libccvs.a

  (In the lib subdirectory.)
  This is the CCVS C API, in a form suitable for statically linking.

ccvs.so

  (In the lib/tcl subdirectory.)
  This is the CCVS TCL API.  You can use it via the TCL "load" command,
  if your installation of TCL supports dynamic loading of modules.
  Just give the full pathname of the ccvs.so file as the argument to the
  load command, and you're ready to go.

ccvsmodule.so

  (In the lib/python subdirectory.)
  This is the CCVS Python API.  The documentation explains how to use it.

include

  The include subdirectory contains header files for CCVS libraries.

cv_api.h

  (In the include subdirectory.)
  This is a C header file making the neccesary declarations for the C API.

man

  The man subdirectory contains manual pages and documentation.

ccvs.3, ccvs.3.ps

  (In the man subdirectory.)
  This is the man page for the CCVS C API.  If you install it in a
  place where your copy of man can find it, you can read it via "man ccvs";
  otherwise, you can read it by "nroff -man ccvs.3 | more".  The file
  ccvs.3.ps is the same document in PostScript form, suitable for
  printing to a PostScript printer or viewing with a PostScript viewer.

src

  The src subdirectory contains the source code for some example programs
  that show how to use CCVS.  The C source for the CLI is included, as
  well as other files.  In version 3.1, the PHP3 and Perl modules are
  distributed as source code, in the src/php3 and src/perl directories.

src/perl

  This is the CCVS Perl API.  Because of the way different sites install
  Perl, it needs to be rebuilt and installed on the machine where it will
  be used.  From this directory, with Perl in your path, execute the
  following commands:
    1) perl Makefile.PL
    2) make
  To install it, as root do
    3) make install


--------------------------------------------

Note to users of CCVS version 2.x:

If you are upgrading from version 2.1.8 or earlier, it is vitally important
that you clear out your existing transactions with the older software.  We
can't bear any responsibility for problems caused by not adhering to this
advice. Starting at version 3.0, the data format used by the system has
changed in an incompatible way. When the system finds data that's not in
the correct format, its behavior can be unpredictable.

If you're upgrading from version 3.0 or later, you do not need to clear out
your existing transactions. The data format is compatible.

If you're having problems with your pre-3.0 version of the software and
feel you need to use a newer version to clear out the existing
transactions, please upgrade to 2.1.8.  This version has no known
outstanding bugs and is compatible with all 2.1 subversions.  Only when
there are no remaining transactions in the system should you upgrade to
3.2.  (Beta testers must clear out their data with the beta version they're
using -- beta versions aren't guaranteed to be compatible with any other
versions.)

--------------------------------------------


HKS, Inc.
2732 Murray Avenue Pittsburgh, PA 15217
Phone: (412) 521-2551, Fx. (412) 521-2994 
Web: <http://www.hks.net/>
Email: <support@hks.net>

-- 
$Id: README,v 1.15 1999/06/30 21:13:28 ddj Exp $
