cgitrc.5.txt: document 'embedded' and 'noheader'

[ps-cgit] / cgitrc.5.txt

diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 60d3ea492d3f8a923a3102235d872b93f1c98664..771bb7dfcfd5b3783c40c302344d8998ef337a6e 100644 (file)
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -59,6 +59,11 @@ css
        Url which specifies the css document to include in all cgit pages.
        Default value: "/cgit.css".
 
+embedded
+       Flag which, when set to "1", will make cgit generate a html fragment
+       suitable for embedding in other html pages. Default value: none. See
+       also: "noheader".
+       
 enable-index-links
        Flag which, when set to "1", will make cgit generate extra links for
        each repo in the repository index (specifically, to the "summary",
@@ -74,10 +79,6 @@ enable-log-linecount
        and removed lines for each commit on the repository log page. Default
        value: "0".
 
-enable-stats
-       Globally enable/disable statistics for each repository. Default
-       value: "0".
-
 favicon
        Url used as link to a shortcut icon for cgit. If specified, it is
        suggested to use the value "/favicon.ico" since certain browsers will
@@ -88,6 +89,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.
@@ -133,6 +138,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
@@ -144,6 +154,10 @@ nocache
        deprecated, and will not be honored starting with cgit-1.0. Default
        value: "0".
 
+noheader
+       Flag which, when set to "1", will make cgit omit the standard header
+       on all pages. Default value: none. See also: "embedded".
+
 renamelimit
        Maximum number of files to consider when detecting renames. The value
         "-1" uses the compiletime value in git (for further info, look at
@@ -222,9 +236,10 @@ repo.enable-log-linecount
        A flag which can be used to disable the global setting
        `enable-log-linecount'. Default value: none.
 
-repo.enable-stats
-       A flag which can be used to disable the global setting
-       `enable-stats'. 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>.
@@ -284,6 +299,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
 
@@ -296,8 +315,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
 
 
 ##
@@ -356,6 +375,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
 ----