$Id: README,v 1.4 1999/06/17 19:46:43 pcharles Exp $

                          net.ultrametrics.qcvs


What is it?

  net.ultrametrics.qcvs is a set of classes for representing, 
  manipulating and querying RCS or CVS repositories.

  ultrametrics.qcvs.Browser is a console utility for browsing RCS or CVS 
  source repositories. It supports more elaborate and powerful queries 
  than are possible using the standard CVS client.

  The tool generates reports of modifications by author or module 
  over time. The resulting reports can be imported into any
  graphing or scientific visualization tool which supports the import 
  of ascii-delimited data.

  
BUILDING

  If you have the ultrametrics and fooware jar distributions, you shouldn't 
  have to build anything. Simply make sure the jars are in your CLASSPATH.

  If you are building from source, make sure you have the 
  net.ultrametrics packages checked out and in your CLASSPATH. 
  In addition, you'll need com.fooware.util. 

  From the ultrametrics/qcvs directory type:
         make


RUNNING

  To start the browser in console mode, run:

    java -cp "classes_net.ultrametrics.jar;classes_com.fooware.jar" \
      net.ultrametrics.qcvs.Browser

  or, if you have the required jars or classes in your CLASSPATH, simply:

    java net.ultrametrics.qcvs.Browser


  To see supported commands, use the command 'help'.

  A typical session might look like the following. In this session, the user 
  locates his CVSROOT, loads two modules, lists the authors of those modules
  then generates a histogram of changes by year.
   
   /user/dl/>java -cp "classes_net.ultrametrics.jar;classes_com.fooware.jar" \
             -D net.ultrametrics.qcvs.Interrogator.majorKey=path \
             net.ultrametrics.qcvs.Browser

    [major interrogation key is 'author']
    /user/dl~ cd /home/cvs

    /home/cvs~ ls
	bin
	java
	www
	etc
      1.2      +10 -1     pcharles  Thu May 20 09:00:14 MDT 1999  release.log,v
	CVSROOT

    /home/cvs~ load bin etc
      searching for RCS objects in 2 locations
        /home/cvs/bin..........
        /home/cvs/etc.....
      fetched 15 objects in 280ms.
      added 15 new objects to set. 15 unique are loaded.

    /home/cvs~ show authors
      [cheetham, pcharles, guest]

    /home/cvs~ show year
                          bin         etc
                          lines       lines
    1997                  1784        310
    1998                  23450       950
    1999                  6509        38