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 187031a..ce78d41 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -189,192 +189,198 @@ max-message-length::
189 Specifies the maximum number of commit message characters to display in 189 Specifies the maximum number of commit message characters to display in
190 "log" view. Default value: "80". 190 "log" view. Default value: "80".
191 191
192max-repo-count:: 192max-repo-count::
193 Specifies the number of entries to list per page on therepository 193 Specifies the number of entries to list per page on therepository
194 index page. Default value: "50". 194 index page. Default value: "50".
195 195
196max-repodesc-length:: 196max-repodesc-length::
197 Specifies the maximum number of repo description characters to display 197 Specifies the maximum number of repo description characters to display
198 on the repository index page. Default value: "80". 198 on the repository index page. Default value: "80".
199 199
200max-blob-size:: 200max-blob-size::
201 Specifies the maximum size of a blob to display HTML for in KBytes. 201 Specifies the maximum size of a blob to display HTML for in KBytes.
202 Default value: "0" (limit disabled). 202 Default value: "0" (limit disabled).
203 203
204max-stats:: 204max-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
209mimetype.<ext>:: 209mimetype.<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
213module-link:: 213module-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
219nocache:: 219nocache::
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
224noplainemail:: 224noplainemail::
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
228noheader:: 228noheader::
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
232project-list:: 232project-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
237readme:: 237readme::
238 Text which will be used as default value for "repo.readme". Default 238 Text which will be used as default value for "repo.readme". Default
239 value: none. 239 value: none.
240 240
241remove-suffix:: 241remove-suffix::
242 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
243 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
244 name. Default value: "0". See also: scan-path. 244 name. Default value: "0". See also: scan-path.
245 245
246renamelimit:: 246renamelimit::
247 Maximum number of files to consider when detecting renames. The value 247 Maximum number of files to consider when detecting renames. The value
248 "-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
249 `man git-diff`). Default value: "-1". 249 `man git-diff`). Default value: "-1".
250 250
251repo.group:: 251repo.group::
252 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
253 supported in cgit-1.0. 253 supported in cgit-1.0.
254 254
255robots:: 255robots::
256 Text used as content for the "robots" meta-tag. Default value: 256 Text used as content for the "robots" meta-tag. Default value:
257 "index, nofollow". 257 "index, nofollow".
258 258
259root-desc:: 259root-desc::
260 Text printed below the heading on the repository index page. Default 260 Text printed below the heading on the repository index page. Default
261 value: "a fast webinterface for the git dscm". 261 value: "a fast webinterface for the git dscm".
262 262
263root-readme:: 263root-readme::
264 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
265 verbatim below the "about" link on the repository index page. Default 265 verbatim below the "about" link on the repository index page. Default
266 value: none. 266 value: none.
267 267
268root-title:: 268root-title::
269 Text printed as heading on the repository index page. Default value: 269 Text printed as heading on the repository index page. Default value:
270 "Git Repository Browser". 270 "Git Repository Browser".
271 271
272scan-path:: 272scan-path::
273 A path which will be scanned for repositories. If caching is enabled, 273 A path which will be scanned for repositories. If caching is enabled,
274 the result will be cached as a cgitrc include-file in the cache 274 the result will be cached as a cgitrc include-file in the cache
275 directory. If project-list has been defined prior to scan-path, 275 directory. If project-list has been defined prior to scan-path,
276 scan-path loads only the directories listed in the file pointed to by 276 scan-path loads only the directories listed in the file pointed to by
277 project-list. Default value: none. See also: cache-scanrc-ttl, 277 project-list. Default value: none. See also: cache-scanrc-ttl,
278 project-list. 278 project-list.
279 279
280section:: 280section::
281 The name of the current repository section - all repositories defined 281 The name of the current repository section - all repositories defined
282 after this option will inherit the current section name. Default value: 282 after this option will inherit the current section name. Default value:
283 none. 283 none.
284 284
285section-from-path::
286 A number which, if specified before scan-path, specifies how many
287 path elements from each repo path to use as a default section name.
288 If negative, cgit will discard the specified number of path elements
289 above the repo directory. Default value: 0.
290
285side-by-side-diffs:: 291side-by-side-diffs::
286 If set to "1" shows side-by-side diffs instead of unidiffs per 292 If set to "1" shows side-by-side diffs instead of unidiffs per
287 default. Default value: "0". 293 default. Default value: "0".
288 294
289snapshots:: 295snapshots::
290 Text which specifies the default set of snapshot formats generated by 296 Text which specifies the default set of snapshot formats generated by
291 cgit. The value is a space-separated list of zero or more of the 297 cgit. The value is a space-separated list of zero or more of the
292 values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none. 298 values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none.
293 299
294source-filter:: 300source-filter::
295 Specifies a command which will be invoked to format plaintext blobs 301 Specifies a command which will be invoked to format plaintext blobs
296 in the tree view. The command will get the blob content on its STDIN 302 in the tree view. The command will get the blob content on its STDIN
297 and the name of the blob as its only command line argument. The STDOUT 303 and the name of the blob as its only command line argument. The STDOUT
298 from the command will be included verbatim as the blob contents, i.e. 304 from the command will be included verbatim as the blob contents, i.e.
299 this can be used to implement e.g. syntax highlighting. Default value: 305 this can be used to implement e.g. syntax highlighting. Default value:
300 none. 306 none.
301 307
302summary-branches:: 308summary-branches::
303 Specifies the number of branches to display in the repository "summary" 309 Specifies the number of branches to display in the repository "summary"
304 view. Default value: "10". 310 view. Default value: "10".
305 311
306summary-log:: 312summary-log::
307 Specifies the number of log entries to display in the repository 313 Specifies the number of log entries to display in the repository
308 "summary" view. Default value: "10". 314 "summary" view. Default value: "10".
309 315
310summary-tags:: 316summary-tags::
311 Specifies the number of tags to display in the repository "summary" 317 Specifies the number of tags to display in the repository "summary"
312 view. Default value: "10". 318 view. Default value: "10".
313 319
314virtual-root:: 320virtual-root::
315 Url which, if specified, will be used as root for all cgit links. It 321 Url which, if specified, will be used as root for all cgit links. It
316 will also cause cgit to generate 'virtual urls', i.e. urls like 322 will also cause cgit to generate 'virtual urls', i.e. urls like
317 '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default 323 '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default
318 value: none. 324 value: none.
319 NOTE: cgit has recently learned how to use PATH_INFO to achieve the 325 NOTE: cgit has recently learned how to use PATH_INFO to achieve the
320 same kind of virtual urls, so this option will probably be deprecated. 326 same kind of virtual urls, so this option will probably be deprecated.
321 327
322REPOSITORY SETTINGS 328REPOSITORY SETTINGS
323------------------- 329-------------------
324repo.about-filter:: 330repo.about-filter::
325 Override the default about-filter. Default value: none. See also: 331 Override the default about-filter. Default value: none. See also:
326 "enable-filter-overrides". 332 "enable-filter-overrides".
327 333
328repo.clone-url:: 334repo.clone-url::
329 A list of space-separated urls which can be used to clone this repo. 335 A list of space-separated urls which can be used to clone this repo.
330 Default value: none. 336 Default value: none.
331 337
332repo.commit-filter:: 338repo.commit-filter::
333 Override the default commit-filter. Default value: none. See also: 339 Override the default commit-filter. Default value: none. See also:
334 "enable-filter-overrides". 340 "enable-filter-overrides".
335 341
336repo.defbranch:: 342repo.defbranch::
337 The name of the default branch for this repository. If no such branch 343 The name of the default branch for this repository. If no such branch
338 exists in the repository, the first branch name (when sorted) is used 344 exists in the repository, the first branch name (when sorted) is used
339 as default instead. Default value: "master". 345 as default instead. Default value: "master".
340 346
341repo.desc:: 347repo.desc::
342 The value to show as repository description. Default value: none. 348 The value to show as repository description. Default value: none.
343 349
344repo.enable-log-filecount:: 350repo.enable-log-filecount::
345 A flag which can be used to disable the global setting 351 A flag which can be used to disable the global setting
346 `enable-log-filecount'. Default value: none. 352 `enable-log-filecount'. Default value: none.
347 353
348repo.enable-log-linecount:: 354repo.enable-log-linecount::
349 A flag which can be used to disable the global setting 355 A flag which can be used to disable the global setting
350 `enable-log-linecount'. Default value: none. 356 `enable-log-linecount'. Default value: none.
351 357
352repo.enable-remote-branches:: 358repo.enable-remote-branches::
353 Flag which, when set to "1", will make cgit display remote branches 359 Flag which, when set to "1", will make cgit display remote branches
354 in the summary and refs views. Default value: <enable-remote-branches>. 360 in the summary and refs views. Default value: <enable-remote-branches>.
355 361
356repo.enable-subject-links:: 362repo.enable-subject-links::
357 A flag which can be used to override the global setting 363 A flag which can be used to override the global setting
358 `enable-subject-links'. Default value: none. 364 `enable-subject-links'. Default value: none.
359 365
360repo.max-stats:: 366repo.max-stats::
361 Override the default maximum statistics period. Valid values are equal 367 Override the default maximum statistics period. Valid values are equal
362 to the values specified for the global "max-stats" setting. Default 368 to the values specified for the global "max-stats" setting. Default
363 value: none. 369 value: none.
364 370
365repo.name:: 371repo.name::
366 The value to show as repository name. Default value: <repo.url>. 372 The value to show as repository name. Default value: <repo.url>.
367 373
368repo.owner:: 374repo.owner::
369 A value used to identify the owner of the repository. Default value: 375 A value used to identify the owner of the repository. Default value:
370 none. 376 none.
371 377
372repo.path:: 378repo.path::
373 An absolute path to the repository directory. For non-bare repositories 379 An absolute path to the repository directory. For non-bare repositories
374 this is the .git-directory. Default value: none. 380 this is the .git-directory. Default value: none.
375 381
376repo.readme:: 382repo.readme::
377 A path (relative to <repo.path>) which specifies a file to include 383 A path (relative to <repo.path>) which specifies a file to include
378 verbatim as the "About" page for this repo. You may also specify a 384 verbatim as the "About" page for this repo. You may also specify a
379 git refspec by head or by hash by prepending the refspec followed by 385 git refspec by head or by hash by prepending the refspec followed by
380 a colon. For example, "master:docs/readme.mkd" Default value: <readme>. 386 a colon. For example, "master:docs/readme.mkd" Default value: <readme>.