-rw-r--r-- | cgitrc.5.txt | 48 |
1 files changed, 43 insertions, 5 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt index 3b16db9..4dc383d 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt | |||
@@ -33,78 +33,86 @@ about-filter:: | |||
33 | agefile:: | 33 | agefile:: |
34 | Specifies a path, relative to each repository path, which can be used | 34 | Specifies a path, relative to each repository path, which can be used |
35 | to specify the date and time of the youngest commit in the repository. | 35 | to specify the date and time of the youngest commit in the repository. |
36 | The first line in the file is used as input to the "parse_date" | 36 | The first line in the file is used as input to the "parse_date" |
37 | function in libgit. Recommended timestamp-format is "yyyy-mm-dd | 37 | function in libgit. Recommended timestamp-format is "yyyy-mm-dd |
38 | hh:mm:ss". Default value: "info/web/last-modified". | 38 | hh:mm:ss". Default value: "info/web/last-modified". |
39 | 39 | ||
40 | cache-root:: | 40 | cache-root:: |
41 | Path used to store the cgit cache entries. Default value: | 41 | Path used to store the cgit cache entries. Default value: |
42 | "/var/cache/cgit". | 42 | "/var/cache/cgit". |
43 | 43 | ||
44 | cache-dynamic-ttl:: | 44 | cache-dynamic-ttl:: |
45 | Number which specifies the time-to-live, in minutes, for the cached | 45 | Number which specifies the time-to-live, in minutes, for the cached |
46 | version of repository pages accessed without a fixed SHA1. Default | 46 | version of repository pages accessed without a fixed SHA1. Default |
47 | value: "5". | 47 | value: "5". |
48 | 48 | ||
49 | cache-repo-ttl:: | 49 | cache-repo-ttl:: |
50 | Number which specifies the time-to-live, in minutes, for the cached | 50 | Number which specifies the time-to-live, in minutes, for the cached |
51 | version of the repository summary page. Default value: "5". | 51 | version of the repository summary page. Default value: "5". |
52 | 52 | ||
53 | cache-root-ttl:: | 53 | cache-root-ttl:: |
54 | Number which specifies the time-to-live, in minutes, for the cached | 54 | Number which specifies the time-to-live, in minutes, for the cached |
55 | version of the repository index page. Default value: "5". | 55 | version of the repository index page. Default value: "5". |
56 | 56 | ||
57 | cache-scanrc-ttl:: | ||
58 | Number which specifies the time-to-live, in minutes, for the result | ||
59 | of scanning a path for git repositories. Default value: "15". | ||
60 | |||
57 | cache-size:: | 61 | cache-size:: |
58 | The maximum number of entries in the cgit cache. Default value: "0" | 62 | The maximum number of entries in the cgit cache. Default value: "0" |
59 | (i.e. caching is disabled). | 63 | (i.e. caching is disabled). |
60 | 64 | ||
61 | cache-static-ttl:: | 65 | cache-static-ttl:: |
62 | Number which specifies the time-to-live, in minutes, for the cached | 66 | Number which specifies the time-to-live, in minutes, for the cached |
63 | version of repository pages accessed with a fixed SHA1. Default value: | 67 | version of repository pages accessed with a fixed SHA1. Default value: |
64 | "5". | 68 | "5". |
65 | 69 | ||
66 | clone-prefix:: | 70 | clone-prefix:: |
67 | Space-separated list of common prefixes which, when combined with a | 71 | Space-separated list of common prefixes which, when combined with a |
68 | repository url, generates valid clone urls for the repository. This | 72 | repository url, generates valid clone urls for the repository. This |
69 | setting is only used if `repo.clone-url` is unspecified. Default value: | 73 | setting is only used if `repo.clone-url` is unspecified. Default value: |
70 | none. | 74 | none. |
71 | 75 | ||
72 | commit-filter:: | 76 | commit-filter:: |
73 | Specifies a command which will be invoked to format commit messages. | 77 | Specifies a command which will be invoked to format commit messages. |
74 | The command will get the message on its STDIN, and the STDOUT from the | 78 | The command will get the message on its STDIN, and the STDOUT from the |
75 | command will be included verbatim as the commit message, i.e. this can | 79 | command will be included verbatim as the commit message, i.e. this can |
76 | be used to implement bugtracker integration. Default value: none. | 80 | be used to implement bugtracker integration. Default value: none. |
77 | 81 | ||
78 | css:: | 82 | css:: |
79 | Url which specifies the css document to include in all cgit pages. | 83 | Url which specifies the css document to include in all cgit pages. |
80 | Default value: "/cgit.css". | 84 | Default value: "/cgit.css". |
81 | 85 | ||
82 | embedded:: | 86 | embedded:: |
83 | Flag which, when set to "1", will make cgit generate a html fragment | 87 | Flag which, when set to "1", will make cgit generate a html fragment |
84 | suitable for embedding in other html pages. Default value: none. See | 88 | suitable for embedding in other html pages. Default value: none. See |
85 | also: "noheader". | 89 | also: "noheader". |
86 | 90 | ||
91 | enable-filter-overrides:: | ||
92 | Flag which, when set to "1", allows all filter settings to be | ||
93 | overridden in repository-specific cgitrc files. Default value: none. | ||
94 | |||
87 | enable-index-links:: | 95 | enable-index-links:: |
88 | Flag which, when set to "1", will make cgit generate extra links for | 96 | Flag which, when set to "1", will make cgit generate extra links for |
89 | each repo in the repository index (specifically, to the "summary", | 97 | each repo in the repository index (specifically, to the "summary", |
90 | "commit" and "tree" pages). Default value: "0". | 98 | "commit" and "tree" pages). Default value: "0". |
91 | 99 | ||
92 | enable-log-filecount:: | 100 | enable-log-filecount:: |
93 | Flag which, when set to "1", will make cgit print the number of | 101 | Flag which, when set to "1", will make cgit print the number of |
94 | modified files for each commit on the repository log page. Default | 102 | modified files for each commit on the repository log page. Default |
95 | value: "0". | 103 | value: "0". |
96 | 104 | ||
97 | enable-log-linecount:: | 105 | enable-log-linecount:: |
98 | Flag which, when set to "1", will make cgit print the number of added | 106 | Flag which, when set to "1", will make cgit print the number of added |
99 | and removed lines for each commit on the repository log page. Default | 107 | and removed lines for each commit on the repository log page. Default |
100 | value: "0". | 108 | value: "0". |
101 | 109 | ||
102 | enable-tree-linenumbers:: | 110 | enable-tree-linenumbers:: |
103 | Flag which, when set to "1", will make cgit generate linenumber links | 111 | Flag which, when set to "1", will make cgit generate linenumber links |
104 | for plaintext blobs printed in the tree view. Default value: "1". | 112 | for plaintext blobs printed in the tree view. Default value: "1". |
105 | 113 | ||
106 | favicon:: | 114 | favicon:: |
107 | Url used as link to a shortcut icon for cgit. If specified, it is | 115 | Url used as link to a shortcut icon for cgit. If specified, it is |
108 | suggested to use the value "/favicon.ico" since certain browsers will | 116 | suggested to use the value "/favicon.ico" since certain browsers will |
109 | ignore other values. Default value: none. | 117 | ignore other values. Default value: none. |
110 | 118 | ||
@@ -179,161 +187,191 @@ module-link:: | |||
179 | Text which will be used as the formatstring for a hyperlink when a | 187 | Text which will be used as the formatstring for a hyperlink when a |
180 | submodule is printed in a directory listing. The arguments for the | 188 | submodule is printed in a directory listing. The arguments for the |
181 | formatstring are the path and SHA1 of the submodule commit. Default | 189 | formatstring are the path and SHA1 of the submodule commit. Default |
182 | value: "./?repo=%s&page=commit&id=%s" | 190 | value: "./?repo=%s&page=commit&id=%s" |
183 | 191 | ||
184 | nocache:: | 192 | nocache:: |
185 | If set to the value "1" caching will be disabled. This settings is | 193 | If set to the value "1" caching will be disabled. This settings is |
186 | deprecated, and will not be honored starting with cgit-1.0. Default | 194 | deprecated, and will not be honored starting with cgit-1.0. Default |
187 | value: "0". | 195 | value: "0". |
188 | 196 | ||
189 | noplainemail:: | 197 | noplainemail:: |
190 | If set to "1" showing full author email adresses will be disabled. | 198 | If set to "1" showing full author email adresses will be disabled. |
191 | Default value: "0". | 199 | Default value: "0". |
192 | 200 | ||
193 | noheader:: | 201 | noheader:: |
194 | Flag which, when set to "1", will make cgit omit the standard header | 202 | Flag which, when set to "1", will make cgit omit the standard header |
195 | on all pages. Default value: none. See also: "embedded". | 203 | on all pages. Default value: none. See also: "embedded". |
196 | 204 | ||
197 | renamelimit:: | 205 | renamelimit:: |
198 | Maximum number of files to consider when detecting renames. The value | 206 | Maximum number of files to consider when detecting renames. The value |
199 | "-1" uses the compiletime value in git (for further info, look at | 207 | "-1" uses the compiletime value in git (for further info, look at |
200 | `man git-diff`). Default value: "-1". | 208 | `man git-diff`). Default value: "-1". |
201 | 209 | ||
202 | repo.group:: | 210 | repo.group:: |
203 | A value for the current repository group, which all repositories | 211 | Legacy alias for "section". This option is deprecated and will not be |
204 | specified after this setting will inherit. Default value: none. | 212 | supported in cgit-1.0. |
205 | 213 | ||
206 | robots:: | 214 | robots:: |
207 | Text used as content for the "robots" meta-tag. Default value: | 215 | Text used as content for the "robots" meta-tag. Default value: |
208 | "index, nofollow". | 216 | "index, nofollow". |
209 | 217 | ||
210 | root-desc:: | 218 | root-desc:: |
211 | Text printed below the heading on the repository index page. Default | 219 | Text printed below the heading on the repository index page. Default |
212 | value: "a fast webinterface for the git dscm". | 220 | value: "a fast webinterface for the git dscm". |
213 | 221 | ||
214 | root-readme:: | 222 | root-readme:: |
215 | The content of the file specified with this option will be included | 223 | The content of the file specified with this option will be included |
216 | verbatim below the "about" link on the repository index page. Default | 224 | verbatim below the "about" link on the repository index page. Default |
217 | value: none. | 225 | value: none. |
218 | 226 | ||
219 | root-title:: | 227 | root-title:: |
220 | Text printed as heading on the repository index page. Default value: | 228 | Text printed as heading on the repository index page. Default value: |
221 | "Git Repository Browser". | 229 | "Git Repository Browser". |
222 | 230 | ||
231 | scan-path:: | ||
232 | A path which will be scanned for repositories. If caching is enabled, | ||
233 | the result will be cached as a cgitrc include-file in the cache | ||
234 | directory. Default value: none. See also: cache-scanrc-ttl. | ||
235 | |||
236 | section:: | ||
237 | The name of the current repository section - all repositories defined | ||
238 | after this option will inherit the current section name. Default value: | ||
239 | none. | ||
240 | |||
223 | snapshots:: | 241 | snapshots:: |
224 | Text which specifies the default set of snapshot formats generated by | 242 | Text which specifies the default set of snapshot formats generated by |
225 | cgit. The value is a space-separated list of zero or more of the | 243 | cgit. The value is a space-separated list of zero or more of the |
226 | values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none. | 244 | values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none. |
227 | 245 | ||
228 | source-filter:: | 246 | source-filter:: |
229 | Specifies a command which will be invoked to format plaintext blobs | 247 | Specifies a command which will be invoked to format plaintext blobs |
230 | in the tree view. The command will get the blob content on its STDIN | 248 | in the tree view. The command will get the blob content on its STDIN |
231 | and the name of the blob as its only command line argument. The STDOUT | 249 | and the name of the blob as its only command line argument. The STDOUT |
232 | from the command will be included verbatim as the blob contents, i.e. | 250 | from the command will be included verbatim as the blob contents, i.e. |
233 | this can be used to implement e.g. syntax highlighting. Default value: | 251 | this can be used to implement e.g. syntax highlighting. Default value: |
234 | none. | 252 | none. |
235 | 253 | ||
236 | summary-branches:: | 254 | summary-branches:: |
237 | Specifies the number of branches to display in the repository "summary" | 255 | Specifies the number of branches to display in the repository "summary" |
238 | view. Default value: "10". | 256 | view. Default value: "10". |
239 | 257 | ||
240 | summary-log:: | 258 | summary-log:: |
241 | Specifies the number of log entries to display in the repository | 259 | Specifies the number of log entries to display in the repository |
242 | "summary" view. Default value: "10". | 260 | "summary" view. Default value: "10". |
243 | 261 | ||
244 | summary-tags:: | 262 | summary-tags:: |
245 | Specifies the number of tags to display in the repository "summary" | 263 | Specifies the number of tags to display in the repository "summary" |
246 | view. Default value: "10". | 264 | view. Default value: "10". |
247 | 265 | ||
248 | virtual-root:: | 266 | virtual-root:: |
249 | Url which, if specified, will be used as root for all cgit links. It | 267 | Url which, if specified, will be used as root for all cgit links. It |
250 | will also cause cgit to generate 'virtual urls', i.e. urls like | 268 | will also cause cgit to generate 'virtual urls', i.e. urls like |
251 | '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default | 269 | '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default |
252 | value: none. | 270 | value: none. |
253 | NOTE: cgit has recently learned how to use PATH_INFO to achieve the | 271 | NOTE: cgit has recently learned how to use PATH_INFO to achieve the |
254 | same kind of virtual urls, so this option will probably be deprecated. | 272 | same kind of virtual urls, so this option will probably be deprecated. |
255 | 273 | ||
256 | REPOSITORY SETTINGS | 274 | REPOSITORY SETTINGS |
257 | ------------------- | 275 | ------------------- |
258 | repo.about-filter:: | 276 | repo.about-filter:: |
259 | Override the default about-filter. Default value: <about-filter>. | 277 | Override the default about-filter. Default value: none. See also: |
278 | "enable-filter-overrides". | ||
260 | 279 | ||
261 | repo.clone-url:: | 280 | repo.clone-url:: |
262 | A list of space-separated urls which can be used to clone this repo. | 281 | A list of space-separated urls which can be used to clone this repo. |
263 | Default value: none. | 282 | Default value: none. |
264 | 283 | ||
265 | repo.commit-filter:: | 284 | repo.commit-filter:: |
266 | Override the default commit-filter. Default value: <commit-filter>. | 285 | Override the default commit-filter. Default value: none. See also: |
286 | "enable-filter-overrides". | ||
267 | 287 | ||
268 | repo.defbranch:: | 288 | repo.defbranch:: |
269 | The name of the default branch for this repository. If no such branch | 289 | The name of the default branch for this repository. If no such branch |
270 | exists in the repository, the first branch name (when sorted) is used | 290 | exists in the repository, the first branch name (when sorted) is used |
271 | as default instead. Default value: "master". | 291 | as default instead. Default value: "master". |
272 | 292 | ||
273 | repo.desc:: | 293 | repo.desc:: |
274 | The value to show as repository description. Default value: none. | 294 | The value to show as repository description. Default value: none. |
275 | 295 | ||
276 | repo.enable-log-filecount:: | 296 | repo.enable-log-filecount:: |
277 | A flag which can be used to disable the global setting | 297 | A flag which can be used to disable the global setting |
278 | `enable-log-filecount'. Default value: none. | 298 | `enable-log-filecount'. Default value: none. |
279 | 299 | ||
280 | repo.enable-log-linecount:: | 300 | repo.enable-log-linecount:: |
281 | A flag which can be used to disable the global setting | 301 | A flag which can be used to disable the global setting |
282 | `enable-log-linecount'. Default value: none. | 302 | `enable-log-linecount'. Default value: none. |
283 | 303 | ||
284 | repo.max-stats:: | 304 | repo.max-stats:: |
285 | Override the default maximum statistics period. Valid values are equal | 305 | Override the default maximum statistics period. Valid values are equal |
286 | to the values specified for the global "max-stats" setting. Default | 306 | to the values specified for the global "max-stats" setting. Default |
287 | value: none. | 307 | value: none. |
288 | 308 | ||
289 | repo.name:: | 309 | repo.name:: |
290 | The value to show as repository name. Default value: <repo.url>. | 310 | The value to show as repository name. Default value: <repo.url>. |
291 | 311 | ||
292 | repo.owner:: | 312 | repo.owner:: |
293 | A value used to identify the owner of the repository. Default value: | 313 | A value used to identify the owner of the repository. Default value: |
294 | none. | 314 | none. |
295 | 315 | ||
296 | repo.path:: | 316 | repo.path:: |
297 | An absolute path to the repository directory. For non-bare repositories | 317 | An absolute path to the repository directory. For non-bare repositories |
298 | this is the .git-directory. Default value: none. | 318 | this is the .git-directory. Default value: none. |
299 | 319 | ||
300 | repo.readme:: | 320 | repo.readme:: |
301 | A path (relative to <repo.path>) which specifies a file to include | 321 | A path (relative to <repo.path>) which specifies a file to include |
302 | verbatim as the "About" page for this repo. Default value: none. | 322 | verbatim as the "About" page for this repo. Default value: none. |
303 | 323 | ||
304 | repo.snapshots:: | 324 | repo.snapshots:: |
305 | A mask of allowed snapshot-formats for this repo, restricted by the | 325 | A mask of allowed snapshot-formats for this repo, restricted by the |
306 | "snapshots" global setting. Default value: <snapshots>. | 326 | "snapshots" global setting. Default value: <snapshots>. |
307 | 327 | ||
328 | repo.section:: | ||
329 | Override the current section name for this repository. Default value: | ||
330 | none. | ||
331 | |||
308 | repo.source-filter:: | 332 | repo.source-filter:: |
309 | Override the default source-filter. Default value: <source-filter>. | 333 | Override the default source-filter. Default value: none. See also: |
334 | "enable-filter-overrides". | ||
310 | 335 | ||
311 | repo.url:: | 336 | repo.url:: |
312 | The relative url used to access the repository. This must be the first | 337 | The relative url used to access the repository. This must be the first |
313 | setting specified for each repo. Default value: none. | 338 | setting specified for each repo. Default value: none. |
314 | 339 | ||
315 | 340 | ||
341 | REPOSITORY-SPECIFIC CGITRC FILE | ||
342 | ------------------------------- | ||
343 | When the option "scan-path" is used to auto-discover git repositories, cgit | ||
344 | will try to parse the file "cgitrc" within any found repository. Such a | ||
345 | repo-specific config file may contain any of the repo-specific options | ||
346 | described above, except "repo.url" and "repo.path". Additionally, the "filter" | ||
347 | options are only acknowledged in repo-specific config files when | ||
348 | "enable-filter-overrides" is set to "1". | ||
349 | |||
350 | Note: the "repo." prefix is dropped from the option names in repo-specific | ||
351 | config files, e.g. "repo.desc" becomes "desc". | ||
352 | |||
353 | |||
316 | EXAMPLE CGITRC FILE | 354 | EXAMPLE CGITRC FILE |
317 | ------------------- | 355 | ------------------- |
318 | 356 | ||
319 | .... | 357 | .... |
320 | # Enable caching of up to 1000 output entriess | 358 | # Enable caching of up to 1000 output entriess |
321 | cache-size=1000 | 359 | cache-size=1000 |
322 | 360 | ||
323 | 361 | ||
324 | # Specify some default clone prefixes | 362 | # Specify some default clone prefixes |
325 | clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git | 363 | clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git |
326 | 364 | ||
327 | # Specify the css url | 365 | # Specify the css url |
328 | css=/css/cgit.css | 366 | css=/css/cgit.css |
329 | 367 | ||
330 | 368 | ||
331 | # Show extra links for each repository on the index page | 369 | # Show extra links for each repository on the index page |
332 | enable-index-links=1 | 370 | enable-index-links=1 |
333 | 371 | ||
334 | 372 | ||
335 | # Show number of affected files per commit on the log pages | 373 | # Show number of affected files per commit on the log pages |
336 | enable-log-filecount=1 | 374 | enable-log-filecount=1 |
337 | 375 | ||
338 | 376 | ||
339 | # Show number of added/removed lines per commit on the log pages | 377 | # Show number of added/removed lines per commit on the log pages |