-rw-r--r-- | cgitrc.5.txt | 8 |
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 | |||
@@ -181,192 +181,200 @@ logo-link:: | |||
181 | Url loaded when clicking on the cgit logo image. If unspecified the | 181 | Url loaded when clicking on the cgit logo image. If unspecified the |
182 | calculated url of the repository index page will be used. Default | 182 | calculated url of the repository index page will be used. Default |
183 | value: none. | 183 | value: none. |
184 | 184 | ||
185 | max-atom-items:: | 185 | max-atom-items:: |
186 | Specifies the number of items to display in atom feeds view. Default | 186 | Specifies the number of items to display in atom feeds view. Default |
187 | value: "10". | 187 | value: "10". |
188 | 188 | ||
189 | max-commit-count:: | 189 | max-commit-count:: |
190 | Specifies the number of entries to list per page in "log" view. Default | 190 | Specifies the number of entries to list per page in "log" view. Default |
191 | value: "50". | 191 | value: "50". |
192 | 192 | ||
193 | max-message-length:: | 193 | max-message-length:: |
194 | Specifies the maximum number of commit message characters to display in | 194 | Specifies the maximum number of commit message characters to display in |
195 | "log" view. Default value: "80". | 195 | "log" view. Default value: "80". |
196 | 196 | ||
197 | max-repo-count:: | 197 | max-repo-count:: |
198 | Specifies the number of entries to list per page on therepository | 198 | Specifies the number of entries to list per page on therepository |
199 | index page. Default value: "50". | 199 | index page. Default value: "50". |
200 | 200 | ||
201 | max-repodesc-length:: | 201 | max-repodesc-length:: |
202 | Specifies the maximum number of repo description characters to display | 202 | Specifies the maximum number of repo description characters to display |
203 | on the repository index page. Default value: "80". | 203 | on the repository index page. Default value: "80". |
204 | 204 | ||
205 | max-blob-size:: | 205 | max-blob-size:: |
206 | Specifies the maximum size of a blob to display HTML for in KBytes. | 206 | Specifies the maximum size of a blob to display HTML for in KBytes. |
207 | Default value: "0" (limit disabled). | 207 | Default value: "0" (limit disabled). |
208 | 208 | ||
209 | max-stats:: | 209 | max-stats:: |
210 | Set the default maximum statistics period. Valid values are "week", | 210 | Set the default maximum statistics period. Valid values are "week", |
211 | "month", "quarter" and "year". If unspecified, statistics are | 211 | "month", "quarter" and "year". If unspecified, statistics are |
212 | disabled. Default value: none. See also: "repo.max-stats". | 212 | disabled. Default value: none. See also: "repo.max-stats". |
213 | 213 | ||
214 | mimetype.<ext>:: | 214 | mimetype.<ext>:: |
215 | Set the mimetype for the specified filename extension. This is used | 215 | Set the mimetype for the specified filename extension. This is used |
216 | by the `plain` command when returning blob content. | 216 | by the `plain` command when returning blob content. |
217 | 217 | ||
218 | module-link:: | 218 | module-link:: |
219 | Text which will be used as the formatstring for a hyperlink when a | 219 | Text which will be used as the formatstring for a hyperlink when a |
220 | submodule is printed in a directory listing. The arguments for the | 220 | submodule is printed in a directory listing. The arguments for the |
221 | formatstring are the path and SHA1 of the submodule commit. Default | 221 | formatstring are the path and SHA1 of the submodule commit. Default |
222 | value: "./?repo=%s&page=commit&id=%s" | 222 | value: "./?repo=%s&page=commit&id=%s" |
223 | 223 | ||
224 | nocache:: | 224 | nocache:: |
225 | If set to the value "1" caching will be disabled. This settings is | 225 | If set to the value "1" caching will be disabled. This settings is |
226 | deprecated, and will not be honored starting with cgit-1.0. Default | 226 | deprecated, and will not be honored starting with cgit-1.0. Default |
227 | value: "0". | 227 | value: "0". |
228 | 228 | ||
229 | noplainemail:: | 229 | noplainemail:: |
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 | ||
233 | noheader:: | 233 | noheader:: |
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 | ||
237 | project-list:: | 237 | project-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 | ||
242 | readme:: | 242 | readme:: |
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 | ||
246 | remove-suffix:: | 246 | remove-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 | ||
251 | renamelimit:: | 251 | renamelimit:: |
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 | ||
256 | repo.group:: | 256 | repo.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 | ||
260 | robots:: | 260 | robots:: |
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 | ||
264 | root-desc:: | 264 | root-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 | ||
268 | root-readme:: | 268 | root-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 | ||
273 | root-title:: | 273 | root-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 | ||
277 | scan-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 | |||
277 | scan-path:: | 285 | scan-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 | ||
285 | section:: | 293 | section:: |
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 | ||
290 | section-from-path:: | 298 | section-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 | ||
296 | side-by-side-diffs:: | 304 | side-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 | ||
300 | snapshots:: | 308 | snapshots:: |
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 | ||
305 | source-filter:: | 313 | source-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 | ||
313 | summary-branches:: | 321 | summary-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 | ||
317 | summary-log:: | 325 | summary-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 | ||
321 | summary-tags:: | 329 | summary-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 | ||
325 | strict-export:: | 333 | strict-export:: |
326 | Filename which, if specified, needs to be present within the repository | 334 | Filename which, if specified, needs to be present within the repository |
327 | for cgit to allow access to that repository. This can be used to emulate | 335 | for cgit to allow access to that repository. This can be used to emulate |
328 | gitweb's EXPORT_OK and STRICT_EXPORT functionality and limit cgit's | 336 | gitweb's EXPORT_OK and STRICT_EXPORT functionality and limit cgit's |
329 | repositories to match those exported by git-daemon. This option MUST come | 337 | repositories to match those exported by git-daemon. This option MUST come |
330 | before 'scan-path'. | 338 | before 'scan-path'. |
331 | 339 | ||
332 | virtual-root:: | 340 | virtual-root:: |
333 | Url which, if specified, will be used as root for all cgit links. It | 341 | Url which, if specified, will be used as root for all cgit links. It |
334 | will also cause cgit to generate 'virtual urls', i.e. urls like | 342 | will also cause cgit to generate 'virtual urls', i.e. urls like |
335 | '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default | 343 | '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default |
336 | value: none. | 344 | value: none. |
337 | NOTE: cgit has recently learned how to use PATH_INFO to achieve the | 345 | NOTE: cgit has recently learned how to use PATH_INFO to achieve the |
338 | same kind of virtual urls, so this option will probably be deprecated. | 346 | same kind of virtual urls, so this option will probably be deprecated. |
339 | 347 | ||
340 | REPOSITORY SETTINGS | 348 | REPOSITORY SETTINGS |
341 | ------------------- | 349 | ------------------- |
342 | repo.about-filter:: | 350 | repo.about-filter:: |
343 | Override the default about-filter. Default value: none. See also: | 351 | Override the default about-filter. Default value: none. See also: |
344 | "enable-filter-overrides". | 352 | "enable-filter-overrides". |
345 | 353 | ||
346 | repo.clone-url:: | 354 | repo.clone-url:: |
347 | A list of space-separated urls which can be used to clone this repo. | 355 | A list of space-separated urls which can be used to clone this repo. |
348 | Default value: none. | 356 | Default value: none. |
349 | 357 | ||
350 | repo.commit-filter:: | 358 | repo.commit-filter:: |
351 | Override the default commit-filter. Default value: none. See also: | 359 | Override the default commit-filter. Default value: none. See also: |
352 | "enable-filter-overrides". | 360 | "enable-filter-overrides". |
353 | 361 | ||
354 | repo.defbranch:: | 362 | repo.defbranch:: |
355 | The name of the default branch for this repository. If no such branch | 363 | The name of the default branch for this repository. If no such branch |
356 | exists in the repository, the first branch name (when sorted) is used | 364 | exists in the repository, the first branch name (when sorted) is used |
357 | as default instead. Default value: "master". | 365 | as default instead. Default value: "master". |
358 | 366 | ||
359 | repo.desc:: | 367 | repo.desc:: |
360 | The value to show as repository description. Default value: none. | 368 | The value to show as repository description. Default value: none. |
361 | 369 | ||
362 | repo.enable-commit-graph:: | 370 | repo.enable-commit-graph:: |
363 | A flag which can be used to disable the global setting | 371 | A flag which can be used to disable the global setting |
364 | `enable-commit-graph'. Default value: none. | 372 | `enable-commit-graph'. Default value: none. |
365 | 373 | ||
366 | repo.enable-log-filecount:: | 374 | repo.enable-log-filecount:: |
367 | A flag which can be used to disable the global setting | 375 | A flag which can be used to disable the global setting |
368 | `enable-log-filecount'. Default value: none. | 376 | `enable-log-filecount'. Default value: none. |
369 | 377 | ||
370 | repo.enable-log-linecount:: | 378 | repo.enable-log-linecount:: |
371 | A flag which can be used to disable the global setting | 379 | A flag which can be used to disable the global setting |
372 | `enable-log-linecount'. Default value: none. | 380 | `enable-log-linecount'. Default value: none. |