doc/gitstats.pod

   1 =encoding utf8
   2
   3 =head1 NAME
   4
   5 gitstats - git history statistics generator
   6
   7 =head1 SYNOPSIS
   8
   9 B<gitstats> [options] <repository dir> <output dir>
  10
  11 =head1 DESCRIPTION
  12
  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. Currently HTML is the only output format.
  14
  15 =head1 OPTIONS
  16
  17 -c option=value
  18
  19 Override a default configuration value. Defaults can be seen by running B<gitstats> without parameters.
  20
  21 =head2 Values:
  22
  23 =over
  24
  25 =item authors_top
  26
  27 How many top authors to show.
  28
  29 =item commit_begin, commit_end
  30
  31 Specify a commit range to generate statistics from. You can specify only commit_end limit statistics to a certain commit or another branch.
  32
  33 =item max_authors
  34
  35 How many authors to show in the list of authors.
  36
  37 =item max_domains
  38
  39 How many domains to show in domains by commits.
  40
  41 =item max_ext_length
  42
  43 Maximum file extension length.
  44
  45 =item style
  46
  47 CSS stylesheet to use.
  48
  49 =back
  50
  51 =head1 FAQ
  52
  53 Q: How do I generate statistics of a non-master branch?
  54
  55 A: Use C<-c commit_end=web> parameter.
  56
  57 Q: I have files in my git repository that I would like to exclude from the statistics, how do I do that?
  58
  59 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.
  60
  61 =head1 AUTHORS
  62
  63 B<gitstats> was written by Heikki Hokkanen and others.
  64
  65 See the git repository at http://repo.or.cz/w/gitstats.git for an up-to-date full list of contributors.
  66
  67 =head1 WWW
  68
  69 http://gitstats.sourceforge.net/
  70
  71 =head1 SEE ALSO
  72
  73 L<git(1)>
  74