summaryrefslogtreecommitdiffabout
path: root/cgitrc.5.txt
Unidiff
Diffstat (limited to 'cgitrc.5.txt') (more/less context) (ignore whitespace changes)
-rw-r--r--cgitrc.5.txt6
1 files changed, 6 insertions, 0 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index c643fae..95782df 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -233,96 +233,102 @@ 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
237remove-suffix:: 237remove-suffix::
238 If set to "1" and scan-path is enabled, if any repositories are found 238 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 239 with a suffix of ".git", this suffix will be removed for the url and
240 name. Default value: "0". See also: scan-path. 240 name. Default value: "0". See also: scan-path.
241 241
242renamelimit:: 242renamelimit::
243 Maximum number of files to consider when detecting renames. The value 243 Maximum number of files to consider when detecting renames. The value
244 "-1" uses the compiletime value in git (for further info, look at 244 "-1" uses the compiletime value in git (for further info, look at
245 `man git-diff`). Default value: "-1". 245 `man git-diff`). Default value: "-1".
246 246
247repo.group:: 247repo.group::
248 Legacy alias for "section". This option is deprecated and will not be 248 Legacy alias for "section". This option is deprecated and will not be
249 supported in cgit-1.0. 249 supported in cgit-1.0.
250 250
251robots:: 251robots::
252 Text used as content for the "robots" meta-tag. Default value: 252 Text used as content for the "robots" meta-tag. Default value:
253 "index, nofollow". 253 "index, nofollow".
254 254
255root-desc:: 255root-desc::
256 Text printed below the heading on the repository index page. Default 256 Text printed below the heading on the repository index page. Default
257 value: "a fast webinterface for the git dscm". 257 value: "a fast webinterface for the git dscm".
258 258
259root-readme:: 259root-readme::
260 The content of the file specified with this option will be included 260 The content of the file specified with this option will be included
261 verbatim below the "about" link on the repository index page. Default 261 verbatim below the "about" link on the repository index page. Default
262 value: none. 262 value: none.
263 263
264root-title:: 264root-title::
265 Text printed as heading on the repository index page. Default value: 265 Text printed as heading on the repository index page. Default value:
266 "Git Repository Browser". 266 "Git Repository Browser".
267 267
268scan-path:: 268scan-path::
269 A path which will be scanned for repositories. If caching is enabled, 269 A path which will be scanned for repositories. If caching is enabled,
270 the result will be cached as a cgitrc include-file in the cache 270 the result will be cached as a cgitrc include-file in the cache
271 directory. If project-list has been defined prior to scan-path, 271 directory. If project-list has been defined prior to scan-path,
272 scan-path loads only the directories listed in the file pointed to by 272 scan-path loads only the directories listed in the file pointed to by
273 project-list. Default value: none. See also: cache-scanrc-ttl, 273 project-list. Default value: none. See also: cache-scanrc-ttl,
274 project-list. 274 project-list.
275 275
276section:: 276section::
277 The name of the current repository section - all repositories defined 277 The name of the current repository section - all repositories defined
278 after this option will inherit the current section name. Default value: 278 after this option will inherit the current section name. Default value:
279 none. 279 none.
280 280
281section-from-path::
282 A number which, if specified before scan-path, specifies how many
283 path elements from each repo path to use as a default section name.
284 If negative, cgit will discard the specified number of path elements
285 above the repo directory. Default value: 0.
286
281side-by-side-diffs:: 287side-by-side-diffs::
282 If set to "1" shows side-by-side diffs instead of unidiffs per 288 If set to "1" shows side-by-side diffs instead of unidiffs per
283 default. Default value: "0". 289 default. Default value: "0".
284 290
285snapshots:: 291snapshots::
286 Text which specifies the default set of snapshot formats generated by 292 Text which specifies the default set of snapshot formats generated by
287 cgit. The value is a space-separated list of zero or more of the 293 cgit. The value is a space-separated list of zero or more of the
288 values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none. 294 values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none.
289 295
290source-filter:: 296source-filter::
291 Specifies a command which will be invoked to format plaintext blobs 297 Specifies a command which will be invoked to format plaintext blobs
292 in the tree view. The command will get the blob content on its STDIN 298 in the tree view. The command will get the blob content on its STDIN
293 and the name of the blob as its only command line argument. The STDOUT 299 and the name of the blob as its only command line argument. The STDOUT
294 from the command will be included verbatim as the blob contents, i.e. 300 from the command will be included verbatim as the blob contents, i.e.
295 this can be used to implement e.g. syntax highlighting. Default value: 301 this can be used to implement e.g. syntax highlighting. Default value:
296 none. 302 none.
297 303
298summary-branches:: 304summary-branches::
299 Specifies the number of branches to display in the repository "summary" 305 Specifies the number of branches to display in the repository "summary"
300 view. Default value: "10". 306 view. Default value: "10".
301 307
302summary-log:: 308summary-log::
303 Specifies the number of log entries to display in the repository 309 Specifies the number of log entries to display in the repository
304 "summary" view. Default value: "10". 310 "summary" view. Default value: "10".
305 311
306summary-tags:: 312summary-tags::
307 Specifies the number of tags to display in the repository "summary" 313 Specifies the number of tags to display in the repository "summary"
308 view. Default value: "10". 314 view. Default value: "10".
309 315
310virtual-root:: 316virtual-root::
311 Url which, if specified, will be used as root for all cgit links. It 317 Url which, if specified, will be used as root for all cgit links. It
312 will also cause cgit to generate 'virtual urls', i.e. urls like 318 will also cause cgit to generate 'virtual urls', i.e. urls like
313 '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default 319 '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default
314 value: none. 320 value: none.
315 NOTE: cgit has recently learned how to use PATH_INFO to achieve the 321 NOTE: cgit has recently learned how to use PATH_INFO to achieve the
316 same kind of virtual urls, so this option will probably be deprecated. 322 same kind of virtual urls, so this option will probably be deprecated.
317 323
318REPOSITORY SETTINGS 324REPOSITORY SETTINGS
319------------------- 325-------------------
320repo.about-filter:: 326repo.about-filter::
321 Override the default about-filter. Default value: none. See also: 327 Override the default about-filter. Default value: none. See also:
322 "enable-filter-overrides". 328 "enable-filter-overrides".
323 329
324repo.clone-url:: 330repo.clone-url::
325 A list of space-separated urls which can be used to clone this repo. 331 A list of space-separated urls which can be used to clone this repo.
326 Default value: none. 332 Default value: none.
327 333
328repo.commit-filter:: 334repo.commit-filter::