summaryrefslogtreecommitdiffabout
Unidiff
Diffstat (more/less context) (ignore whitespace changes)
-rw-r--r--cgitrc.5.txt19
1 files changed, 10 insertions, 9 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index df494aa..46df291 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -191,50 +191,50 @@ noplainemail::
191 Default value: "0". 191 Default value: "0".
192 192
193noheader:: 193noheader::
194 Flag which, when set to "1", will make cgit omit the standard header 194 Flag which, when set to "1", will make cgit omit the standard header
195 on all pages. Default value: none. See also: "embedded". 195 on all pages. Default value: none. See also: "embedded".
196 196
197renamelimit:: 197renamelimit::
198 Maximum number of files to consider when detecting renames. The value 198 Maximum number of files to consider when detecting renames. The value
199 "-1" uses the compiletime value in git (for further info, look at 199 "-1" uses the compiletime value in git (for further info, look at
200 `man git-diff`). Default value: "-1". 200 `man git-diff`). Default value: "-1".
201 201
202repo.group:: 202repo.group::
203 Legacy alias for 'section' which will be deprecated starting with 203 Legacy alias for "section". This option is deprecated and will not be
204 cgit-1.0. 204 supported in cgit-1.0.
205 205
206robots:: 206robots::
207 Text used as content for the "robots" meta-tag. Default value: 207 Text used as content for the "robots" meta-tag. Default value:
208 "index, nofollow". 208 "index, nofollow".
209 209
210root-desc:: 210root-desc::
211 Text printed below the heading on the repository index page. Default 211 Text printed below the heading on the repository index page. Default
212 value: "a fast webinterface for the git dscm". 212 value: "a fast webinterface for the git dscm".
213 213
214root-readme:: 214root-readme::
215 The content of the file specified with this option will be included 215 The content of the file specified with this option will be included
216 verbatim below the "about" link on the repository index page. Default 216 verbatim below the "about" link on the repository index page. Default
217 value: none. 217 value: none.
218 218
219root-title:: 219root-title::
220 Text printed as heading on the repository index page. Default value: 220 Text printed as heading on the repository index page. Default value:
221 "Git Repository Browser". 221 "Git Repository Browser".
222 222
223scan-path:: 223scan-path::
224 A path which will be scanned for repositories. If caching is enabled, 224 A path which will be scanned for repositories. If caching is enabled,
225 the result will be cached as a cgitrc include-file in the cache 225 the result will be cached as a cgitrc include-file in the cache
226 directory. Default value: none. See also: cache-scanrc-ttl. 226 directory. Default value: none. See also: cache-scanrc-ttl.
227 227
228section: 228section::
229 The name of the current repository section - all repositories defined 229 The name of the current repository section - all repositories defined
230 after this option will inherit the current section name. Default value: 230 after this option will inherit the current section name. Default value:
231 none. 231 none.
232 232
233snapshots:: 233snapshots::
234 Text which specifies the default set of snapshot formats generated by 234 Text which specifies the default set of snapshot formats generated by
235 cgit. The value is a space-separated list of zero or more of the 235 cgit. The value is a space-separated list of zero or more of the
236 values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none. 236 values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none.
237 237
238source-filter:: 238source-filter::
239 Specifies a command which will be invoked to format plaintext blobs 239 Specifies a command which will be invoked to format plaintext blobs
240 in the tree view. The command will get the blob content on its STDIN 240 in the tree view. The command will get the blob content on its STDIN
@@ -307,41 +307,42 @@ repo.path::
307 An absolute path to the repository directory. For non-bare repositories 307 An absolute path to the repository directory. For non-bare repositories
308 this is the .git-directory. Default value: none. 308 this is the .git-directory. Default value: none.
309 309
310repo.readme:: 310repo.readme::
311 A path (relative to <repo.path>) which specifies a file to include 311 A path (relative to <repo.path>) which specifies a file to include
312 verbatim as the "About" page for this repo. Default value: none. 312 verbatim as the "About" page for this repo. Default value: none.
313 313
314repo.snapshots:: 314repo.snapshots::
315 A mask of allowed snapshot-formats for this repo, restricted by the 315 A mask of allowed snapshot-formats for this repo, restricted by the
316 "snapshots" global setting. Default value: <snapshots>. 316 "snapshots" global setting. Default value: <snapshots>.
317 317
318repo.section:: 318repo.section::
319 Override the current section for this repository. Default value: none. 319 Override the current section name for this repository. Default value:
320 none.
320 321
321repo.source-filter:: 322repo.source-filter::
322 Override the default source-filter. Default value: <source-filter>. 323 Override the default source-filter. Default value: <source-filter>.
323 324
324repo.url:: 325repo.url::
325 The relative url used to access the repository. This must be the first 326 The relative url used to access the repository. This must be the first
326 setting specified for each repo. Default value: none. 327 setting specified for each repo. Default value: none.
327 328
328 329
329REPOSITORY-SPECIFIC CGITRC FILE 330REPOSITORY-SPECIFIC CGITRC FILE
330------------------------------- 331-------------------------------
331When the option 'scan-path' is used to auto-discover git repositories, cgit 332When the option "scan-path" is used to auto-discover git repositories, cgit
332will try to parse the file 'cgitrc' within any found repository. Such a repo- 333will try to parse the file "cgitrc" within any found repository. Such a
333specific config file may contain any of the repo-specific options described 334repo-specific config file may contain any of the repo-specific options
334above, except 'repo.url' and 'repo.path'. Also, in a repo-specific config 335described above, except "repo.url" and "repo.path". Also, in a repo-specific
335file, the 'repo.' prefix is dropped from the config option names. 336config file, the "repo." prefix is dropped from the config option names.
336 337
337 338
338EXAMPLE CGITRC FILE 339EXAMPLE CGITRC FILE
339------------------- 340-------------------
340 341
341.... 342....
342# Enable caching of up to 1000 output entriess 343# Enable caching of up to 1000 output entriess
343cache-size=1000 344cache-size=1000
344 345
345 346
346# Specify some default clone prefixes 347# Specify some default clone prefixes
347clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git 348clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git