-rw-r--r-- | cgitrc.5.txt | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt index ab9ab66..09f56a6 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt | |||
@@ -108,48 +108,53 @@ logo | |||
108 | Url which specifies the source of an image which will be used as a logo | 108 | Url which specifies the source of an image which will be used as a logo |
109 | on all cgit pages. | 109 | on all cgit pages. |
110 | 110 | ||
111 | logo-link | 111 | logo-link |
112 | Url loaded when clicking on the cgit logo image. If unspecified the | 112 | Url loaded when clicking on the cgit logo image. If unspecified the |
113 | calculated url of the repository index page will be used. Default | 113 | calculated url of the repository index page will be used. Default |
114 | value: none. | 114 | value: none. |
115 | 115 | ||
116 | max-commit-count | 116 | max-commit-count |
117 | Specifies the number of entries to list per page in "log" view. Default | 117 | Specifies the number of entries to list per page in "log" view. Default |
118 | value: "50". | 118 | value: "50". |
119 | 119 | ||
120 | max-message-length | 120 | max-message-length |
121 | Specifies the maximum number of commit message characters to display in | 121 | Specifies the maximum number of commit message characters to display in |
122 | "log" view. Default value: "80". | 122 | "log" view. Default value: "80". |
123 | 123 | ||
124 | max-repo-count | 124 | max-repo-count |
125 | Specifies the number of entries to list per page on therepository | 125 | Specifies the number of entries to list per page on therepository |
126 | index page. Default value: "50". | 126 | index page. Default value: "50". |
127 | 127 | ||
128 | max-repodesc-length | 128 | max-repodesc-length |
129 | Specifies the maximum number of repo description characters to display | 129 | Specifies the maximum number of repo description characters to display |
130 | on the repository index page. Default value: "80". | 130 | on the repository index page. Default value: "80". |
131 | 131 | ||
132 | max-stats | ||
133 | Set the default maximum statistics period. Valid values are "week", | ||
134 | "month", "quarter" and "year". If unspecified, statistics are | ||
135 | disabled. Default value: none. See also: "repo.max-stats". | ||
136 | |||
132 | module-link | 137 | module-link |
133 | Text which will be used as the formatstring for a hyperlink when a | 138 | Text which will be used as the formatstring for a hyperlink when a |
134 | submodule is printed in a directory listing. The arguments for the | 139 | submodule is printed in a directory listing. The arguments for the |
135 | formatstring are the path and SHA1 of the submodule commit. Default | 140 | formatstring are the path and SHA1 of the submodule commit. Default |
136 | value: "./?repo=%s&page=commit&id=%s" | 141 | value: "./?repo=%s&page=commit&id=%s" |
137 | 142 | ||
138 | nocache | 143 | nocache |
139 | If set to the value "1" caching will be disabled. This settings is | 144 | If set to the value "1" caching will be disabled. This settings is |
140 | deprecated, and will not be honored starting with cgit-1.0. Default | 145 | deprecated, and will not be honored starting with cgit-1.0. Default |
141 | value: "0". | 146 | value: "0". |
142 | 147 | ||
143 | renamelimit | 148 | renamelimit |
144 | Maximum number of files to consider when detecting renames. The value | 149 | Maximum number of files to consider when detecting renames. The value |
145 | "-1" uses the compiletime value in git (for further info, look at | 150 | "-1" uses the compiletime value in git (for further info, look at |
146 | `man git-diff`). Default value: "-1". | 151 | `man git-diff`). Default value: "-1". |
147 | 152 | ||
148 | repo.group | 153 | repo.group |
149 | A value for the current repository group, which all repositories | 154 | A value for the current repository group, which all repositories |
150 | specified after this setting will inherit. Default value: none. | 155 | specified after this setting will inherit. Default value: none. |
151 | 156 | ||
152 | robots | 157 | robots |
153 | Text used as content for the "robots" meta-tag. Default value: | 158 | Text used as content for the "robots" meta-tag. Default value: |
154 | "index, nofollow". | 159 | "index, nofollow". |
155 | 160 | ||
@@ -197,48 +202,53 @@ virtual-root | |||
197 | same kind of virtual urls, so this option will probably be deprecated. | 202 | same kind of virtual urls, so this option will probably be deprecated. |
198 | 203 | ||
199 | REPOSITORY SETTINGS | 204 | REPOSITORY SETTINGS |
200 | ------------------- | 205 | ------------------- |
201 | repo.clone-url | 206 | repo.clone-url |
202 | A list of space-separated urls which can be used to clone this repo. | 207 | A list of space-separated urls which can be used to clone this repo. |
203 | Default value: none. | 208 | Default value: none. |
204 | 209 | ||
205 | repo.defbranch | 210 | repo.defbranch |
206 | The name of the default branch for this repository. If no such branch | 211 | The name of the default branch for this repository. If no such branch |
207 | exists in the repository, the first branch name (when sorted) is used | 212 | exists in the repository, the first branch name (when sorted) is used |
208 | as default instead. Default value: "master". | 213 | as default instead. Default value: "master". |
209 | 214 | ||
210 | repo.desc | 215 | repo.desc |
211 | The value to show as repository description. Default value: none. | 216 | The value to show as repository description. Default value: none. |
212 | 217 | ||
213 | repo.enable-log-filecount | 218 | repo.enable-log-filecount |
214 | A flag which can be used to disable the global setting | 219 | A flag which can be used to disable the global setting |
215 | `enable-log-filecount'. Default value: none. | 220 | `enable-log-filecount'. Default value: none. |
216 | 221 | ||
217 | repo.enable-log-linecount | 222 | repo.enable-log-linecount |
218 | A flag which can be used to disable the global setting | 223 | A flag which can be used to disable the global setting |
219 | `enable-log-linecount'. Default value: none. | 224 | `enable-log-linecount'. Default value: none. |
220 | 225 | ||
226 | repo.max-stats | ||
227 | Override the default maximum statistics period. Valid values are equal | ||
228 | to the values specified for the global "max-stats" setting. Default | ||
229 | value: none. | ||
230 | |||
221 | repo.name | 231 | repo.name |
222 | The value to show as repository name. Default value: <repo.url>. | 232 | The value to show as repository name. Default value: <repo.url>. |
223 | 233 | ||
224 | repo.owner | 234 | repo.owner |
225 | A value used to identify the owner of the repository. Default value: | 235 | A value used to identify the owner of the repository. Default value: |
226 | none. | 236 | none. |
227 | 237 | ||
228 | repo.path | 238 | repo.path |
229 | An absolute path to the repository directory. For non-bare repositories | 239 | An absolute path to the repository directory. For non-bare repositories |
230 | this is the .git-directory. Default value: none. | 240 | this is the .git-directory. Default value: none. |
231 | 241 | ||
232 | repo.readme | 242 | repo.readme |
233 | A path (relative to <repo.path>) which specifies a file to include | 243 | A path (relative to <repo.path>) which specifies a file to include |
234 | verbatim as the "About" page for this repo. Default value: none. | 244 | verbatim as the "About" page for this repo. Default value: none. |
235 | 245 | ||
236 | repo.snapshots | 246 | repo.snapshots |
237 | A mask of allowed snapshot-formats for this repo, restricted by the | 247 | A mask of allowed snapshot-formats for this repo, restricted by the |
238 | "snapshots" global setting. Default value: <snapshots>. | 248 | "snapshots" global setting. Default value: <snapshots>. |
239 | 249 | ||
240 | repo.url | 250 | repo.url |
241 | The relative url used to access the repository. This must be the first | 251 | The relative url used to access the repository. This must be the first |
242 | setting specified for each repo. Default value: none. | 252 | setting specified for each repo. Default value: none. |
243 | 253 | ||
244 | 254 | ||
@@ -255,48 +265,52 @@ clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git | |||
255 | # Specify the css url | 265 | # Specify the css url |
256 | css=/css/cgit.css | 266 | css=/css/cgit.css |
257 | 267 | ||
258 | 268 | ||
259 | # Show extra links for each repository on the index page | 269 | # Show extra links for each repository on the index page |
260 | enable-index-links=1 | 270 | enable-index-links=1 |
261 | 271 | ||
262 | 272 | ||
263 | # Show number of affected files per commit on the log pages | 273 | # Show number of affected files per commit on the log pages |
264 | enable-log-filecount=1 | 274 | enable-log-filecount=1 |
265 | 275 | ||
266 | 276 | ||
267 | # Show number of added/removed lines per commit on the log pages | 277 | # Show number of added/removed lines per commit on the log pages |
268 | enable-log-linecount=1 | 278 | enable-log-linecount=1 |
269 | 279 | ||
270 | 280 | ||
271 | # Add a cgit favicon | 281 | # Add a cgit favicon |
272 | favicon=/favicon.ico | 282 | favicon=/favicon.ico |
273 | 283 | ||
274 | 284 | ||
275 | # Use a custom logo | 285 | # Use a custom logo |
276 | logo=/img/mylogo.png | 286 | logo=/img/mylogo.png |
277 | 287 | ||
278 | 288 | ||
289 | # Enable statistics per week, month and quarter | ||
290 | max-stats=quarter | ||
291 | |||
292 | |||
279 | # Set the title and heading of the repository index page | 293 | # Set the title and heading of the repository index page |
280 | root-title=foobar.com git repositories | 294 | root-title=foobar.com git repositories |
281 | 295 | ||
282 | 296 | ||
283 | # Set a subheading for the repository index page | 297 | # Set a subheading for the repository index page |
284 | root-desc=tracking the foobar development | 298 | root-desc=tracking the foobar development |
285 | 299 | ||
286 | 300 | ||
287 | # Include some more info about foobar.com on the index page | 301 | # Include some more info about foobar.com on the index page |
288 | root-readme=/var/www/htdocs/about.html | 302 | root-readme=/var/www/htdocs/about.html |
289 | 303 | ||
290 | 304 | ||
291 | # Allow download of tar.gz, tar.bz2 and zip-files | 305 | # Allow download of tar.gz, tar.bz2 and zip-files |
292 | snapshots=tar.gz tar.bz2 zip | 306 | snapshots=tar.gz tar.bz2 zip |
293 | 307 | ||
294 | 308 | ||
295 | ## | 309 | ## |
296 | ## List of repositories. | 310 | ## List of repositories. |
297 | ## PS: Any repositories listed when repo.group is unset will not be | 311 | ## PS: Any repositories listed when repo.group is unset will not be |
298 | ## displayed under a group heading | 312 | ## displayed under a group heading |
299 | ## PPS: This list could be kept in a different file (e.g. '/etc/cgitrepos') | 313 | ## PPS: This list could be kept in a different file (e.g. '/etc/cgitrepos') |
300 | ## and included like this: | 314 | ## and included like this: |
301 | ## include=/etc/cgitrepos | 315 | ## include=/etc/cgitrepos |
302 | ## | 316 | ## |
@@ -327,41 +341,44 @@ repo.desc=a set of extensions for bar users | |||
327 | repo.url=wiz | 341 | repo.url=wiz |
328 | repo.path=/pub/git/wiz.git | 342 | repo.path=/pub/git/wiz.git |
329 | repo.desc=the wizard of foo | 343 | repo.desc=the wizard of foo |
330 | 344 | ||
331 | 345 | ||
332 | # Add some mirrored repositories | 346 | # Add some mirrored repositories |
333 | repo.group=mirrors | 347 | repo.group=mirrors |
334 | 348 | ||
335 | 349 | ||
336 | repo.url=git | 350 | repo.url=git |
337 | repo.path=/pub/git/git.git | 351 | repo.path=/pub/git/git.git |
338 | repo.desc=the dscm | 352 | repo.desc=the dscm |
339 | 353 | ||
340 | 354 | ||
341 | repo.url=linux | 355 | repo.url=linux |
342 | repo.path=/pub/git/linux.git | 356 | repo.path=/pub/git/linux.git |
343 | repo.desc=the kernel | 357 | repo.desc=the kernel |
344 | 358 | ||
345 | # Disable adhoc downloads of this repo | 359 | # Disable adhoc downloads of this repo |
346 | repo.snapshots=0 | 360 | repo.snapshots=0 |
347 | 361 | ||
348 | # Disable line-counts for this repo | 362 | # Disable line-counts for this repo |
349 | repo.enable-log-linecount=0 | 363 | repo.enable-log-linecount=0 |
350 | 364 | ||
365 | # Restrict the max statistics period for this repo | ||
366 | repo.max-stats=month | ||
367 | |||
351 | 368 | ||
352 | BUGS | 369 | BUGS |
353 | ---- | 370 | ---- |
354 | Comments currently cannot appear on the same line as a setting; the comment | 371 | Comments currently cannot appear on the same line as a setting; the comment |
355 | will be included as part of the value. E.g. this line: | 372 | will be included as part of the value. E.g. this line: |
356 | 373 | ||
357 | robots=index # allow indexing | 374 | robots=index # allow indexing |
358 | 375 | ||
359 | will generate the following html element: | 376 | will generate the following html element: |
360 | 377 | ||
361 | <meta name='robots' content='index # allow indexing'/> | 378 | <meta name='robots' content='index # allow indexing'/> |
362 | 379 | ||
363 | 380 | ||
364 | 381 | ||
365 | AUTHOR | 382 | AUTHOR |
366 | ------ | 383 | ------ |
367 | Lars Hjemli <hjemli@gmail.com> | 384 | Lars Hjemli <hjemli@gmail.com> |