Commit ee882e7505ef92bf73fbb54352a67fdf56857e95
2020-01-28T19:40:27
Wording tweaks for gotweb.conf(5) global configuration section.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73
diff --git a/gotweb/gotweb.conf.5 b/gotweb/gotweb.conf.5
index 81219c2..f31730a 100644
--- a/gotweb/gotweb.conf.5
+++ b/gotweb/gotweb.conf.5
@@ -33,31 +33,39 @@ the
environment of
.Xr httpd 8 .
.Sh GLOBAL CONFIGURATION
-Here are the settings that can be set globally:
+The available settings are as follows:
.Bl -tag -width Ds
.It Ic got_max_commits_display Ar number
Set the maximum amount of log lines displayed.
-.It Ic got_logo Ar string
-Set the displayed logo.
-.It Ic got_logo_url Ar string
-Set the href link for the logo.
+.It Ic got_logo Ar path
+Set the path to an image file containing a logo to be displayed.
+.It Ic got_logo_url Ar url
+Set a hyperlink link for the logo.
.It Ic got_max_repos Ar number
Set the maximum amount of repositories gotweb will work with.
.It Ic got_max_repos_display Ar number
Set the maximum amount of repositories displayed on the index screen.
-.It Ic got_show_repo_age Ar string
-Set whether to display the repository age, or not.
-.It Ic got_show_repo_cloneurl Ar string
-Set whether to display clone URLs for a repository.
-This requires the creation of a cloneurl file in the repository.
-.It Ic got_show_repo_description Ar string
-Set whether to display the repository description, or not.
-This requires the description file to be edited in the repository.
-.It Ic got_repos_path Ar string
-Set the default git repository path.
-.It Ic got_show_repo_owner Ar string
-Set whether to display the repository owner, or not.
-This requires the owner to be added to the config file in the repository.
+.It Ic got_show_repo_age Ar on | off
+Toggle display of last repository modification date.
+.It Ic got_show_repo_cloneurl Ar on | off
+Toggle display of clone URLs for a repository.
+This requires the creation of a
+.Pa cloneurl
+file inside the repository which contains one URL per line.
+.It Ic got_show_repo_description Ar on | off
+Toggle display of the repository description.
+The
+.Pa description
+file in the repository should be updated with an appropriate description.
+.It Ic got_repos_path Ar path
+Set the path to the directory which contains Git repositories that
+.Xr gotweb 8
+should publish.
+.It Ic got_show_repo_owner Ar on | off
+Set whether to display the repository owner.
+Displaying the owner requires owner information to be added to the
+.Pa config
+file in the repository.
The gotweb code will parse either [gotweb] or [gitweb] owner information.
For example:
.Bd -literal -offset indent
@@ -70,8 +78,8 @@ Set the displayed site link name for the index page.
Set the displayed site name title.
.It Ic got_site_owner Ar string
Set the displayed site owner.
-.It Ic got_show_site_owner Ar string
-Set whether to display the site owner, or not.
+.It Ic got_show_site_owner Ar on | off
+Toggle display of the site owner.
.It Ic got_www_path Ar string
Set the public gotweb httpd path.
.El