-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 d420ad4..2efd6aa 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt | |||
@@ -26,64 +26,70 @@ agefile:: | |||
26 | cache-root:: | 26 | cache-root:: |
27 | Path used to store the cgit cache entries. Default value: | 27 | Path used to store the cgit cache entries. Default value: |
28 | "/var/cache/cgit". | 28 | "/var/cache/cgit". |
29 | 29 | ||
30 | cache-dynamic-ttl:: | 30 | cache-dynamic-ttl:: |
31 | Number which specifies the time-to-live, in minutes, for the cached | 31 | Number which specifies the time-to-live, in minutes, for the cached |
32 | version of repository pages accessed without a fixed SHA1. Default | 32 | version of repository pages accessed without a fixed SHA1. Default |
33 | value: "5". | 33 | value: "5". |
34 | 34 | ||
35 | cache-repo-ttl:: | 35 | cache-repo-ttl:: |
36 | Number which specifies the time-to-live, in minutes, for the cached | 36 | Number which specifies the time-to-live, in minutes, for the cached |
37 | version of the repository summary page. Default value: "5". | 37 | version of the repository summary page. Default value: "5". |
38 | 38 | ||
39 | cache-root-ttl:: | 39 | cache-root-ttl:: |
40 | Number which specifies the time-to-live, in minutes, for the cached | 40 | Number which specifies the time-to-live, in minutes, for the cached |
41 | version of the repository index page. Default value: "5". | 41 | version of the repository index page. Default value: "5". |
42 | 42 | ||
43 | cache-size:: | 43 | cache-size:: |
44 | The maximum number of entries in the cgit cache. Default value: "0" | 44 | The maximum number of entries in the cgit cache. Default value: "0" |
45 | (i.e. caching is disabled). | 45 | (i.e. caching is disabled). |
46 | 46 | ||
47 | cache-static-ttl:: | 47 | cache-static-ttl:: |
48 | Number which specifies the time-to-live, in minutes, for the cached | 48 | Number which specifies the time-to-live, in minutes, for the cached |
49 | version of repository pages accessed with a fixed SHA1. Default value: | 49 | version of repository pages accessed with a fixed SHA1. Default value: |
50 | "5". | 50 | "5". |
51 | 51 | ||
52 | clone-prefix:: | 52 | clone-prefix:: |
53 | Space-separated list of common prefixes which, when combined with a | 53 | Space-separated list of common prefixes which, when combined with a |
54 | repository url, generates valid clone urls for the repository. This | 54 | repository url, generates valid clone urls for the repository. This |
55 | setting is only used if `repo.clone-url` is unspecified. Default value: | 55 | setting is only used if `repo.clone-url` is unspecified. Default value: |
56 | none. | 56 | none. |
57 | 57 | ||
58 | commit-filter:: | ||
59 | Specifies a command which will be invoked to format commit messages. | ||
60 | The command will get the message on its STDIN, and the STDOUT from the | ||
61 | command will be included verbatim as the commit message, i.e. this can | ||
62 | be used to implement bugtracker integration. Default value: none. | ||
63 | |||
58 | css:: | 64 | css:: |
59 | Url which specifies the css document to include in all cgit pages. | 65 | Url which specifies the css document to include in all cgit pages. |
60 | Default value: "/cgit.css". | 66 | Default value: "/cgit.css". |
61 | 67 | ||
62 | embedded:: | 68 | embedded:: |
63 | Flag which, when set to "1", will make cgit generate a html fragment | 69 | Flag which, when set to "1", will make cgit generate a html fragment |
64 | suitable for embedding in other html pages. Default value: none. See | 70 | suitable for embedding in other html pages. Default value: none. See |
65 | also: "noheader". | 71 | also: "noheader". |
66 | 72 | ||
67 | enable-index-links:: | 73 | enable-index-links:: |
68 | Flag which, when set to "1", will make cgit generate extra links for | 74 | Flag which, when set to "1", will make cgit generate extra links for |
69 | each repo in the repository index (specifically, to the "summary", | 75 | each repo in the repository index (specifically, to the "summary", |
70 | "commit" and "tree" pages). Default value: "0". | 76 | "commit" and "tree" pages). Default value: "0". |
71 | 77 | ||
72 | enable-log-filecount:: | 78 | enable-log-filecount:: |
73 | Flag which, when set to "1", will make cgit print the number of | 79 | Flag which, when set to "1", will make cgit print the number of |
74 | modified files for each commit on the repository log page. Default | 80 | modified files for each commit on the repository log page. Default |
75 | value: "0". | 81 | value: "0". |
76 | 82 | ||
77 | enable-log-linecount:: | 83 | enable-log-linecount:: |
78 | Flag which, when set to "1", will make cgit print the number of added | 84 | Flag which, when set to "1", will make cgit print the number of added |
79 | and removed lines for each commit on the repository log page. Default | 85 | and removed lines for each commit on the repository log page. Default |
80 | value: "0". | 86 | value: "0". |
81 | 87 | ||
82 | favicon:: | 88 | favicon:: |
83 | Url used as link to a shortcut icon for cgit. If specified, it is | 89 | Url used as link to a shortcut icon for cgit. If specified, it is |
84 | suggested to use the value "/favicon.ico" since certain browsers will | 90 | suggested to use the value "/favicon.ico" since certain browsers will |
85 | ignore other values. Default value: none. | 91 | ignore other values. Default value: none. |
86 | 92 | ||
87 | footer:: | 93 | footer:: |
88 | The content of the file specified with this option will be included | 94 | The content of the file specified with this option will be included |
89 | verbatim at the bottom of all pages (i.e. it replaces the standard | 95 | verbatim at the bottom of all pages (i.e. it replaces the standard |