-rw-r--r-- | cgitrc.5.txt | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt index c643fae..187031a 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt | |||
@@ -205,64 +205,68 @@ max-stats:: | |||
205 | Set the default maximum statistics period. Valid values are "week", | 205 | Set the default maximum statistics period. Valid values are "week", |
206 | "month", "quarter" and "year". If unspecified, statistics are | 206 | "month", "quarter" and "year". If unspecified, statistics are |
207 | disabled. Default value: none. See also: "repo.max-stats". | 207 | disabled. Default value: none. See also: "repo.max-stats". |
208 | 208 | ||
209 | mimetype.<ext>:: | 209 | mimetype.<ext>:: |
210 | Set the mimetype for the specified filename extension. This is used | 210 | Set the mimetype for the specified filename extension. This is used |
211 | by the `plain` command when returning blob content. | 211 | by the `plain` command when returning blob content. |
212 | 212 | ||
213 | module-link:: | 213 | module-link:: |
214 | 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 |
215 | submodule is printed in a directory listing. The arguments for the | 215 | submodule is printed in a directory listing. The arguments for the |
216 | formatstring are the path and SHA1 of the submodule commit. Default | 216 | formatstring are the path and SHA1 of the submodule commit. Default |
217 | value: "./?repo=%s&page=commit&id=%s" | 217 | value: "./?repo=%s&page=commit&id=%s" |
218 | 218 | ||
219 | nocache:: | 219 | nocache:: |
220 | 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 |
221 | 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 |
222 | value: "0". | 222 | value: "0". |
223 | 223 | ||
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:: | ||
238 | Text which will be used as default value for "repo.readme". Default | ||
239 | value: none. | ||
240 | |||
237 | remove-suffix:: | 241 | remove-suffix:: |
238 | 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 |
239 | 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 |
240 | name. Default value: "0". See also: scan-path. | 244 | name. Default value: "0". See also: scan-path. |
241 | 245 | ||
242 | renamelimit:: | 246 | renamelimit:: |
243 | Maximum number of files to consider when detecting renames. The value | 247 | Maximum number of files to consider when detecting renames. The value |
244 | "-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 |
245 | `man git-diff`). Default value: "-1". | 249 | `man git-diff`). Default value: "-1". |
246 | 250 | ||
247 | repo.group:: | 251 | repo.group:: |
248 | 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 |
249 | supported in cgit-1.0. | 253 | supported in cgit-1.0. |
250 | 254 | ||
251 | robots:: | 255 | robots:: |
252 | Text used as content for the "robots" meta-tag. Default value: | 256 | Text used as content for the "robots" meta-tag. Default value: |
253 | "index, nofollow". | 257 | "index, nofollow". |
254 | 258 | ||
255 | root-desc:: | 259 | root-desc:: |
256 | Text printed below the heading on the repository index page. Default | 260 | Text printed below the heading on the repository index page. Default |
257 | value: "a fast webinterface for the git dscm". | 261 | value: "a fast webinterface for the git dscm". |
258 | 262 | ||
259 | root-readme:: | 263 | root-readme:: |
260 | 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 |
261 | verbatim below the "about" link on the repository index page. Default | 265 | verbatim below the "about" link on the repository index page. Default |
262 | value: none. | 266 | value: none. |
263 | 267 | ||
264 | root-title:: | 268 | root-title:: |
265 | Text printed as heading on the repository index page. Default value: | 269 | Text printed as heading on the repository index page. Default value: |
266 | "Git Repository Browser". | 270 | "Git Repository Browser". |
267 | 271 | ||
268 | scan-path:: | 272 | scan-path:: |
@@ -344,65 +348,65 @@ repo.enable-log-filecount:: | |||
344 | repo.enable-log-linecount:: | 348 | repo.enable-log-linecount:: |
345 | A flag which can be used to disable the global setting | 349 | A flag which can be used to disable the global setting |
346 | `enable-log-linecount'. Default value: none. | 350 | `enable-log-linecount'. Default value: none. |
347 | 351 | ||
348 | repo.enable-remote-branches:: | 352 | repo.enable-remote-branches:: |
349 | Flag which, when set to "1", will make cgit display remote branches | 353 | Flag which, when set to "1", will make cgit display remote branches |
350 | in the summary and refs views. Default value: <enable-remote-branches>. | 354 | in the summary and refs views. Default value: <enable-remote-branches>. |
351 | 355 | ||
352 | repo.enable-subject-links:: | 356 | repo.enable-subject-links:: |
353 | A flag which can be used to override the global setting | 357 | A flag which can be used to override the global setting |
354 | `enable-subject-links'. Default value: none. | 358 | `enable-subject-links'. Default value: none. |
355 | 359 | ||
356 | repo.max-stats:: | 360 | repo.max-stats:: |
357 | Override the default maximum statistics period. Valid values are equal | 361 | Override the default maximum statistics period. Valid values are equal |
358 | to the values specified for the global "max-stats" setting. Default | 362 | to the values specified for the global "max-stats" setting. Default |
359 | value: none. | 363 | value: none. |
360 | 364 | ||
361 | repo.name:: | 365 | repo.name:: |
362 | The value to show as repository name. Default value: <repo.url>. | 366 | The value to show as repository name. Default value: <repo.url>. |
363 | 367 | ||
364 | repo.owner:: | 368 | repo.owner:: |
365 | A value used to identify the owner of the repository. Default value: | 369 | A value used to identify the owner of the repository. Default value: |
366 | none. | 370 | none. |
367 | 371 | ||
368 | repo.path:: | 372 | repo.path:: |
369 | An absolute path to the repository directory. For non-bare repositories | 373 | An absolute path to the repository directory. For non-bare repositories |
370 | this is the .git-directory. Default value: none. | 374 | this is the .git-directory. Default value: none. |
371 | 375 | ||
372 | repo.readme:: | 376 | repo.readme:: |
373 | A path (relative to <repo.path>) which specifies a file to include | 377 | A path (relative to <repo.path>) which specifies a file to include |
374 | verbatim as the "About" page for this repo. You may also specify a | 378 | verbatim as the "About" page for this repo. You may also specify a |
375 | git refspec by head or by hash by prepending the refspec followed by | 379 | git refspec by head or by hash by prepending the refspec followed by |
376 | a colon. For example, "master:docs/readme.mkd" Default value: none. | 380 | a colon. For example, "master:docs/readme.mkd" Default value: <readme>. |
377 | 381 | ||
378 | repo.snapshots:: | 382 | repo.snapshots:: |
379 | A mask of allowed snapshot-formats for this repo, restricted by the | 383 | A mask of allowed snapshot-formats for this repo, restricted by the |
380 | "snapshots" global setting. Default value: <snapshots>. | 384 | "snapshots" global setting. Default value: <snapshots>. |
381 | 385 | ||
382 | repo.section:: | 386 | repo.section:: |
383 | Override the current section name for this repository. Default value: | 387 | Override the current section name for this repository. Default value: |
384 | none. | 388 | none. |
385 | 389 | ||
386 | repo.source-filter:: | 390 | repo.source-filter:: |
387 | Override the default source-filter. Default value: none. See also: | 391 | Override the default source-filter. Default value: none. See also: |
388 | "enable-filter-overrides". | 392 | "enable-filter-overrides". |
389 | 393 | ||
390 | repo.url:: | 394 | repo.url:: |
391 | The relative url used to access the repository. This must be the first | 395 | The relative url used to access the repository. This must be the first |
392 | setting specified for each repo. Default value: none. | 396 | setting specified for each repo. Default value: none. |
393 | 397 | ||
394 | 398 | ||
395 | REPOSITORY-SPECIFIC CGITRC FILE | 399 | REPOSITORY-SPECIFIC CGITRC FILE |
396 | ------------------------------- | 400 | ------------------------------- |
397 | When the option "scan-path" is used to auto-discover git repositories, cgit | 401 | When the option "scan-path" is used to auto-discover git repositories, cgit |
398 | will try to parse the file "cgitrc" within any found repository. Such a | 402 | will try to parse the file "cgitrc" within any found repository. Such a |
399 | repo-specific config file may contain any of the repo-specific options | 403 | repo-specific config file may contain any of the repo-specific options |
400 | described above, except "repo.url" and "repo.path". Additionally, the "filter" | 404 | described above, except "repo.url" and "repo.path". Additionally, the "filter" |
401 | options are only acknowledged in repo-specific config files when | 405 | options are only acknowledged in repo-specific config files when |
402 | "enable-filter-overrides" is set to "1". | 406 | "enable-filter-overrides" is set to "1". |
403 | 407 | ||
404 | Note: the "repo." prefix is dropped from the option names in repo-specific | 408 | Note: the "repo." prefix is dropped from the option names in repo-specific |
405 | config files, e.g. "repo.desc" becomes "desc". | 409 | config files, e.g. "repo.desc" becomes "desc". |
406 | 410 | ||
407 | 411 | ||
408 | EXAMPLE CGITRC FILE | 412 | EXAMPLE CGITRC FILE |