-rw-r--r-- | cgitrc.5.txt | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt index ce78d41..75b6584 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt | |||
@@ -224,192 +224,199 @@ nocache:: | |||
224 | noplainemail:: | 224 | noplainemail:: |
225 | 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. |
226 | Default value: "0". | 226 | Default value: "0". |
227 | 227 | ||
228 | noheader:: | 228 | noheader:: |
229 | 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 |
230 | on all pages. Default value: none. See also: "embedded". | 230 | on all pages. Default value: none. See also: "embedded". |
231 | 231 | ||
232 | project-list:: | 232 | project-list:: |
233 | A list of subdirectories inside of scan-path, relative to it, that | 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 | 234 | should loaded as git repositories. This must be defined prior to |
235 | scan-path. Default value: none. See also: scan-path. | 235 | scan-path. Default value: none. See also: scan-path. |
236 | 236 | ||
237 | readme:: | 237 | readme:: |
238 | Text which will be used as default value for "repo.readme". Default | 238 | Text which will be used as default value for "repo.readme". Default |
239 | value: none. | 239 | value: none. |
240 | 240 | ||
241 | remove-suffix:: | 241 | remove-suffix:: |
242 | If set to "1" and scan-path is enabled, if any repositories are found | 242 | If set to "1" and scan-path is enabled, if any repositories are found |
243 | with a suffix of ".git", this suffix will be removed for the url and | 243 | with a suffix of ".git", this suffix will be removed for the url and |
244 | name. Default value: "0". See also: scan-path. | 244 | name. Default value: "0". See also: scan-path. |
245 | 245 | ||
246 | renamelimit:: | 246 | renamelimit:: |
247 | Maximum number of files to consider when detecting renames. The value | 247 | Maximum number of files to consider when detecting renames. The value |
248 | "-1" uses the compiletime value in git (for further info, look at | 248 | "-1" uses the compiletime value in git (for further info, look at |
249 | `man git-diff`). Default value: "-1". | 249 | `man git-diff`). Default value: "-1". |
250 | 250 | ||
251 | repo.group:: | 251 | repo.group:: |
252 | Legacy alias for "section". This option is deprecated and will not be | 252 | Legacy alias for "section". This option is deprecated and will not be |
253 | supported in cgit-1.0. | 253 | supported in cgit-1.0. |
254 | 254 | ||
255 | robots:: | 255 | robots:: |
256 | Text used as content for the "robots" meta-tag. Default value: | 256 | Text used as content for the "robots" meta-tag. Default value: |
257 | "index, nofollow". | 257 | "index, nofollow". |
258 | 258 | ||
259 | root-desc:: | 259 | root-desc:: |
260 | Text printed below the heading on the repository index page. Default | 260 | Text printed below the heading on the repository index page. Default |
261 | value: "a fast webinterface for the git dscm". | 261 | value: "a fast webinterface for the git dscm". |
262 | 262 | ||
263 | root-readme:: | 263 | root-readme:: |
264 | The content of the file specified with this option will be included | 264 | The content of the file specified with this option will be included |
265 | verbatim below the "about" link on the repository index page. Default | 265 | verbatim below the "about" link on the repository index page. Default |
266 | value: none. | 266 | value: none. |
267 | 267 | ||
268 | root-title:: | 268 | root-title:: |
269 | Text printed as heading on the repository index page. Default value: | 269 | Text printed as heading on the repository index page. Default value: |
270 | "Git Repository Browser". | 270 | "Git Repository Browser". |
271 | 271 | ||
272 | scan-path:: | 272 | scan-path:: |
273 | A path which will be scanned for repositories. If caching is enabled, | 273 | A path which will be scanned for repositories. If caching is enabled, |
274 | the result will be cached as a cgitrc include-file in the cache | 274 | the result will be cached as a cgitrc include-file in the cache |
275 | directory. If project-list has been defined prior to scan-path, | 275 | directory. If project-list has been defined prior to scan-path, |
276 | scan-path loads only the directories listed in the file pointed to by | 276 | scan-path loads only the directories listed in the file pointed to by |
277 | project-list. Default value: none. See also: cache-scanrc-ttl, | 277 | project-list. Default value: none. See also: cache-scanrc-ttl, |
278 | project-list. | 278 | project-list. |
279 | 279 | ||
280 | section:: | 280 | section:: |
281 | The name of the current repository section - all repositories defined | 281 | The name of the current repository section - all repositories defined |
282 | after this option will inherit the current section name. Default value: | 282 | after this option will inherit the current section name. Default value: |
283 | none. | 283 | none. |
284 | 284 | ||
285 | section-from-path:: | 285 | section-from-path:: |
286 | A number which, if specified before scan-path, specifies how many | 286 | A number which, if specified before scan-path, specifies how many |
287 | path elements from each repo path to use as a default section name. | 287 | path elements from each repo path to use as a default section name. |
288 | If negative, cgit will discard the specified number of path elements | 288 | If negative, cgit will discard the specified number of path elements |
289 | above the repo directory. Default value: 0. | 289 | above the repo directory. Default value: 0. |
290 | 290 | ||
291 | side-by-side-diffs:: | 291 | side-by-side-diffs:: |
292 | If set to "1" shows side-by-side diffs instead of unidiffs per | 292 | If set to "1" shows side-by-side diffs instead of unidiffs per |
293 | default. Default value: "0". | 293 | default. Default value: "0". |
294 | 294 | ||
295 | snapshots:: | 295 | snapshots:: |
296 | Text which specifies the default set of snapshot formats generated by | 296 | Text which specifies the default set of snapshot formats generated by |
297 | cgit. The value is a space-separated list of zero or more of the | 297 | cgit. The value is a space-separated list of zero or more of the |
298 | values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none. | 298 | values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none. |
299 | 299 | ||
300 | source-filter:: | 300 | source-filter:: |
301 | Specifies a command which will be invoked to format plaintext blobs | 301 | Specifies a command which will be invoked to format plaintext blobs |
302 | in the tree view. The command will get the blob content on its STDIN | 302 | in the tree view. The command will get the blob content on its STDIN |
303 | and the name of the blob as its only command line argument. The STDOUT | 303 | and the name of the blob as its only command line argument. The STDOUT |
304 | from the command will be included verbatim as the blob contents, i.e. | 304 | from the command will be included verbatim as the blob contents, i.e. |
305 | this can be used to implement e.g. syntax highlighting. Default value: | 305 | this can be used to implement e.g. syntax highlighting. Default value: |
306 | none. | 306 | none. |
307 | 307 | ||
308 | summary-branches:: | 308 | summary-branches:: |
309 | Specifies the number of branches to display in the repository "summary" | 309 | Specifies the number of branches to display in the repository "summary" |
310 | view. Default value: "10". | 310 | view. Default value: "10". |
311 | 311 | ||
312 | summary-log:: | 312 | summary-log:: |
313 | Specifies the number of log entries to display in the repository | 313 | Specifies the number of log entries to display in the repository |
314 | "summary" view. Default value: "10". | 314 | "summary" view. Default value: "10". |
315 | 315 | ||
316 | summary-tags:: | 316 | summary-tags:: |
317 | Specifies the number of tags to display in the repository "summary" | 317 | Specifies the number of tags to display in the repository "summary" |
318 | view. Default value: "10". | 318 | view. Default value: "10". |
319 | 319 | ||
320 | strict-export:: | ||
321 | Filename which, if specified, needs to be present within the repository | ||
322 | for cgit to allow access to that repository. This can be used to emulate | ||
323 | gitweb's EXPORT_OK and STRICT_EXPORT functionality and limit cgit's | ||
324 | repositories to match those exported by git-daemon. This option MUST come | ||
325 | before 'scan-path'. | ||
326 | |||
320 | virtual-root:: | 327 | virtual-root:: |
321 | Url which, if specified, will be used as root for all cgit links. It | 328 | Url which, if specified, will be used as root for all cgit links. It |
322 | will also cause cgit to generate 'virtual urls', i.e. urls like | 329 | will also cause cgit to generate 'virtual urls', i.e. urls like |
323 | '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default | 330 | '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default |
324 | value: none. | 331 | value: none. |
325 | NOTE: cgit has recently learned how to use PATH_INFO to achieve the | 332 | NOTE: cgit has recently learned how to use PATH_INFO to achieve the |
326 | same kind of virtual urls, so this option will probably be deprecated. | 333 | same kind of virtual urls, so this option will probably be deprecated. |
327 | 334 | ||
328 | REPOSITORY SETTINGS | 335 | REPOSITORY SETTINGS |
329 | ------------------- | 336 | ------------------- |
330 | repo.about-filter:: | 337 | repo.about-filter:: |
331 | Override the default about-filter. Default value: none. See also: | 338 | Override the default about-filter. Default value: none. See also: |
332 | "enable-filter-overrides". | 339 | "enable-filter-overrides". |
333 | 340 | ||
334 | repo.clone-url:: | 341 | repo.clone-url:: |
335 | A list of space-separated urls which can be used to clone this repo. | 342 | A list of space-separated urls which can be used to clone this repo. |
336 | Default value: none. | 343 | Default value: none. |
337 | 344 | ||
338 | repo.commit-filter:: | 345 | repo.commit-filter:: |
339 | Override the default commit-filter. Default value: none. See also: | 346 | Override the default commit-filter. Default value: none. See also: |
340 | "enable-filter-overrides". | 347 | "enable-filter-overrides". |
341 | 348 | ||
342 | repo.defbranch:: | 349 | repo.defbranch:: |
343 | The name of the default branch for this repository. If no such branch | 350 | The name of the default branch for this repository. If no such branch |
344 | exists in the repository, the first branch name (when sorted) is used | 351 | exists in the repository, the first branch name (when sorted) is used |
345 | as default instead. Default value: "master". | 352 | as default instead. Default value: "master". |
346 | 353 | ||
347 | repo.desc:: | 354 | repo.desc:: |
348 | The value to show as repository description. Default value: none. | 355 | The value to show as repository description. Default value: none. |
349 | 356 | ||
350 | repo.enable-log-filecount:: | 357 | repo.enable-log-filecount:: |
351 | A flag which can be used to disable the global setting | 358 | A flag which can be used to disable the global setting |
352 | `enable-log-filecount'. Default value: none. | 359 | `enable-log-filecount'. Default value: none. |
353 | 360 | ||
354 | repo.enable-log-linecount:: | 361 | repo.enable-log-linecount:: |
355 | A flag which can be used to disable the global setting | 362 | A flag which can be used to disable the global setting |
356 | `enable-log-linecount'. Default value: none. | 363 | `enable-log-linecount'. Default value: none. |
357 | 364 | ||
358 | repo.enable-remote-branches:: | 365 | repo.enable-remote-branches:: |
359 | Flag which, when set to "1", will make cgit display remote branches | 366 | Flag which, when set to "1", will make cgit display remote branches |
360 | in the summary and refs views. Default value: <enable-remote-branches>. | 367 | in the summary and refs views. Default value: <enable-remote-branches>. |
361 | 368 | ||
362 | repo.enable-subject-links:: | 369 | repo.enable-subject-links:: |
363 | A flag which can be used to override the global setting | 370 | A flag which can be used to override the global setting |
364 | `enable-subject-links'. Default value: none. | 371 | `enable-subject-links'. Default value: none. |
365 | 372 | ||
366 | repo.max-stats:: | 373 | repo.max-stats:: |
367 | Override the default maximum statistics period. Valid values are equal | 374 | Override the default maximum statistics period. Valid values are equal |
368 | to the values specified for the global "max-stats" setting. Default | 375 | to the values specified for the global "max-stats" setting. Default |
369 | value: none. | 376 | value: none. |
370 | 377 | ||
371 | repo.name:: | 378 | repo.name:: |
372 | The value to show as repository name. Default value: <repo.url>. | 379 | The value to show as repository name. Default value: <repo.url>. |
373 | 380 | ||
374 | repo.owner:: | 381 | repo.owner:: |
375 | A value used to identify the owner of the repository. Default value: | 382 | A value used to identify the owner of the repository. Default value: |
376 | none. | 383 | none. |
377 | 384 | ||
378 | repo.path:: | 385 | repo.path:: |
379 | An absolute path to the repository directory. For non-bare repositories | 386 | An absolute path to the repository directory. For non-bare repositories |
380 | this is the .git-directory. Default value: none. | 387 | this is the .git-directory. Default value: none. |
381 | 388 | ||
382 | repo.readme:: | 389 | repo.readme:: |
383 | A path (relative to <repo.path>) which specifies a file to include | 390 | A path (relative to <repo.path>) which specifies a file to include |
384 | verbatim as the "About" page for this repo. You may also specify a | 391 | verbatim as the "About" page for this repo. You may also specify a |
385 | git refspec by head or by hash by prepending the refspec followed by | 392 | git refspec by head or by hash by prepending the refspec followed by |
386 | a colon. For example, "master:docs/readme.mkd" Default value: <readme>. | 393 | a colon. For example, "master:docs/readme.mkd" Default value: <readme>. |
387 | 394 | ||
388 | repo.snapshots:: | 395 | repo.snapshots:: |
389 | A mask of allowed snapshot-formats for this repo, restricted by the | 396 | A mask of allowed snapshot-formats for this repo, restricted by the |
390 | "snapshots" global setting. Default value: <snapshots>. | 397 | "snapshots" global setting. Default value: <snapshots>. |
391 | 398 | ||
392 | repo.section:: | 399 | repo.section:: |
393 | Override the current section name for this repository. Default value: | 400 | Override the current section name for this repository. Default value: |
394 | none. | 401 | none. |
395 | 402 | ||
396 | repo.source-filter:: | 403 | repo.source-filter:: |
397 | Override the default source-filter. Default value: none. See also: | 404 | Override the default source-filter. Default value: none. See also: |
398 | "enable-filter-overrides". | 405 | "enable-filter-overrides". |
399 | 406 | ||
400 | repo.url:: | 407 | repo.url:: |
401 | The relative url used to access the repository. This must be the first | 408 | The relative url used to access the repository. This must be the first |
402 | setting specified for each repo. Default value: none. | 409 | setting specified for each repo. Default value: none. |
403 | 410 | ||
404 | 411 | ||
405 | REPOSITORY-SPECIFIC CGITRC FILE | 412 | REPOSITORY-SPECIFIC CGITRC FILE |
406 | ------------------------------- | 413 | ------------------------------- |
407 | When the option "scan-path" is used to auto-discover git repositories, cgit | 414 | When the option "scan-path" is used to auto-discover git repositories, cgit |
408 | will try to parse the file "cgitrc" within any found repository. Such a | 415 | will try to parse the file "cgitrc" within any found repository. Such a |
409 | repo-specific config file may contain any of the repo-specific options | 416 | repo-specific config file may contain any of the repo-specific options |
410 | described above, except "repo.url" and "repo.path". Additionally, the "filter" | 417 | described above, except "repo.url" and "repo.path". Additionally, the "filter" |
411 | options are only acknowledged in repo-specific config files when | 418 | options are only acknowledged in repo-specific config files when |
412 | "enable-filter-overrides" is set to "1". | 419 | "enable-filter-overrides" is set to "1". |
413 | 420 | ||
414 | Note: the "repo." prefix is dropped from the option names in repo-specific | 421 | Note: the "repo." prefix is dropped from the option names in repo-specific |
415 | config files, e.g. "repo.desc" becomes "desc". | 422 | config files, e.g. "repo.desc" becomes "desc". |