summaryrefslogtreecommitdiffabout
path: root/cgitrc.5.txt
Unidiff
Diffstat (limited to 'cgitrc.5.txt') (more/less context) (ignore whitespace changes)
-rw-r--r--cgitrc.5.txt8
1 files changed, 8 insertions, 0 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 3c20fe1..a832830 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -229,96 +229,104 @@ nocache::
229noplainemail:: 229noplainemail::
230 If set to "1" showing full author email adresses will be disabled. 230 If set to "1" showing full author email adresses will be disabled.
231 Default value: "0". 231 Default value: "0".
232 232
233noheader:: 233noheader::
234 Flag which, when set to "1", will make cgit omit the standard header 234 Flag which, when set to "1", will make cgit omit the standard header
235 on all pages. Default value: none. See also: "embedded". 235 on all pages. Default value: none. See also: "embedded".
236 236
237project-list:: 237project-list::
238 A list of subdirectories inside of scan-path, relative to it, that 238 A list of subdirectories inside of scan-path, relative to it, that
239 should loaded as git repositories. This must be defined prior to 239 should loaded as git repositories. This must be defined prior to
240 scan-path. Default value: none. See also: scan-path. 240 scan-path. Default value: none. See also: scan-path.
241 241
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::
278 If set to "1" and scan-path is enabled, scan-path will recurse into
279 directories whose name starts with a period ('.'). Otherwise,
280 scan-path will stay away from such directories (considered as
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.
283 Default value: 0. See also: scan-path.
284
277scan-path:: 285scan-path::
278 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,
279 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
280 directory. If project-list has been defined prior to scan-path, 288 directory. If project-list has been defined prior to scan-path,
281 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
282 project-list. Default value: none. See also: cache-scanrc-ttl, 290 project-list. Default value: none. See also: cache-scanrc-ttl,
283 project-list. 291 project-list.
284 292
285section:: 293section::
286 The name of the current repository section - all repositories defined 294 The name of the current repository section - all repositories defined
287 after this option will inherit the current section name. Default value: 295 after this option will inherit the current section name. Default value:
288 none. 296 none.
289 297
290section-from-path:: 298section-from-path::
291 A number which, if specified before scan-path, specifies how many 299 A number which, if specified before scan-path, specifies how many
292 path elements from each repo path to use as a default section name. 300 path elements from each repo path to use as a default section name.
293 If negative, cgit will discard the specified number of path elements 301 If negative, cgit will discard the specified number of path elements
294 above the repo directory. Default value: 0. 302 above the repo directory. Default value: 0.
295 303
296side-by-side-diffs:: 304side-by-side-diffs::
297 If set to "1" shows side-by-side diffs instead of unidiffs per 305 If set to "1" shows side-by-side diffs instead of unidiffs per
298 default. Default value: "0". 306 default. Default value: "0".
299 307
300snapshots:: 308snapshots::
301 Text which specifies the default set of snapshot formats generated by 309 Text which specifies the default set of snapshot formats generated by
302 cgit. The value is a space-separated list of zero or more of the 310 cgit. The value is a space-separated list of zero or more of the
303 values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none. 311 values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none.
304 312
305source-filter:: 313source-filter::
306 Specifies a command which will be invoked to format plaintext blobs 314 Specifies a command which will be invoked to format plaintext blobs
307 in the tree view. The command will get the blob content on its STDIN 315 in the tree view. The command will get the blob content on its STDIN
308 and the name of the blob as its only command line argument. The STDOUT 316 and the name of the blob as its only command line argument. The STDOUT
309 from the command will be included verbatim as the blob contents, i.e. 317 from the command will be included verbatim as the blob contents, i.e.
310 this can be used to implement e.g. syntax highlighting. Default value: 318 this can be used to implement e.g. syntax highlighting. Default value:
311 none. 319 none.
312 320
313summary-branches:: 321summary-branches::
314 Specifies the number of branches to display in the repository "summary" 322 Specifies the number of branches to display in the repository "summary"
315 view. Default value: "10". 323 view. Default value: "10".
316 324
317summary-log:: 325summary-log::
318 Specifies the number of log entries to display in the repository 326 Specifies the number of log entries to display in the repository
319 "summary" view. Default value: "10". 327 "summary" view. Default value: "10".
320 328
321summary-tags:: 329summary-tags::
322 Specifies the number of tags to display in the repository "summary" 330 Specifies the number of tags to display in the repository "summary"
323 view. Default value: "10". 331 view. Default value: "10".
324 332