improve documentation

- add example to README to extract gitweb.owner from a git config.
  this is used in gitweb and some cgit configurations.
- fix (new) mandoc warnings (new sentence on each line).
- improve some texts in the man pages, sort / structure some list items.
This commit is contained in:
Hiltjo Posthuma
2017-04-22 14:38:39 +02:00
parent e9e7978381
commit 8eabe24bdd
3 changed files with 52 additions and 27 deletions

View File

@@ -10,13 +10,14 @@
.Sh DESCRIPTION
.Nm
will create an index HTML page for the repositories specified and writes
the HTML data to stdout. The repos in the index are in the same order as
the arguments
the HTML data to stdout.
The repos in the index are in the same order as the arguments
.Ar repodir
specified.
.Pp
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.
The basename of the directory is used as the repository name.
The suffix ".git" is removed from the basename, this suffix is commonly used
for "bare" repos.
.Pp
The content of the follow files specifies the meta data for each repository:
.Bl -tag -width Ds
@@ -28,10 +29,10 @@ owner of repository
.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 logo.png
32x32 logo.
.It style.css
CSS stylesheet.
.El