]> git.armaanb.net Git - stagit.git/blob - stagit-index.1
update man pages: document stripping of .git suffix
[stagit.git] / stagit-index.1
1 .Dd December 26, 2015
2 .Dt STAGIT-INDEX 1
3 .Os
4 .Sh NAME
5 .Nm stagit-index
6 .Nd static git index page generator
7 .Sh SYNOPSIS
8 .Nm
9 .Op Ar repodir...
10 .Sh DESCRIPTION
11 .Nm
12 will create an index HTML page for the repositories specified and writes
13 the HTML data to stdout.
14 .Pp
15 The basename of the directory is used as the name. The suffix ".git" is
16 removed from the basename, this is commonly used for "bare" repos.
17 .Pp
18 The content of the follow files specifies the meta data for each repository:
19 .Bl -tag -width Ds
20 .It .git/description or description (bare repos).
21 description
22 .It .git/owner or owner (bare repo).
23 owner of repository
24 .El
25 .Pp
26 For changing the style of the page you can use the following files:
27 .Bl -tag -width Ds
28 .It logo.png
29 32x32 logo.
30 .It favicon.png
31 favicon image.
32 .It style.css
33 CSS stylesheet.
34 .El
35 .Sh SEE ALSO
36 .Xr stagit 1
37 .Sh AUTHORS
38 .An Hiltjo Posthuma Aq Mt hiltjo@codemadness.org