update README and improve man pages - stagit-gopher - A git gopher frontend. (m… | |
git clone git://bitreich.org/stagit-gopher/ git://enlrupgkhuxnvlhsf6lc3fziv5h2h… | |
Log | |
Files | |
Refs | |
Tags | |
README | |
LICENSE | |
--- | |
commit b8fc56187ee8c2b726ccf0bc19305a2128f9c3fe | |
parent 2e4ed81390ff8ed331d10d3fba13dfdc2f6b6b20 | |
Author: Hiltjo Posthuma <[email protected]> | |
Date: Sun, 20 Dec 2015 21:34:40 +0100 | |
update README and improve man pages | |
Diffstat: | |
M README | 3 ++- | |
M urmoms-index.1 | 19 ++++++++++++++++--- | |
M urmoms.1 | 37 +++++++++++++++++++++++++++++… | |
3 files changed, 53 insertions(+), 6 deletions(-) | |
--- | |
diff --git a/README b/README | |
@@ -4,7 +4,7 @@ Usage | |
mkdir -p htmldir | |
cd htmldir | |
-urmoms <path-to-repo> | |
+urmoms path-to-repo | |
Install | |
@@ -27,3 +27,4 @@ Features | |
- Show file tree. | |
- Detect README and LICENSE file to make a webpage. | |
- Atom feed git log. | |
+- Make index page for multiple repositories. | |
diff --git a/urmoms-index.1 b/urmoms-index.1 | |
@@ -1,14 +1,27 @@ | |
-.Dd December 15, 2015 | |
+.Dd December 20, 2015 | |
.Dt URMOMS-INDEX 1 | |
.Os | |
.Sh NAME | |
.Nm urmoms-index | |
-.Nd static git page generator (repo list) | |
+.Nd static git index page generator | |
.Sh SYNOPSIS | |
.Nm | |
.Op Ar repodir... | |
.Sh DESCRIPTION | |
.Nm | |
-is undocumented | |
+will create an index HTML page for the repositories specified and writes | |
+the HTML data to stdout. | |
+.Pp | |
+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 urmoms 1 | |
.Sh AUTHORS | |
.An Hiltjo Posthuma Aq Mt [email protected] | |
diff --git a/urmoms.1 b/urmoms.1 | |
@@ -1,4 +1,4 @@ | |
-.Dd December 15, 2015 | |
+.Dd December 20, 2015 | |
.Dt URMOMS 1 | |
.Os | |
.Sh NAME | |
@@ -9,6 +9,39 @@ | |
.Op Ar repodir | |
.Sh DESCRIPTION | |
.Nm | |
-is undocumented | |
+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.html | |
+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. | |
+.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 | |
+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 urmoms-index 1 | |
.Sh AUTHORS | |
.An Hiltjo Posthuma Aq Mt [email protected] |