]> git.cameronkatri.com Git - cgit.git/blobdiff - cgitrc.5.txt
Add support for "readme" option
[cgit.git] / cgitrc.5.txt
index 617b7c39a03aaa7a5bc355fc05e2ea2be1d2bf5c..187031aaa408a486eb1673d96ad68c1f0bbfb5df 100644 (file)
@@ -1,3 +1,6 @@
+:man source:   cgit
+:man manual:   cgit
+
 CGITRC(5)
 ========
 
@@ -92,6 +95,11 @@ 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-gitweb-owner::
+       If set to "1" and scan-path is enabled, we first check each repository
+       for the git config value "gitweb.owner" to determine the owner.
+       Default value: "1". See also: scan-path.
+
 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",
@@ -107,6 +115,21 @@ enable-log-linecount::
        and removed lines for each commit on the repository log page. Default
        value: "0".
 
+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
@@ -154,6 +177,10 @@ logo-link::
        calculated url of the repository index page will be used. Default
        value: none.
 
+max-atom-items::
+       Specifies the number of items to display in atom feeds view. Default
+       value: "10".
+
 max-commit-count::
        Specifies the number of entries to list per page in "log" view. Default
        value: "50".
@@ -170,6 +197,10 @@ max-repodesc-length::
        Specifies the maximum number of repo description characters to display
        on the repository index page. Default value: "80".
 
+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
@@ -198,6 +229,20 @@ noheader::
        Flag which, when set to "1", will make cgit omit the standard header
        on all pages. Default value: none. See also: "embedded".
 
+project-list::
+       A list of subdirectories inside of scan-path, relative to it, that
+       should loaded as git repositories. This must be defined prior to
+       scan-path. Default value: none. See also: scan-path.
+
+readme::
+       Text which will be used as default value for "repo.readme". Default
+       value: none.
+
+remove-suffix::
+       If set to "1" and scan-path is enabled, if any repositories are found
+       with a suffix of ".git", this suffix will be removed for the url and
+       name. Default value: "0". See also: scan-path.
+
 renamelimit::
        Maximum number of files to consider when detecting renames. The value
         "-1" uses the compiletime value in git (for further info, look at
@@ -227,13 +272,20 @@ root-title::
 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.
+       directory. If project-list has been defined prior to scan-path,
+       scan-path loads only the directories listed in the file pointed to by
+       project-list. Default value: none. See also: cache-scanrc-ttl,
+       project-list.
 
 section::
        The name of the current repository section - all repositories defined
        after this option will inherit the current section name. Default value:
        none.
 
+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
@@ -297,6 +349,14 @@ repo.enable-log-linecount::
        A flag which can be used to disable the global setting
        `enable-log-linecount'. Default value: none.
 
+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
@@ -315,7 +375,9 @@ repo.path::
 
 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.
+       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>.
 
 repo.snapshots::
        A mask of allowed snapshot-formats for this repo, restricted by the
@@ -406,7 +468,7 @@ snapshots=tar.gz tar.bz2 zip
 ## List of common mimetypes
 ##
 
-mimetype.git=image/git
+mimetype.gif=image/gif
 mimetype.html=text/html
 mimetype.jpg=image/jpeg
 mimetype.jpeg=image/jpeg
@@ -417,8 +479,8 @@ mimetype.svg=image/svg+xml
 
 ##
 ## 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
@@ -440,7 +502,7 @@ repo.readme=info/web/about.html
 
 
 # The next repositories will be displayed under the 'extras' heading
-repo.group=extras
+section=extras
 
 
 repo.url=baz
@@ -453,7 +515,7 @@ repo.desc=the wizard of foo
 
 
 # Add some mirrored repositories
-repo.group=mirrors
+section=mirrors
 
 
 repo.url=git
@@ -492,3 +554,4 @@ will generate the following html element:
 AUTHOR
 ------
 Lars Hjemli <hjemli@gmail.com>
+Jason A. Donenfeld <Jason@zx2c4.com>