depp

No frills static page generator for Git repositories

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

 1.Dd $Mdocdate: June 10 2020 $
 2.Dt DEPP-INDEX 1
 3.Os
 4.Sh NAME
 5.Nm depp-index
 6.Nd generate an index page for Git web viewers
 7.Sh SYNOPSIS
 8.Nm depp-index
 9.Op Fl d Ar destination
10.Op Fl p Ar num
11.Op Fl s Ar description
12.Op Fl t Ar title
13.Op Fl x
14.Ar repository ...
15.Sh DESCRIPTION
16For the given
17.Ar repostories
18.Nm
19generates an HTML index page listing all of them.
20The listing includes a short description of each repository, the time it was last modified, and a link to a repository page which provides more information.
21Repositories are sorted in descending order by their modification time.
22Referenced repository pages must be generated separately, for instance using
23.Xr depp 1 .
24.Pp
25The options are as follows:
26.Bl -tag -width Ds
27.It Fl d Ar destination
28The generated HTML and CSS files are written to the given
29.Ar destination
30directory.
31This directory is created if it does not exist yet.
32By default a
33.Pa www
34subdirectory is created and used in the current directory.
35.It Fl p Ar num
36List
37.Ar num
38repositories per generated web page.
39The default is 20, the special value -1 disable pagination entirely.
40.It Fl s Ar description
41The header of the generated HTML optionally contains a short
42.Ar description
43of the page.
44By default, no description is included.
45.It Fl t Ar title
46This argument specifies the
47.Ar title
48of the generated index page.
49.It Fl x
50Strip the
51.Pa .git
52file name extension (if it exists) when linking to the repository on the index page.
53This is useful when serving both the HTML and the Git repository itself over HTTP in the same directory.
54.El
55.Sh FILES
56The following files are used in bare Git repositories for metadata:
57.Bl -tag -width Ds
58.It Pa git-description
59Used to provide a description for each repository in the list.
60.El
61.Sh EXIT STATUS
62.Ex -std depp-index
63.Sh SEE ALSO
64.Xr depp 1 ,
65.Xr git 1
66.Sh AUTHORS
67.An Sören Tempel Aq Mt soeren@soeren-tempel.net