-rw-r--r-- | cgitrc.5.txt | 68 |
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 | |||
@@ -96,4 +96,9 @@ enable-filter-overrides:: | |||
96 | overridden in repository-specific cgitrc files. Default value: none. | 96 | overridden in repository-specific cgitrc files. Default value: none. |
97 | 97 | ||
98 | enable-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 | |||
98 | enable-index-links:: | 103 | enable-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 |
@@ -111,4 +116,15 @@ enable-log-linecount:: | |||
111 | value: "0". | 116 | value: "0". |
112 | 117 | ||
118 | enable-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 | |||
123 | enable-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 | |||
113 | enable-tree-linenumbers:: | 129 | enable-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 |
@@ -162,4 +178,8 @@ logo-link:: | |||
162 | value: none. | 178 | value: none. |
163 | 179 | ||
180 | max-atom-items:: | ||
181 | Specifies the number of items to display in atom feeds view. Default | ||
182 | value: "10". | ||
183 | |||
164 | max-commit-count:: | 184 | max-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 |
@@ -178,4 +198,8 @@ max-repodesc-length:: | |||
178 | on the repository index page. Default value: "80". | 198 | on the repository index page. Default value: "80". |
179 | 199 | ||
200 | max-blob-size:: | ||
201 | Specifies the maximum size of a blob to display HTML for in KBytes. | ||
202 | Default value: "0" (limit disabled). | ||
203 | |||
180 | max-stats:: | 204 | max-stats:: |
181 | Set the default maximum statistics period. Valid values are "week", | 205 | Set the default maximum statistics period. Valid values are "week", |
@@ -206,4 +230,18 @@ noheader:: | |||
206 | on all pages. Default value: none. See also: "embedded". | 230 | on all pages. Default value: none. See also: "embedded". |
207 | 231 | ||
232 | project-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 | |||
237 | readme:: | ||
238 | Text which will be used as default value for "repo.readme". Default | ||
239 | value: none. | ||
240 | |||
241 | remove-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 | |||
208 | renamelimit:: | 246 | renamelimit:: |
209 | Maximum number of files to consider when detecting renames. The value | 247 | Maximum number of files to consider when detecting renames. The value |
@@ -235,5 +273,8 @@ scan-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 | ||
239 | section:: | 280 | section:: |
@@ -242,4 +283,14 @@ section:: | |||
242 | none. | 283 | none. |
243 | 284 | ||
285 | section-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 | |||
291 | side-by-side-diffs:: | ||
292 | If set to "1" shows side-by-side diffs instead of unidiffs per | ||
293 | default. Default value: "0". | ||
294 | |||
244 | snapshots:: | 295 | snapshots:: |
245 | Text which specifies the default set of snapshot formats generated by | 296 | Text which specifies the default set of snapshot formats generated by |
@@ -305,4 +356,12 @@ repo.enable-log-linecount:: | |||
305 | `enable-log-linecount'. Default value: none. | 356 | `enable-log-linecount'. Default value: none. |
306 | 357 | ||
358 | repo.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 | |||
362 | repo.enable-subject-links:: | ||
363 | A flag which can be used to override the global setting | ||
364 | `enable-subject-links'. Default value: none. | ||
365 | |||
307 | repo.max-stats:: | 366 | repo.max-stats:: |
308 | Override the default maximum statistics period. Valid values are equal | 367 | Override the default maximum statistics period. Valid values are equal |
@@ -323,5 +382,7 @@ repo.path:: | |||
323 | repo.readme:: | 382 | repo.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 | ||
327 | repo.snapshots:: | 388 | repo.snapshots:: |
@@ -414,5 +475,5 @@ snapshots=tar.gz tar.bz2 zip | |||
414 | ## | 475 | ## |
415 | 476 | ||
416 | mimetype.git=image/git | 477 | mimetype.gif=image/gif |
417 | mimetype.html=text/html | 478 | mimetype.html=text/html |
418 | mimetype.jpg=image/jpeg | 479 | mimetype.jpg=image/jpeg |
@@ -500,2 +561,3 @@ AUTHOR | |||
500 | ------ | 561 | ------ |
501 | Lars Hjemli <hjemli@gmail.com> | 562 | Lars Hjemli <hjemli@gmail.com> |
563 | Jason A. Donenfeld <Jason@zx2c4.com> | ||