stagit/stagit.1

62 lines
1.7 KiB
Groff
Raw Normal View History

.Dd December 26, 2015
.Dt STAGIT 1
2015-12-05 20:01:38 +00:00
.Os
.Sh NAME
.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.
.It log/HEAD.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.
.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
The basename of the directory is used as the name.
.Pp
The content of the follow files specifies the meta data for each repository:
.Bl -tag -width Ds
.It .git/description or description (bare repos).
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
.Xr stagit-index 1
2015-12-05 20:01:38 +00:00
.Sh AUTHORS
.An Hiltjo Posthuma Aq Mt hiltjo@codemadness.org