-rw-r--r-- | cgitrc.5.txt | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt index be8483c..65b210f 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt | |||
@@ -226,130 +226,131 @@ nocache:: | |||
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:: | 277 | scan-hidden-path:: |
278 | If set to "1" and scan-path is enabled, scan-path will recurse into | 278 | If set to "1" and scan-path is enabled, scan-path will recurse into |
279 | directories whose name starts with a period ('.'). Otherwise, | 279 | directories whose name starts with a period ('.'). Otherwise, |
280 | scan-path will stay away from such directories (considered as | 280 | scan-path will stay away from such directories (considered as |
281 | "hidden"). Note that this does not apply to the ".git" directory in | 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. | 282 | non-bare repos. This must be defined prior to scan-path. |
283 | Default value: 0. See also: scan-path. | 283 | Default value: 0. See also: scan-path. |
284 | 284 | ||
285 | scan-path:: | 285 | scan-path:: |
286 | 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, |
287 | 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 |
288 | directory. If project-list has been defined prior to scan-path, | 288 | directory. If project-list has been defined prior to scan-path, |
289 | 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 |
290 | project-list. Default value: none. See also: cache-scanrc-ttl, | 290 | project-list. Be advised that only the global settings taken |
291 | project-list. | 291 | before the scan-path directive will be applied to each repository. |
292 | Default value: none. See also: cache-scanrc-ttl, project-list. | ||
292 | 293 | ||
293 | section:: | 294 | section:: |
294 | The name of the current repository section - all repositories defined | 295 | The name of the current repository section - all repositories defined |
295 | after this option will inherit the current section name. Default value: | 296 | after this option will inherit the current section name. Default value: |
296 | none. | 297 | none. |
297 | 298 | ||
298 | section-from-path:: | 299 | section-from-path:: |
299 | A number which, if specified before scan-path, specifies how many | 300 | A number which, if specified before scan-path, specifies how many |
300 | path elements from each repo path to use as a default section name. | 301 | path elements from each repo path to use as a default section name. |
301 | If negative, cgit will discard the specified number of path elements | 302 | If negative, cgit will discard the specified number of path elements |
302 | above the repo directory. Default value: 0. | 303 | above the repo directory. Default value: 0. |
303 | 304 | ||
304 | side-by-side-diffs:: | 305 | side-by-side-diffs:: |
305 | If set to "1" shows side-by-side diffs instead of unidiffs per | 306 | If set to "1" shows side-by-side diffs instead of unidiffs per |
306 | default. Default value: "0". | 307 | default. Default value: "0". |
307 | 308 | ||
308 | snapshots:: | 309 | snapshots:: |
309 | Text which specifies the default set of snapshot formats generated by | 310 | Text which specifies the default set of snapshot formats generated by |
310 | cgit. The value is a space-separated list of zero or more of the | 311 | cgit. The value is a space-separated list of zero or more of the |
311 | values "tar", "tar.gz", "tar.bz2", "tar.xz" and "zip". Default value: | 312 | values "tar", "tar.gz", "tar.bz2", "tar.xz" and "zip". Default value: |
312 | none. | 313 | none. |
313 | 314 | ||
314 | source-filter:: | 315 | source-filter:: |
315 | Specifies a command which will be invoked to format plaintext blobs | 316 | Specifies a command which will be invoked to format plaintext blobs |
316 | in the tree view. The command will get the blob content on its STDIN | 317 | in the tree view. The command will get the blob content on its STDIN |
317 | and the name of the blob as its only command line argument. The STDOUT | 318 | and the name of the blob as its only command line argument. The STDOUT |
318 | from the command will be included verbatim as the blob contents, i.e. | 319 | from the command will be included verbatim as the blob contents, i.e. |
319 | this can be used to implement e.g. syntax highlighting. Default value: | 320 | this can be used to implement e.g. syntax highlighting. Default value: |
320 | none. | 321 | none. |
321 | 322 | ||
322 | summary-branches:: | 323 | summary-branches:: |
323 | Specifies the number of branches to display in the repository "summary" | 324 | Specifies the number of branches to display in the repository "summary" |
324 | view. Default value: "10". | 325 | view. Default value: "10". |
325 | 326 | ||
326 | summary-log:: | 327 | summary-log:: |
327 | Specifies the number of log entries to display in the repository | 328 | Specifies the number of log entries to display in the repository |
328 | "summary" view. Default value: "10". | 329 | "summary" view. Default value: "10". |
329 | 330 | ||
330 | summary-tags:: | 331 | summary-tags:: |
331 | Specifies the number of tags to display in the repository "summary" | 332 | Specifies the number of tags to display in the repository "summary" |
332 | view. Default value: "10". | 333 | view. Default value: "10". |
333 | 334 | ||
334 | strict-export:: | 335 | strict-export:: |
335 | Filename which, if specified, needs to be present within the repository | 336 | Filename which, if specified, needs to be present within the repository |
336 | for cgit to allow access to that repository. This can be used to emulate | 337 | for cgit to allow access to that repository. This can be used to emulate |
337 | gitweb's EXPORT_OK and STRICT_EXPORT functionality and limit cgit's | 338 | gitweb's EXPORT_OK and STRICT_EXPORT functionality and limit cgit's |
338 | repositories to match those exported by git-daemon. This option MUST come | 339 | repositories to match those exported by git-daemon. This option MUST come |
339 | before 'scan-path'. | 340 | before 'scan-path'. |
340 | 341 | ||
341 | virtual-root:: | 342 | virtual-root:: |
342 | Url which, if specified, will be used as root for all cgit links. It | 343 | Url which, if specified, will be used as root for all cgit links. It |
343 | will also cause cgit to generate 'virtual urls', i.e. urls like | 344 | will also cause cgit to generate 'virtual urls', i.e. urls like |
344 | '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default | 345 | '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default |
345 | value: none. | 346 | value: none. |
346 | NOTE: cgit has recently learned how to use PATH_INFO to achieve the | 347 | NOTE: cgit has recently learned how to use PATH_INFO to achieve the |
347 | same kind of virtual urls, so this option will probably be deprecated. | 348 | same kind of virtual urls, so this option will probably be deprecated. |
348 | 349 | ||
349 | REPOSITORY SETTINGS | 350 | REPOSITORY SETTINGS |
350 | ------------------- | 351 | ------------------- |
351 | repo.about-filter:: | 352 | repo.about-filter:: |
352 | Override the default about-filter. Default value: none. See also: | 353 | Override the default about-filter. Default value: none. See also: |
353 | "enable-filter-overrides". | 354 | "enable-filter-overrides". |
354 | 355 | ||
355 | repo.clone-url:: | 356 | repo.clone-url:: |