Browse Source

Cover options in the manpage.

Heikki Hokkanen 15 years ago
parent
commit
9473138e28
1 changed files with 37 additions and 1 deletions
  1. 37
    1
      doc/gitstats.pod

+ 37
- 1
doc/gitstats.pod View File

10
 
10
 
11
 =head1 DESCRIPTION
11
 =head1 DESCRIPTION
12
 
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.
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
14
 
50
 
15
 =head1 FAQ
51
 =head1 FAQ
16
 
52