update README and improve man pages
| 3 files changed, 53 insertions(+), 6 deletions(-) | |||
|---|---|---|---|
| M | README | +2 | -1 |
| M | urmoms-index.1 | +16 | -3 |
| M | urmoms.1 | +35 | -2 |
1@@ -4,7 +4,7 @@ Usage
2
3 mkdir -p htmldir
4 cd htmldir
5-urmoms <path-to-repo>
6+urmoms path-to-repo
7
8
9 Install
10@@ -27,3 +27,4 @@ Features
11 - Show file tree.
12 - Detect README and LICENSE file to make a webpage.
13 - Atom feed git log.
14+- Make index page for multiple repositories.
1@@ -1,14 +1,27 @@
2-.Dd December 15, 2015
3+.Dd December 20, 2015
4 .Dt URMOMS-INDEX 1
5 .Os
6 .Sh NAME
7 .Nm urmoms-index
8-.Nd static git page generator (repo list)
9+.Nd static git index page generator
10 .Sh SYNOPSIS
11 .Nm
12 .Op Ar repodir...
13 .Sh DESCRIPTION
14 .Nm
15-is undocumented
16+will create an index HTML page for the repositories specified and writes
17+the HTML data to stdout.
18+.Pp
19+For changing the style of the page you can use the following files:
20+.Bl -tag -width Ds
21+.It logo.png
22+32x32 logo.
23+.It favicon.png
24+favicon image.
25+.It style.css
26+CSS stylesheet.
27+.El
28+.Sh SEE ALSO
29+.Xr urmoms 1
30 .Sh AUTHORS
31 .An Hiltjo Posthuma Aq Mt hiltjo@codemadness.org
1@@ -1,4 +1,4 @@
2-.Dd December 15, 2015
3+.Dd December 20, 2015
4 .Dt URMOMS 1
5 .Os
6 .Sh NAME
7@@ -9,6 +9,39 @@
8 .Op Ar repodir
9 .Sh DESCRIPTION
10 .Nm
11-is undocumented
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