depp

No frills static page generator for Git repositories

git clone https://git.8pit.net/depp.git

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