-rw-r--r-- | cgitrc.5.txt | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt index 70e4c78..d74d9e7 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt | |||
@@ -49,128 +49,133 @@ cache-dynamic-ttl:: | |||
49 | version of repository pages accessed without a fixed SHA1. Default | 49 | version of repository pages accessed without a fixed SHA1. Default |
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-index-links:: | 98 | enable-index-links:: |
99 | Flag which, when set to "1", will make cgit generate extra links for | 99 | Flag which, when set to "1", will make cgit generate extra links for |
100 | each repo in the repository index (specifically, to the "summary", | 100 | each repo in the repository index (specifically, to the "summary", |
101 | "commit" and "tree" pages). Default value: "0". | 101 | "commit" and "tree" pages). Default value: "0". |
102 | 102 | ||
103 | enable-log-filecount:: | 103 | enable-log-filecount:: |
104 | Flag which, when set to "1", will make cgit print the number of | 104 | 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 | 105 | modified files for each commit on the repository log page. Default |
106 | value: "0". | 106 | value: "0". |
107 | 107 | ||
108 | enable-log-linecount:: | 108 | enable-log-linecount:: |
109 | Flag which, when set to "1", will make cgit print the number of added | 109 | 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 | 110 | and removed lines for each commit on the repository log page. Default |
111 | value: "0". | 111 | value: "0". |
112 | 112 | ||
113 | enable-remote-branches:: | ||
114 | Flag which, when set to "1", will make cgit display remote branches | ||
115 | in the summary and refs views. Default value: "0". See also: | ||
116 | "repo.enable-remote-branches". | ||
117 | |||
113 | enable-tree-linenumbers:: | 118 | enable-tree-linenumbers:: |
114 | Flag which, when set to "1", will make cgit generate linenumber links | 119 | Flag which, when set to "1", will make cgit generate linenumber links |
115 | for plaintext blobs printed in the tree view. Default value: "1". | 120 | for plaintext blobs printed in the tree view. Default value: "1". |
116 | 121 | ||
117 | favicon:: | 122 | favicon:: |
118 | Url used as link to a shortcut icon for cgit. If specified, it is | 123 | Url used as link to a shortcut icon for cgit. If specified, it is |
119 | suggested to use the value "/favicon.ico" since certain browsers will | 124 | suggested to use the value "/favicon.ico" since certain browsers will |
120 | ignore other values. Default value: none. | 125 | ignore other values. Default value: none. |
121 | 126 | ||
122 | footer:: | 127 | footer:: |
123 | The content of the file specified with this option will be included | 128 | The content of the file specified with this option will be included |
124 | verbatim at the bottom of all pages (i.e. it replaces the standard | 129 | verbatim at the bottom of all pages (i.e. it replaces the standard |
125 | "generated by..." message. Default value: none. | 130 | "generated by..." message. Default value: none. |
126 | 131 | ||
127 | head-include:: | 132 | head-include:: |
128 | The content of the file specified with this option will be included | 133 | The content of the file specified with this option will be included |
129 | verbatim in the html HEAD section on all pages. Default value: none. | 134 | verbatim in the html HEAD section on all pages. Default value: none. |
130 | 135 | ||
131 | header:: | 136 | header:: |
132 | The content of the file specified with this option will be included | 137 | The content of the file specified with this option will be included |
133 | verbatim at the top of all pages. Default value: none. | 138 | verbatim at the top of all pages. Default value: none. |
134 | 139 | ||
135 | include:: | 140 | include:: |
136 | Name of a configfile to include before the rest of the current config- | 141 | Name of a configfile to include before the rest of the current config- |
137 | file is parsed. Default value: none. | 142 | file is parsed. Default value: none. |
138 | 143 | ||
139 | index-header:: | 144 | index-header:: |
140 | The content of the file specified with this option will be included | 145 | The content of the file specified with this option will be included |
141 | verbatim above the repository index. This setting is deprecated, and | 146 | verbatim above the repository index. This setting is deprecated, and |
142 | will not be supported by cgit-1.0 (use root-readme instead). Default | 147 | will not be supported by cgit-1.0 (use root-readme instead). Default |
143 | value: none. | 148 | value: none. |
144 | 149 | ||
145 | index-info:: | 150 | index-info:: |
146 | The content of the file specified with this option will be included | 151 | The content of the file specified with this option will be included |
147 | verbatim below the heading on the repository index page. This setting | 152 | verbatim below the heading on the repository index page. This setting |
148 | is deprecated, and will not be supported by cgit-1.0 (use root-desc | 153 | is deprecated, and will not be supported by cgit-1.0 (use root-desc |
149 | instead). Default value: none. | 154 | instead). Default value: none. |
150 | 155 | ||
151 | local-time:: | 156 | local-time:: |
152 | Flag which, if set to "1", makes cgit print commit and tag times in the | 157 | Flag which, if set to "1", makes cgit print commit and tag times in the |
153 | servers timezone. Default value: "0". | 158 | servers timezone. Default value: "0". |
154 | 159 | ||
155 | logo:: | 160 | logo:: |
156 | Url which specifies the source of an image which will be used as a logo | 161 | Url which specifies the source of an image which will be used as a logo |
157 | on all cgit pages. Default value: "/cgit.png". | 162 | on all cgit pages. Default value: "/cgit.png". |
158 | 163 | ||
159 | logo-link:: | 164 | logo-link:: |
160 | Url loaded when clicking on the cgit logo image. If unspecified the | 165 | Url loaded when clicking on the cgit logo image. If unspecified the |
161 | calculated url of the repository index page will be used. Default | 166 | calculated url of the repository index page will be used. Default |
162 | value: none. | 167 | value: none. |
163 | 168 | ||
164 | max-commit-count:: | 169 | max-commit-count:: |
165 | Specifies the number of entries to list per page in "log" view. Default | 170 | Specifies the number of entries to list per page in "log" view. Default |
166 | value: "50". | 171 | value: "50". |
167 | 172 | ||
168 | max-message-length:: | 173 | max-message-length:: |
169 | Specifies the maximum number of commit message characters to display in | 174 | Specifies the maximum number of commit message characters to display in |
170 | "log" view. Default value: "80". | 175 | "log" view. Default value: "80". |
171 | 176 | ||
172 | max-repo-count:: | 177 | max-repo-count:: |
173 | Specifies the number of entries to list per page on therepository | 178 | Specifies the number of entries to list per page on therepository |
174 | index page. Default value: "50". | 179 | index page. Default value: "50". |
175 | 180 | ||
176 | max-repodesc-length:: | 181 | max-repodesc-length:: |
@@ -251,128 +256,132 @@ side-by-side-diffs:: | |||
251 | 256 | ||
252 | snapshots:: | 257 | snapshots:: |
253 | Text which specifies the default set of snapshot formats generated by | 258 | Text which specifies the default set of snapshot formats generated by |
254 | cgit. The value is a space-separated list of zero or more of the | 259 | cgit. The value is a space-separated list of zero or more of the |
255 | values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none. | 260 | values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none. |
256 | 261 | ||
257 | source-filter:: | 262 | source-filter:: |
258 | Specifies a command which will be invoked to format plaintext blobs | 263 | Specifies a command which will be invoked to format plaintext blobs |
259 | in the tree view. The command will get the blob content on its STDIN | 264 | in the tree view. The command will get the blob content on its STDIN |
260 | and the name of the blob as its only command line argument. The STDOUT | 265 | and the name of the blob as its only command line argument. The STDOUT |
261 | from the command will be included verbatim as the blob contents, i.e. | 266 | from the command will be included verbatim as the blob contents, i.e. |
262 | this can be used to implement e.g. syntax highlighting. Default value: | 267 | this can be used to implement e.g. syntax highlighting. Default value: |
263 | none. | 268 | none. |
264 | 269 | ||
265 | summary-branches:: | 270 | summary-branches:: |
266 | Specifies the number of branches to display in the repository "summary" | 271 | Specifies the number of branches to display in the repository "summary" |
267 | view. Default value: "10". | 272 | view. Default value: "10". |
268 | 273 | ||
269 | summary-log:: | 274 | summary-log:: |
270 | Specifies the number of log entries to display in the repository | 275 | Specifies the number of log entries to display in the repository |
271 | "summary" view. Default value: "10". | 276 | "summary" view. Default value: "10". |
272 | 277 | ||
273 | summary-tags:: | 278 | summary-tags:: |
274 | Specifies the number of tags to display in the repository "summary" | 279 | Specifies the number of tags to display in the repository "summary" |
275 | view. Default value: "10". | 280 | view. Default value: "10". |
276 | 281 | ||
277 | virtual-root:: | 282 | virtual-root:: |
278 | Url which, if specified, will be used as root for all cgit links. It | 283 | Url which, if specified, will be used as root for all cgit links. It |
279 | will also cause cgit to generate 'virtual urls', i.e. urls like | 284 | will also cause cgit to generate 'virtual urls', i.e. urls like |
280 | '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default | 285 | '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default |
281 | value: none. | 286 | value: none. |
282 | NOTE: cgit has recently learned how to use PATH_INFO to achieve the | 287 | NOTE: cgit has recently learned how to use PATH_INFO to achieve the |
283 | same kind of virtual urls, so this option will probably be deprecated. | 288 | same kind of virtual urls, so this option will probably be deprecated. |
284 | 289 | ||
285 | REPOSITORY SETTINGS | 290 | REPOSITORY SETTINGS |
286 | ------------------- | 291 | ------------------- |
287 | repo.about-filter:: | 292 | repo.about-filter:: |
288 | Override the default about-filter. Default value: none. See also: | 293 | Override the default about-filter. Default value: none. See also: |
289 | "enable-filter-overrides". | 294 | "enable-filter-overrides". |
290 | 295 | ||
291 | repo.clone-url:: | 296 | repo.clone-url:: |
292 | A list of space-separated urls which can be used to clone this repo. | 297 | A list of space-separated urls which can be used to clone this repo. |
293 | Default value: none. | 298 | Default value: none. |
294 | 299 | ||
295 | repo.commit-filter:: | 300 | repo.commit-filter:: |
296 | Override the default commit-filter. Default value: none. See also: | 301 | Override the default commit-filter. Default value: none. See also: |
297 | "enable-filter-overrides". | 302 | "enable-filter-overrides". |
298 | 303 | ||
299 | repo.defbranch:: | 304 | repo.defbranch:: |
300 | The name of the default branch for this repository. If no such branch | 305 | The name of the default branch for this repository. If no such branch |
301 | exists in the repository, the first branch name (when sorted) is used | 306 | exists in the repository, the first branch name (when sorted) is used |
302 | as default instead. Default value: "master". | 307 | as default instead. Default value: "master". |
303 | 308 | ||
304 | repo.desc:: | 309 | repo.desc:: |
305 | The value to show as repository description. Default value: none. | 310 | The value to show as repository description. Default value: none. |
306 | 311 | ||
307 | repo.enable-log-filecount:: | 312 | repo.enable-log-filecount:: |
308 | A flag which can be used to disable the global setting | 313 | A flag which can be used to disable the global setting |
309 | `enable-log-filecount'. Default value: none. | 314 | `enable-log-filecount'. Default value: none. |
310 | 315 | ||
311 | repo.enable-log-linecount:: | 316 | repo.enable-log-linecount:: |
312 | A flag which can be used to disable the global setting | 317 | A flag which can be used to disable the global setting |
313 | `enable-log-linecount'. Default value: none. | 318 | `enable-log-linecount'. Default value: none. |
314 | 319 | ||
320 | repo.enable-remote-branches:: | ||
321 | Flag which, when set to "1", will make cgit display remote branches | ||
322 | in the summary and refs views. Default value: <enable-remote-branches>. | ||
323 | |||
315 | repo.max-stats:: | 324 | repo.max-stats:: |
316 | Override the default maximum statistics period. Valid values are equal | 325 | Override the default maximum statistics period. Valid values are equal |
317 | to the values specified for the global "max-stats" setting. Default | 326 | to the values specified for the global "max-stats" setting. Default |
318 | value: none. | 327 | value: none. |
319 | 328 | ||
320 | repo.name:: | 329 | repo.name:: |
321 | The value to show as repository name. Default value: <repo.url>. | 330 | The value to show as repository name. Default value: <repo.url>. |
322 | 331 | ||
323 | repo.owner:: | 332 | repo.owner:: |
324 | A value used to identify the owner of the repository. Default value: | 333 | A value used to identify the owner of the repository. Default value: |
325 | none. | 334 | none. |
326 | 335 | ||
327 | repo.path:: | 336 | repo.path:: |
328 | An absolute path to the repository directory. For non-bare repositories | 337 | An absolute path to the repository directory. For non-bare repositories |
329 | this is the .git-directory. Default value: none. | 338 | this is the .git-directory. Default value: none. |
330 | 339 | ||
331 | repo.readme:: | 340 | repo.readme:: |
332 | A path (relative to <repo.path>) which specifies a file to include | 341 | A path (relative to <repo.path>) which specifies a file to include |
333 | verbatim as the "About" page for this repo. Default value: none. | 342 | verbatim as the "About" page for this repo. Default value: none. |
334 | 343 | ||
335 | repo.snapshots:: | 344 | repo.snapshots:: |
336 | A mask of allowed snapshot-formats for this repo, restricted by the | 345 | A mask of allowed snapshot-formats for this repo, restricted by the |
337 | "snapshots" global setting. Default value: <snapshots>. | 346 | "snapshots" global setting. Default value: <snapshots>. |
338 | 347 | ||
339 | repo.section:: | 348 | repo.section:: |
340 | Override the current section name for this repository. Default value: | 349 | Override the current section name for this repository. Default value: |
341 | none. | 350 | none. |
342 | 351 | ||
343 | repo.source-filter:: | 352 | repo.source-filter:: |
344 | Override the default source-filter. Default value: none. See also: | 353 | Override the default source-filter. Default value: none. See also: |
345 | "enable-filter-overrides". | 354 | "enable-filter-overrides". |
346 | 355 | ||
347 | repo.url:: | 356 | repo.url:: |
348 | The relative url used to access the repository. This must be the first | 357 | The relative url used to access the repository. This must be the first |
349 | setting specified for each repo. Default value: none. | 358 | setting specified for each repo. Default value: none. |
350 | 359 | ||
351 | 360 | ||
352 | REPOSITORY-SPECIFIC CGITRC FILE | 361 | REPOSITORY-SPECIFIC CGITRC FILE |
353 | ------------------------------- | 362 | ------------------------------- |
354 | When the option "scan-path" is used to auto-discover git repositories, cgit | 363 | When the option "scan-path" is used to auto-discover git repositories, cgit |
355 | will try to parse the file "cgitrc" within any found repository. Such a | 364 | will try to parse the file "cgitrc" within any found repository. Such a |
356 | repo-specific config file may contain any of the repo-specific options | 365 | repo-specific config file may contain any of the repo-specific options |
357 | described above, except "repo.url" and "repo.path". Additionally, the "filter" | 366 | described above, except "repo.url" and "repo.path". Additionally, the "filter" |
358 | options are only acknowledged in repo-specific config files when | 367 | options are only acknowledged in repo-specific config files when |
359 | "enable-filter-overrides" is set to "1". | 368 | "enable-filter-overrides" is set to "1". |
360 | 369 | ||
361 | Note: the "repo." prefix is dropped from the option names in repo-specific | 370 | Note: the "repo." prefix is dropped from the option names in repo-specific |
362 | config files, e.g. "repo.desc" becomes "desc". | 371 | config files, e.g. "repo.desc" becomes "desc". |
363 | 372 | ||
364 | 373 | ||
365 | EXAMPLE CGITRC FILE | 374 | EXAMPLE CGITRC FILE |
366 | ------------------- | 375 | ------------------- |
367 | 376 | ||
368 | .... | 377 | .... |
369 | # Enable caching of up to 1000 output entriess | 378 | # Enable caching of up to 1000 output entriess |
370 | cache-size=1000 | 379 | cache-size=1000 |
371 | 380 | ||
372 | 381 | ||
373 | # Specify some default clone prefixes | 382 | # Specify some default clone prefixes |
374 | clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git | 383 | clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git |
375 | 384 | ||
376 | # Specify the css url | 385 | # Specify the css url |
377 | css=/css/cgit.css | 386 | css=/css/cgit.css |
378 | 387 | ||