[pkg-java] r5943 - in trunk/statsvn/debian: . manpages
fourmond at alioth.debian.org
fourmond at alioth.debian.org
Tue Mar 4 22:55:05 UTC 2008
Author: fourmond
Date: 2008-03-04 22:55:03 +0000 (Tue, 04 Mar 2008)
New Revision: 5943
Added:
trunk/statsvn/debian/manpages/statsvn.1
trunk/statsvn/debian/statsvn.manpages
Modified:
trunk/statsvn/debian/changelog
trunk/statsvn/debian/copyright
Log:
[statsvn] Added manual page and README.Debian
Modified: trunk/statsvn/debian/changelog
===================================================================
--- trunk/statsvn/debian/changelog 2008-03-04 22:45:19 UTC (rev 5942)
+++ trunk/statsvn/debian/changelog 2008-03-04 22:55:03 UTC (rev 5943)
@@ -6,5 +6,6 @@
jar containing only statsvn code (and not many more as upstreams').
* 20-disable-jtreemap to disable the jtreemap-based report, as jtreemap
is not currently packaged for Debian
+ * Wrote a manual page, based on the one from statcvs
- -- Vincent Fourmond <fourmond at debian.org> Tue, 04 Mar 2008 21:10:45 +0100
+ -- Vincent Fourmond <fourmond at debian.org> Tue, 04 Mar 2008 23:47:36 +0100
Modified: trunk/statsvn/debian/copyright
===================================================================
--- trunk/statsvn/debian/copyright 2008-03-04 22:45:19 UTC (rev 5942)
+++ trunk/statsvn/debian/copyright 2008-03-04 22:55:03 UTC (rev 5943)
@@ -39,5 +39,5 @@
Public License can be found in `/usr/share/common-licenses/LGPL-2.1'.
-The debian packaging is copyright 2008 by Vincent Fourmond,
+The debian packaging, is copyright 2008 by Vincent Fourmond,
licensed under the same terms as statsvn itself.
\ No newline at end of file
Added: trunk/statsvn/debian/manpages/statsvn.1
===================================================================
--- trunk/statsvn/debian/manpages/statsvn.1 (rev 0)
+++ trunk/statsvn/debian/manpages/statsvn.1 2008-03-04 22:55:03 UTC (rev 5943)
@@ -0,0 +1,196 @@
+.\" Hey, EMACS: -*- nroff -*-
+.\" First parameter, NAME, should be all caps
+.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
+.\" other parameters are allowed: see man(7), man(1)
+.TH STATSVN 1 "03-04-2008"
+.\" Please adjust this date whenever revising the manpage.
+.\"
+.\" Some roff macros, for reference:
+.\" .nh disable hyphenation
+.\" .hy enable hyphenation
+.\" .ad l left justify
+.\" .ad b justify to both left and right margins
+.\" .nf disable filling
+.\" .fi enable filling
+.\" .br insert line break
+.\" .sp <n> insert n+1 empty lines
+.\" for manpage-specific macros, see man(7)
+.SH NAME
+statsvn \- SVN repository statistic analysis tool
+.SH SYNOPSIS
+.B svn log --xml -v
+.I path/to/repos
+.B >
+.I svn-logfile.xml
+
+.B statsvn
+.I [options] svn-logfile path/to/repos
+
+.SH DESCRIPTION
+This manual page documents the
+.B statsvn
+command.
+This manual page was written for the Debian distribution
+because the original program does not have a manual page.
+.PP
+.\" TeX users may be more comfortable with the \fB<whatever>\fP and
+.\" \fI<whatever>\fP escape sequences to invode bold face and italics,
+.\" respectively.
+.B statsvn
+is a program that retrieves information from
+a SVN repository and generates
+various tables and charts describing
+the project development,
+e.g. timeline for the lines of code,
+contribution of each developer, etc.
+
+.br
+
+The current version of
+.B statsvn
+generates a static suite of
+HTML documents containing tables and chart images.
+.B statsvn
+is opens source software, released under the terms oft the LGPL.
+.B statsvn
+is based on
+.BR statcvs (1)
+(hence the striking similarity between their interfaces and manual
+pages) and uses JFreeChart to generate charts.
+
+.TP
+.I svn-log-file
+path to the output of
+.B svn log --xml -v
+for the given repository.
+.B IMPORTANT NOTE:
+do not forget the
+.B -v
+option, else
+.B statsvn
+will crash !!!
+
+.TP
+
+.I path/to/repos
+path to a checkout of the repository.
+
+.SH OPTIONS
+These programs follow the usual command line syntax, with long
+options starting with one dash ("\-").
+A list of common options is included below.
+For more up-to-date information, see
+.BR statsvn 's
+website.
+
+.TP
+.B \-version
+print the version information and exit
+
+.TP
+.BI \-output\-dir \ dir
+directory where HTML suite will be saved
+
+.TP
+.BI \-include \ pattern
+include only files matching pattern, e.g. **/*.c;**/*.h
+
+.TP
+.BI \-exclude \ pattern
+exclude matching files, e.g. tests/**;docs/**
+
+.TP
+.BI \-title \ title
+Project title to be used in reports
+
+.TP
+.BI \-viewcvs \ url
+integrate with ViewCVS installation at
+.I url
+
+.TP
+.B \-verbose
+print extra progress information
+
+.TP
+.BI \-bugzilla \ url
+integrate with Bugzilla installation at
+.I url
+
+.TP
+.BI \-username \ svnusername
+.TP
+.BI \-password \ svnpassword
+username and password for
+.BR svn (1)
+
+.TP
+.B \-xdoc
+generates Maven XDoc instead of HTML for output
+
+.TP
+.BI \-threads \ number
+How many concurrent
+.BR svn (1)
+processes will be spawned
+
+.TP
+.B \-dump
+dump the Repository content on console.
+
+.SH IMPORTANT NOTES
+
+Unlike its cousin
+.BR statcvs (1),
+.B statsvn
+can work on distant repositories. Please note however, that
+.B statsvn
+needs to download many diffs from the repository, so it is often more
+network-efficient to simply
+.BR rsync (1)
+the repository to a local host and run it on the local copy.
+
+To compensate for that, however, diffs are cached in the
+.I $HOME/.statsvn
+directory.
+
+.B Do not forget the -v option to svn diff !
+
+Finally, note that the default value for the number of concurrent
+.BR svn (1)
+processes might be too much for the target host. If you get weird
+error messages about unreachable hosts and similar problems, try
+taking down the
+.I \-threads
+parameter.
+
+
+.SH JAVA-WRAPPERS NOTE
+
+This program is a shell script wrapper based on
+.BR java-wrappers (7).
+You therefore benefit from several features; please see the
+.BR java-wrappers (7)
+manual page for more information about them.
+
+
+.SH SEE ALSO
+
+.BR svn (1),
+.BR statcvs (1)
+and
+.BR java-wrappers (7)
+
+.BR statsvn 's
+website at
+.IR http://www.statsvn.org ,
+and most particularly the user manual at
+.IR http://svn.statsvn.org/statsvnwiki/index.php/User_Manual .
+
+
+.SH AUTHOR
+This manual page was adapted
+by Vincent Fourmond <fourmond at debian.org> from the one for
+.BR statcvs (1)
+written by Christian Bayle <bayle at debian.org>. It was written for the
+Debian project, but may be used by others.
Added: trunk/statsvn/debian/statsvn.manpages
===================================================================
--- trunk/statsvn/debian/statsvn.manpages (rev 0)
+++ trunk/statsvn/debian/statsvn.manpages 2008-03-04 22:55:03 UTC (rev 5943)
@@ -0,0 +1 @@
+debian/manpages/statsvn.1
\ No newline at end of file
More information about the pkg-java-commits
mailing list