repolist: add owner-filter

[ps-cgit] / cgitrc.5.txt

diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index cbaebcab4d22e30e101bdcdeb5c49ae49dad61de..be6703fdb1e0bfce51907c4420dab4ce3d47cff1 100644 (file)
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -247,6 +247,15 @@ logo-link::
        calculated url of the repository index page will be used. Default
        value: none.
 
        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".
 max-atom-items::
        Specifies the number of items to display in atom feeds view. Default
        value: "10".


@@ -509,6 +518,10 @@ repo.logo-link::
        calculated url of the repository index page will be used. Default
        value: global 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
 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


@@ -603,7 +616,7 @@ specification with the relevant string; available values are:
                This is called when the current filtering operation is
                completed. It must return an integer value. Usually 0
                indicates success.
                This is called when the current filtering operation is
                completed. It must return an integer value. Usually 0
                indicates success.

-       
+

        Additionally, cgit exposes to the Lua the following built-in functions:
 
        'html(str)'::
        Additionally, cgit exposes to the Lua the following built-in functions:
 
        'html(str)'::


@@ -641,6 +654,11 @@ email filter::
        expected to write to standard output the formatted text to be included
        in the page.
 
        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
+       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
 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


@@ -667,7 +685,7 @@ auth filter::
        the http cookie and return a 0 if it is invalid or 1 if it is invalid,
        in the exit code / close function. If the filter action is
        "authenticate-post", this filter receives POST'd parameters on
        the http cookie and return a 0 if it is invalid or 1 if it is invalid,
        in the exit code / close function. If the filter action is
        "authenticate-post", this filter receives POST'd parameters on

-       standard input, and should write a complete CGI request, preferably
+       standard input, and should write a complete CGI response, preferably

        with a 302 redirect, and write to output one or more "Set-Cookie"
        HTTP headers, each followed by a newline.
 
        with a 302 redirect, and write to output one or more "Set-Cookie"
        HTTP headers, each followed by a newline.