ui-tree: move set_title_from_path to ui-shared

[cgit.git] / cgitrc.5.txt

diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 104b223b9b9e64c62c5c6d2c8e7c35db8fbb1960..9fcf445bef2df3cb226d2dffea85438e16ead17f 100644 (file)
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -150,6 +150,10 @@ enable-filter-overrides::
        Flag which, when set to "1", allows all filter settings to be
        overridden in repository-specific cgitrc files. Default value: none.
 
+enable-follow-links::
+       Flag which, when set to "1", allows users to follow a file in the log
+       view.  Default value: "0".
+
 enable-http-clone::
        If set to "1", cgit will act as an dumb HTTP endpoint for git clones.
        You can add "http://$HTTP_HOST$SCRIPT_NAME/$CGIT_REPO_URL" to clone-url
@@ -186,6 +190,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".
@@ -194,11 +205,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
@@ -247,6 +258,15 @@ logo-link::
        calculated url of the repository index page will be used. Default
        value: none.
 
+owner-filter::
+       Specifies a command which will be invoked to format the Owner
+       column of the main page.  The command will get the owner on STDIN,
+       and the STDOUT from the command will be included verbatim in the
+       table.  This can be used to link to additional context such as an
+       owners home page.  When active this filter is used instead of the
+       default owner query url.  Default value: none.
+       See also: "FILTER API".
+
 max-atom-items::
        Specifies the number of items to display in atom feeds view. Default
        value: "10".
@@ -476,6 +496,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".
@@ -500,6 +523,20 @@ 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.
+       Default value: "0". See also: "repo.ignore".
+
+repo.ignore::
+       Flag which, when set to "1", ignores the repository. The repository
+       is not shown in the index and cannot be accessed by providing a direct
+       path. Default value: "0". See also: "repo.hide".
+
 repo.logo::
        Url which specifies the source of an image which will be used as a logo
        on this repo's pages. Default value: global logo.
@@ -509,6 +546,10 @@ repo.logo-link::
        calculated url of the repository index page will be used. Default
        value: global logo-link.
 
+repo.owner-filter::
+       Override the default owner-filter. Default value: none. See also:
+       "enable-filter-overrides". See also: "FILTER API".
+
 repo.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
@@ -635,12 +676,17 @@ 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 available on
+       standard input and the filter is expected to write to standard
+       output.  The output is included in the Owner column.
+
 source filter::
        This filter is given a single parameter: the filename of the source
        file to filter. The filter can use the filename to determine (for