aboutsummaryrefslogtreecommitdiffstats
path: root/cgitrc.5.txt
diff options
context:
space:
mode:
Diffstat (limited to 'cgitrc.5.txt')
-rw-r--r--cgitrc.5.txt68
1 files changed, 65 insertions, 3 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 0c13485..ce78d41 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -95,6 +95,11 @@ enable-filter-overrides::
95 Flag which, when set to "1", allows all filter settings to be 95 Flag which, when set to "1", allows all filter settings to be
96 overridden in repository-specific cgitrc files. Default value: none. 96 overridden in repository-specific cgitrc files. Default value: none.
97 97
98enable-gitweb-owner::
99 If set to "1" and scan-path is enabled, we first check each repository
100 for the git config value "gitweb.owner" to determine the owner.
101 Default value: "1". See also: scan-path.
102
98enable-index-links:: 103enable-index-links::
99 Flag which, when set to "1", will make cgit generate extra links for 104 Flag which, when set to "1", will make cgit generate extra links for
100 each repo in the repository index (specifically, to the "summary", 105 each repo in the repository index (specifically, to the "summary",
@@ -110,6 +115,17 @@ enable-log-linecount::
110 and removed lines for each commit on the repository log page. Default 115 and removed lines for each commit on the repository log page. Default
111 value: "0". 116 value: "0".
112 117
118enable-remote-branches::
119 Flag which, when set to "1", will make cgit display remote branches
120 in the summary and refs views. Default value: "0". See also:
121 "repo.enable-remote-branches".
122
123enable-subject-links::
124 Flag which, when set to "1", will make cgit use the subject of the
125 parent commit as link text when generating links to parent commits
126 in commit view. Default value: "0". See also:
127 "repo.enable-subject-links".
128
113enable-tree-linenumbers:: 129enable-tree-linenumbers::
114 Flag which, when set to "1", will make cgit generate linenumber links 130 Flag which, when set to "1", will make cgit generate linenumber links
115 for plaintext blobs printed in the tree view. Default value: "1". 131 for plaintext blobs printed in the tree view. Default value: "1".
@@ -161,6 +177,10 @@ logo-link::
161 calculated url of the repository index page will be used. Default 177 calculated url of the repository index page will be used. Default
162 value: none. 178 value: none.
163 179
180max-atom-items::
181 Specifies the number of items to display in atom feeds view. Default
182 value: "10".
183
164max-commit-count:: 184max-commit-count::
165 Specifies the number of entries to list per page in "log" view. Default 185 Specifies the number of entries to list per page in "log" view. Default
166 value: "50". 186 value: "50".
@@ -177,6 +197,10 @@ max-repodesc-length::
177 Specifies the maximum number of repo description characters to display 197 Specifies the maximum number of repo description characters to display
178 on the repository index page. Default value: "80". 198 on the repository index page. Default value: "80".
179 199
200max-blob-size::
201 Specifies the maximum size of a blob to display HTML for in KBytes.
202 Default value: "0" (limit disabled).
203
180max-stats:: 204max-stats::
181 Set the default maximum statistics period. Valid values are "week", 205 Set the default maximum statistics period. Valid values are "week",
182 "month", "quarter" and "year". If unspecified, statistics are 206 "month", "quarter" and "year". If unspecified, statistics are
@@ -205,6 +229,20 @@ noheader::
205 Flag which, when set to "1", will make cgit omit the standard header 229 Flag which, when set to "1", will make cgit omit the standard header
206 on all pages. Default value: none. See also: "embedded". 230 on all pages. Default value: none. See also: "embedded".
207 231
232project-list::
233 A list of subdirectories inside of scan-path, relative to it, that
234 should loaded as git repositories. This must be defined prior to
235 scan-path. Default value: none. See also: scan-path.
236
237readme::
238 Text which will be used as default value for "repo.readme". Default
239 value: none.
240
241remove-suffix::
242 If set to "1" and scan-path is enabled, if any repositories are found
243 with a suffix of ".git", this suffix will be removed for the url and
244 name. Default value: "0". See also: scan-path.
245
208renamelimit:: 246renamelimit::
209 Maximum number of files to consider when detecting renames. The value 247 Maximum number of files to consider when detecting renames. The value
210 "-1" uses the compiletime value in git (for further info, look at 248 "-1" uses the compiletime value in git (for further info, look at
@@ -234,13 +272,26 @@ root-title::
234scan-path:: 272scan-path::
235 A path which will be scanned for repositories. If caching is enabled, 273 A path which will be scanned for repositories. If caching is enabled,
236 the result will be cached as a cgitrc include-file in the cache 274 the result will be cached as a cgitrc include-file in the cache
237 directory. Default value: none. See also: cache-scanrc-ttl. 275 directory. If project-list has been defined prior to scan-path,
276 scan-path loads only the directories listed in the file pointed to by
277 project-list. Default value: none. See also: cache-scanrc-ttl,
278 project-list.
238 279
239section:: 280section::
240 The name of the current repository section - all repositories defined 281 The name of the current repository section - all repositories defined
241 after this option will inherit the current section name. Default value: 282 after this option will inherit the current section name. Default value:
242 none. 283 none.
243 284
285section-from-path::
286 A number which, if specified before scan-path, specifies how many
287 path elements from each repo path to use as a default section name.
288 If negative, cgit will discard the specified number of path elements
289 above the repo directory. Default value: 0.
290
291side-by-side-diffs::
292 If set to "1" shows side-by-side diffs instead of unidiffs per
293 default. Default value: "0".
294
244snapshots:: 295snapshots::
245 Text which specifies the default set of snapshot formats generated by 296 Text which specifies the default set of snapshot formats generated by
246 cgit. The value is a space-separated list of zero or more of the 297 cgit. The value is a space-separated list of zero or more of the
@@ -304,6 +355,14 @@ repo.enable-log-linecount::
304 A flag which can be used to disable the global setting 355 A flag which can be used to disable the global setting
305 `enable-log-linecount'. Default value: none. 356 `enable-log-linecount'. Default value: none.
306 357
358repo.enable-remote-branches::
359 Flag which, when set to "1", will make cgit display remote branches
360 in the summary and refs views. Default value: <enable-remote-branches>.
361
362repo.enable-subject-links::
363 A flag which can be used to override the global setting
364 `enable-subject-links'. Default value: none.
365
307repo.max-stats:: 366repo.max-stats::
308 Override the default maximum statistics period. Valid values are equal 367 Override the default maximum statistics period. Valid values are equal
309 to the values specified for the global "max-stats" setting. Default 368 to the values specified for the global "max-stats" setting. Default
@@ -322,7 +381,9 @@ repo.path::
322 381
323repo.readme:: 382repo.readme::
324 A path (relative to <repo.path>) which specifies a file to include 383 A path (relative to <repo.path>) which specifies a file to include
325 verbatim as the "About" page for this repo. Default value: none. 384 verbatim as the "About" page for this repo. You may also specify a
385 git refspec by head or by hash by prepending the refspec followed by
386 a colon. For example, "master:docs/readme.mkd" Default value: <readme>.
326 387
327repo.snapshots:: 388repo.snapshots::
328 A mask of allowed snapshot-formats for this repo, restricted by the 389 A mask of allowed snapshot-formats for this repo, restricted by the
@@ -413,7 +474,7 @@ snapshots=tar.gz tar.bz2 zip
413## List of common mimetypes 474## List of common mimetypes
414## 475##
415 476
416mimetype.git=image/git 477mimetype.gif=image/gif
417mimetype.html=text/html 478mimetype.html=text/html
418mimetype.jpg=image/jpeg 479mimetype.jpg=image/jpeg
419mimetype.jpeg=image/jpeg 480mimetype.jpeg=image/jpeg
@@ -499,3 +560,4 @@ will generate the following html element:
499AUTHOR 560AUTHOR
500------ 561------
501Lars Hjemli <hjemli@gmail.com> 562Lars Hjemli <hjemli@gmail.com>
563Jason A. Donenfeld <Jason@zx2c4.com>