Added a manpage

1 files changed, 44 insertions, 0 deletions

diff --git a/activity.1 b/activity.1
new file mode 100644
index 0000000..0ed1eb3
--- /dev/null
+++ b/activity.1
@@ -0,0 +1,44 @@
+.TH activity 1 "2024-02-11"
+.SH NAME
+activity - generates a rolling or yearly activity chart for git repositories
+.SH SYNOPSIS
+.B activity
+.RB [ \-y
+.IR year ]
+.RB [ \-f
+.IR format ]
+.RB [ \-A | \-C
+.IR email ]...
+.RI [ repositories ]...
+.SH DESCRIPTION
+Activity counts daily commits in selected repositories and creates a calendar year chart or up to last 53 weeks rolling
+chart. Chart is a day-based heatmap, where the colour intensifies along the number of commits.
+.P
+Optionally, a filter can be applied to only count commits committed or authored by a person using selected e-mails. More
+than one address can be provided and if any of them match, the commit will be included.
+.SH EXIT STATUS
+If no errors were encountered during chart generation, a
+.B 0
+exit status is returned from the process. If an error occurred, a non-zero exit status is returned. Not all errors are
+considered critical and in some cases an incomplete chart may be still generated.
+.SH EXAMPLES
+.SS Print rolling chart for the repository owning current working directory
+.RS
+.EX
+$ activity
+.EE
+.RE
+.SS Generate SVG chart for 2023 for all repositories in a list
+.RS
+.EX
+$ xargs activity -y2023 -fsvg <repositories >activity.svh
+.EE
+.RE
+.SS Generate HTML5 rolling chart filtered by matching either author or committer in all repositories in a list
+.RS
+.EX
+$ xargs activity -Aplease@ignore.pl -Cplease@ignore.pl -fhtml5 <repositories >activity.html
+.EE
+.RE
+.SH SEE ALSO
+.BR git (1)