| -rw-r--r-- | cgitrc.5.txt | 187 |
1 files changed, 130 insertions, 57 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt index fd299ae..3c35b02 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt @@ -1,3 +1,3 @@ -CGITRC -====== +CGITRC(5) +======== @@ -6,7 +6,7 @@ NAME ---- - cgitrc - runtime configuration for cgit +cgitrc - runtime configuration for cgit -DESCRIPTION ------------ +SYNOPSIS +-------- Cgitrc contains all runtime settings for cgit, including the list of git @@ -16,5 +16,19 @@ lines, and lines starting with '#', are ignored. +LOCATION +-------- +The default location of cgitrc, defined at compile time, is /etc/cgitrc. At +runtime, cgit will consult the environment variable CGIT_CONFIG and, if +defined, use its value instead. + + GLOBAL SETTINGS --------------- -agefile +about-filter:: + Specifies a command which will be invoked to format the content of + about pages (both top-level and for each repository). The command will + get the content of the about-file on its STDIN, and the STDOUT from the + command will be included verbatim on the about page. Default value: + none. + +agefile:: Specifies a path, relative to each repository path, which can be used @@ -25,3 +39,3 @@ agefile -cache-root +cache-root:: Path used to store the cgit cache entries. Default value: @@ -29,3 +43,3 @@ cache-root -cache-dynamic-ttl +cache-dynamic-ttl:: Number which specifies the time-to-live, in minutes, for the cached @@ -34,3 +48,3 @@ cache-dynamic-ttl -cache-repo-ttl +cache-repo-ttl:: Number which specifies the time-to-live, in minutes, for the cached @@ -38,3 +52,3 @@ cache-repo-ttl -cache-root-ttl +cache-root-ttl:: Number which specifies the time-to-live, in minutes, for the cached @@ -42,3 +56,3 @@ cache-root-ttl -cache-size +cache-size:: The maximum number of entries in the cgit cache. Default value: "0" @@ -46,3 +60,3 @@ cache-size -cache-static-ttl +cache-static-ttl:: Number which specifies the time-to-live, in minutes, for the cached @@ -51,3 +65,3 @@ cache-static-ttl -clone-prefix +clone-prefix:: Space-separated list of common prefixes which, when combined with a @@ -57,3 +71,9 @@ clone-prefix -css +commit-filter:: + Specifies a command which will be invoked to format commit messages. + The command will get the message on its STDIN, and the STDOUT from the + command will be included verbatim as the commit message, i.e. this can + be used to implement bugtracker integration. Default value: none. + +css:: Url which specifies the css document to include in all cgit pages. @@ -61,3 +81,8 @@ css -enable-index-links +embedded:: + Flag which, when set to "1", will make cgit generate a html fragment + suitable for embedding in other html pages. Default value: none. See + also: "noheader". + +enable-index-links:: Flag which, when set to "1", will make cgit generate extra links for @@ -66,3 +91,3 @@ enable-index-links -enable-log-filecount +enable-log-filecount:: Flag which, when set to "1", will make cgit print the number of @@ -71,3 +96,3 @@ enable-log-filecount -enable-log-linecount +enable-log-linecount:: Flag which, when set to "1", will make cgit print the number of added @@ -76,3 +101,3 @@ enable-log-linecount -favicon +favicon:: Url used as link to a shortcut icon for cgit. If specified, it is @@ -81,3 +106,3 @@ favicon -footer +footer:: The content of the file specified with this option will be included @@ -86,3 +111,7 @@ footer -header +head-include:: + The content of the file specified with this option will be included + verbatim in the html HEAD section on all pages. Default value: none. + +header:: The content of the file specified with this option will be included @@ -90,3 +119,3 @@ header -include +include:: Name of a configfile to include before the rest of the current config- @@ -94,3 +123,3 @@ include -index-header +index-header:: The content of the file specified with this option will be included @@ -100,3 +129,3 @@ index-header -index-info +index-info:: The content of the file specified with this option will be included @@ -106,3 +135,3 @@ index-info -local-time +local-time:: Flag which, if set to "1", makes cgit print commit and tag times in the @@ -110,7 +139,7 @@ local-time -logo +logo:: Url which specifies the source of an image which will be used as a logo - on all cgit pages. + on all cgit pages. Default value: "/cgit.png". -logo-link +logo-link:: Url loaded when clicking on the cgit logo image. If unspecified the @@ -119,3 +148,3 @@ logo-link -max-commit-count +max-commit-count:: Specifies the number of entries to list per page in "log" view. Default @@ -123,3 +152,3 @@ max-commit-count -max-message-length +max-message-length:: Specifies the maximum number of commit message characters to display in @@ -127,3 +156,3 @@ max-message-length -max-repo-count +max-repo-count:: Specifies the number of entries to list per page on the repository @@ -131,3 +160,3 @@ max-repo-count -max-repodesc-length +max-repodesc-length:: Specifies the maximum number of repo description characters to display @@ -135,3 +164,3 @@ max-repodesc-length -max-stats +max-stats:: Set the default maximum statistics period. Valid values are "week", @@ -140,3 +169,7 @@ max-stats -module-link +mimetype.<ext>:: + Set the mimetype for the specified filename extension. This is used + by the `plain` command when returning blob content. + +module-link:: Text which will be used as the formatstring for a hyperlink when a @@ -146,3 +179,3 @@ module-link -nocache +nocache:: If set to the value "1" caching will be disabled. This settings is @@ -151,3 +184,11 @@ nocache -renamelimit +noplainemail:: + If set to "1" showing full author email adresses will be disabled. + Default value: "0". + +noheader:: + Flag which, when set to "1", will make cgit omit the standard header + on all pages. Default value: none. See also: "embedded". + +renamelimit:: Maximum number of files to consider when detecting renames. The value @@ -156,3 +197,3 @@ renamelimit -repo.group +repo.group:: A value for the current repository group, which all repositories @@ -160,3 +201,3 @@ repo.group -robots +robots:: Text used as content for the "robots" meta-tag. Default value: @@ -164,3 +205,3 @@ robots -root-desc +root-desc:: Text printed below the heading on the repository index page. Default @@ -168,3 +209,3 @@ root-desc -root-readme: +root-readme:: The content of the file specified with this option will be included @@ -173,3 +214,3 @@ root-readme: -root-title +root-title:: Text printed as heading on the repository index page. Default value: @@ -177,3 +218,3 @@ root-title -snapshots +snapshots:: Text which specifies the default (and allowed) set of snapshot formats @@ -187,3 +228,11 @@ snapshots -summary-branches +source-filter:: + Specifies a command which will be invoked to format plaintext blobs + in the tree view. The command will get the blob content on its STDIN + and the name of the blob as its only command line argument. The STDOUT + from the command will be included verbatim as the blob contents, i.e. + this can be used to implement e.g. syntax highlighting. Default value: + none. + +summary-branches:: Specifies the number of branches to display in the repository "summary" @@ -191,3 +240,3 @@ summary-branches -summary-log +summary-log:: Specifies the number of log entries to display in the repository @@ -195,3 +244,3 @@ summary-log -summary-tags +summary-tags:: Specifies the number of tags to display in the repository "summary" @@ -199,3 +248,3 @@ summary-tags -virtual-root +virtual-root:: Url which, if specified, will be used as root for all cgit links. It @@ -209,3 +258,6 @@ REPOSITORY SETTINGS ------------------- -repo.clone-url +repo.about-filter:: + Override the default about-filter. Default value: <about-filter>. + +repo.clone-url:: A list of space-separated urls which can be used to clone this repo. @@ -213,3 +265,6 @@ repo.clone-url -repo.defbranch +repo.commit-filter:: + Override the default commit-filter. Default value: <commit-filter>. + +repo.defbranch:: The name of the default branch for this repository. If no such branch @@ -218,6 +273,6 @@ repo.defbranch -repo.desc +repo.desc:: The value to show as repository description. Default value: none. -repo.enable-log-filecount +repo.enable-log-filecount:: A flag which can be used to disable the global setting @@ -225,3 +280,3 @@ repo.enable-log-filecount -repo.enable-log-linecount +repo.enable-log-linecount:: A flag which can be used to disable the global setting @@ -229,3 +284,3 @@ repo.enable-log-linecount -repo.max-stats +repo.max-stats:: Override the default maximum statistics period. Valid values are equal @@ -234,6 +289,6 @@ repo.max-stats -repo.name +repo.name:: The value to show as repository name. Default value: <repo.url>. -repo.owner +repo.owner:: A value used to identify the owner of the repository. Default value: @@ -241,3 +296,3 @@ repo.owner -repo.path +repo.path:: An absolute path to the repository directory. For non-bare repositories @@ -245,3 +300,3 @@ repo.path -repo.readme +repo.readme:: A path (relative to <repo.path>) which specifies a file to include @@ -249,3 +304,3 @@ repo.readme -repo.snapshots +repo.snapshots:: A mask of allowed snapshot-formats for this repo, restricted by the @@ -253,3 +308,6 @@ repo.snapshots -repo.url +repo.source-filter:: + Override the default source-filter. Default value: <source-filter>. + +repo.url:: The relative url used to access the repository. This must be the first @@ -261,2 +319,3 @@ EXAMPLE CGITRC FILE +.... # Enable caching of up to 1000 output entriess @@ -313,2 +372,15 @@ snapshots=tar.gz tar.bz2 zip ## +## List of common mimetypes +## + +mimetype.git=image/git +mimetype.html=text/html +mimetype.jpg=image/jpeg +mimetype.jpeg=image/jpeg +mimetype.pdf=application/pdf +mimetype.png=image/png +mimetype.svg=image/svg+xml + + +## ## List of repositories. @@ -370,2 +442,3 @@ repo.enable-log-linecount=0 repo.max-stats=month +.... |