-rw-r--r-- | cgitrc.5.txt | 21 |
1 files changed, 20 insertions, 1 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt index a853522..5d77973 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt | |||
@@ -50,96 +50,101 @@ cache-dynamic-ttl:: | |||
50 | value: "5". | 50 | value: "5". |
51 | 51 | ||
52 | cache-repo-ttl:: | 52 | cache-repo-ttl:: |
53 | Number which specifies the time-to-live, in minutes, for the cached | 53 | Number which specifies the time-to-live, in minutes, for the cached |
54 | version of the repository summary page. Default value: "5". | 54 | version of the repository summary page. Default value: "5". |
55 | 55 | ||
56 | cache-root-ttl:: | 56 | cache-root-ttl:: |
57 | Number which specifies the time-to-live, in minutes, for the cached | 57 | Number which specifies the time-to-live, in minutes, for the cached |
58 | version of the repository index page. Default value: "5". | 58 | version of the repository index page. Default value: "5". |
59 | 59 | ||
60 | cache-scanrc-ttl:: | 60 | cache-scanrc-ttl:: |
61 | Number which specifies the time-to-live, in minutes, for the result | 61 | Number which specifies the time-to-live, in minutes, for the result |
62 | of scanning a path for git repositories. Default value: "15". | 62 | of scanning a path for git repositories. Default value: "15". |
63 | 63 | ||
64 | cache-size:: | 64 | cache-size:: |
65 | The maximum number of entries in the cgit cache. Default value: "0" | 65 | The maximum number of entries in the cgit cache. Default value: "0" |
66 | (i.e. caching is disabled). | 66 | (i.e. caching is disabled). |
67 | 67 | ||
68 | cache-static-ttl:: | 68 | cache-static-ttl:: |
69 | Number which specifies the time-to-live, in minutes, for the cached | 69 | Number which specifies the time-to-live, in minutes, for the cached |
70 | version of repository pages accessed with a fixed SHA1. Default value: | 70 | version of repository pages accessed with a fixed SHA1. Default value: |
71 | "5". | 71 | "5". |
72 | 72 | ||
73 | clone-prefix:: | 73 | clone-prefix:: |
74 | Space-separated list of common prefixes which, when combined with a | 74 | Space-separated list of common prefixes which, when combined with a |
75 | repository url, generates valid clone urls for the repository. This | 75 | repository url, generates valid clone urls for the repository. This |
76 | setting is only used if `repo.clone-url` is unspecified. Default value: | 76 | setting is only used if `repo.clone-url` is unspecified. Default value: |
77 | none. | 77 | none. |
78 | 78 | ||
79 | commit-filter:: | 79 | commit-filter:: |
80 | Specifies a command which will be invoked to format commit messages. | 80 | Specifies a command which will be invoked to format commit messages. |
81 | The command will get the message on its STDIN, and the STDOUT from the | 81 | The command will get the message on its STDIN, and the STDOUT from the |
82 | command will be included verbatim as the commit message, i.e. this can | 82 | command will be included verbatim as the commit message, i.e. this can |
83 | be used to implement bugtracker integration. Default value: none. | 83 | be used to implement bugtracker integration. Default value: none. |
84 | 84 | ||
85 | css:: | 85 | css:: |
86 | Url which specifies the css document to include in all cgit pages. | 86 | Url which specifies the css document to include in all cgit pages. |
87 | Default value: "/cgit.css". | 87 | Default value: "/cgit.css". |
88 | 88 | ||
89 | embedded:: | 89 | embedded:: |
90 | Flag which, when set to "1", will make cgit generate a html fragment | 90 | Flag which, when set to "1", will make cgit generate a html fragment |
91 | suitable for embedding in other html pages. Default value: none. See | 91 | suitable for embedding in other html pages. Default value: none. See |
92 | also: "noheader". | 92 | also: "noheader". |
93 | 93 | ||
94 | enable-filter-overrides:: | 94 | 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 | ||
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 |
100 | each repo in the repository index (specifically, to the "summary", | 105 | each repo in the repository index (specifically, to the "summary", |
101 | "commit" and "tree" pages). Default value: "0". | 106 | "commit" and "tree" pages). Default value: "0". |
102 | 107 | ||
103 | enable-log-filecount:: | 108 | enable-log-filecount:: |
104 | Flag which, when set to "1", will make cgit print the number of | 109 | Flag which, when set to "1", will make cgit print the number of |
105 | modified files for each commit on the repository log page. Default | 110 | modified files for each commit on the repository log page. Default |
106 | value: "0". | 111 | value: "0". |
107 | 112 | ||
108 | enable-log-linecount:: | 113 | enable-log-linecount:: |
109 | Flag which, when set to "1", will make cgit print the number of added | 114 | Flag which, when set to "1", will make cgit print the number of added |
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 | ||
113 | enable-remote-branches:: | 118 | enable-remote-branches:: |
114 | Flag which, when set to "1", will make cgit display remote branches | 119 | Flag which, when set to "1", will make cgit display remote branches |
115 | in the summary and refs views. Default value: "0". See also: | 120 | in the summary and refs views. Default value: "0". See also: |
116 | "repo.enable-remote-branches". | 121 | "repo.enable-remote-branches". |
117 | 122 | ||
118 | enable-subject-links:: | 123 | enable-subject-links:: |
119 | Flag which, when set to "1", will make cgit use the subject of the | 124 | Flag which, when set to "1", will make cgit use the subject of the |
120 | parent commit as link text when generating links to parent commits | 125 | parent commit as link text when generating links to parent commits |
121 | in commit view. Default value: "0". See also: | 126 | in commit view. Default value: "0". See also: |
122 | "repo.enable-subject-links". | 127 | "repo.enable-subject-links". |
123 | 128 | ||
124 | enable-tree-linenumbers:: | 129 | enable-tree-linenumbers:: |
125 | 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 |
126 | for plaintext blobs printed in the tree view. Default value: "1". | 131 | for plaintext blobs printed in the tree view. Default value: "1". |
127 | 132 | ||
128 | favicon:: | 133 | favicon:: |
129 | Url used as link to a shortcut icon for cgit. If specified, it is | 134 | Url used as link to a shortcut icon for cgit. If specified, it is |
130 | suggested to use the value "/favicon.ico" since certain browsers will | 135 | suggested to use the value "/favicon.ico" since certain browsers will |
131 | ignore other values. Default value: none. | 136 | ignore other values. Default value: none. |
132 | 137 | ||
133 | footer:: | 138 | footer:: |
134 | The content of the file specified with this option will be included | 139 | The content of the file specified with this option will be included |
135 | verbatim at the bottom of all pages (i.e. it replaces the standard | 140 | verbatim at the bottom of all pages (i.e. it replaces the standard |
136 | "generated by..." message. Default value: none. | 141 | "generated by..." message. Default value: none. |
137 | 142 | ||
138 | head-include:: | 143 | head-include:: |
139 | The content of the file specified with this option will be included | 144 | The content of the file specified with this option will be included |
140 | verbatim in the html HEAD section on all pages. Default value: none. | 145 | verbatim in the html HEAD section on all pages. Default value: none. |
141 | 146 | ||
142 | header:: | 147 | header:: |
143 | The content of the file specified with this option will be included | 148 | The content of the file specified with this option will be included |
144 | verbatim at the top of all pages. Default value: none. | 149 | verbatim at the top of all pages. Default value: none. |
145 | 150 | ||
@@ -179,126 +184,139 @@ max-atom-items:: | |||
179 | max-commit-count:: | 184 | max-commit-count:: |
180 | 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 |
181 | value: "50". | 186 | value: "50". |
182 | 187 | ||
183 | max-message-length:: | 188 | max-message-length:: |
184 | Specifies the maximum number of commit message characters to display in | 189 | Specifies the maximum number of commit message characters to display in |
185 | "log" view. Default value: "80". | 190 | "log" view. Default value: "80". |
186 | 191 | ||
187 | max-repo-count:: | 192 | max-repo-count:: |
188 | Specifies the number of entries to list per page on therepository | 193 | Specifies the number of entries to list per page on therepository |
189 | index page. Default value: "50". | 194 | index page. Default value: "50". |
190 | 195 | ||
191 | max-repodesc-length:: | 196 | max-repodesc-length:: |
192 | Specifies the maximum number of repo description characters to display | 197 | Specifies the maximum number of repo description characters to display |
193 | on the repository index page. Default value: "80". | 198 | on the repository index page. Default value: "80". |
194 | 199 | ||
195 | max-blob-size:: | 200 | max-blob-size:: |
196 | Specifies the maximum size of a blob to display HTML for in KBytes. | 201 | Specifies the maximum size of a blob to display HTML for in KBytes. |
197 | Default value: "0" (limit disabled). | 202 | Default value: "0" (limit disabled). |
198 | 203 | ||
199 | max-stats:: | 204 | max-stats:: |
200 | Set the default maximum statistics period. Valid values are "week", | 205 | Set the default maximum statistics period. Valid values are "week", |
201 | "month", "quarter" and "year". If unspecified, statistics are | 206 | "month", "quarter" and "year". If unspecified, statistics are |
202 | disabled. Default value: none. See also: "repo.max-stats". | 207 | disabled. Default value: none. See also: "repo.max-stats". |
203 | 208 | ||
204 | mimetype.<ext>:: | 209 | mimetype.<ext>:: |
205 | Set the mimetype for the specified filename extension. This is used | 210 | Set the mimetype for the specified filename extension. This is used |
206 | by the `plain` command when returning blob content. | 211 | by the `plain` command when returning blob content. |
207 | 212 | ||
208 | module-link:: | 213 | module-link:: |
209 | Text which will be used as the formatstring for a hyperlink when a | 214 | 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 | 215 | submodule is printed in a directory listing. The arguments for the |
211 | formatstring are the path and SHA1 of the submodule commit. Default | 216 | formatstring are the path and SHA1 of the submodule commit. Default |
212 | value: "./?repo=%s&page=commit&id=%s" | 217 | value: "./?repo=%s&page=commit&id=%s" |
213 | 218 | ||
214 | nocache:: | 219 | nocache:: |
215 | If set to the value "1" caching will be disabled. This settings is | 220 | 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 | 221 | deprecated, and will not be honored starting with cgit-1.0. Default |
217 | value: "0". | 222 | value: "0". |
218 | 223 | ||
219 | noplainemail:: | 224 | noplainemail:: |
220 | If set to "1" showing full author email adresses will be disabled. | 225 | If set to "1" showing full author email adresses will be disabled. |
221 | Default value: "0". | 226 | Default value: "0". |
222 | 227 | ||
223 | noheader:: | 228 | noheader:: |
224 | 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 |
225 | on all pages. Default value: none. See also: "embedded". | 230 | on all pages. Default value: none. See also: "embedded". |
226 | 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 | remove-suffix:: | ||
238 | If set to "1" and scan-path is enabled, if any repositories are found | ||
239 | with a suffix of ".git", this suffix will be removed for the url and | ||
240 | name. Default value: "0". See also: scan-path. | ||
241 | |||
227 | renamelimit:: | 242 | renamelimit:: |
228 | Maximum number of files to consider when detecting renames. The value | 243 | Maximum number of files to consider when detecting renames. The value |
229 | "-1" uses the compiletime value in git (for further info, look at | 244 | "-1" uses the compiletime value in git (for further info, look at |
230 | `man git-diff`). Default value: "-1". | 245 | `man git-diff`). Default value: "-1". |
231 | 246 | ||
232 | repo.group:: | 247 | repo.group:: |
233 | Legacy alias for "section". This option is deprecated and will not be | 248 | Legacy alias for "section". This option is deprecated and will not be |
234 | supported in cgit-1.0. | 249 | supported in cgit-1.0. |
235 | 250 | ||
236 | robots:: | 251 | robots:: |
237 | Text used as content for the "robots" meta-tag. Default value: | 252 | Text used as content for the "robots" meta-tag. Default value: |
238 | "index, nofollow". | 253 | "index, nofollow". |
239 | 254 | ||
240 | root-desc:: | 255 | root-desc:: |
241 | Text printed below the heading on the repository index page. Default | 256 | Text printed below the heading on the repository index page. Default |
242 | value: "a fast webinterface for the git dscm". | 257 | value: "a fast webinterface for the git dscm". |
243 | 258 | ||
244 | root-readme:: | 259 | root-readme:: |
245 | The content of the file specified with this option will be included | 260 | The content of the file specified with this option will be included |
246 | verbatim below the "about" link on the repository index page. Default | 261 | verbatim below the "about" link on the repository index page. Default |
247 | value: none. | 262 | value: none. |
248 | 263 | ||
249 | root-title:: | 264 | root-title:: |
250 | Text printed as heading on the repository index page. Default value: | 265 | Text printed as heading on the repository index page. Default value: |
251 | "Git Repository Browser". | 266 | "Git Repository Browser". |
252 | 267 | ||
253 | scan-path:: | 268 | scan-path:: |
254 | A path which will be scanned for repositories. If caching is enabled, | 269 | A path which will be scanned for repositories. If caching is enabled, |
255 | the result will be cached as a cgitrc include-file in the cache | 270 | the result will be cached as a cgitrc include-file in the cache |
256 | directory. Default value: none. See also: cache-scanrc-ttl. | 271 | directory. If project-list has been defined prior to scan-path, |
272 | scan-path loads only the directories listed in the file pointed to by | ||
273 | project-list. Default value: none. See also: cache-scanrc-ttl, | ||
274 | project-list. | ||
257 | 275 | ||
258 | section:: | 276 | section:: |
259 | The name of the current repository section - all repositories defined | 277 | The name of the current repository section - all repositories defined |
260 | after this option will inherit the current section name. Default value: | 278 | after this option will inherit the current section name. Default value: |
261 | none. | 279 | none. |
262 | 280 | ||
263 | side-by-side-diffs:: | 281 | side-by-side-diffs:: |
264 | If set to "1" shows side-by-side diffs instead of unidiffs per | 282 | If set to "1" shows side-by-side diffs instead of unidiffs per |
265 | default. Default value: "0". | 283 | default. Default value: "0". |
266 | 284 | ||
267 | snapshots:: | 285 | snapshots:: |
268 | Text which specifies the default set of snapshot formats generated by | 286 | Text which specifies the default set of snapshot formats generated by |
269 | cgit. The value is a space-separated list of zero or more of the | 287 | cgit. The value is a space-separated list of zero or more of the |
270 | values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none. | 288 | values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none. |
271 | 289 | ||
272 | source-filter:: | 290 | source-filter:: |
273 | Specifies a command which will be invoked to format plaintext blobs | 291 | Specifies a command which will be invoked to format plaintext blobs |
274 | in the tree view. The command will get the blob content on its STDIN | 292 | in the tree view. The command will get the blob content on its STDIN |
275 | and the name of the blob as its only command line argument. The STDOUT | 293 | and the name of the blob as its only command line argument. The STDOUT |
276 | from the command will be included verbatim as the blob contents, i.e. | 294 | from the command will be included verbatim as the blob contents, i.e. |
277 | this can be used to implement e.g. syntax highlighting. Default value: | 295 | this can be used to implement e.g. syntax highlighting. Default value: |
278 | none. | 296 | none. |
279 | 297 | ||
280 | summary-branches:: | 298 | summary-branches:: |
281 | Specifies the number of branches to display in the repository "summary" | 299 | Specifies the number of branches to display in the repository "summary" |
282 | view. Default value: "10". | 300 | view. Default value: "10". |
283 | 301 | ||
284 | summary-log:: | 302 | summary-log:: |
285 | Specifies the number of log entries to display in the repository | 303 | Specifies the number of log entries to display in the repository |
286 | "summary" view. Default value: "10". | 304 | "summary" view. Default value: "10". |
287 | 305 | ||
288 | summary-tags:: | 306 | summary-tags:: |
289 | Specifies the number of tags to display in the repository "summary" | 307 | Specifies the number of tags to display in the repository "summary" |
290 | view. Default value: "10". | 308 | view. Default value: "10". |
291 | 309 | ||
292 | virtual-root:: | 310 | virtual-root:: |
293 | Url which, if specified, will be used as root for all cgit links. It | 311 | Url which, if specified, will be used as root for all cgit links. It |
294 | will also cause cgit to generate 'virtual urls', i.e. urls like | 312 | will also cause cgit to generate 'virtual urls', i.e. urls like |
295 | '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default | 313 | '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default |
296 | value: none. | 314 | value: none. |
297 | NOTE: cgit has recently learned how to use PATH_INFO to achieve the | 315 | NOTE: cgit has recently learned how to use PATH_INFO to achieve the |
298 | same kind of virtual urls, so this option will probably be deprecated. | 316 | same kind of virtual urls, so this option will probably be deprecated. |
299 | 317 | ||
300 | REPOSITORY SETTINGS | 318 | REPOSITORY SETTINGS |
301 | ------------------- | 319 | ------------------- |
302 | repo.about-filter:: | 320 | repo.about-filter:: |
303 | Override the default about-filter. Default value: none. See also: | 321 | Override the default about-filter. Default value: none. See also: |
304 | "enable-filter-overrides". | 322 | "enable-filter-overrides". |
@@ -485,48 +503,49 @@ repo.url=baz | |||
485 | repo.path=/pub/git/baz.git | 503 | repo.path=/pub/git/baz.git |
486 | repo.desc=a set of extensions for bar users | 504 | repo.desc=a set of extensions for bar users |
487 | 505 | ||
488 | repo.url=wiz | 506 | repo.url=wiz |
489 | repo.path=/pub/git/wiz.git | 507 | repo.path=/pub/git/wiz.git |
490 | repo.desc=the wizard of foo | 508 | repo.desc=the wizard of foo |
491 | 509 | ||
492 | 510 | ||
493 | # Add some mirrored repositories | 511 | # Add some mirrored repositories |
494 | section=mirrors | 512 | section=mirrors |
495 | 513 | ||
496 | 514 | ||
497 | repo.url=git | 515 | repo.url=git |
498 | repo.path=/pub/git/git.git | 516 | repo.path=/pub/git/git.git |
499 | repo.desc=the dscm | 517 | repo.desc=the dscm |
500 | 518 | ||
501 | 519 | ||
502 | repo.url=linux | 520 | repo.url=linux |
503 | repo.path=/pub/git/linux.git | 521 | repo.path=/pub/git/linux.git |
504 | repo.desc=the kernel | 522 | repo.desc=the kernel |
505 | 523 | ||
506 | # Disable adhoc downloads of this repo | 524 | # Disable adhoc downloads of this repo |
507 | repo.snapshots=0 | 525 | repo.snapshots=0 |
508 | 526 | ||
509 | # Disable line-counts for this repo | 527 | # Disable line-counts for this repo |
510 | repo.enable-log-linecount=0 | 528 | repo.enable-log-linecount=0 |
511 | 529 | ||
512 | # Restrict the max statistics period for this repo | 530 | # Restrict the max statistics period for this repo |
513 | repo.max-stats=month | 531 | repo.max-stats=month |
514 | .... | 532 | .... |
515 | 533 | ||
516 | 534 | ||
517 | BUGS | 535 | BUGS |
518 | ---- | 536 | ---- |
519 | Comments currently cannot appear on the same line as a setting; the comment | 537 | Comments currently cannot appear on the same line as a setting; the comment |
520 | will be included as part of the value. E.g. this line: | 538 | will be included as part of the value. E.g. this line: |
521 | 539 | ||
522 | robots=index # allow indexing | 540 | robots=index # allow indexing |
523 | 541 | ||
524 | will generate the following html element: | 542 | will generate the following html element: |
525 | 543 | ||
526 | <meta name='robots' content='index # allow indexing'/> | 544 | <meta name='robots' content='index # allow indexing'/> |
527 | 545 | ||
528 | 546 | ||
529 | 547 | ||
530 | AUTHOR | 548 | AUTHOR |
531 | ------ | 549 | ------ |
532 | Lars Hjemli <hjemli@gmail.com> | 550 | Lars Hjemli <hjemli@gmail.com> |
551 | Jason A. Donenfeld <Jason@zx2c4.com> | ||