add a note about generating agefile in hook

[ps-cgit] / cgitrc.5.txt

diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 9b803b372ad97832b245f0e1b8adf78ac8d1d388..8b0ad21270d992fdebcc3469188df7b64a875a2f 100644 (file)
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -29,16 +29,18 @@ GLOBAL SETTINGS
 about-filter::
        Specifies a command which will be invoked to format the content of
        about pages (both top-level and for each repository). The command will
 about-filter::
        Specifies a command which will be invoked to format the content of
        about pages (both top-level and for each repository). The command will

-       get the content of the about-file on its STDIN, and the STDOUT from the
-       command will be included verbatim on the about page. Default value:
-       none. See also: "FILTER API".
+       get the content of the about-file on its STDIN, the name of the file
+       as the first argument, and the STDOUT from the command will be
+       included verbatim on the about page. Default value: none. See
+       also: "FILTER API".

 
 agefile::
        Specifies a path, relative to each repository path, which can be used
        to specify the date and time of the youngest commit in the repository.
        The first line in the file is used as input to the "parse_date"
        function in libgit. Recommended timestamp-format is "yyyy-mm-dd
 
 agefile::
        Specifies a path, relative to each repository path, which can be used
        to specify the date and time of the youngest commit in the repository.
        The first line in the file is used as input to the "parse_date"
        function in libgit. Recommended timestamp-format is "yyyy-mm-dd

-       hh:mm:ss". Default value: "info/web/last-modified".
+       hh:mm:ss". You may want to generate this file from a post-receive
+       hook. Default value: "info/web/last-modified".

 
 branch-sort::
        Flag which, when set to "age", enables date ordering in the branch ref
 
 branch-sort::
        Flag which, when set to "age", enables date ordering in the branch ref


@@ -49,32 +51,40 @@ cache-root::
        Path used to store the cgit cache entries. Default value:
        "/var/cache/cgit". See also: "MACRO EXPANSION".
 
        Path used to store the cgit cache entries. Default value:
        "/var/cache/cgit". See also: "MACRO EXPANSION".
 

+cache-static-ttl::
+       Number which specifies the time-to-live, in minutes, for the cached
+       version of repository pages accessed with a fixed SHA1. Negative
+       values have infinite ttl. Default value: -1".
+

 cache-dynamic-ttl::
        Number which specifies the time-to-live, in minutes, for the cached
 cache-dynamic-ttl::
        Number which specifies the time-to-live, in minutes, for the cached

-       version of repository pages accessed without a fixed SHA1. Default
-       value: "5".
+       version of repository pages accessed without a fixed SHA1. Negative
+       values have infinite ttl. Default value: "5".

 
 cache-repo-ttl::
        Number which specifies the time-to-live, in minutes, for the cached
 
 cache-repo-ttl::
        Number which specifies the time-to-live, in minutes, for the cached

-       version of the repository summary page. Default value: "5".
+       version of the repository summary page. Negative values have infinite
+       ttl. Default value: "5".

 
 cache-root-ttl::
        Number which specifies the time-to-live, in minutes, for the cached
 
 cache-root-ttl::
        Number which specifies the time-to-live, in minutes, for the cached

-       version of the repository index page. Default value: "5".
+       version of the repository index page. Negative values have infinite
+       ttl. Default value: "5".

 
 cache-scanrc-ttl::
        Number which specifies the time-to-live, in minutes, for the result
 
 cache-scanrc-ttl::
        Number which specifies the time-to-live, in minutes, for the result

-       of scanning a path for git repositories. Default value: "15".
+       of scanning a path for git repositories. Negative values have infinite
+       ttl. Default value: "15".
+
+cache-about-ttl::
+       Number which specifies the time-to-live, in minutes, for the cached
+       version of the repository about page. Negative values have infinite
+       ttl. Default value: "15".

 
 cache-size::
        The maximum number of entries in the cgit cache. Default value: "0"
        (i.e. caching is disabled).
 
 
 cache-size::
        The maximum number of entries in the cgit cache. Default value: "0"
        (i.e. caching is disabled).
 

-cache-static-ttl::
-       Number which specifies the time-to-live, in minutes, for the cached
-       version of repository pages accessed with a fixed SHA1. Default value:
-       "5".
-

 case-sensitive-sort::
        Sort items in the repo list case sensitively. Default value: "1".
        See also: repository-sort, section-sort.
 case-sensitive-sort::
        Sort items in the repo list case sensitively. Default value: "1".
        See also: repository-sort, section-sort.


@@ -171,9 +181,9 @@ enable-git-config::
        scan-path, section-from-path.
 
 favicon::
        scan-path, section-from-path.
 
 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
-       ignore other values. Default value: none.
+       Url used as link to a shortcut icon for cgit. It is suggested to use
+       the value "/favicon.ico" since certain browsers will ignore other
+       values. Default value: "/favicon.ico".

 
 footer::
        The content of the file specified with this option will be included
 
 footer::
        The content of the file specified with this option will be included


@@ -288,8 +298,10 @@ project-list::
        EXPANSION".
 
 readme::
        EXPANSION".
 
 readme::

-       Text which will be used as default value for "repo.readme". Default
-       value: none.
+       Text which will be used as default value for "repo.readme". Multiple
+       config keys may be specified, and cgit will use the first found file
+       in this list. This is useful in conjunction with scan-path. Default
+       value: none. See also: scan-path, repo.readme.

 
 remove-suffix::
        If set to "1" and scan-path is enabled, if any repositories are found
 
 remove-suffix::
        If set to "1" and scan-path is enabled, if any repositories are found


@@ -505,7 +517,12 @@ repo.readme::
        A path (relative to <repo.path>) which specifies a file to include
        verbatim as the "About" page for this repo. You may also specify a
        git refspec by head or by hash by prepending the refspec followed by
        A path (relative to <repo.path>) which specifies a file to include
        verbatim as the "About" page for this repo. You may also specify a
        git refspec by head or by hash by prepending the refspec followed by

-       a colon. For example, "master:docs/readme.mkd" Default value: <readme>.
+       a colon. For example, "master:docs/readme.mkd". If the value begins
+       with a colon, i.e. ":docs/readme.rst", the default branch of the
+       repository will be used. Sharing any file will expose that entire
+       directory tree to the "/about/PATH" endpoints, so be sure that there
+       are no non-public files located in the same directory as the readme
+       file. Default value: <readme>.

 
 repo.snapshots::
        A mask of allowed snapshot-formats for this repo, restricted by the
 
 repo.snapshots::
        A mask of allowed snapshot-formats for this repo, restricted by the


@@ -540,9 +557,11 @@ config files, e.g. "repo.desc" becomes "desc".
 FILTER API
 ----------
 about filter::
 FILTER API
 ----------
 about filter::

-       This filter is given no arguments. The about text that is to be
-       filtered is available on standard input and the filtered text is
-       expected on standard output.
+       This filter is given a single parameter: the filename of the source
+       file to filter. The filter can use the filename to determine (for
+       example) the type of syntax to follow when formatting the readme file.
+       The about text that is to be filtered is available on standard input
+       and the filtered text is expected on standard output.

 
 commit filter::
        This filter is given no arguments. The commit message text that is to
 
 commit filter::
        This filter is given no arguments. The commit message text that is to


@@ -612,6 +631,14 @@ clone-url=git://foo.org/$CGIT_REPO_URL git@foo.org:$CGIT_REPO_URL
 css=/css/cgit.css
 
 
 css=/css/cgit.css
 
 

+# Show owner on index page
+enable-index-owner=1
+
+
+# Allow http transport git clone
+enable-git-clone=1
+
+

 # Show extra links for each repository on the index page
 enable-index-links=1
 
 # Show extra links for each repository on the index page
 enable-index-links=1
 


@@ -628,6 +655,10 @@ enable-log-filecount=1
 enable-log-linecount=1
 
 
 enable-log-linecount=1
 
 

+# Sort branches by date
+branch-sort=age
+
+

 # Add a cgit favicon
 favicon=/favicon.ico
 
 # Add a cgit favicon
 favicon=/favicon.ico
 


@@ -669,6 +700,47 @@ mimetype.png=image/png
 mimetype.svg=image/svg+xml
 
 
 mimetype.svg=image/svg+xml
 
 

+# Highlight source code with python pygments-based highligher
+source-filter=/var/www/cgit/filters/syntax-highlighting.py
+
+# Format markdown, restructuredtext, manpages, text files, and html files
+# through the right converters
+about-filter=/var/www/cgit/filters/about-formatting.sh
+
+##
+## Search for these files in the root of the default branch of repositories
+## for coming up with the about page:
+##
+readme=:README.md
+readme=:readme.md
+readme=:README.mkd
+readme=:readme.mkd
+readme=:README.rst
+readme=:readme.rst
+readme=:README.html
+readme=:readme.html
+readme=:README.htm
+readme=:readme.htm
+readme=:README.txt
+readme=:readme.txt
+readme=:README
+readme=:readme
+readme=:INSTALL.md
+readme=:install.md
+readme=:INSTALL.mkd
+readme=:install.mkd
+readme=:INSTALL.rst
+readme=:install.rst
+readme=:INSTALL.html
+readme=:install.html
+readme=:INSTALL.htm
+readme=:install.htm
+readme=:INSTALL.txt
+readme=:install.txt
+readme=:INSTALL
+readme=:install
+
+

 ##
 ## List of repositories.
 ## PS: Any repositories listed when section is unset will not be
 ##
 ## List of repositories.
 ## PS: Any repositories listed when section is unset will not be