author | Loui Chang <louipc.ist@gmail.com> | 2009-09-14 05:21:11 (UTC) |
---|---|---|
committer | Lars Hjemli <hjemli@gmail.com> | 2009-09-14 20:47:57 (UTC) |
commit | 8071e18dcbf56b98ecea4332e85884cdd91236cc (patch) (unidiff) | |
tree | c10bfc24391d9c31732d0e824bd00cdc2bcdafa4 | |
parent | 676d17b22f09faf99295505f68d558b92f3281cb (diff) | |
download | cgit-8071e18dcbf56b98ecea4332e85884cdd91236cc.zip cgit-8071e18dcbf56b98ecea4332e85884cdd91236cc.tar.gz cgit-8071e18dcbf56b98ecea4332e85884cdd91236cc.tar.bz2 |
cgitrc.5.txt: Change repo.group to section in example config.
Signed-off-by: Loui Chang <louipc.ist@gmail.com>
Signed-off-by: Lars Hjemli <hjemli@gmail.com>
-rw-r--r-- | cgitrc.5.txt | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt index e7f1a78..0c13485 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt | |||
@@ -171,331 +171,331 @@ max-message-length:: | |||
171 | 171 | ||
172 | max-repo-count:: | 172 | max-repo-count:: |
173 | Specifies the number of entries to list per page on therepository | 173 | Specifies the number of entries to list per page on therepository |
174 | index page. Default value: "50". | 174 | index page. Default value: "50". |
175 | 175 | ||
176 | max-repodesc-length:: | 176 | max-repodesc-length:: |
177 | Specifies the maximum number of repo description characters to display | 177 | Specifies the maximum number of repo description characters to display |
178 | on the repository index page. Default value: "80". | 178 | on the repository index page. Default value: "80". |
179 | 179 | ||
180 | max-stats:: | 180 | max-stats:: |
181 | Set the default maximum statistics period. Valid values are "week", | 181 | Set the default maximum statistics period. Valid values are "week", |
182 | "month", "quarter" and "year". If unspecified, statistics are | 182 | "month", "quarter" and "year". If unspecified, statistics are |
183 | disabled. Default value: none. See also: "repo.max-stats". | 183 | disabled. Default value: none. See also: "repo.max-stats". |
184 | 184 | ||
185 | mimetype.<ext>:: | 185 | mimetype.<ext>:: |
186 | Set the mimetype for the specified filename extension. This is used | 186 | Set the mimetype for the specified filename extension. This is used |
187 | by the `plain` command when returning blob content. | 187 | by the `plain` command when returning blob content. |
188 | 188 | ||
189 | module-link:: | 189 | module-link:: |
190 | Text which will be used as the formatstring for a hyperlink when a | 190 | Text which will be used as the formatstring for a hyperlink when a |
191 | submodule is printed in a directory listing. The arguments for the | 191 | submodule is printed in a directory listing. The arguments for the |
192 | formatstring are the path and SHA1 of the submodule commit. Default | 192 | formatstring are the path and SHA1 of the submodule commit. Default |
193 | value: "./?repo=%s&page=commit&id=%s" | 193 | value: "./?repo=%s&page=commit&id=%s" |
194 | 194 | ||
195 | nocache:: | 195 | nocache:: |
196 | If set to the value "1" caching will be disabled. This settings is | 196 | If set to the value "1" caching will be disabled. This settings is |
197 | deprecated, and will not be honored starting with cgit-1.0. Default | 197 | deprecated, and will not be honored starting with cgit-1.0. Default |
198 | value: "0". | 198 | value: "0". |
199 | 199 | ||
200 | noplainemail:: | 200 | noplainemail:: |
201 | If set to "1" showing full author email adresses will be disabled. | 201 | If set to "1" showing full author email adresses will be disabled. |
202 | Default value: "0". | 202 | Default value: "0". |
203 | 203 | ||
204 | noheader:: | 204 | noheader:: |
205 | Flag which, when set to "1", will make cgit omit the standard header | 205 | Flag which, when set to "1", will make cgit omit the standard header |
206 | on all pages. Default value: none. See also: "embedded". | 206 | on all pages. Default value: none. See also: "embedded". |
207 | 207 | ||
208 | renamelimit:: | 208 | renamelimit:: |
209 | Maximum number of files to consider when detecting renames. The value | 209 | Maximum number of files to consider when detecting renames. The value |
210 | "-1" uses the compiletime value in git (for further info, look at | 210 | "-1" uses the compiletime value in git (for further info, look at |
211 | `man git-diff`). Default value: "-1". | 211 | `man git-diff`). Default value: "-1". |
212 | 212 | ||
213 | repo.group:: | 213 | repo.group:: |
214 | Legacy alias for "section". This option is deprecated and will not be | 214 | Legacy alias for "section". This option is deprecated and will not be |
215 | supported in cgit-1.0. | 215 | supported in cgit-1.0. |
216 | 216 | ||
217 | robots:: | 217 | robots:: |
218 | Text used as content for the "robots" meta-tag. Default value: | 218 | Text used as content for the "robots" meta-tag. Default value: |
219 | "index, nofollow". | 219 | "index, nofollow". |
220 | 220 | ||
221 | root-desc:: | 221 | root-desc:: |
222 | Text printed below the heading on the repository index page. Default | 222 | Text printed below the heading on the repository index page. Default |
223 | value: "a fast webinterface for the git dscm". | 223 | value: "a fast webinterface for the git dscm". |
224 | 224 | ||
225 | root-readme:: | 225 | root-readme:: |
226 | The content of the file specified with this option will be included | 226 | The content of the file specified with this option will be included |
227 | verbatim below the "about" link on the repository index page. Default | 227 | verbatim below the "about" link on the repository index page. Default |
228 | value: none. | 228 | value: none. |
229 | 229 | ||
230 | root-title:: | 230 | root-title:: |
231 | Text printed as heading on the repository index page. Default value: | 231 | Text printed as heading on the repository index page. Default value: |
232 | "Git Repository Browser". | 232 | "Git Repository Browser". |
233 | 233 | ||
234 | scan-path:: | 234 | scan-path:: |
235 | A path which will be scanned for repositories. If caching is enabled, | 235 | 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 | 236 | the result will be cached as a cgitrc include-file in the cache |
237 | directory. Default value: none. See also: cache-scanrc-ttl. | 237 | directory. Default value: none. See also: cache-scanrc-ttl. |
238 | 238 | ||
239 | section:: | 239 | section:: |
240 | The name of the current repository section - all repositories defined | 240 | The name of the current repository section - all repositories defined |
241 | after this option will inherit the current section name. Default value: | 241 | after this option will inherit the current section name. Default value: |
242 | none. | 242 | none. |
243 | 243 | ||
244 | snapshots:: | 244 | snapshots:: |
245 | Text which specifies the default set of snapshot formats generated by | 245 | Text which specifies the default set of snapshot formats generated by |
246 | cgit. The value is a space-separated list of zero or more of the | 246 | cgit. The value is a space-separated list of zero or more of the |
247 | values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none. | 247 | values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none. |
248 | 248 | ||
249 | source-filter:: | 249 | source-filter:: |
250 | Specifies a command which will be invoked to format plaintext blobs | 250 | Specifies a command which will be invoked to format plaintext blobs |
251 | in the tree view. The command will get the blob content on its STDIN | 251 | in the tree view. The command will get the blob content on its STDIN |
252 | and the name of the blob as its only command line argument. The STDOUT | 252 | and the name of the blob as its only command line argument. The STDOUT |
253 | from the command will be included verbatim as the blob contents, i.e. | 253 | from the command will be included verbatim as the blob contents, i.e. |
254 | this can be used to implement e.g. syntax highlighting. Default value: | 254 | this can be used to implement e.g. syntax highlighting. Default value: |
255 | none. | 255 | none. |
256 | 256 | ||
257 | summary-branches:: | 257 | summary-branches:: |
258 | Specifies the number of branches to display in the repository "summary" | 258 | Specifies the number of branches to display in the repository "summary" |
259 | view. Default value: "10". | 259 | view. Default value: "10". |
260 | 260 | ||
261 | summary-log:: | 261 | summary-log:: |
262 | Specifies the number of log entries to display in the repository | 262 | Specifies the number of log entries to display in the repository |
263 | "summary" view. Default value: "10". | 263 | "summary" view. Default value: "10". |
264 | 264 | ||
265 | summary-tags:: | 265 | summary-tags:: |
266 | Specifies the number of tags to display in the repository "summary" | 266 | Specifies the number of tags to display in the repository "summary" |
267 | view. Default value: "10". | 267 | view. Default value: "10". |
268 | 268 | ||
269 | virtual-root:: | 269 | virtual-root:: |
270 | Url which, if specified, will be used as root for all cgit links. It | 270 | Url which, if specified, will be used as root for all cgit links. It |
271 | will also cause cgit to generate 'virtual urls', i.e. urls like | 271 | will also cause cgit to generate 'virtual urls', i.e. urls like |
272 | '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default | 272 | '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default |
273 | value: none. | 273 | value: none. |
274 | NOTE: cgit has recently learned how to use PATH_INFO to achieve the | 274 | NOTE: cgit has recently learned how to use PATH_INFO to achieve the |
275 | same kind of virtual urls, so this option will probably be deprecated. | 275 | same kind of virtual urls, so this option will probably be deprecated. |
276 | 276 | ||
277 | REPOSITORY SETTINGS | 277 | REPOSITORY SETTINGS |
278 | ------------------- | 278 | ------------------- |
279 | repo.about-filter:: | 279 | repo.about-filter:: |
280 | Override the default about-filter. Default value: none. See also: | 280 | Override the default about-filter. Default value: none. See also: |
281 | "enable-filter-overrides". | 281 | "enable-filter-overrides". |
282 | 282 | ||
283 | repo.clone-url:: | 283 | repo.clone-url:: |
284 | A list of space-separated urls which can be used to clone this repo. | 284 | A list of space-separated urls which can be used to clone this repo. |
285 | Default value: none. | 285 | Default value: none. |
286 | 286 | ||
287 | repo.commit-filter:: | 287 | repo.commit-filter:: |
288 | Override the default commit-filter. Default value: none. See also: | 288 | Override the default commit-filter. Default value: none. See also: |
289 | "enable-filter-overrides". | 289 | "enable-filter-overrides". |
290 | 290 | ||
291 | repo.defbranch:: | 291 | repo.defbranch:: |
292 | The name of the default branch for this repository. If no such branch | 292 | The name of the default branch for this repository. If no such branch |
293 | exists in the repository, the first branch name (when sorted) is used | 293 | exists in the repository, the first branch name (when sorted) is used |
294 | as default instead. Default value: "master". | 294 | as default instead. Default value: "master". |
295 | 295 | ||
296 | repo.desc:: | 296 | repo.desc:: |
297 | The value to show as repository description. Default value: none. | 297 | The value to show as repository description. Default value: none. |
298 | 298 | ||
299 | repo.enable-log-filecount:: | 299 | repo.enable-log-filecount:: |
300 | A flag which can be used to disable the global setting | 300 | A flag which can be used to disable the global setting |
301 | `enable-log-filecount'. Default value: none. | 301 | `enable-log-filecount'. Default value: none. |
302 | 302 | ||
303 | repo.enable-log-linecount:: | 303 | repo.enable-log-linecount:: |
304 | A flag which can be used to disable the global setting | 304 | A flag which can be used to disable the global setting |
305 | `enable-log-linecount'. Default value: none. | 305 | `enable-log-linecount'. Default value: none. |
306 | 306 | ||
307 | repo.max-stats:: | 307 | repo.max-stats:: |
308 | Override the default maximum statistics period. Valid values are equal | 308 | Override the default maximum statistics period. Valid values are equal |
309 | to the values specified for the global "max-stats" setting. Default | 309 | to the values specified for the global "max-stats" setting. Default |
310 | value: none. | 310 | value: none. |
311 | 311 | ||
312 | repo.name:: | 312 | repo.name:: |
313 | The value to show as repository name. Default value: <repo.url>. | 313 | The value to show as repository name. Default value: <repo.url>. |
314 | 314 | ||
315 | repo.owner:: | 315 | repo.owner:: |
316 | A value used to identify the owner of the repository. Default value: | 316 | A value used to identify the owner of the repository. Default value: |
317 | none. | 317 | none. |
318 | 318 | ||
319 | repo.path:: | 319 | repo.path:: |
320 | An absolute path to the repository directory. For non-bare repositories | 320 | An absolute path to the repository directory. For non-bare repositories |
321 | this is the .git-directory. Default value: none. | 321 | this is the .git-directory. Default value: none. |
322 | 322 | ||
323 | repo.readme:: | 323 | repo.readme:: |
324 | A path (relative to <repo.path>) which specifies a file to include | 324 | A path (relative to <repo.path>) which specifies a file to include |
325 | verbatim as the "About" page for this repo. Default value: none. | 325 | verbatim as the "About" page for this repo. Default value: none. |
326 | 326 | ||
327 | repo.snapshots:: | 327 | repo.snapshots:: |
328 | A mask of allowed snapshot-formats for this repo, restricted by the | 328 | A mask of allowed snapshot-formats for this repo, restricted by the |
329 | "snapshots" global setting. Default value: <snapshots>. | 329 | "snapshots" global setting. Default value: <snapshots>. |
330 | 330 | ||
331 | repo.section:: | 331 | repo.section:: |
332 | Override the current section name for this repository. Default value: | 332 | Override the current section name for this repository. Default value: |
333 | none. | 333 | none. |
334 | 334 | ||
335 | repo.source-filter:: | 335 | repo.source-filter:: |
336 | Override the default source-filter. Default value: none. See also: | 336 | Override the default source-filter. Default value: none. See also: |
337 | "enable-filter-overrides". | 337 | "enable-filter-overrides". |
338 | 338 | ||
339 | repo.url:: | 339 | repo.url:: |
340 | The relative url used to access the repository. This must be the first | 340 | The relative url used to access the repository. This must be the first |
341 | setting specified for each repo. Default value: none. | 341 | setting specified for each repo. Default value: none. |
342 | 342 | ||
343 | 343 | ||
344 | REPOSITORY-SPECIFIC CGITRC FILE | 344 | REPOSITORY-SPECIFIC CGITRC FILE |
345 | ------------------------------- | 345 | ------------------------------- |
346 | When the option "scan-path" is used to auto-discover git repositories, cgit | 346 | When the option "scan-path" is used to auto-discover git repositories, cgit |
347 | will try to parse the file "cgitrc" within any found repository. Such a | 347 | will try to parse the file "cgitrc" within any found repository. Such a |
348 | repo-specific config file may contain any of the repo-specific options | 348 | repo-specific config file may contain any of the repo-specific options |
349 | described above, except "repo.url" and "repo.path". Additionally, the "filter" | 349 | described above, except "repo.url" and "repo.path". Additionally, the "filter" |
350 | options are only acknowledged in repo-specific config files when | 350 | options are only acknowledged in repo-specific config files when |
351 | "enable-filter-overrides" is set to "1". | 351 | "enable-filter-overrides" is set to "1". |
352 | 352 | ||
353 | Note: the "repo." prefix is dropped from the option names in repo-specific | 353 | Note: the "repo." prefix is dropped from the option names in repo-specific |
354 | config files, e.g. "repo.desc" becomes "desc". | 354 | config files, e.g. "repo.desc" becomes "desc". |
355 | 355 | ||
356 | 356 | ||
357 | EXAMPLE CGITRC FILE | 357 | EXAMPLE CGITRC FILE |
358 | ------------------- | 358 | ------------------- |
359 | 359 | ||
360 | .... | 360 | .... |
361 | # Enable caching of up to 1000 output entriess | 361 | # Enable caching of up to 1000 output entriess |
362 | cache-size=1000 | 362 | cache-size=1000 |
363 | 363 | ||
364 | 364 | ||
365 | # Specify some default clone prefixes | 365 | # Specify some default clone prefixes |
366 | clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git | 366 | clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git |
367 | 367 | ||
368 | # Specify the css url | 368 | # Specify the css url |
369 | css=/css/cgit.css | 369 | css=/css/cgit.css |
370 | 370 | ||
371 | 371 | ||
372 | # Show extra links for each repository on the index page | 372 | # Show extra links for each repository on the index page |
373 | enable-index-links=1 | 373 | enable-index-links=1 |
374 | 374 | ||
375 | 375 | ||
376 | # Show number of affected files per commit on the log pages | 376 | # Show number of affected files per commit on the log pages |
377 | enable-log-filecount=1 | 377 | enable-log-filecount=1 |
378 | 378 | ||
379 | 379 | ||
380 | # Show number of added/removed lines per commit on the log pages | 380 | # Show number of added/removed lines per commit on the log pages |
381 | enable-log-linecount=1 | 381 | enable-log-linecount=1 |
382 | 382 | ||
383 | 383 | ||
384 | # Add a cgit favicon | 384 | # Add a cgit favicon |
385 | favicon=/favicon.ico | 385 | favicon=/favicon.ico |
386 | 386 | ||
387 | 387 | ||
388 | # Use a custom logo | 388 | # Use a custom logo |
389 | logo=/img/mylogo.png | 389 | logo=/img/mylogo.png |
390 | 390 | ||
391 | 391 | ||
392 | # Enable statistics per week, month and quarter | 392 | # Enable statistics per week, month and quarter |
393 | max-stats=quarter | 393 | max-stats=quarter |
394 | 394 | ||
395 | 395 | ||
396 | # Set the title and heading of the repository index page | 396 | # Set the title and heading of the repository index page |
397 | root-title=foobar.com git repositories | 397 | root-title=foobar.com git repositories |
398 | 398 | ||
399 | 399 | ||
400 | # Set a subheading for the repository index page | 400 | # Set a subheading for the repository index page |
401 | root-desc=tracking the foobar development | 401 | root-desc=tracking the foobar development |
402 | 402 | ||
403 | 403 | ||
404 | # Include some more info about foobar.com on the index page | 404 | # Include some more info about foobar.com on the index page |
405 | root-readme=/var/www/htdocs/about.html | 405 | root-readme=/var/www/htdocs/about.html |
406 | 406 | ||
407 | 407 | ||
408 | # Allow download of tar.gz, tar.bz2 and zip-files | 408 | # Allow download of tar.gz, tar.bz2 and zip-files |
409 | snapshots=tar.gz tar.bz2 zip | 409 | snapshots=tar.gz tar.bz2 zip |
410 | 410 | ||
411 | 411 | ||
412 | ## | 412 | ## |
413 | ## List of common mimetypes | 413 | ## List of common mimetypes |
414 | ## | 414 | ## |
415 | 415 | ||
416 | mimetype.git=image/git | 416 | mimetype.git=image/git |
417 | mimetype.html=text/html | 417 | mimetype.html=text/html |
418 | mimetype.jpg=image/jpeg | 418 | mimetype.jpg=image/jpeg |
419 | mimetype.jpeg=image/jpeg | 419 | mimetype.jpeg=image/jpeg |
420 | mimetype.pdf=application/pdf | 420 | mimetype.pdf=application/pdf |
421 | mimetype.png=image/png | 421 | mimetype.png=image/png |
422 | mimetype.svg=image/svg+xml | 422 | mimetype.svg=image/svg+xml |
423 | 423 | ||
424 | 424 | ||
425 | ## | 425 | ## |
426 | ## List of repositories. | 426 | ## List of repositories. |
427 | ## PS: Any repositories listed when repo.group is unset will not be | 427 | ## PS: Any repositories listed when section is unset will not be |
428 | ## displayed under a group heading | 428 | ## displayed under a section heading |
429 | ## PPS: This list could be kept in a different file (e.g. '/etc/cgitrepos') | 429 | ## PPS: This list could be kept in a different file (e.g. '/etc/cgitrepos') |
430 | ## and included like this: | 430 | ## and included like this: |
431 | ## include=/etc/cgitrepos | 431 | ## include=/etc/cgitrepos |
432 | ## | 432 | ## |
433 | 433 | ||
434 | 434 | ||
435 | repo.url=foo | 435 | repo.url=foo |
436 | repo.path=/pub/git/foo.git | 436 | repo.path=/pub/git/foo.git |
437 | repo.desc=the master foo repository | 437 | repo.desc=the master foo repository |
438 | repo.owner=fooman@foobar.com | 438 | repo.owner=fooman@foobar.com |
439 | repo.readme=info/web/about.html | 439 | repo.readme=info/web/about.html |
440 | 440 | ||
441 | 441 | ||
442 | repo.url=bar | 442 | repo.url=bar |
443 | repo.path=/pub/git/bar.git | 443 | repo.path=/pub/git/bar.git |
444 | repo.desc=the bars for your foo | 444 | repo.desc=the bars for your foo |
445 | repo.owner=barman@foobar.com | 445 | repo.owner=barman@foobar.com |
446 | repo.readme=info/web/about.html | 446 | repo.readme=info/web/about.html |
447 | 447 | ||
448 | 448 | ||
449 | # The next repositories will be displayed under the 'extras' heading | 449 | # The next repositories will be displayed under the 'extras' heading |
450 | repo.group=extras | 450 | section=extras |
451 | 451 | ||
452 | 452 | ||
453 | repo.url=baz | 453 | repo.url=baz |
454 | repo.path=/pub/git/baz.git | 454 | repo.path=/pub/git/baz.git |
455 | repo.desc=a set of extensions for bar users | 455 | repo.desc=a set of extensions for bar users |
456 | 456 | ||
457 | repo.url=wiz | 457 | repo.url=wiz |
458 | repo.path=/pub/git/wiz.git | 458 | repo.path=/pub/git/wiz.git |
459 | repo.desc=the wizard of foo | 459 | repo.desc=the wizard of foo |
460 | 460 | ||
461 | 461 | ||
462 | # Add some mirrored repositories | 462 | # Add some mirrored repositories |
463 | repo.group=mirrors | 463 | section=mirrors |
464 | 464 | ||
465 | 465 | ||
466 | repo.url=git | 466 | repo.url=git |
467 | repo.path=/pub/git/git.git | 467 | repo.path=/pub/git/git.git |
468 | repo.desc=the dscm | 468 | repo.desc=the dscm |
469 | 469 | ||
470 | 470 | ||
471 | repo.url=linux | 471 | repo.url=linux |
472 | repo.path=/pub/git/linux.git | 472 | repo.path=/pub/git/linux.git |
473 | repo.desc=the kernel | 473 | repo.desc=the kernel |
474 | 474 | ||
475 | # Disable adhoc downloads of this repo | 475 | # Disable adhoc downloads of this repo |
476 | repo.snapshots=0 | 476 | repo.snapshots=0 |
477 | 477 | ||
478 | # Disable line-counts for this repo | 478 | # Disable line-counts for this repo |
479 | repo.enable-log-linecount=0 | 479 | repo.enable-log-linecount=0 |
480 | 480 | ||
481 | # Restrict the max statistics period for this repo | 481 | # Restrict the max statistics period for this repo |
482 | repo.max-stats=month | 482 | repo.max-stats=month |
483 | .... | 483 | .... |
484 | 484 | ||
485 | 485 | ||
486 | BUGS | 486 | BUGS |
487 | ---- | 487 | ---- |
488 | Comments currently cannot appear on the same line as a setting; the comment | 488 | Comments currently cannot appear on the same line as a setting; the comment |
489 | will be included as part of the value. E.g. this line: | 489 | will be included as part of the value. E.g. this line: |
490 | 490 | ||
491 | robots=index # allow indexing | 491 | robots=index # allow indexing |
492 | 492 | ||
493 | will generate the following html element: | 493 | will generate the following html element: |
494 | 494 | ||
495 | <meta name='robots' content='index # allow indexing'/> | 495 | <meta name='robots' content='index # allow indexing'/> |
496 | 496 | ||
497 | 497 | ||
498 | 498 | ||
499 | AUTHOR | 499 | AUTHOR |
500 | ------ | 500 | ------ |
501 | Lars Hjemli <hjemli@gmail.com> | 501 | Lars Hjemli <hjemli@gmail.com> |