Commit 87db323e65c704c9186f9876bcec01012a891dd2
2020-01-15T22:10:31
gotweb.conf man
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 74 75
diff --git a/gotweb/gotweb.conf.5 b/gotweb/gotweb.conf.5
index 442c156..dc7cb15 100644
--- a/gotweb/gotweb.conf.5
+++ b/gotweb/gotweb.conf.5
@@ -25,41 +25,45 @@ is the configuration file for gotweb.
.Sh GLOBAL CONFIGURATION
Here are the settings that can be set globally:
.Bl -tag -width Ds
-.It Ic got_repos_path Ar string
-Set the default git repository path.
-This is a required setting.
-.It Ic got_www_path Ar string
-Set the public gotweb httpd path.
-This is a required setting.
-.It Ic got_max_repos Ar string
-Set the maximum amount of repositories gotweb will work with.
-.It Ic got_max_repos_display Ar string
-Set the maximum amount of repositories displayed on the index screen.
-.It Ic got_commits_display Ar string
+.It Ic got_commits_display Ar number
Set the maximum amount of log lines displayed.
-.It Ic got_site_name Ar string
-Set the displayed site name title.
-.It Ic got_site_owner Ar string
-Set the displayed site owner.
-.It Ic got_site_link Ar string
-Set the displayed site link name for the index page.
.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_show_site_owner Ar string
-Set whether to display the site owner, or not.
-.It Ic got_repo_owner Ar string
-Set whether to display the repository owner, or not.
-This requires the owner to be added to config in the repository.
+.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_repo_age Ar string
Set whether to display the repository age, or not.
-.It Ic got_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_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_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_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.
+The gotweb code will parse either [gotweb] or [gitweb] owner information.
+For example:
+.Bd -literal -offset indent
+[gotweb]
+owner = "Your Name"
+.Ed
+.It Ic got_site_link Ar string
+Set the displayed site link name for the index page.
+.It Ic got_site_name Ar string
+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_www_path Ar string
+Set the public gotweb httpd path.
.El
.Sh FILES
.Bl -tag -width Ds -compact