]> gitweb.ps.run Git - ps-cgit/blobdiff - cgitrc.5.txt
make cgitrc.5.txt asciidoc manpage compatible
[ps-cgit] / cgitrc.5.txt
index 7887b02ce60ca7701b0a3d5d4db9aac9a2136325..f368cedcca11c39ee157502131d0f77f7b84c5db 100644 (file)
@@ -1,5 +1,5 @@
-CGITRC
-======
+CGITRC(5)
+========
 
 
 NAME
@@ -7,8 +7,8 @@ NAME
        cgitrc - runtime configuration for cgit
 
 
-DESCRIPTION
------------
+SYNOPSIS
+--------
 Cgitrc contains all runtime settings for cgit, including the list of git
 repositories, formatted as a line-separated list of NAME=VALUE pairs. Blank
 lines, and lines starting with '#', are ignored.
@@ -84,6 +84,10 @@ footer
        verbatim at the bottom of all pages (i.e. it replaces the standard
        "generated by..." message. Default value: none.
 
+header
+       The content of the file specified with this option will be included
+       verbatim at the top of all pages. Default value: none.
+
 include
        Name of a configfile to include before the rest of the current config-
        file is parsed. Default value: none.
@@ -129,6 +133,11 @@ max-repodesc-length
        Specifies the maximum number of repo description characters to display
        on the repository index page. Default value: "80".
 
+max-stats
+       Set the default maximum statistics period. Valid values are "week",
+       "month", "quarter" and "year". If unspecified, statistics are
+       disabled. Default value: none. See also: "repo.max-stats".
+
 module-link
        Text which will be used as the formatstring for a hyperlink when a
        submodule is printed in a directory listing. The arguments for the
@@ -218,6 +227,11 @@ repo.enable-log-linecount
        A flag which can be used to disable the global setting
        `enable-log-linecount'. Default value: none.
 
+repo.max-stats
+       Override the default maximum statistics period. Valid values are equal
+       to the values specified for the global "max-stats" setting. Default
+       value: none.
+
 repo.name
        The value to show as repository name. Default value: <repo.url>.
 
@@ -276,6 +290,10 @@ favicon=/favicon.ico
 logo=/img/mylogo.png
 
 
+# Enable statistics per week, month and quarter
+max-stats=quarter
+
+
 # Set the title and heading of the repository index page
 root-title=foobar.com git repositories
 
@@ -288,8 +306,8 @@ root-desc=tracking the foobar development
 root-readme=/var/www/htdocs/about.html
 
 
-# Allow download of tar.gz, tar.bz and zip-files
-snapshots=tar.gz tar.bz zip
+# Allow download of tar.gz, tar.bz2 and zip-files
+snapshots=tar.gz tar.bz2 zip
 
 
 ##
@@ -348,6 +366,9 @@ repo.snapshots=0
 # Disable line-counts for this repo
 repo.enable-log-linecount=0
 
+# Restrict the max statistics period for this repo
+repo.max-stats=month
+
 
 BUGS
 ----