depp

 1.Dd $Mdocdate: November 28 2024 $
 2.Dt DEPP 1
 3.Os
 4.Sh NAME
 5.Nm depp
 6.Nd generate HTML files for a git repository
 7.Sh SYNOPSIS
 8.Nm depp
 9.Op Fl c Ar commits
10.Op Fl d Ar destination
11.Op Fl f
12.Op Fl u Ar URL
13.Op Fl v
14.Ar repository
15.Sh DESCRIPTION
16For the given
17.Xr git 1
18.Ar repository
19.Nm
20generates static HTML files which provide a simple repository overview.
21This includes recent commits, a file tree, and (rendered) README files.
22In regards to the file tree,
23.Nm
24only operates on the current repository head.
25.Pp
26This software is most commonly invoked from a
27.Pa post-receive
28hook registered on the Git server.
29Thereby causing generated HTML to be updated automatically.
30Refer to
31.Xr githooks 5
32for more information on these hooks.
33.Pp
34The options are as follows:
35.Bl -tag -width Ds
36.It Fl c Ar commits
37Amount of
38.Ar commits
39to include on the index page.
40For each commit the commit message, the author name, and the commit date are displayed.
41By default the last 5 commits are displayed.
42.It Fl d Ar destination
43The generated HTML file are written to the given
44.Ar destination
45directory.
46This directory is created if it does not exist yet.
47By default a
48.Pa www
49subdirectory is created and used in the current directory.
50.It Fl f
51By default
52.Nm
53only generates HTML for files that changed since the last invocation.
54If this option is passed, all files are regenerated unconditionally.
55.It Fl u Ar URL
56The
57.Ar URL
58used to clone the repository.
59If provided, this information is displayed in the header of each generated HTML page.
60.It Fl v
61Print the name of each file that changed since the last invocation.
62.El
63.Sh FILES
64The following special files in bare Git repositories are recognized:
65.Bl -tag -width Ds
66.It Pa git-description
67Contains a short description of the repository which is displayed in the header of each HTML file (if present).
68.It Pa git-render-readme
69Executable file which receives
70.Pa README
71files on standard input and should write HTML for these files to standard output.
72.El
73.Sh EXIT STATUS
74.Ex -std depp
75.Sh SEE ALSO
76.Xr git 1 ,
77.Xr gitweb 1 ,
78.Xr githooks 5
79.Sh AUTHORS
80.An Sören Tempel Aq Mt soeren@soeren-tempel.net
81.Sh CAVEATS
82Existing HTML files are not tracked by this utility.
83If a file is removed from the repository, it is not automatically removed from the .Ar destination directory.