dotfiles

My PC Dotfiles & Website

site/git/stagit/stagit-index.1 (1205B)


 1.Dd August 2, 2021
 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 Fl n Ar sitename
10.Op Ar repodir...
11.Sh DESCRIPTION
12.Nm
13will create an index HTML page for the repositories specified and writes
14the HTML data to stdout.
15The repos in the index are sorted by last commit time, newest first.
16Repositories with the same commit time are sorted by name.
17.Pp
18The basename of the directory is used as the repository name.
19The suffix ".git" is removed from the basename, this suffix is commonly used
20for "bare" repos.
21.Pp
22The content of the follow files specifies the meta data for each repository:
23.Bl -tag -width Ds
24.It .git/description or description (bare repos).
25description
26.It .git/owner or owner (bare repo).
27owner of repository
28.It Fl n Ar sitename
29Set the site name used in the header link and page title.
30.El
31.Pp
32For changing the style of the page you can use the following files:
33.Bl -tag -width Ds
34.It favicon.png
35favicon image.
36.It style.css
37Global CSS stylesheet (must be present at root).
38.El
39.Sh EXAMPLES
40.Bd -literal
41cd htmlroot
42stagit-index path/to/gitrepo1 path/to/gitrepo2 > index.html
43.Ed
44.Sh SEE ALSO
45.Xr stagit 1
46.Sh AUTHORS
47.An V7