-rw-r--r-- | cgitrc.5.txt | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt index c643fae..95782df 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt | |||
@@ -217,128 +217,134 @@ module-link:: | |||
217 | value: "./?repo=%s&page=commit&id=%s" | 217 | value: "./?repo=%s&page=commit&id=%s" |
218 | 218 | ||
219 | nocache:: | 219 | nocache:: |
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 | ||
224 | noplainemail:: | 224 | noplainemail:: |
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 | ||
228 | noheader:: | 228 | noheader:: |
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 | ||
232 | project-list:: | 232 | project-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 | ||
237 | remove-suffix:: | 237 | remove-suffix:: |
238 | If set to "1" and scan-path is enabled, if any repositories are found | 238 | If set to "1" and scan-path is enabled, if any repositories are found |
239 | with a suffix of ".git", this suffix will be removed for the url and | 239 | with a suffix of ".git", this suffix will be removed for the url and |
240 | name. Default value: "0". See also: scan-path. | 240 | name. Default value: "0". See also: scan-path. |
241 | 241 | ||
242 | renamelimit:: | 242 | renamelimit:: |
243 | Maximum number of files to consider when detecting renames. The value | 243 | Maximum number of files to consider when detecting renames. The value |
244 | "-1" uses the compiletime value in git (for further info, look at | 244 | "-1" uses the compiletime value in git (for further info, look at |
245 | `man git-diff`). Default value: "-1". | 245 | `man git-diff`). Default value: "-1". |
246 | 246 | ||
247 | repo.group:: | 247 | repo.group:: |
248 | Legacy alias for "section". This option is deprecated and will not be | 248 | Legacy alias for "section". This option is deprecated and will not be |
249 | supported in cgit-1.0. | 249 | supported in cgit-1.0. |
250 | 250 | ||
251 | robots:: | 251 | robots:: |
252 | Text used as content for the "robots" meta-tag. Default value: | 252 | Text used as content for the "robots" meta-tag. Default value: |
253 | "index, nofollow". | 253 | "index, nofollow". |
254 | 254 | ||
255 | root-desc:: | 255 | root-desc:: |
256 | Text printed below the heading on the repository index page. Default | 256 | Text printed below the heading on the repository index page. Default |
257 | value: "a fast webinterface for the git dscm". | 257 | value: "a fast webinterface for the git dscm". |
258 | 258 | ||
259 | root-readme:: | 259 | root-readme:: |
260 | The content of the file specified with this option will be included | 260 | The content of the file specified with this option will be included |
261 | verbatim below the "about" link on the repository index page. Default | 261 | verbatim below the "about" link on the repository index page. Default |
262 | value: none. | 262 | value: none. |
263 | 263 | ||
264 | root-title:: | 264 | root-title:: |
265 | Text printed as heading on the repository index page. Default value: | 265 | Text printed as heading on the repository index page. Default value: |
266 | "Git Repository Browser". | 266 | "Git Repository Browser". |
267 | 267 | ||
268 | scan-path:: | 268 | scan-path:: |
269 | A path which will be scanned for repositories. If caching is enabled, | 269 | A path which will be scanned for repositories. If caching is enabled, |
270 | the result will be cached as a cgitrc include-file in the cache | 270 | the result will be cached as a cgitrc include-file in the cache |
271 | directory. If project-list has been defined prior to scan-path, | 271 | directory. If project-list has been defined prior to scan-path, |
272 | scan-path loads only the directories listed in the file pointed to by | 272 | scan-path loads only the directories listed in the file pointed to by |
273 | project-list. Default value: none. See also: cache-scanrc-ttl, | 273 | project-list. Default value: none. See also: cache-scanrc-ttl, |
274 | project-list. | 274 | project-list. |
275 | 275 | ||
276 | section:: | 276 | section:: |
277 | The name of the current repository section - all repositories defined | 277 | The name of the current repository section - all repositories defined |
278 | after this option will inherit the current section name. Default value: | 278 | after this option will inherit the current section name. Default value: |
279 | none. | 279 | none. |
280 | 280 | ||
281 | section-from-path:: | ||
282 | A number which, if specified before scan-path, specifies how many | ||
283 | path elements from each repo path to use as a default section name. | ||
284 | If negative, cgit will discard the specified number of path elements | ||
285 | above the repo directory. Default value: 0. | ||
286 | |||
281 | side-by-side-diffs:: | 287 | side-by-side-diffs:: |
282 | If set to "1" shows side-by-side diffs instead of unidiffs per | 288 | If set to "1" shows side-by-side diffs instead of unidiffs per |
283 | default. Default value: "0". | 289 | default. Default value: "0". |
284 | 290 | ||
285 | snapshots:: | 291 | snapshots:: |
286 | Text which specifies the default set of snapshot formats generated by | 292 | Text which specifies the default set of snapshot formats generated by |
287 | cgit. The value is a space-separated list of zero or more of the | 293 | cgit. The value is a space-separated list of zero or more of the |
288 | values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none. | 294 | values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none. |
289 | 295 | ||
290 | source-filter:: | 296 | source-filter:: |
291 | Specifies a command which will be invoked to format plaintext blobs | 297 | Specifies a command which will be invoked to format plaintext blobs |
292 | in the tree view. The command will get the blob content on its STDIN | 298 | in the tree view. The command will get the blob content on its STDIN |
293 | and the name of the blob as its only command line argument. The STDOUT | 299 | and the name of the blob as its only command line argument. The STDOUT |
294 | from the command will be included verbatim as the blob contents, i.e. | 300 | from the command will be included verbatim as the blob contents, i.e. |
295 | this can be used to implement e.g. syntax highlighting. Default value: | 301 | this can be used to implement e.g. syntax highlighting. Default value: |
296 | none. | 302 | none. |
297 | 303 | ||
298 | summary-branches:: | 304 | summary-branches:: |
299 | Specifies the number of branches to display in the repository "summary" | 305 | Specifies the number of branches to display in the repository "summary" |
300 | view. Default value: "10". | 306 | view. Default value: "10". |
301 | 307 | ||
302 | summary-log:: | 308 | summary-log:: |
303 | Specifies the number of log entries to display in the repository | 309 | Specifies the number of log entries to display in the repository |
304 | "summary" view. Default value: "10". | 310 | "summary" view. Default value: "10". |
305 | 311 | ||
306 | summary-tags:: | 312 | summary-tags:: |
307 | Specifies the number of tags to display in the repository "summary" | 313 | Specifies the number of tags to display in the repository "summary" |
308 | view. Default value: "10". | 314 | view. Default value: "10". |
309 | 315 | ||
310 | virtual-root:: | 316 | virtual-root:: |
311 | Url which, if specified, will be used as root for all cgit links. It | 317 | Url which, if specified, will be used as root for all cgit links. It |
312 | will also cause cgit to generate 'virtual urls', i.e. urls like | 318 | will also cause cgit to generate 'virtual urls', i.e. urls like |
313 | '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default | 319 | '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default |
314 | value: none. | 320 | value: none. |
315 | NOTE: cgit has recently learned how to use PATH_INFO to achieve the | 321 | NOTE: cgit has recently learned how to use PATH_INFO to achieve the |
316 | same kind of virtual urls, so this option will probably be deprecated. | 322 | same kind of virtual urls, so this option will probably be deprecated. |
317 | 323 | ||
318 | REPOSITORY SETTINGS | 324 | REPOSITORY SETTINGS |
319 | ------------------- | 325 | ------------------- |
320 | repo.about-filter:: | 326 | repo.about-filter:: |
321 | Override the default about-filter. Default value: none. See also: | 327 | Override the default about-filter. Default value: none. See also: |
322 | "enable-filter-overrides". | 328 | "enable-filter-overrides". |
323 | 329 | ||
324 | repo.clone-url:: | 330 | repo.clone-url:: |
325 | A list of space-separated urls which can be used to clone this repo. | 331 | A list of space-separated urls which can be used to clone this repo. |
326 | Default value: none. | 332 | Default value: none. |
327 | 333 | ||
328 | repo.commit-filter:: | 334 | repo.commit-filter:: |
329 | Override the default commit-filter. Default value: none. See also: | 335 | Override the default commit-filter. Default value: none. See also: |
330 | "enable-filter-overrides". | 336 | "enable-filter-overrides". |
331 | 337 | ||
332 | repo.defbranch:: | 338 | repo.defbranch:: |
333 | The name of the default branch for this repository. If no such branch | 339 | The name of the default branch for this repository. If no such branch |
334 | exists in the repository, the first branch name (when sorted) is used | 340 | exists in the repository, the first branch name (when sorted) is used |
335 | as default instead. Default value: "master". | 341 | as default instead. Default value: "master". |
336 | 342 | ||
337 | repo.desc:: | 343 | repo.desc:: |
338 | The value to show as repository description. Default value: none. | 344 | The value to show as repository description. Default value: none. |
339 | 345 | ||
340 | repo.enable-log-filecount:: | 346 | repo.enable-log-filecount:: |
341 | A flag which can be used to disable the global setting | 347 | A flag which can be used to disable the global setting |
342 | `enable-log-filecount'. Default value: none. | 348 | `enable-log-filecount'. Default value: none. |
343 | 349 | ||
344 | repo.enable-log-linecount:: | 350 | repo.enable-log-linecount:: |