2015-12-26 20:05:55 +00:00
|
|
|
.Dd December 26, 2015
|
|
|
|
|
.Dt STAGIT 1
|
2015-12-05 20:01:38 +00:00
|
|
|
.Os
|
|
|
|
|
.Sh NAME
|
2015-12-26 20:05:55 +00:00
|
|
|
.Nm stagit
|
2015-12-05 20:01:38 +00:00
|
|
|
.Nd static git page generator
|
|
|
|
|
.Sh SYNOPSIS
|
|
|
|
|
.Nm
|
|
|
|
|
.Op Ar repodir
|
|
|
|
|
.Sh DESCRIPTION
|
|
|
|
|
.Nm
|
2015-12-20 20:34:40 +00:00
|
|
|
writes HTML pages for the repository
|
|
|
|
|
.Ar repodir
|
|
|
|
|
to the current directory. The following files will be written:
|
|
|
|
|
.Bl -tag -width Ds
|
|
|
|
|
.It atom.xml
|
|
|
|
|
Atom XML feed
|
|
|
|
|
.It files.html
|
|
|
|
|
List of files in the latest HEAD commit, linking to the file.
|
2016-01-05 20:04:07 +00:00
|
|
|
.It log.html
|
2015-12-20 20:34:40 +00:00
|
|
|
List of commits in order of most recent to old of the commits (top to bottom),
|
|
|
|
|
each commit links to a page with a diff and diffstat of the commit.
|
2016-01-03 21:42:00 +00:00
|
|
|
.It refs.html
|
|
|
|
|
Lists references of the repository such as branches and tags.
|
2015-12-20 20:34:40 +00:00
|
|
|
.El
|
|
|
|
|
.Pp
|
|
|
|
|
For each file in HEAD a file will be written in the format:
|
|
|
|
|
file/filepath.html. This file will contain the textual data of the file
|
|
|
|
|
prefixed by line numbers. The file will have the string "binary file"
|
|
|
|
|
if the data is considered to be non-textual.
|
|
|
|
|
.Pp
|
|
|
|
|
For each commit a file will be written in the format:
|
|
|
|
|
commit/commitid.html . This file will contain the diff and diffstat of the
|
|
|
|
|
commit. It will write the string "binary files differ" if the data is
|
|
|
|
|
considered to be non-textual.
|
|
|
|
|
.Pp
|
2016-01-06 19:04:34 +00:00
|
|
|
The basename of the directory is used as the name. The suffix ".git" is
|
|
|
|
|
removed from the basename, this is commonly used for "bare" repos.
|
2015-12-26 20:05:55 +00:00
|
|
|
.Pp
|
|
|
|
|
The content of the follow files specifies the meta data for each repository:
|
|
|
|
|
.Bl -tag -width Ds
|
2016-01-06 19:04:34 +00:00
|
|
|
.It .git/description or description (bare repo).
|
2015-12-26 20:05:55 +00:00
|
|
|
description
|
|
|
|
|
.It .git/owner or owner (bare repo).
|
|
|
|
|
owner of repository
|
|
|
|
|
.It .git/url or url (bare repo).
|
|
|
|
|
primary clone url of the repository, for example: git://git.2f30.org/stagit
|
|
|
|
|
.El
|
|
|
|
|
.Pp
|
2015-12-20 20:34:40 +00:00
|
|
|
For changing the style of the page you can use the following files:
|
|
|
|
|
.Bl -tag -width Ds
|
|
|
|
|
.It logo.png
|
|
|
|
|
32x32 logo.
|
|
|
|
|
.It favicon.png
|
|
|
|
|
favicon image.
|
|
|
|
|
.It style.css
|
|
|
|
|
CSS stylesheet.
|
|
|
|
|
.El
|
|
|
|
|
.Sh SEE ALSO
|
2015-12-26 20:05:55 +00:00
|
|
|
.Xr stagit-index 1
|
2015-12-05 20:01:38 +00:00
|
|
|
.Sh AUTHORS
|
|
|
|
|
.An Hiltjo Posthuma Aq Mt hiltjo@codemadness.org
|
