]> git.armaanb.net Git - stagit.git/blob - urmoms.1
nvm, dont strip .git from bare repos
[stagit.git] / urmoms.1
1 .Dd December 20, 2015
2 .Dt URMOMS 1
3 .Os
4 .Sh NAME
5 .Nm urmoms
6 .Nd static git page generator
7 .Sh SYNOPSIS
8 .Nm
9 .Op Ar repodir
10 .Sh DESCRIPTION
11 .Nm
12 writes HTML pages for the repository
13 .Ar repodir
14 to the current directory. The following files will be written:
15 .Bl -tag -width Ds
16 .It atom.xml
17 Atom XML feed
18 .It files.html
19 List of files in the latest HEAD commit, linking to the file.
20 .It log.html
21 List of commits in order of most recent to old of the commits (top to bottom),
22 each commit links to a page with a diff and diffstat of the commit.
23 .El
24 .Pp
25 For each file in HEAD a file will be written in the format:
26 file/filepath.html. This file will contain the textual data of the file
27 prefixed by line numbers. The file will have the string "binary file"
28 if the data is considered to be non-textual.
29 .Pp
30 For each commit a file will be written in the format:
31 commit/commitid.html . This file will contain the diff and diffstat of the
32 commit. It will write the string "binary files differ" if the data is
33 considered to be non-textual.
34 .Pp
35 For changing the style of the page you can use the following files:
36 .Bl -tag -width Ds
37 .It logo.png
38 32x32 logo.
39 .It favicon.png
40 favicon image.
41 .It style.css
42 CSS stylesheet.
43 .El
44 .Sh SEE ALSO
45 .Xr urmoms-index 1
46 .Sh AUTHORS
47 .An Hiltjo Posthuma Aq Mt hiltjo@codemadness.org