summaryrefslogtreecommitdiffabout
Unidiff
Diffstat (more/less context) (ignore whitespace changes)
-rw-r--r--cgitrc.5.txt5
1 files changed, 3 insertions, 2 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index be8483c..65b210f 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -242,98 +242,99 @@ project-list::
242readme:: 242readme::
243 Text which will be used as default value for "repo.readme". Default 243 Text which will be used as default value for "repo.readme". Default
244 value: none. 244 value: none.
245 245
246remove-suffix:: 246remove-suffix::
247 If set to "1" and scan-path is enabled, if any repositories are found 247 If set to "1" and scan-path is enabled, if any repositories are found
248 with a suffix of ".git", this suffix will be removed for the url and 248 with a suffix of ".git", this suffix will be removed for the url and
249 name. Default value: "0". See also: scan-path. 249 name. Default value: "0". See also: scan-path.
250 250
251renamelimit:: 251renamelimit::
252 Maximum number of files to consider when detecting renames. The value 252 Maximum number of files to consider when detecting renames. The value
253 "-1" uses the compiletime value in git (for further info, look at 253 "-1" uses the compiletime value in git (for further info, look at
254 `man git-diff`). Default value: "-1". 254 `man git-diff`). Default value: "-1".
255 255
256repo.group:: 256repo.group::
257 Legacy alias for "section". This option is deprecated and will not be 257 Legacy alias for "section". This option is deprecated and will not be
258 supported in cgit-1.0. 258 supported in cgit-1.0.
259 259
260robots:: 260robots::
261 Text used as content for the "robots" meta-tag. Default value: 261 Text used as content for the "robots" meta-tag. Default value:
262 "index, nofollow". 262 "index, nofollow".
263 263
264root-desc:: 264root-desc::
265 Text printed below the heading on the repository index page. Default 265 Text printed below the heading on the repository index page. Default
266 value: "a fast webinterface for the git dscm". 266 value: "a fast webinterface for the git dscm".
267 267
268root-readme:: 268root-readme::
269 The content of the file specified with this option will be included 269 The content of the file specified with this option will be included
270 verbatim below the "about" link on the repository index page. Default 270 verbatim below the "about" link on the repository index page. Default
271 value: none. 271 value: none.
272 272
273root-title:: 273root-title::
274 Text printed as heading on the repository index page. Default value: 274 Text printed as heading on the repository index page. Default value:
275 "Git Repository Browser". 275 "Git Repository Browser".
276 276
277scan-hidden-path:: 277scan-hidden-path::
278 If set to "1" and scan-path is enabled, scan-path will recurse into 278 If set to "1" and scan-path is enabled, scan-path will recurse into
279 directories whose name starts with a period ('.'). Otherwise, 279 directories whose name starts with a period ('.'). Otherwise,
280 scan-path will stay away from such directories (considered as 280 scan-path will stay away from such directories (considered as
281 "hidden"). Note that this does not apply to the ".git" directory in 281 "hidden"). Note that this does not apply to the ".git" directory in
282 non-bare repos. This must be defined prior to scan-path. 282 non-bare repos. This must be defined prior to scan-path.
283 Default value: 0. See also: scan-path. 283 Default value: 0. See also: scan-path.
284 284
285scan-path:: 285scan-path::
286 A path which will be scanned for repositories. If caching is enabled, 286 A path which will be scanned for repositories. If caching is enabled,
287 the result will be cached as a cgitrc include-file in the cache 287 the result will be cached as a cgitrc include-file in the cache
288 directory. If project-list has been defined prior to scan-path, 288 directory. If project-list has been defined prior to scan-path,
289 scan-path loads only the directories listed in the file pointed to by 289 scan-path loads only the directories listed in the file pointed to by
290 project-list. Default value: none. See also: cache-scanrc-ttl, 290 project-list. Be advised that only the global settings taken
291 project-list. 291 before the scan-path directive will be applied to each repository.
292 Default value: none. See also: cache-scanrc-ttl, project-list.
292 293
293section:: 294section::
294 The name of the current repository section - all repositories defined 295 The name of the current repository section - all repositories defined
295 after this option will inherit the current section name. Default value: 296 after this option will inherit the current section name. Default value:
296 none. 297 none.
297 298
298section-from-path:: 299section-from-path::
299 A number which, if specified before scan-path, specifies how many 300 A number which, if specified before scan-path, specifies how many
300 path elements from each repo path to use as a default section name. 301 path elements from each repo path to use as a default section name.
301 If negative, cgit will discard the specified number of path elements 302 If negative, cgit will discard the specified number of path elements
302 above the repo directory. Default value: 0. 303 above the repo directory. Default value: 0.
303 304
304side-by-side-diffs:: 305side-by-side-diffs::
305 If set to "1" shows side-by-side diffs instead of unidiffs per 306 If set to "1" shows side-by-side diffs instead of unidiffs per
306 default. Default value: "0". 307 default. Default value: "0".
307 308
308snapshots:: 309snapshots::
309 Text which specifies the default set of snapshot formats generated by 310 Text which specifies the default set of snapshot formats generated by
310 cgit. The value is a space-separated list of zero or more of the 311 cgit. The value is a space-separated list of zero or more of the
311 values "tar", "tar.gz", "tar.bz2", "tar.xz" and "zip". Default value: 312 values "tar", "tar.gz", "tar.bz2", "tar.xz" and "zip". Default value:
312 none. 313 none.
313 314
314source-filter:: 315source-filter::
315 Specifies a command which will be invoked to format plaintext blobs 316 Specifies a command which will be invoked to format plaintext blobs
316 in the tree view. The command will get the blob content on its STDIN 317 in the tree view. The command will get the blob content on its STDIN
317 and the name of the blob as its only command line argument. The STDOUT 318 and the name of the blob as its only command line argument. The STDOUT
318 from the command will be included verbatim as the blob contents, i.e. 319 from the command will be included verbatim as the blob contents, i.e.
319 this can be used to implement e.g. syntax highlighting. Default value: 320 this can be used to implement e.g. syntax highlighting. Default value:
320 none. 321 none.
321 322
322summary-branches:: 323summary-branches::
323 Specifies the number of branches to display in the repository "summary" 324 Specifies the number of branches to display in the repository "summary"
324 view. Default value: "10". 325 view. Default value: "10".
325 326
326summary-log:: 327summary-log::
327 Specifies the number of log entries to display in the repository 328 Specifies the number of log entries to display in the repository
328 "summary" view. Default value: "10". 329 "summary" view. Default value: "10".
329 330
330summary-tags:: 331summary-tags::
331 Specifies the number of tags to display in the repository "summary" 332 Specifies the number of tags to display in the repository "summary"
332 view. Default value: "10". 333 view. Default value: "10".
333 334
334strict-export:: 335strict-export::
335 Filename which, if specified, needs to be present within the repository 336 Filename which, if specified, needs to be present within the repository
336 for cgit to allow access to that repository. This can be used to emulate 337 for cgit to allow access to that repository. This can be used to emulate
337 gitweb's EXPORT_OK and STRICT_EXPORT functionality and limit cgit's 338 gitweb's EXPORT_OK and STRICT_EXPORT functionality and limit cgit's
338 repositories to match those exported by git-daemon. This option MUST come 339 repositories to match those exported by git-daemon. This option MUST come
339 before 'scan-path'. 340 before 'scan-path'.