Add a simple manpage.
[gitstats.git] / doc / gitstats.pod
blobb60c391e5fe6cf760d32983c32822c334c6bd573
1 =encoding utf8
3 =head1 NAME
5 gitstats - git history statistics generator
7 =head1 SYNOPSIS
9 B<gitstats> [options] <repository dir> <output dir>
11 =head1 DESCRIPTION
13 B<gitstats> is a statistics generator for L<git(1)> repositories. It examines the repository and produces some interesting statistics from the history of it.
15 =head1 FAQ
17 Q: How do I generate statistics of a non-master branch?
19 A: Use C<-c commit_end=web> parameter.
21 Q: I have files in my git repository that I would like to exclude from the statistics, how do I do that?
23 A: At the moment the only way is to use L<git-filter-branch(1)> to create a temporary repository and generate the statistics from that.
25 =head1 AUTHORS
27 B<gitstats> was written by Heikki Hokkanen and others.
29 See the git repository at http://repo.or.cz/w/gitstats.git for an up-to-date full list of contributors.
31 =head1 WWW
33 http://gitstats.sourceforge.net/
35 =head1 SEE ALSO
37 L<git(1)>