<document>
    <properties>
        <title>Introduction</title>
    </properties>
    <head>
        <meta name="description" content="StatCVS retrieves information from a CVS repository and generates various tables and charts describing the project development."/>

        <meta name="keywords" content="CVS, StatCVS, Statistics, Code Repository, cvs statistics, cvs graphs, java, open source"/>
        <meta name="Subject" content="Statistics CVS"/>
        <meta name="Copyright" content="StatCVS Team and Appendium Ltd"/>
        <meta name="Language" content="English"/>
        <meta name="Designer" content="StatCVS Team and Appendium Ltd"/>
        <meta name="Distribution" content="Global"/>
        <meta name="robots" content="ALL"/>
        <meta name="Revisit-After" content="20 Days"/>
        <link rel="alternate" type="application/rss+xml" title="ObjectLab Open Source News" href="http://feeds.feedburner.com/ObjectLabOpenSourceNews?format=xml"/>
    </head>
    <body>
        <!-- The body of the document contains a number of sections -->
        <section name="StatCVS News">
            <p style="margin-top:10px; margin-bottom:0; padding-bottom:0; text-align:center; line-height:0">
                <a href="http://feeds.feedburner.com/~r/ObjectlabOpenSourceNews/~6/1">
                    <img src="http://feeds.feedburner.com/ObjectlabOpenSourceNews.1.gif" alt="ObjectLab Open Source News" style="border:0"/>
                </a>
            </p>
            <p style="margin-top:5px; padding-top:0; font-size:x-small; text-align:center">
                <a href="http://www.feedburner.com/fb/a/headlineanimator/install?id=829470&amp;w=1" onclick="window.open(this.href, 'haHowto', 'width=520,height=600,toolbar=no,address=no,resizable=yes,scrollbars'); return false"
                    target="_blank">
                    Grab this Headline Animator
                </a>
            </p>

            <p>
                <a href="http://feeds.feedburner.com/ObjectLabOpenSourceNews" rel="alternate" type="application/rss+xml">
                    <img src="http://www.feedburner.com/fb/images/pub/feed-icon16x16.png" alt="" style="vertical-align:middle;border:0"/>
                </a>
                <a href="http://feeds.feedburner.com/ObjectLabOpenSourceNews" rel="alternate" type="application/rss+xml">
                    Subscribe to the ObjectLab Open Source News
                </a>
                (which includes news about statcvs).
            </p>
            <p>
                2009-08-06, StatCVS is still alive! No joke!
                <a href="http://www.appendium.com">Appendium Ltd</a>
                is pleased to announce version 0.6.0, available right now! More info
                <a href="changes-report.html">here</a>
                and the download
                <a href="http://sourceforge.net/project/showfiles.php?group_id=57558">here</a>
                .
            </p>
        </section>

        <section name="Tweet Tweet from the Authors">
            <object classid="clsid:d27cdb6e-ae6d-11cf-96b8-444553540000" codebase="http://download.macromedia.com/pub/shockwave/cabs/flash/swflash.cab#version=9,0,124,0"
                width="290" height="350" id="TwitterWidget" align="middle">
                <param name="allowScriptAccess" value="sameDomain"/>
                <param name="allowFullScreen" value="false"/>
                <param name="movie" value="http://static.twitter.com/flash/widgets/profile/TwitterWidget.swf"/>
                <param name="quality" value="high"/>
                <param name="bgcolor" value="#000000"/>
                <param name="FlashVars" value="userID=18722145&amp;styleURL=http://static.twitter.com/flash/widgets/profile/velvetica.xml"/>
                <embed src="http://static.twitter.com/flash/widgets/profile/TwitterWidget.swf" quality="high" bgcolor="#000000" width="290" height="350" name="TwitterWidget"
                    align="middle" allowScriptAccess="sameDomain" allowFullScreen="false" type="application/x-shockwave-flash" pluginspage="http://www.macromedia.com/go/getflashplayer"
                    FlashVars="userID=18722145&amp;styleURL=http://static.twitter.com/flash/widgets/profile/velvetica.xml"/>
            </object>
            <object classid="clsid:d27cdb6e-ae6d-11cf-96b8-444553540000" codebase="http://download.macromedia.com/pub/shockwave/cabs/flash/swflash.cab#version=9,0,124,0"
                width="290" height="350" id="TwitterWidget" align="middle">
                <param name="allowScriptAccess" value="sameDomain"/>
                <param name="allowFullScreen" value="false"/>
                <param name="movie" value="http://static.twitter.com/flash/widgets/profile/TwitterWidget.swf"/>
                <param name="quality" value="high"/>
                <param name="bgcolor" value="#000000"/>
                <param name="FlashVars" value="userID=14773094&amp;styleURL=http://static.twitter.com/flash/widgets/profile/velvetica.xml"/>
                <embed src="http://static.twitter.com/flash/widgets/profile/TwitterWidget.swf" quality="high" bgcolor="#000000" width="290" height="350" name="TwitterWidget"
                    align="middle" allowScriptAccess="sameDomain" allowFullScreen="false" type="application/x-shockwave-flash" pluginspage="http://www.macromedia.com/go/getflashplayer"
                    FlashVars="userID=14773094&amp;styleURL=http://static.twitter.com/flash/widgets/profile/velvetica.xml"/>
            </object>
        </section>


        <section name="So, what is StatCVS? Great statistics for CVS!">
            <p>
                StatCVS retrieves information from a CVS repository and generates various tables and charts describing the project development, e.g.
                <ul>
                    <li>
                        <a href="statcvs/loc.html">Timeline</a>
                        for the lines of code
                    </li>
                    <li>
                        Lines of code for each
                        <a href="statcvs/developers.html">developer</a>
                    </li>
                    <li>
                        Activity by
                        <a href="statcvs/developers.html#Activity_by_Clock_Time">Clock time</a>
                    </li>
                    <li>
                        <a href="statcvs/developers.html#Author_Activity">Authors Activity</a>
                    </li>
                    <li>
                        Author activity per
                        <a href="statcvs/user_jkealey.html#Modules">Module</a>
                    </li>
                    <li>
                        Author
                        <a href="statcvs/user_jkealey.html#Most_Recent_Commits">Most Recent Commits</a>
                        with links to ViewVc
                    </li>
                    <li>
                        Stats per
                        <a href="statcvs/dir_src_net_sf_statcvs_output.html">directory</a>
                    </li>
                    <li>
                        <a href="statcvs/file_sizes.html#File_Count">File count</a>
                    </li>
                    <li>
                        <a href="statcvs/file_sizes.html#Average_File_Size">Average file size</a>
                    </li>
                    <li>
                        <a href="statcvs/file_sizes.html#Largest_Files">Largest files</a>
                    </li>
                    <li>
                        <a href="statcvs/file_sizes.html#Files_With_Most_Revisions">Files with most revisions</a>
                    </li>
                    <li>
                        <a href="statcvs/dir_sizes.html#Directory_Sizes">Directory Sizes</a>
                    </li>
                    <li>
                        <a href="statcvs/index.html#Repository_Tags">Repository Tags</a>
                        Number of LOC per version.
                    </li>
                    <li>
                        <a href="statcvs/index.html#Directories">Repository tree</a>
                        with file count and lines of code
                    </li>
                    <li>
                        <a href="statcvs/churn.html">LOC and Churn</a>
                        the evolution of LOC and the amount of change per day
                    </li>
                    <li>
                        <a href="statcvs/repomap.html">Repo Map</a>
                        the dynamic hierarchical view of your repo for the last 30 days
                    </li>
                </ul>

                The current version of StatCVS generates a static suite of HTML documents containing tables and chart images. StatCVS is open source software,
                released
                under the terms of the LGPL. StatCVS uses JFreeChart to generate charts.
            </p>
            <p>
                <img src="statcvs/loc_small.png"/>
            </p>
        </section>

        <section name="Quick Start">
            <p>
                First,
                <a href="download">download</a>
                StatCVS.
            </p>

            <p>
                Check out a working copy of your project from CVS. You need the CVS command line client (CVS for Unix or
                <a href="http://www.cvsnt.org/">CVSNT</a>
                for Windows). Typically, the command looks like this:
            </p>
            <pre>cvs -d /cvsroot checkout modulename</pre>

            <p>Create a CVS log file:</p>
            <pre>cvs log > logfile.log</pre>

            <p>Run StatCVS:</p>
            <pre>java -jar /path/to/statcvs.jar /path/to/module/logfile.log /path/to/module</pre>
            <p>This command creates the HTML reports in the current directory.</p>
            <p>
                More details are available from the
                <a href="manual">Manual</a>
                . It also has all the options for customizing the reports. If you run into problems, consider asking for help on the
                <a href="mailto:statcvs-users@lists.sourceforge.net">statcvs-users Mailing list</a>
                .
            </p>
            <p>
                <strong>Note:</strong>
                StatCVS can only generate reports for the main branch.
            </p>
        </section>


        <section name="Where is the manual?">
            <p>
                <a href="manual.html">Here.</a>
            </p>
        </section>

        <section name="History">
            <p>
                The StatCVS project was initiated by
                <a href="http://www.pekacki.de/">Lukasz Pekacki</a>
                . The current maintainers are Benoit Xhenseval and Jason Kealey. Other members of the development team are
                <a href="http://page.mi.fu-berlin.de/~jentzsch/">Anja Jentzsch</a>
                ,
                <a href="mailto:mschulze@inf.fu-berlin.de">Manuel Schulze</a>
                ,
                <a href="http://steffenpingel.de/">Steffen Pingel</a>
                and
                <a href="http://www.taval.de/">Tammo van Lessen</a>
                .
                <a href="developers.html">2002 photo of the original development team</a>
            </p>
        </section>

        <section name="Related Projects">
            <dl>
                <dt>
                    <a href="http://statsvn.org/">StatSVN</a>
                </dt>
                <dd>
                    is a port of StatCVS to the
                    <a href="http://subversion.tigris.org/">Subversion</a>
                    version control system. Actively maintained.
                </dd>

                <dt>
                    <a href="http://statcvs-xml.berlios.de/">StatCVS-XML</a>
                </dt>
                <dd>is a fork of StatCVS that generates XML instead of HTML reports. (not updated since Oct 2006)</dd>

                <dt>
                    <a href="http://statcvs-xml.berlios.de/maven-plugin/">StatCVS Maven Plugin</a>
                </dt>
                <dd>provides StatCVS reports for the Maven project automation software and is based on StatCVS-XML.</dd>

                <dt>
                    <a href="http://bloof.sourceforge.net/">Bloof</a>
                </dt>
                <dd>is a comprehensive framework for analysis of version control data (not updated since 2003)</dd>

                <dt>
                    <a href="http://freshmeat.net/projects/cvstat/">cvstat</a>
                </dt>
                <dd>
                    is a small Perl script which generates a table comparing contributions by individual developers. (StatCVS contains a similar table.) (not
                    updated since
                    2002)
                </dd>

                <dt>
                    <a href="http://cvsplot.sourceforge.net/">Cvsplot</a>
                </dt>
                <dd>
                    generates a graph showing lines of code development over time; requires GnuPlot. (StatCVS contains a similar chart.) (not updated since Dec
                    2004)
                </dd>
            </dl>
        </section>
    </body>
</document>