-rw-r--r-- | cgitrc.5.txt | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt index 3c35b02..a762ccc 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt | |||
@@ -21,256 +21,260 @@ runtime, cgit will consult the environment variable CGIT_CONFIG and, if | |||
21 | defined, use its value instead. | 21 | defined, use its value instead. |
22 | 22 | ||
23 | 23 | ||
24 | GLOBAL SETTINGS | 24 | GLOBAL SETTINGS |
25 | --------------- | 25 | --------------- |
26 | about-filter:: | 26 | about-filter:: |
27 | Specifies a command which will be invoked to format the content of | 27 | Specifies a command which will be invoked to format the content of |
28 | about pages (both top-level and for each repository). The command will | 28 | about pages (both top-level and for each repository). The command will |
29 | get the content of the about-file on its STDIN, and the STDOUT from the | 29 | get the content of the about-file on its STDIN, and the STDOUT from the |
30 | command will be included verbatim on the about page. Default value: | 30 | command will be included verbatim on the about page. Default value: |
31 | none. | 31 | none. |
32 | 32 | ||
33 | agefile:: | 33 | agefile:: |
34 | Specifies a path, relative to each repository path, which can be used | 34 | Specifies a path, relative to each repository path, which can be used |
35 | to specify the date and time of the youngest commit in the repository. | 35 | to specify the date and time of the youngest commit in the repository. |
36 | The first line in the file is used as input to the "parse_date" | 36 | The first line in the file is used as input to the "parse_date" |
37 | function in libgit. Recommended timestamp-format is "yyyy-mm-dd | 37 | function in libgit. Recommended timestamp-format is "yyyy-mm-dd |
38 | hh:mm:ss". Default value: "info/web/last-modified". | 38 | hh:mm:ss". Default value: "info/web/last-modified". |
39 | 39 | ||
40 | cache-root:: | 40 | cache-root:: |
41 | Path used to store the cgit cache entries. Default value: | 41 | Path used to store the cgit cache entries. Default value: |
42 | "/var/cache/cgit". | 42 | "/var/cache/cgit". |
43 | 43 | ||
44 | cache-dynamic-ttl:: | 44 | cache-dynamic-ttl:: |
45 | Number which specifies the time-to-live, in minutes, for the cached | 45 | Number which specifies the time-to-live, in minutes, for the cached |
46 | version of repository pages accessed without a fixed SHA1. Default | 46 | version of repository pages accessed without a fixed SHA1. Default |
47 | value: "5". | 47 | value: "5". |
48 | 48 | ||
49 | cache-repo-ttl:: | 49 | cache-repo-ttl:: |
50 | Number which specifies the time-to-live, in minutes, for the cached | 50 | Number which specifies the time-to-live, in minutes, for the cached |
51 | version of the repository summary page. Default value: "5". | 51 | version of the repository summary page. Default value: "5". |
52 | 52 | ||
53 | cache-root-ttl:: | 53 | cache-root-ttl:: |
54 | Number which specifies the time-to-live, in minutes, for the cached | 54 | Number which specifies the time-to-live, in minutes, for the cached |
55 | version of the repository index page. Default value: "5". | 55 | version of the repository index page. Default value: "5". |
56 | 56 | ||
57 | cache-size:: | 57 | cache-size:: |
58 | The maximum number of entries in the cgit cache. Default value: "0" | 58 | The maximum number of entries in the cgit cache. Default value: "0" |
59 | (i.e. caching is disabled). | 59 | (i.e. caching is disabled). |
60 | 60 | ||
61 | cache-static-ttl:: | 61 | cache-static-ttl:: |
62 | Number which specifies the time-to-live, in minutes, for the cached | 62 | Number which specifies the time-to-live, in minutes, for the cached |
63 | version of repository pages accessed with a fixed SHA1. Default value: | 63 | version of repository pages accessed with a fixed SHA1. Default value: |
64 | "5". | 64 | "5". |
65 | 65 | ||
66 | clone-prefix:: | 66 | clone-prefix:: |
67 | Space-separated list of common prefixes which, when combined with a | 67 | Space-separated list of common prefixes which, when combined with a |
68 | repository url, generates valid clone urls for the repository. This | 68 | repository url, generates valid clone urls for the repository. This |
69 | setting is only used if `repo.clone-url` is unspecified. Default value: | 69 | setting is only used if `repo.clone-url` is unspecified. Default value: |
70 | none. | 70 | none. |
71 | 71 | ||
72 | commit-filter:: | 72 | commit-filter:: |
73 | Specifies a command which will be invoked to format commit messages. | 73 | Specifies a command which will be invoked to format commit messages. |
74 | The command will get the message on its STDIN, and the STDOUT from the | 74 | The command will get the message on its STDIN, and the STDOUT from the |
75 | command will be included verbatim as the commit message, i.e. this can | 75 | command will be included verbatim as the commit message, i.e. this can |
76 | be used to implement bugtracker integration. Default value: none. | 76 | be used to implement bugtracker integration. Default value: none. |
77 | 77 | ||
78 | css:: | 78 | css:: |
79 | Url which specifies the css document to include in all cgit pages. | 79 | Url which specifies the css document to include in all cgit pages. |
80 | Default value: "/cgit.css". | 80 | Default value: "/cgit.css". |
81 | 81 | ||
82 | embedded:: | 82 | embedded:: |
83 | Flag which, when set to "1", will make cgit generate a html fragment | 83 | Flag which, when set to "1", will make cgit generate a html fragment |
84 | suitable for embedding in other html pages. Default value: none. See | 84 | suitable for embedding in other html pages. Default value: none. See |
85 | also: "noheader". | 85 | also: "noheader". |
86 | 86 | ||
87 | enable-index-links:: | 87 | enable-index-links:: |
88 | Flag which, when set to "1", will make cgit generate extra links for | 88 | Flag which, when set to "1", will make cgit generate extra links for |
89 | each repo in the repository index (specifically, to the "summary", | 89 | each repo in the repository index (specifically, to the "summary", |
90 | "commit" and "tree" pages). Default value: "0". | 90 | "commit" and "tree" pages). Default value: "0". |
91 | 91 | ||
92 | enable-log-filecount:: | 92 | enable-log-filecount:: |
93 | Flag which, when set to "1", will make cgit print the number of | 93 | Flag which, when set to "1", will make cgit print the number of |
94 | modified files for each commit on the repository log page. Default | 94 | modified files for each commit on the repository log page. Default |
95 | value: "0". | 95 | value: "0". |
96 | 96 | ||
97 | enable-log-linecount:: | 97 | enable-log-linecount:: |
98 | Flag which, when set to "1", will make cgit print the number of added | 98 | Flag which, when set to "1", will make cgit print the number of added |
99 | and removed lines for each commit on the repository log page. Default | 99 | and removed lines for each commit on the repository log page. Default |
100 | value: "0". | 100 | value: "0". |
101 | 101 | ||
102 | favicon:: | 102 | favicon:: |
103 | Url used as link to a shortcut icon for cgit. If specified, it is | 103 | Url used as link to a shortcut icon for cgit. If specified, it is |
104 | suggested to use the value "/favicon.ico" since certain browsers will | 104 | suggested to use the value "/favicon.ico" since certain browsers will |
105 | ignore other values. Default value: none. | 105 | ignore other values. Default value: none. |
106 | 106 | ||
107 | footer:: | 107 | footer:: |
108 | The content of the file specified with this option will be included | 108 | The content of the file specified with this option will be included |
109 | verbatim at the bottom of all pages (i.e. it replaces the standard | 109 | verbatim at the bottom of all pages (i.e. it replaces the standard |
110 | "generated by..." message. Default value: none. | 110 | "generated by..." message. Default value: none. |
111 | 111 | ||
112 | head-include:: | 112 | head-include:: |
113 | The content of the file specified with this option will be included | 113 | The content of the file specified with this option will be included |
114 | verbatim in the html HEAD section on all pages. Default value: none. | 114 | verbatim in the html HEAD section on all pages. Default value: none. |
115 | 115 | ||
116 | header:: | 116 | header:: |
117 | The content of the file specified with this option will be included | 117 | The content of the file specified with this option will be included |
118 | verbatim at the top of all pages. Default value: none. | 118 | verbatim at the top of all pages. Default value: none. |
119 | 119 | ||
120 | include:: | 120 | include:: |
121 | Name of a configfile to include before the rest of the current config- | 121 | Name of a configfile to include before the rest of the current config- |
122 | file is parsed. Default value: none. | 122 | file is parsed. Default value: none. |
123 | 123 | ||
124 | index-header:: | 124 | index-header:: |
125 | The content of the file specified with this option will be included | 125 | The content of the file specified with this option will be included |
126 | verbatim above the repository index. This setting is deprecated, and | 126 | verbatim above the repository index. This setting is deprecated, and |
127 | will not be supported by cgit-1.0 (use root-readme instead). Default | 127 | will not be supported by cgit-1.0 (use root-readme instead). Default |
128 | value: none. | 128 | value: none. |
129 | 129 | ||
130 | index-info:: | 130 | index-info:: |
131 | The content of the file specified with this option will be included | 131 | The content of the file specified with this option will be included |
132 | verbatim below the heading on the repository index page. This setting | 132 | verbatim below the heading on the repository index page. This setting |
133 | is deprecated, and will not be supported by cgit-1.0 (use root-desc | 133 | is deprecated, and will not be supported by cgit-1.0 (use root-desc |
134 | instead). Default value: none. | 134 | instead). Default value: none. |
135 | 135 | ||
136 | local-time:: | 136 | local-time:: |
137 | Flag which, if set to "1", makes cgit print commit and tag times in the | 137 | Flag which, if set to "1", makes cgit print commit and tag times in the |
138 | servers timezone. Default value: "0". | 138 | servers timezone. Default value: "0". |
139 | 139 | ||
140 | logo:: | 140 | logo:: |
141 | Url which specifies the source of an image which will be used as a logo | 141 | Url which specifies the source of an image which will be used as a logo |
142 | on all cgit pages. Default value: "/cgit.png". | 142 | on all cgit pages. Default value: "/cgit.png". |
143 | 143 | ||
144 | logo-link:: | 144 | logo-link:: |
145 | Url loaded when clicking on the cgit logo image. If unspecified the | 145 | Url loaded when clicking on the cgit logo image. If unspecified the |
146 | calculated url of the repository index page will be used. Default | 146 | calculated url of the repository index page will be used. Default |
147 | value: none. | 147 | value: none. |
148 | 148 | ||
149 | linenumbers:: | ||
150 | If set to "1" lines in tree view will have numbers. | ||
151 | Default value: "0". | ||
152 | |||
149 | max-commit-count:: | 153 | max-commit-count:: |
150 | Specifies the number of entries to list per page in "log" view. Default | 154 | Specifies the number of entries to list per page in "log" view. Default |
151 | value: "50". | 155 | value: "50". |
152 | 156 | ||
153 | max-message-length:: | 157 | max-message-length:: |
154 | Specifies the maximum number of commit message characters to display in | 158 | Specifies the maximum number of commit message characters to display in |
155 | "log" view. Default value: "80". | 159 | "log" view. Default value: "80". |
156 | 160 | ||
157 | max-repo-count:: | 161 | max-repo-count:: |
158 | Specifies the number of entries to list per page on therepository | 162 | Specifies the number of entries to list per page on therepository |
159 | index page. Default value: "50". | 163 | index page. Default value: "50". |
160 | 164 | ||
161 | max-repodesc-length:: | 165 | max-repodesc-length:: |
162 | Specifies the maximum number of repo description characters to display | 166 | Specifies the maximum number of repo description characters to display |
163 | on the repository index page. Default value: "80". | 167 | on the repository index page. Default value: "80". |
164 | 168 | ||
165 | max-stats:: | 169 | max-stats:: |
166 | Set the default maximum statistics period. Valid values are "week", | 170 | Set the default maximum statistics period. Valid values are "week", |
167 | "month", "quarter" and "year". If unspecified, statistics are | 171 | "month", "quarter" and "year". If unspecified, statistics are |
168 | disabled. Default value: none. See also: "repo.max-stats". | 172 | disabled. Default value: none. See also: "repo.max-stats". |
169 | 173 | ||
170 | mimetype.<ext>:: | 174 | mimetype.<ext>:: |
171 | Set the mimetype for the specified filename extension. This is used | 175 | Set the mimetype for the specified filename extension. This is used |
172 | by the `plain` command when returning blob content. | 176 | by the `plain` command when returning blob content. |
173 | 177 | ||
174 | module-link:: | 178 | module-link:: |
175 | Text which will be used as the formatstring for a hyperlink when a | 179 | Text which will be used as the formatstring for a hyperlink when a |
176 | submodule is printed in a directory listing. The arguments for the | 180 | submodule is printed in a directory listing. The arguments for the |
177 | formatstring are the path and SHA1 of the submodule commit. Default | 181 | formatstring are the path and SHA1 of the submodule commit. Default |
178 | value: "./?repo=%s&page=commit&id=%s" | 182 | value: "./?repo=%s&page=commit&id=%s" |
179 | 183 | ||
180 | nocache:: | 184 | nocache:: |
181 | If set to the value "1" caching will be disabled. This settings is | 185 | If set to the value "1" caching will be disabled. This settings is |
182 | deprecated, and will not be honored starting with cgit-1.0. Default | 186 | deprecated, and will not be honored starting with cgit-1.0. Default |
183 | value: "0". | 187 | value: "0". |
184 | 188 | ||
185 | noplainemail:: | 189 | noplainemail:: |
186 | If set to "1" showing full author email adresses will be disabled. | 190 | If set to "1" showing full author email adresses will be disabled. |
187 | Default value: "0". | 191 | Default value: "0". |
188 | 192 | ||
189 | noheader:: | 193 | noheader:: |
190 | Flag which, when set to "1", will make cgit omit the standard header | 194 | Flag which, when set to "1", will make cgit omit the standard header |
191 | on all pages. Default value: none. See also: "embedded". | 195 | on all pages. Default value: none. See also: "embedded". |
192 | 196 | ||
193 | renamelimit:: | 197 | renamelimit:: |
194 | Maximum number of files to consider when detecting renames. The value | 198 | Maximum number of files to consider when detecting renames. The value |
195 | "-1" uses the compiletime value in git (for further info, look at | 199 | "-1" uses the compiletime value in git (for further info, look at |
196 | `man git-diff`). Default value: "-1". | 200 | `man git-diff`). Default value: "-1". |
197 | 201 | ||
198 | repo.group:: | 202 | repo.group:: |
199 | A value for the current repository group, which all repositories | 203 | A value for the current repository group, which all repositories |
200 | specified after this setting will inherit. Default value: none. | 204 | specified after this setting will inherit. Default value: none. |
201 | 205 | ||
202 | robots:: | 206 | robots:: |
203 | Text used as content for the "robots" meta-tag. Default value: | 207 | Text used as content for the "robots" meta-tag. Default value: |
204 | "index, nofollow". | 208 | "index, nofollow". |
205 | 209 | ||
206 | root-desc:: | 210 | root-desc:: |
207 | Text printed below the heading on the repository index page. Default | 211 | Text printed below the heading on the repository index page. Default |
208 | value: "a fast webinterface for the git dscm". | 212 | value: "a fast webinterface for the git dscm". |
209 | 213 | ||
210 | root-readme:: | 214 | root-readme:: |
211 | The content of the file specified with this option will be included | 215 | The content of the file specified with this option will be included |
212 | verbatim below the "about" link on the repository index page. Default | 216 | verbatim below the "about" link on the repository index page. Default |
213 | value: none. | 217 | value: none. |
214 | 218 | ||
215 | root-title:: | 219 | root-title:: |
216 | Text printed as heading on the repository index page. Default value: | 220 | Text printed as heading on the repository index page. Default value: |
217 | "Git Repository Browser". | 221 | "Git Repository Browser". |
218 | 222 | ||
219 | snapshots:: | 223 | snapshots:: |
220 | Text which specifies the default (and allowed) set of snapshot formats | 224 | Text which specifies the default (and allowed) set of snapshot formats |
221 | supported by cgit. The value is a space-separated list of zero or more | 225 | supported by cgit. The value is a space-separated list of zero or more |
222 | of the following values: | 226 | of the following values: |
223 | "tar" uncompressed tar-file | 227 | "tar" uncompressed tar-file |
224 | "tar.gz"gzip-compressed tar-file | 228 | "tar.gz"gzip-compressed tar-file |
225 | "tar.bz2"bzip-compressed tar-file | 229 | "tar.bz2"bzip-compressed tar-file |
226 | "zip" zip-file | 230 | "zip" zip-file |
227 | Default value: none. | 231 | Default value: none. |
228 | 232 | ||
229 | source-filter:: | 233 | source-filter:: |
230 | Specifies a command which will be invoked to format plaintext blobs | 234 | Specifies a command which will be invoked to format plaintext blobs |
231 | in the tree view. The command will get the blob content on its STDIN | 235 | in the tree view. The command will get the blob content on its STDIN |
232 | and the name of the blob as its only command line argument. The STDOUT | 236 | and the name of the blob as its only command line argument. The STDOUT |
233 | from the command will be included verbatim as the blob contents, i.e. | 237 | from the command will be included verbatim as the blob contents, i.e. |
234 | this can be used to implement e.g. syntax highlighting. Default value: | 238 | this can be used to implement e.g. syntax highlighting. Default value: |
235 | none. | 239 | none. |
236 | 240 | ||
237 | summary-branches:: | 241 | summary-branches:: |
238 | Specifies the number of branches to display in the repository "summary" | 242 | Specifies the number of branches to display in the repository "summary" |
239 | view. Default value: "10". | 243 | view. Default value: "10". |
240 | 244 | ||
241 | summary-log:: | 245 | summary-log:: |
242 | Specifies the number of log entries to display in the repository | 246 | Specifies the number of log entries to display in the repository |
243 | "summary" view. Default value: "10". | 247 | "summary" view. Default value: "10". |
244 | 248 | ||
245 | summary-tags:: | 249 | summary-tags:: |
246 | Specifies the number of tags to display in the repository "summary" | 250 | Specifies the number of tags to display in the repository "summary" |
247 | view. Default value: "10". | 251 | view. Default value: "10". |
248 | 252 | ||
249 | virtual-root:: | 253 | virtual-root:: |
250 | Url which, if specified, will be used as root for all cgit links. It | 254 | Url which, if specified, will be used as root for all cgit links. It |
251 | will also cause cgit to generate 'virtual urls', i.e. urls like | 255 | will also cause cgit to generate 'virtual urls', i.e. urls like |
252 | '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default | 256 | '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default |
253 | value: none. | 257 | value: none. |
254 | NOTE: cgit has recently learned how to use PATH_INFO to achieve the | 258 | NOTE: cgit has recently learned how to use PATH_INFO to achieve the |
255 | same kind of virtual urls, so this option will probably be deprecated. | 259 | same kind of virtual urls, so this option will probably be deprecated. |
256 | 260 | ||
257 | REPOSITORY SETTINGS | 261 | REPOSITORY SETTINGS |
258 | ------------------- | 262 | ------------------- |
259 | repo.about-filter:: | 263 | repo.about-filter:: |
260 | Override the default about-filter. Default value: <about-filter>. | 264 | Override the default about-filter. Default value: <about-filter>. |
261 | 265 | ||
262 | repo.clone-url:: | 266 | repo.clone-url:: |
263 | A list of space-separated urls which can be used to clone this repo. | 267 | A list of space-separated urls which can be used to clone this repo. |
264 | Default value: none. | 268 | Default value: none. |
265 | 269 | ||
266 | repo.commit-filter:: | 270 | repo.commit-filter:: |
267 | Override the default commit-filter. Default value: <commit-filter>. | 271 | Override the default commit-filter. Default value: <commit-filter>. |
268 | 272 | ||
269 | repo.defbranch:: | 273 | repo.defbranch:: |
270 | The name of the default branch for this repository. If no such branch | 274 | The name of the default branch for this repository. If no such branch |
271 | exists in the repository, the first branch name (when sorted) is used | 275 | exists in the repository, the first branch name (when sorted) is used |
272 | as default instead. Default value: "master". | 276 | as default instead. Default value: "master". |
273 | 277 | ||
274 | repo.desc:: | 278 | repo.desc:: |
275 | The value to show as repository description. Default value: none. | 279 | The value to show as repository description. Default value: none. |
276 | 280 | ||