-rw-r--r-- | cgitrc.5.txt | 185 |
1 files changed, 129 insertions, 56 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 @@ | |||
1 | CGITRC | 1 | CGITRC(5) |
2 | ====== | 2 | ======== |
3 | 3 | ||
@@ -9,4 +9,4 @@ NAME | |||
9 | 9 | ||
10 | DESCRIPTION | 10 | SYNOPSIS |
11 | ----------- | 11 | -------- |
12 | Cgitrc contains all runtime settings for cgit, including the list of git | 12 | Cgitrc contains all runtime settings for cgit, including the list of git |
@@ -16,5 +16,19 @@ lines, and lines starting with '#', are ignored. | |||
16 | 16 | ||
17 | LOCATION | ||
18 | -------- | ||
19 | The default location of cgitrc, defined at compile time, is /etc/cgitrc. At | ||
20 | runtime, cgit will consult the environment variable CGIT_CONFIG and, if | ||
21 | defined, use its value instead. | ||
22 | |||
23 | |||
17 | GLOBAL SETTINGS | 24 | GLOBAL SETTINGS |
18 | --------------- | 25 | --------------- |
19 | agefile | 26 | about-filter:: |
27 | Specifies a command which will be invoked to format the content of | ||
28 | about pages (both top-level and for each repository). The command will | ||
29 | get the content of the about-file on its STDIN, and the STDOUT from the | ||
30 | command will be included verbatim on the about page. Default value: | ||
31 | none. | ||
32 | |||
33 | agefile:: | ||
20 | Specifies a path, relative to each repository path, which can be used | 34 | Specifies a path, relative to each repository path, which can be used |
@@ -25,3 +39,3 @@ agefile | |||
25 | 39 | ||
26 | cache-root | 40 | cache-root:: |
27 | Path used to store the cgit cache entries. Default value: | 41 | Path used to store the cgit cache entries. Default value: |
@@ -29,3 +43,3 @@ cache-root | |||
29 | 43 | ||
30 | cache-dynamic-ttl | 44 | cache-dynamic-ttl:: |
31 | Number which specifies the time-to-live, in minutes, for the cached | 45 | Number which specifies the time-to-live, in minutes, for the cached |
@@ -34,3 +48,3 @@ cache-dynamic-ttl | |||
34 | 48 | ||
35 | cache-repo-ttl | 49 | cache-repo-ttl:: |
36 | Number which specifies the time-to-live, in minutes, for the cached | 50 | Number which specifies the time-to-live, in minutes, for the cached |
@@ -38,3 +52,3 @@ cache-repo-ttl | |||
38 | 52 | ||
39 | cache-root-ttl | 53 | cache-root-ttl:: |
40 | Number which specifies the time-to-live, in minutes, for the cached | 54 | Number which specifies the time-to-live, in minutes, for the cached |
@@ -42,3 +56,3 @@ cache-root-ttl | |||
42 | 56 | ||
43 | cache-size | 57 | cache-size:: |
44 | The maximum number of entries in the cgit cache. Default value: "0" | 58 | The maximum number of entries in the cgit cache. Default value: "0" |
@@ -46,3 +60,3 @@ cache-size | |||
46 | 60 | ||
47 | cache-static-ttl | 61 | cache-static-ttl:: |
48 | Number which specifies the time-to-live, in minutes, for the cached | 62 | Number which specifies the time-to-live, in minutes, for the cached |
@@ -51,3 +65,3 @@ cache-static-ttl | |||
51 | 65 | ||
52 | clone-prefix | 66 | clone-prefix:: |
53 | Space-separated list of common prefixes which, when combined with a | 67 | Space-separated list of common prefixes which, when combined with a |
@@ -57,3 +71,9 @@ clone-prefix | |||
57 | 71 | ||
58 | css | 72 | commit-filter:: |
73 | Specifies a command which will be invoked to format commit messages. | ||
74 | The command will get the message on its STDIN, and the STDOUT from the | ||
75 | command will be included verbatim as the commit message, i.e. this can | ||
76 | be used to implement bugtracker integration. Default value: none. | ||
77 | |||
78 | css:: | ||
59 | Url which specifies the css document to include in all cgit pages. | 79 | Url which specifies the css document to include in all cgit pages. |
@@ -61,3 +81,8 @@ css | |||
61 | 81 | ||
62 | enable-index-links | 82 | embedded:: |
83 | Flag which, when set to "1", will make cgit generate a html fragment | ||
84 | suitable for embedding in other html pages. Default value: none. See | ||
85 | also: "noheader". | ||
86 | |||
87 | enable-index-links:: | ||
63 | Flag which, when set to "1", will make cgit generate extra links for | 88 | Flag which, when set to "1", will make cgit generate extra links for |
@@ -66,3 +91,3 @@ enable-index-links | |||
66 | 91 | ||
67 | enable-log-filecount | 92 | enable-log-filecount:: |
68 | Flag which, when set to "1", will make cgit print the number of | 93 | Flag which, when set to "1", will make cgit print the number of |
@@ -71,3 +96,3 @@ enable-log-filecount | |||
71 | 96 | ||
72 | enable-log-linecount | 97 | enable-log-linecount:: |
73 | Flag which, when set to "1", will make cgit print the number of added | 98 | Flag which, when set to "1", will make cgit print the number of added |
@@ -76,3 +101,3 @@ enable-log-linecount | |||
76 | 101 | ||
77 | favicon | 102 | favicon:: |
78 | Url used as link to a shortcut icon for cgit. If specified, it is | 103 | Url used as link to a shortcut icon for cgit. If specified, it is |
@@ -81,3 +106,3 @@ favicon | |||
81 | 106 | ||
82 | footer | 107 | footer:: |
83 | The content of the file specified with this option will be included | 108 | The content of the file specified with this option will be included |
@@ -86,3 +111,7 @@ footer | |||
86 | 111 | ||
87 | header | 112 | head-include:: |
113 | The content of the file specified with this option will be included | ||
114 | verbatim in the html HEAD section on all pages. Default value: none. | ||
115 | |||
116 | header:: | ||
88 | The content of the file specified with this option will be included | 117 | The content of the file specified with this option will be included |
@@ -90,3 +119,3 @@ header | |||
90 | 119 | ||
91 | include | 120 | include:: |
92 | Name of a configfile to include before the rest of the current config- | 121 | Name of a configfile to include before the rest of the current config- |
@@ -94,3 +123,3 @@ include | |||
94 | 123 | ||
95 | index-header | 124 | index-header:: |
96 | The content of the file specified with this option will be included | 125 | The content of the file specified with this option will be included |
@@ -100,3 +129,3 @@ index-header | |||
100 | 129 | ||
101 | index-info | 130 | index-info:: |
102 | The content of the file specified with this option will be included | 131 | The content of the file specified with this option will be included |
@@ -106,3 +135,3 @@ index-info | |||
106 | 135 | ||
107 | local-time | 136 | local-time:: |
108 | Flag which, if set to "1", makes cgit print commit and tag times in the | 137 | Flag which, if set to "1", makes cgit print commit and tag times in the |
@@ -110,7 +139,7 @@ local-time | |||
110 | 139 | ||
111 | logo | 140 | logo:: |
112 | Url which specifies the source of an image which will be used as a logo | 141 | Url which specifies the source of an image which will be used as a logo |
113 | on all cgit pages. | 142 | on all cgit pages. Default value: "/cgit.png". |
114 | 143 | ||
115 | logo-link | 144 | logo-link:: |
116 | Url loaded when clicking on the cgit logo image. If unspecified the | 145 | Url loaded when clicking on the cgit logo image. If unspecified the |
@@ -119,3 +148,3 @@ logo-link | |||
119 | 148 | ||
120 | max-commit-count | 149 | max-commit-count:: |
121 | Specifies the number of entries to list per page in "log" view. Default | 150 | Specifies the number of entries to list per page in "log" view. Default |
@@ -123,3 +152,3 @@ max-commit-count | |||
123 | 152 | ||
124 | max-message-length | 153 | max-message-length:: |
125 | Specifies the maximum number of commit message characters to display in | 154 | Specifies the maximum number of commit message characters to display in |
@@ -127,3 +156,3 @@ max-message-length | |||
127 | 156 | ||
128 | max-repo-count | 157 | max-repo-count:: |
129 | Specifies the number of entries to list per page on therepository | 158 | Specifies the number of entries to list per page on therepository |
@@ -131,3 +160,3 @@ max-repo-count | |||
131 | 160 | ||
132 | max-repodesc-length | 161 | max-repodesc-length:: |
133 | Specifies the maximum number of repo description characters to display | 162 | Specifies the maximum number of repo description characters to display |
@@ -135,3 +164,3 @@ max-repodesc-length | |||
135 | 164 | ||
136 | max-stats | 165 | max-stats:: |
137 | Set the default maximum statistics period. Valid values are "week", | 166 | Set the default maximum statistics period. Valid values are "week", |
@@ -140,3 +169,7 @@ max-stats | |||
140 | 169 | ||
141 | module-link | 170 | mimetype.<ext>:: |
171 | Set the mimetype for the specified filename extension. This is used | ||
172 | by the `plain` command when returning blob content. | ||
173 | |||
174 | module-link:: | ||
142 | Text which will be used as the formatstring for a hyperlink when a | 175 | Text which will be used as the formatstring for a hyperlink when a |
@@ -146,3 +179,3 @@ module-link | |||
146 | 179 | ||
147 | nocache | 180 | nocache:: |
148 | If set to the value "1" caching will be disabled. This settings is | 181 | If set to the value "1" caching will be disabled. This settings is |
@@ -151,3 +184,11 @@ nocache | |||
151 | 184 | ||
152 | renamelimit | 185 | noplainemail:: |
186 | If set to "1" showing full author email adresses will be disabled. | ||
187 | Default value: "0". | ||
188 | |||
189 | noheader:: | ||
190 | Flag which, when set to "1", will make cgit omit the standard header | ||
191 | on all pages. Default value: none. See also: "embedded". | ||
192 | |||
193 | renamelimit:: | ||
153 | Maximum number of files to consider when detecting renames. The value | 194 | Maximum number of files to consider when detecting renames. The value |
@@ -156,3 +197,3 @@ renamelimit | |||
156 | 197 | ||
157 | repo.group | 198 | repo.group:: |
158 | A value for the current repository group, which all repositories | 199 | A value for the current repository group, which all repositories |
@@ -160,3 +201,3 @@ repo.group | |||
160 | 201 | ||
161 | robots | 202 | robots:: |
162 | Text used as content for the "robots" meta-tag. Default value: | 203 | Text used as content for the "robots" meta-tag. Default value: |
@@ -164,3 +205,3 @@ robots | |||
164 | 205 | ||
165 | root-desc | 206 | root-desc:: |
166 | Text printed below the heading on the repository index page. Default | 207 | Text printed below the heading on the repository index page. Default |
@@ -168,3 +209,3 @@ root-desc | |||
168 | 209 | ||
169 | root-readme: | 210 | root-readme:: |
170 | The content of the file specified with this option will be included | 211 | The content of the file specified with this option will be included |
@@ -173,3 +214,3 @@ root-readme: | |||
173 | 214 | ||
174 | root-title | 215 | root-title:: |
175 | Text printed as heading on the repository index page. Default value: | 216 | Text printed as heading on the repository index page. Default value: |
@@ -177,3 +218,3 @@ root-title | |||
177 | 218 | ||
178 | snapshots | 219 | snapshots:: |
179 | Text which specifies the default (and allowed) set of snapshot formats | 220 | Text which specifies the default (and allowed) set of snapshot formats |
@@ -187,3 +228,11 @@ snapshots | |||
187 | 228 | ||
188 | summary-branches | 229 | source-filter:: |
230 | Specifies a command which will be invoked to format plaintext blobs | ||
231 | in the tree view. The command will get the blob content on its STDIN | ||
232 | and the name of the blob as its only command line argument. The STDOUT | ||
233 | from the command will be included verbatim as the blob contents, i.e. | ||
234 | this can be used to implement e.g. syntax highlighting. Default value: | ||
235 | none. | ||
236 | |||
237 | summary-branches:: | ||
189 | Specifies the number of branches to display in the repository "summary" | 238 | Specifies the number of branches to display in the repository "summary" |
@@ -191,3 +240,3 @@ summary-branches | |||
191 | 240 | ||
192 | summary-log | 241 | summary-log:: |
193 | Specifies the number of log entries to display in the repository | 242 | Specifies the number of log entries to display in the repository |
@@ -195,3 +244,3 @@ summary-log | |||
195 | 244 | ||
196 | summary-tags | 245 | summary-tags:: |
197 | Specifies the number of tags to display in the repository "summary" | 246 | Specifies the number of tags to display in the repository "summary" |
@@ -199,3 +248,3 @@ summary-tags | |||
199 | 248 | ||
200 | virtual-root | 249 | virtual-root:: |
201 | Url which, if specified, will be used as root for all cgit links. It | 250 | Url which, if specified, will be used as root for all cgit links. It |
@@ -209,3 +258,6 @@ REPOSITORY SETTINGS | |||
209 | ------------------- | 258 | ------------------- |
210 | repo.clone-url | 259 | repo.about-filter:: |
260 | Override the default about-filter. Default value: <about-filter>. | ||
261 | |||
262 | repo.clone-url:: | ||
211 | A list of space-separated urls which can be used to clone this repo. | 263 | A list of space-separated urls which can be used to clone this repo. |
@@ -213,3 +265,6 @@ repo.clone-url | |||
213 | 265 | ||
214 | repo.defbranch | 266 | repo.commit-filter:: |
267 | Override the default commit-filter. Default value: <commit-filter>. | ||
268 | |||
269 | repo.defbranch:: | ||
215 | The name of the default branch for this repository. If no such branch | 270 | The name of the default branch for this repository. If no such branch |
@@ -218,6 +273,6 @@ repo.defbranch | |||
218 | 273 | ||
219 | repo.desc | 274 | repo.desc:: |
220 | The value to show as repository description. Default value: none. | 275 | The value to show as repository description. Default value: none. |
221 | 276 | ||
222 | repo.enable-log-filecount | 277 | repo.enable-log-filecount:: |
223 | A flag which can be used to disable the global setting | 278 | A flag which can be used to disable the global setting |
@@ -225,3 +280,3 @@ repo.enable-log-filecount | |||
225 | 280 | ||
226 | repo.enable-log-linecount | 281 | repo.enable-log-linecount:: |
227 | A flag which can be used to disable the global setting | 282 | A flag which can be used to disable the global setting |
@@ -229,3 +284,3 @@ repo.enable-log-linecount | |||
229 | 284 | ||
230 | repo.max-stats | 285 | repo.max-stats:: |
231 | Override the default maximum statistics period. Valid values are equal | 286 | Override the default maximum statistics period. Valid values are equal |
@@ -234,6 +289,6 @@ repo.max-stats | |||
234 | 289 | ||
235 | repo.name | 290 | repo.name:: |
236 | The value to show as repository name. Default value: <repo.url>. | 291 | The value to show as repository name. Default value: <repo.url>. |
237 | 292 | ||
238 | repo.owner | 293 | repo.owner:: |
239 | A value used to identify the owner of the repository. Default value: | 294 | A value used to identify the owner of the repository. Default value: |
@@ -241,3 +296,3 @@ repo.owner | |||
241 | 296 | ||
242 | repo.path | 297 | repo.path:: |
243 | An absolute path to the repository directory. For non-bare repositories | 298 | An absolute path to the repository directory. For non-bare repositories |
@@ -245,3 +300,3 @@ repo.path | |||
245 | 300 | ||
246 | repo.readme | 301 | repo.readme:: |
247 | A path (relative to <repo.path>) which specifies a file to include | 302 | A path (relative to <repo.path>) which specifies a file to include |
@@ -249,3 +304,3 @@ repo.readme | |||
249 | 304 | ||
250 | repo.snapshots | 305 | repo.snapshots:: |
251 | A mask of allowed snapshot-formats for this repo, restricted by the | 306 | A mask of allowed snapshot-formats for this repo, restricted by the |
@@ -253,3 +308,6 @@ repo.snapshots | |||
253 | 308 | ||
254 | repo.url | 309 | repo.source-filter:: |
310 | Override the default source-filter. Default value: <source-filter>. | ||
311 | |||
312 | repo.url:: | ||
255 | The relative url used to access the repository. This must be the first | 313 | The relative url used to access the repository. This must be the first |
@@ -261,2 +319,3 @@ EXAMPLE CGITRC FILE | |||
261 | 319 | ||
320 | .... | ||
262 | # Enable caching of up to 1000 output entriess | 321 | # Enable caching of up to 1000 output entriess |
@@ -313,2 +372,15 @@ snapshots=tar.gz tar.bz2 zip | |||
313 | ## | 372 | ## |
373 | ## List of common mimetypes | ||
374 | ## | ||
375 | |||
376 | mimetype.git=image/git | ||
377 | mimetype.html=text/html | ||
378 | mimetype.jpg=image/jpeg | ||
379 | mimetype.jpeg=image/jpeg | ||
380 | mimetype.pdf=application/pdf | ||
381 | mimetype.png=image/png | ||
382 | mimetype.svg=image/svg+xml | ||
383 | |||
384 | |||
385 | ## | ||
314 | ## List of repositories. | 386 | ## List of repositories. |
@@ -370,2 +442,3 @@ repo.enable-log-linecount=0 | |||
370 | repo.max-stats=month | 442 | repo.max-stats=month |
443 | .... | ||
371 | 444 | ||