cgit: prepare repo before error pages

[cgit.git] / cgitrc.5.txt

diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 759f353efaf7651d0372e64e8501a30c2398ee38..4da166c51f90ed16a12731179a9988a674fdbf0b 100644 (file)
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -141,6 +141,11 @@ embedded::
        suitable for embedding in other html pages. Default value: none. See
        also: "noheader".
 
+enable-blame::
+       Flag which, when set to "1", will allow cgit to provide a "blame" page
+       for files, and will make it generate links to that page in appropriate
+       places. Default value: "0".
+
 enable-commit-graph::
        Flag which, when set to "1", will make cgit print an ASCII-art commit
        history graph to the left of the commit messages in the repository
@@ -190,6 +195,13 @@ enable-subject-links::
        in commit view. Default value: "0". See also:
        "repo.enable-subject-links".
 
+enable-html-serving::
+       Flag which, when set to "1", will allow the /plain handler to serve
+       mimetype headers that result in the file being treated as HTML by the
+       browser. When set to "0", such file types are returned instead as
+       text/plain or application/octet-stream. Default value: "0". See also:
+       "repo.enable-html-serving".
+
 enable-tree-linenumbers::
        Flag which, when set to "1", will make cgit generate linenumber links
        for plaintext blobs printed in the tree view. Default value: "1".
@@ -198,11 +210,11 @@ enable-git-config::
        Flag which, when set to "1", will allow cgit to use git config to set
        any repo specific settings. This option is used in conjunction with
        "scan-path", and must be defined prior, to augment repo-specific
-       settings. The keys gitweb.owner, gitweb.category, and gitweb.description
-       will map to the cgit keys repo.owner, repo.section, and repo.desc,
-       respectively. All git config keys that begin with "cgit." will be mapped
-       to the corresponding "repo." key in cgit. Default value: "0". See also:
-       scan-path, section-from-path.
+       settings. The keys gitweb.owner, gitweb.category, gitweb.description,
+       and gitweb.homepage will map to the cgit keys repo.owner, repo.section,
+       repo.desc, and repo.homepage respectively. All git config keys that begin
+       with "cgit." will be mapped to the corresponding "repo." key in cgit.
+       Default value: "0". See also: scan-path, section-from-path.
 
 favicon::
        Url used as link to a shortcut icon for cgit. It is suggested to use
@@ -489,6 +501,9 @@ repo.defbranch::
 repo.desc::
        The value to show as repository description. Default value: none.
 
+repo.homepage::
+       The value to show as repository homepage. Default value: none.
+
 repo.email-filter::
        Override the default email-filter. Default value: none. See also:
        "enable-filter-overrides". See also: "FILTER API".
@@ -513,6 +528,10 @@ repo.enable-subject-links::
        A flag which can be used to override the global setting
        `enable-subject-links'. Default value: none.
 
+repo.enable-html-serving::
+       A flag which can be used to override the global setting
+       `enable-html-serving`. Default value: none.
+
 repo.hide::
        Flag which, when set to "1", hides the repository from the repository
        index. The repository can still be accessed by providing a direct path.
@@ -662,14 +681,14 @@ commit filter::
        expected on standard output.
 
 email filter::
-       This filter is given two parameters: the email address of the relevent
+       This filter is given two parameters: the email address of the relevant
        author and a string indicating the originating page. The filter will
        then receive the text string to format on standard input and is
        expected to write to standard output the formatted text to be included
        in the page.
 
 owner filter::
-       This filter is given no arguments.  The owner text is avilable on
+       This filter is given no arguments.  The owner text is available on
        standard input and the filter is expected to write to standard
        output.  The output is included in the Owner column.
 
@@ -785,6 +804,10 @@ enable-http-clone=1
 enable-index-links=1
 
 
+# Enable blame page and create links to it from tree page
+enable-blame=1
+
+
 # Enable ASCII art commit history graph on the log pages
 enable-commit-graph=1