-rw-r--r-- | cgitrc.5.txt | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt index ec004d4..6fb1083 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt | |||
@@ -184,96 +184,101 @@ max-message-length:: | |||
184 | Specifies the maximum number of commit message characters to display in | 184 | Specifies the maximum number of commit message characters to display in |
185 | "log" view. Default value: "80". | 185 | "log" view. Default value: "80". |
186 | 186 | ||
187 | max-repo-count:: | 187 | max-repo-count:: |
188 | Specifies the number of entries to list per page on therepository | 188 | Specifies the number of entries to list per page on therepository |
189 | index page. Default value: "50". | 189 | index page. Default value: "50". |
190 | 190 | ||
191 | max-repodesc-length:: | 191 | max-repodesc-length:: |
192 | Specifies the maximum number of repo description characters to display | 192 | Specifies the maximum number of repo description characters to display |
193 | on the repository index page. Default value: "80". | 193 | on the repository index page. Default value: "80". |
194 | 194 | ||
195 | max-blob-size:: | 195 | max-blob-size:: |
196 | Specifies the maximum size of a blob to display HTML for in KBytes. | 196 | Specifies the maximum size of a blob to display HTML for in KBytes. |
197 | Default value: "0" (limit disabled). | 197 | Default value: "0" (limit disabled). |
198 | 198 | ||
199 | max-stats:: | 199 | max-stats:: |
200 | Set the default maximum statistics period. Valid values are "week", | 200 | Set the default maximum statistics period. Valid values are "week", |
201 | "month", "quarter" and "year". If unspecified, statistics are | 201 | "month", "quarter" and "year". If unspecified, statistics are |
202 | disabled. Default value: none. See also: "repo.max-stats". | 202 | disabled. Default value: none. See also: "repo.max-stats". |
203 | 203 | ||
204 | mimetype.<ext>:: | 204 | mimetype.<ext>:: |
205 | Set the mimetype for the specified filename extension. This is used | 205 | Set the mimetype for the specified filename extension. This is used |
206 | by the `plain` command when returning blob content. | 206 | by the `plain` command when returning blob content. |
207 | 207 | ||
208 | module-link:: | 208 | module-link:: |
209 | Text which will be used as the formatstring for a hyperlink when a | 209 | Text which will be used as the formatstring for a hyperlink when a |
210 | submodule is printed in a directory listing. The arguments for the | 210 | submodule is printed in a directory listing. The arguments for the |
211 | formatstring are the path and SHA1 of the submodule commit. Default | 211 | formatstring are the path and SHA1 of the submodule commit. Default |
212 | value: "./?repo=%s&page=commit&id=%s" | 212 | value: "./?repo=%s&page=commit&id=%s" |
213 | 213 | ||
214 | nocache:: | 214 | nocache:: |
215 | If set to the value "1" caching will be disabled. This settings is | 215 | If set to the value "1" caching will be disabled. This settings is |
216 | deprecated, and will not be honored starting with cgit-1.0. Default | 216 | deprecated, and will not be honored starting with cgit-1.0. Default |
217 | value: "0". | 217 | value: "0". |
218 | 218 | ||
219 | noplainemail:: | 219 | noplainemail:: |
220 | If set to "1" showing full author email adresses will be disabled. | 220 | If set to "1" showing full author email adresses will be disabled. |
221 | Default value: "0". | 221 | Default value: "0". |
222 | 222 | ||
223 | noheader:: | 223 | noheader:: |
224 | Flag which, when set to "1", will make cgit omit the standard header | 224 | Flag which, when set to "1", will make cgit omit the standard header |
225 | on all pages. Default value: none. See also: "embedded". | 225 | on all pages. Default value: none. See also: "embedded". |
226 | 226 | ||
227 | project-list:: | 227 | project-list:: |
228 | A list of subdirectories inside of scan-path, relative to it, that | 228 | A list of subdirectories inside of scan-path, relative to it, that |
229 | should loaded as git repositories. This must be defined prior to | 229 | should loaded as git repositories. This must be defined prior to |
230 | scan-path. Default value: none. See also: scan-path. | 230 | scan-path. Default value: none. See also: scan-path. |
231 | 231 | ||
232 | remove-suffix:: | ||
233 | If set to "1" and scan-path is enabled, if any repositories are found | ||
234 | with a suffix of ".git", this suffix will be removed for the url and | ||
235 | name. Default value: "0". See also: scan-path. | ||
236 | |||
232 | renamelimit:: | 237 | renamelimit:: |
233 | Maximum number of files to consider when detecting renames. The value | 238 | Maximum number of files to consider when detecting renames. The value |
234 | "-1" uses the compiletime value in git (for further info, look at | 239 | "-1" uses the compiletime value in git (for further info, look at |
235 | `man git-diff`). Default value: "-1". | 240 | `man git-diff`). Default value: "-1". |
236 | 241 | ||
237 | repo.group:: | 242 | repo.group:: |
238 | Legacy alias for "section". This option is deprecated and will not be | 243 | Legacy alias for "section". This option is deprecated and will not be |
239 | supported in cgit-1.0. | 244 | supported in cgit-1.0. |
240 | 245 | ||
241 | robots:: | 246 | robots:: |
242 | Text used as content for the "robots" meta-tag. Default value: | 247 | Text used as content for the "robots" meta-tag. Default value: |
243 | "index, nofollow". | 248 | "index, nofollow". |
244 | 249 | ||
245 | root-desc:: | 250 | root-desc:: |
246 | Text printed below the heading on the repository index page. Default | 251 | Text printed below the heading on the repository index page. Default |
247 | value: "a fast webinterface for the git dscm". | 252 | value: "a fast webinterface for the git dscm". |
248 | 253 | ||
249 | root-readme:: | 254 | root-readme:: |
250 | The content of the file specified with this option will be included | 255 | The content of the file specified with this option will be included |
251 | verbatim below the "about" link on the repository index page. Default | 256 | verbatim below the "about" link on the repository index page. Default |
252 | value: none. | 257 | value: none. |
253 | 258 | ||
254 | root-title:: | 259 | root-title:: |
255 | Text printed as heading on the repository index page. Default value: | 260 | Text printed as heading on the repository index page. Default value: |
256 | "Git Repository Browser". | 261 | "Git Repository Browser". |
257 | 262 | ||
258 | scan-path:: | 263 | scan-path:: |
259 | A path which will be scanned for repositories. If caching is enabled, | 264 | A path which will be scanned for repositories. If caching is enabled, |
260 | the result will be cached as a cgitrc include-file in the cache | 265 | the result will be cached as a cgitrc include-file in the cache |
261 | directory. If project-list has been defined prior to scan-path, | 266 | directory. If project-list has been defined prior to scan-path, |
262 | scan-path loads only the directories listed in the file pointed to by | 267 | scan-path loads only the directories listed in the file pointed to by |
263 | project-list. Default value: none. See also: cache-scanrc-ttl, | 268 | project-list. Default value: none. See also: cache-scanrc-ttl, |
264 | project-list. | 269 | project-list. |
265 | 270 | ||
266 | section:: | 271 | section:: |
267 | The name of the current repository section - all repositories defined | 272 | The name of the current repository section - all repositories defined |
268 | after this option will inherit the current section name. Default value: | 273 | after this option will inherit the current section name. Default value: |
269 | none. | 274 | none. |
270 | 275 | ||
271 | side-by-side-diffs:: | 276 | side-by-side-diffs:: |
272 | If set to "1" shows side-by-side diffs instead of unidiffs per | 277 | If set to "1" shows side-by-side diffs instead of unidiffs per |
273 | default. Default value: "0". | 278 | default. Default value: "0". |
274 | 279 | ||
275 | snapshots:: | 280 | snapshots:: |
276 | Text which specifies the default set of snapshot formats generated by | 281 | Text which specifies the default set of snapshot formats generated by |
277 | cgit. The value is a space-separated list of zero or more of the | 282 | cgit. The value is a space-separated list of zero or more of the |
278 | values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none. | 283 | values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none. |
279 | 284 | ||
@@ -493,48 +498,49 @@ repo.url=baz | |||
493 | repo.path=/pub/git/baz.git | 498 | repo.path=/pub/git/baz.git |
494 | repo.desc=a set of extensions for bar users | 499 | repo.desc=a set of extensions for bar users |
495 | 500 | ||
496 | repo.url=wiz | 501 | repo.url=wiz |
497 | repo.path=/pub/git/wiz.git | 502 | repo.path=/pub/git/wiz.git |
498 | repo.desc=the wizard of foo | 503 | repo.desc=the wizard of foo |
499 | 504 | ||
500 | 505 | ||
501 | # Add some mirrored repositories | 506 | # Add some mirrored repositories |
502 | section=mirrors | 507 | section=mirrors |
503 | 508 | ||
504 | 509 | ||
505 | repo.url=git | 510 | repo.url=git |
506 | repo.path=/pub/git/git.git | 511 | repo.path=/pub/git/git.git |
507 | repo.desc=the dscm | 512 | repo.desc=the dscm |
508 | 513 | ||
509 | 514 | ||
510 | repo.url=linux | 515 | repo.url=linux |
511 | repo.path=/pub/git/linux.git | 516 | repo.path=/pub/git/linux.git |
512 | repo.desc=the kernel | 517 | repo.desc=the kernel |
513 | 518 | ||
514 | # Disable adhoc downloads of this repo | 519 | # Disable adhoc downloads of this repo |
515 | repo.snapshots=0 | 520 | repo.snapshots=0 |
516 | 521 | ||
517 | # Disable line-counts for this repo | 522 | # Disable line-counts for this repo |
518 | repo.enable-log-linecount=0 | 523 | repo.enable-log-linecount=0 |
519 | 524 | ||
520 | # Restrict the max statistics period for this repo | 525 | # Restrict the max statistics period for this repo |
521 | repo.max-stats=month | 526 | repo.max-stats=month |
522 | .... | 527 | .... |
523 | 528 | ||
524 | 529 | ||
525 | BUGS | 530 | BUGS |
526 | ---- | 531 | ---- |
527 | Comments currently cannot appear on the same line as a setting; the comment | 532 | Comments currently cannot appear on the same line as a setting; the comment |
528 | will be included as part of the value. E.g. this line: | 533 | will be included as part of the value. E.g. this line: |
529 | 534 | ||
530 | robots=index # allow indexing | 535 | robots=index # allow indexing |
531 | 536 | ||
532 | will generate the following html element: | 537 | will generate the following html element: |
533 | 538 | ||
534 | <meta name='robots' content='index # allow indexing'/> | 539 | <meta name='robots' content='index # allow indexing'/> |
535 | 540 | ||
536 | 541 | ||
537 | 542 | ||
538 | AUTHOR | 543 | AUTHOR |
539 | ------ | 544 | ------ |
540 | Lars Hjemli <hjemli@gmail.com> | 545 | Lars Hjemli <hjemli@gmail.com> |
546 | Jason A. Donenfeld <Jason@zx2c4.com> | ||