depp - depp-index.1

 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 s Ar description
11.Op Fl t Ar title
12.Op Fl x
13.Ar repository ...
14.Sh DESCRIPTION
15For the given
16.Ar repostories
17.Nm
18generates an HTML index page listing all of them.
19The 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.
20Repositories are sorted in descending order by their modification time.
21Referenced repository pages must be generated separately, for instance using
22.Xr depp 1 .
23.Pp
24The options are as follows:
25.Bl -tag -width Ds
26.It Fl d Ar destination
27The generated HTML and CSS files are written to the given
28.Ar destination
29directory.
30This directory is created if it does not exist yet.
31By default a
32.Pa www
33subdirectory is created and used in the current directory.
34.It Fl s Ar description
35The header of the generated HTML optionally contains a short
36.Ar description
37of the page.
38By default, no description is included.
39.It Fl t Ar title
40This argument specifies the
41.Ar title
42of the generated index page.
43.It Fl x
44Strip the
45.Pa .git
46file name extension (if it exists) when linking to the repository on the index page.
47This is useful when serving both the HTML and the Git repository itself over HTTP in the same directory.
48.El
49.Sh FILES
50The following files are used in bare Git repositories for metadata:
51.Bl -tag -width Ds
52.It Pa git-description
53Used to provide a description for each repository in the list.
54.El
55.Sh EXIT STATUS
56.Ex -std depp-index
57.Sh SEE ALSO
58.Xr depp 1 ,
59.Xr git 1
60.Sh AUTHORS
61.An Sören Tempel Aq Mt soeren@soeren-tempel.net