Merge branch 'lh/noweb'

[cgit.git] / cgitrc.5.txt

diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index ab9ab66571b4934f6837186d99cd5712f65a478f..fcd4308d603a89c6823618531da4e76eedb5a7c3 100644 (file)
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -1,194 +1,291 @@
-CGITRC
-======
+:man source:   cgit
+:man manual:   cgit
+
+CGITRC(5)
+========

 
 
 NAME
 ----
 
 
 NAME
 ----

-       cgitrc - runtime configuration for cgit
+cgitrc - runtime configuration for cgit

 
 
 
 

-DESCRIPTION
------------
+SYNOPSIS
+--------

 Cgitrc contains all runtime settings for cgit, including the list of git
 repositories, formatted as a line-separated list of NAME=VALUE pairs. Blank
 lines, and lines starting with '#', are ignored.
 
 
 Cgitrc contains all runtime settings for cgit, including the list of git
 repositories, formatted as a line-separated list of NAME=VALUE pairs. Blank
 lines, and lines starting with '#', are ignored.
 
 

+LOCATION
+--------
+The default location of cgitrc, defined at compile time, is /etc/cgitrc. At
+runtime, cgit will consult the environment variable CGIT_CONFIG and, if
+defined, use its value instead.
+
+

 GLOBAL SETTINGS
 ---------------
 GLOBAL SETTINGS
 ---------------

-agefile
+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.
+
+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".
 
        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".
 

-cache-root
+cache-root::

        Path used to store the cgit cache entries. Default value:
        "/var/cache/cgit".
 
        Path used to store the cgit cache entries. Default value:
        "/var/cache/cgit".
 

-cache-dynamic-ttl
+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".
 
        Number which specifies the time-to-live, in minutes, for the cached
        version of repository pages accessed without a fixed SHA1. Default
        value: "5".
 

-cache-repo-ttl
+cache-repo-ttl::

        Number which specifies the time-to-live, in minutes, for the cached
        version of the repository summary page. Default value: "5".
 
        Number which specifies the time-to-live, in minutes, for the cached
        version of the repository summary page. Default value: "5".
 

-cache-root-ttl
+cache-root-ttl::

        Number which specifies the time-to-live, in minutes, for the cached
        version of the repository index page. Default value: "5".
 
        Number which specifies the time-to-live, in minutes, for the cached
        version of the repository index page. Default value: "5".
 

-cache-size
+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".
+
+cache-size::

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

-cache-static-ttl
+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".
 
        Number which specifies the time-to-live, in minutes, for the cached
        version of repository pages accessed with a fixed SHA1. Default value:
        "5".
 

-clone-prefix
+clone-prefix::

        Space-separated list of common prefixes which, when combined with a
        repository url, generates valid clone urls for the repository. This
        setting is only used if `repo.clone-url` is unspecified. Default value:
        none.
 
        Space-separated list of common prefixes which, when combined with a
        repository url, generates valid clone urls for the repository. This
        setting is only used if `repo.clone-url` is unspecified. Default value:
        none.
 

-css
+commit-filter::
+       Specifies a command which will be invoked to format commit messages.
+       The command will get the message on its STDIN, and the STDOUT from the
+       command will be included verbatim as the commit message, i.e. this can
+       be used to implement bugtracker integration. Default value: none.
+
+css::

        Url which specifies the css document to include in all cgit pages.
        Default value: "/cgit.css".
 
        Url which specifies the css document to include in all cgit pages.
        Default value: "/cgit.css".
 

-enable-index-links
+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-filter-overrides::
+       Flag which, when set to "1", allows all filter settings to be
+       overridden in repository-specific cgitrc files. Default value: none.
+
+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",
        "commit" and "tree" pages). Default value: "0".
 
        Flag which, when set to "1", will make cgit generate extra links for
        each repo in the repository index (specifically, to the "summary",
        "commit" and "tree" pages). Default value: "0".
 

-enable-log-filecount
+enable-log-filecount::

        Flag which, when set to "1", will make cgit print the number of
        modified files for each commit on the repository log page. Default
        value: "0".
 
        Flag which, when set to "1", will make cgit print the number of
        modified files for each commit on the repository log page. Default
        value: "0".
 

-enable-log-linecount
+enable-log-linecount::

        Flag which, when set to "1", will make cgit print the number of added
        and removed lines for each commit on the repository log page. Default
        value: "0".
 
        Flag which, when set to "1", will make cgit print the number of added
        and removed lines for each commit on the repository log page. Default
        value: "0".
 

-favicon
+enable-remote-branches::
+       Flag which, when set to "1", will make cgit display remote branches
+       in the summary and refs views. Default value: "0". See also:
+       "repo.enable-remote-branches".
+
+enable-subject-links::
+       Flag which, when set to "1", will make cgit use the subject of the
+       parent commit as link text when generating links to parent commits
+       in commit view. Default value: "0". See also:
+       "repo.enable-subject-links".
+
+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".
+
+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. If specified, it is
        suggested to use the value "/favicon.ico" since certain browsers will
        ignore other values. Default value: none.
 

-footer
+footer::

        The content of the file specified with this option will be included
        verbatim at the bottom of all pages (i.e. it replaces the standard
        "generated by..." message. Default value: none.
 
        The content of the file specified with this option will be included
        verbatim at the bottom of all pages (i.e. it replaces the standard
        "generated by..." message. Default value: none.
 

-include
+head-include::
+       The content of the file specified with this option will be included
+       verbatim in the html HEAD section on all pages. 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.
 
        Name of a configfile to include before the rest of the current config-
        file is parsed. Default value: none.
 

-index-header
+index-header::

        The content of the file specified with this option will be included
        verbatim above the repository index. This setting is deprecated, and
        will not be supported by cgit-1.0 (use root-readme instead). Default
        value: none.
 
        The content of the file specified with this option will be included
        verbatim above the repository index. This setting is deprecated, and
        will not be supported by cgit-1.0 (use root-readme instead). Default
        value: none.
 

-index-info
+index-info::

        The content of the file specified with this option will be included
        verbatim below the heading on the repository index page. This setting
        is deprecated, and will not be supported by cgit-1.0 (use root-desc
        instead). Default value: none.
 
        The content of the file specified with this option will be included
        verbatim below the heading on the repository index page. This setting
        is deprecated, and will not be supported by cgit-1.0 (use root-desc
        instead). Default value: none.
 

-local-time
+local-time::

        Flag which, if set to "1", makes cgit print commit and tag times in the
        servers timezone. Default value: "0".
 
        Flag which, if set to "1", makes cgit print commit and tag times in the
        servers timezone. Default value: "0".
 

-logo
+logo::

        Url which specifies the source of an image which will be used as a logo
        Url which specifies the source of an image which will be used as a logo

-       on all cgit pages.
+       on all cgit pages. Default value: "/cgit.png".

 
 

-logo-link
+logo-link::

        Url loaded when clicking on the cgit logo image. If unspecified the
        calculated url of the repository index page will be used. Default
        value: none.
 
        Url loaded when clicking on the cgit logo image. If unspecified the
        calculated url of the repository index page will be used. Default
        value: none.
 

-max-commit-count
+max-commit-count::

        Specifies the number of entries to list per page in "log" view. Default
        value: "50".
 
        Specifies the number of entries to list per page in "log" view. Default
        value: "50".
 

-max-message-length
+max-message-length::

        Specifies the maximum number of commit message characters to display in
        "log" view. Default value: "80".
 
        Specifies the maximum number of commit message characters to display in
        "log" view. Default value: "80".
 

-max-repo-count
+max-repo-count::

        Specifies the number of entries to list per page on the repository
        index page. Default value: "50".
 
        Specifies the number of entries to list per page on the repository
        index page. Default value: "50".
 

-max-repodesc-length
+max-repodesc-length::

        Specifies the maximum number of repo description characters to display
        on the repository index page. Default value: "80".
 
        Specifies the maximum number of repo description characters to display
        on the repository index page. Default value: "80".
 

-module-link
+max-blob-size::
+       Specifies the maximum size of a blob to display HTML for in KBytes.
+       Default value: "0" (limit disabled).
+
+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".
+
+mimetype.<ext>::
+       Set the mimetype for the specified filename extension. This is used
+       by the `plain` command when returning blob content.
+
+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
        formatstring are the path and SHA1 of the submodule commit. Default
        value: "./?repo=%s&page=commit&id=%s"
 
        Text which will be used as the formatstring for a hyperlink when a
        submodule is printed in a directory listing. The arguments for the
        formatstring are the path and SHA1 of the submodule commit. Default
        value: "./?repo=%s&page=commit&id=%s"
 

-nocache
+nocache::

        If set to the value "1" caching will be disabled. This settings is
        deprecated, and will not be honored starting with cgit-1.0. Default
        value: "0".
 
        If set to the value "1" caching will be disabled. This settings is
        deprecated, and will not be honored starting with cgit-1.0. Default
        value: "0".
 

-renamelimit
+noplainemail::
+       If set to "1" showing full author email adresses will be disabled.
+       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
          `man git-diff`). Default value: "-1".
 
        Maximum number of files to consider when detecting renames. The value
         "-1" uses the compiletime value in git (for further info, look at
          `man git-diff`). Default value: "-1".
 

-repo.group
-       A value for the current repository group, which all repositories
-       specified after this setting will inherit. Default value: none.
+repo.group::
+       Legacy alias for "section". This option is deprecated and will not be
+       supported in cgit-1.0.

 
 

-robots
+robots::

        Text used as content for the "robots" meta-tag. Default value:
        "index, nofollow".
 
        Text used as content for the "robots" meta-tag. Default value:
        "index, nofollow".
 

-root-desc
+root-desc::

        Text printed below the heading on the repository index page. Default
        value: "a fast webinterface for the git dscm".
 
        Text printed below the heading on the repository index page. Default
        value: "a fast webinterface for the git dscm".
 

-root-readme:
+root-readme::

        The content of the file specified with this option will be included
        verbatim below the "about" link on the repository index page. Default
        value: none.
 
        The content of the file specified with this option will be included
        verbatim below the "about" link on the repository index page. Default
        value: none.
 

-root-title
+root-title::

        Text printed as heading on the repository index page. Default value:
        "Git Repository Browser".
 
        Text printed as heading on the repository index page. Default value:
        "Git Repository Browser".
 

-snapshots
-       Text which specifies the default (and allowed) set of snapshot formats
-       supported by cgit. The value is a space-separated list of zero or more
-       of the following values:
-               "tar"           uncompressed tar-file
-               "tar.gz"        gzip-compressed tar-file
-               "tar.bz2"       bzip-compressed tar-file
-               "zip"           zip-file
-       Default value: none.
+scan-path::
+       A path which will be scanned for repositories. If caching is enabled,
+       the result will be cached as a cgitrc include-file in the cache
+       directory. Default value: none. See also: cache-scanrc-ttl.
+
+section::
+       The name of the current repository section - all repositories defined
+       after this option will inherit the current section name. Default value:
+       none.

 
 

-summary-branches
+side-by-side-diffs::
+       If set to "1" shows side-by-side diffs instead of unidiffs per
+       default. Default value: "0".
+
+snapshots::
+       Text which specifies the default set of snapshot formats generated by
+       cgit. The value is a space-separated list of zero or more of the
+       values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none.
+
+source-filter::
+       Specifies a command which will be invoked to format plaintext blobs
+       in the tree view. The command will get the blob content on its STDIN
+       and the name of the blob as its only command line argument. The STDOUT
+       from the command will be included verbatim as the blob contents, i.e.
+       this can be used to implement e.g. syntax highlighting. Default value:
+       none.
+
+summary-branches::

        Specifies the number of branches to display in the repository "summary"
        view. Default value: "10".
 
        Specifies the number of branches to display in the repository "summary"
        view. Default value: "10".
 

-summary-log
+summary-log::

        Specifies the number of log entries to display in the repository
        "summary" view. Default value: "10".
 
        Specifies the number of log entries to display in the repository
        "summary" view. Default value: "10".
 

-summary-tags
+summary-tags::

        Specifies the number of tags to display in the repository "summary"
        view. Default value: "10".
 
        Specifies the number of tags to display in the repository "summary"
        view. Default value: "10".
 

-virtual-root
+virtual-root::

        Url which, if specified, will be used as root for all cgit links. It
        will also cause cgit to generate 'virtual urls', i.e. urls like
        '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default
        Url which, if specified, will be used as root for all cgit links. It
        will also cause cgit to generate 'virtual urls', i.e. urls like
        '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default


@@ -198,53 +295,96 @@ virtual-root
 
 REPOSITORY SETTINGS
 -------------------
 
 REPOSITORY SETTINGS
 -------------------

-repo.clone-url
+repo.about-filter::
+       Override the default about-filter. Default value: none. See also:
+       "enable-filter-overrides".
+
+repo.clone-url::

        A list of space-separated urls which can be used to clone this repo.
        Default value: none.
 
        A list of space-separated urls which can be used to clone this repo.
        Default value: none.
 

-repo.defbranch
+repo.commit-filter::
+       Override the default commit-filter. Default value: none. See also:
+       "enable-filter-overrides".
+
+repo.defbranch::

        The name of the default branch for this repository. If no such branch
        exists in the repository, the first branch name (when sorted) is used
        as default instead. Default value: "master".
 
        The name of the default branch for this repository. If no such branch
        exists in the repository, the first branch name (when sorted) is used
        as default instead. Default value: "master".
 

-repo.desc
+repo.desc::

        The value to show as repository description. Default value: none.
 
        The value to show as repository description. Default value: none.
 

-repo.enable-log-filecount
+repo.enable-log-filecount::

        A flag which can be used to disable the global setting
        `enable-log-filecount'. Default value: none.
 
        A flag which can be used to disable the global setting
        `enable-log-filecount'. Default value: none.
 

-repo.enable-log-linecount
+repo.enable-log-linecount::

        A flag which can be used to disable the global setting
        `enable-log-linecount'. Default value: none.
 
        A flag which can be used to disable the global setting
        `enable-log-linecount'. Default value: none.
 

-repo.name
+repo.enable-remote-branches::
+       Flag which, when set to "1", will make cgit display remote branches
+       in the summary and refs views. Default value: <enable-remote-branches>.
+
+repo.enable-subject-links::
+       A flag which can be used to override the global setting
+       `enable-subject-links'. 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>.
 
        The value to show as repository name. Default value: <repo.url>.
 

-repo.owner
+repo.owner::

        A value used to identify the owner of the repository. Default value:
        none.
 
        A value used to identify the owner of the repository. Default value:
        none.
 

-repo.path
+repo.path::

        An absolute path to the repository directory. For non-bare repositories
        this is the .git-directory. Default value: none.
 
        An absolute path to the repository directory. For non-bare repositories
        this is the .git-directory. Default value: none.
 

-repo.readme
+repo.readme::

        A path (relative to <repo.path>) which specifies a file to include
        verbatim as the "About" page for this repo. Default value: none.
 
        A path (relative to <repo.path>) which specifies a file to include
        verbatim as the "About" page for this repo. Default value: none.
 

-repo.snapshots
+repo.snapshots::

        A mask of allowed snapshot-formats for this repo, restricted by the
        "snapshots" global setting. Default value: <snapshots>.
 
        A mask of allowed snapshot-formats for this repo, restricted by the
        "snapshots" global setting. Default value: <snapshots>.
 

-repo.url
+repo.section::
+       Override the current section name for this repository. Default value:
+       none.
+
+repo.source-filter::
+       Override the default source-filter. Default value: none. See also:
+       "enable-filter-overrides".
+
+repo.url::

        The relative url used to access the repository. This must be the first
        setting specified for each repo. Default value: none.
 
 
        The relative url used to access the repository. This must be the first
        setting specified for each repo. Default value: none.
 
 

+REPOSITORY-SPECIFIC CGITRC FILE
+-------------------------------
+When the option "scan-path" is used to auto-discover git repositories, cgit
+will try to parse the file "cgitrc" within any found repository. Such a
+repo-specific config file may contain any of the repo-specific options
+described above, except "repo.url" and "repo.path". Additionally, the "filter"
+options are only acknowledged in repo-specific config files when
+"enable-filter-overrides" is set to "1".
+
+Note: the "repo." prefix is dropped from the option names in repo-specific
+config files, e.g. "repo.desc" becomes "desc".
+
+

 EXAMPLE CGITRC FILE
 -------------------
 
 EXAMPLE CGITRC FILE
 -------------------
 

+....

 # Enable caching of up to 1000 output entriess
 cache-size=1000
 
 # Enable caching of up to 1000 output entriess
 cache-size=1000
 


@@ -276,6 +416,10 @@ favicon=/favicon.ico
 logo=/img/mylogo.png
 
 
 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
 
 # Set the title and heading of the repository index page
 root-title=foobar.com git repositories
 


@@ -292,10 +436,23 @@ root-readme=/var/www/htdocs/about.html
 snapshots=tar.gz tar.bz2 zip
 
 
 snapshots=tar.gz tar.bz2 zip
 
 

+##
+## List of common mimetypes
+##
+
+mimetype.git=image/git
+mimetype.html=text/html
+mimetype.jpg=image/jpeg
+mimetype.jpeg=image/jpeg
+mimetype.pdf=application/pdf
+mimetype.png=image/png
+mimetype.svg=image/svg+xml
+
+

 ##
 ## List of repositories.
 ##
 ## List of repositories.

-## PS: Any repositories listed when repo.group is unset will not be
-##     displayed under a group heading
+## PS: Any repositories listed when section is unset will not be
+##     displayed under a section heading

 ## PPS: This list could be kept in a different file (e.g. '/etc/cgitrepos')
 ##      and included like this:
 ##        include=/etc/cgitrepos
 ## PPS: This list could be kept in a different file (e.g. '/etc/cgitrepos')
 ##      and included like this:
 ##        include=/etc/cgitrepos


@@ -317,7 +474,7 @@ repo.readme=info/web/about.html
 
 
 # The next repositories will be displayed under the 'extras' heading
 
 
 # The next repositories will be displayed under the 'extras' heading

-repo.group=extras
+section=extras

 
 
 repo.url=baz
 
 
 repo.url=baz


@@ -330,7 +487,7 @@ repo.desc=the wizard of foo
 
 
 # Add some mirrored repositories
 
 
 # Add some mirrored repositories

-repo.group=mirrors
+section=mirrors

 
 
 repo.url=git
 
 
 repo.url=git


@@ -348,6 +505,10 @@ repo.snapshots=0
 # Disable line-counts for this repo
 repo.enable-log-linecount=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
 ----
 
 BUGS
 ----