-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 | |||
@@ -98,386 +98,387 @@ enable-commit-graph:: | |||
98 | 98 | ||
99 | enable-filter-overrides:: | 99 | enable-filter-overrides:: |
100 | Flag which, when set to "1", allows all filter settings to be | 100 | Flag which, when set to "1", allows all filter settings to be |
101 | overridden in repository-specific cgitrc files. Default value: none. | 101 | overridden in repository-specific cgitrc files. Default value: none. |
102 | 102 | ||
103 | enable-gitweb-owner:: | 103 | enable-gitweb-owner:: |
104 | If set to "1" and scan-path is enabled, we first check each repository | 104 | If set to "1" and scan-path is enabled, we first check each repository |
105 | for the git config value "gitweb.owner" to determine the owner. | 105 | for the git config value "gitweb.owner" to determine the owner. |
106 | Default value: "1". See also: scan-path. | 106 | Default value: "1". See also: scan-path. |
107 | 107 | ||
108 | enable-index-links:: | 108 | enable-index-links:: |
109 | Flag which, when set to "1", will make cgit generate extra links for | 109 | Flag which, when set to "1", will make cgit generate extra links for |
110 | each repo in the repository index (specifically, to the "summary", | 110 | each repo in the repository index (specifically, to the "summary", |
111 | "commit" and "tree" pages). Default value: "0". | 111 | "commit" and "tree" pages). Default value: "0". |
112 | 112 | ||
113 | enable-log-filecount:: | 113 | enable-log-filecount:: |
114 | Flag which, when set to "1", will make cgit print the number of | 114 | Flag which, when set to "1", will make cgit print the number of |
115 | modified files for each commit on the repository log page. Default | 115 | modified files for each commit on the repository log page. Default |
116 | value: "0". | 116 | value: "0". |
117 | 117 | ||
118 | enable-log-linecount:: | 118 | enable-log-linecount:: |
119 | Flag which, when set to "1", will make cgit print the number of added | 119 | Flag which, when set to "1", will make cgit print the number of added |
120 | and removed lines for each commit on the repository log page. Default | 120 | and removed lines for each commit on the repository log page. Default |
121 | value: "0". | 121 | value: "0". |
122 | 122 | ||
123 | enable-remote-branches:: | 123 | enable-remote-branches:: |
124 | Flag which, when set to "1", will make cgit display remote branches | 124 | Flag which, when set to "1", will make cgit display remote branches |
125 | in the summary and refs views. Default value: "0". See also: | 125 | in the summary and refs views. Default value: "0". See also: |
126 | "repo.enable-remote-branches". | 126 | "repo.enable-remote-branches". |
127 | 127 | ||
128 | enable-subject-links:: | 128 | enable-subject-links:: |
129 | Flag which, when set to "1", will make cgit use the subject of the | 129 | Flag which, when set to "1", will make cgit use the subject of the |
130 | parent commit as link text when generating links to parent commits | 130 | parent commit as link text when generating links to parent commits |
131 | in commit view. Default value: "0". See also: | 131 | in commit view. Default value: "0". See also: |
132 | "repo.enable-subject-links". | 132 | "repo.enable-subject-links". |
133 | 133 | ||
134 | enable-tree-linenumbers:: | 134 | enable-tree-linenumbers:: |
135 | Flag which, when set to "1", will make cgit generate linenumber links | 135 | Flag which, when set to "1", will make cgit generate linenumber links |
136 | for plaintext blobs printed in the tree view. Default value: "1". | 136 | for plaintext blobs printed in the tree view. Default value: "1". |
137 | 137 | ||
138 | favicon:: | 138 | favicon:: |
139 | Url used as link to a shortcut icon for cgit. If specified, it is | 139 | Url used as link to a shortcut icon for cgit. If specified, it is |
140 | suggested to use the value "/favicon.ico" since certain browsers will | 140 | suggested to use the value "/favicon.ico" since certain browsers will |
141 | ignore other values. Default value: none. | 141 | ignore other values. Default value: none. |
142 | 142 | ||
143 | footer:: | 143 | footer:: |
144 | The content of the file specified with this option will be included | 144 | The content of the file specified with this option will be included |
145 | verbatim at the bottom of all pages (i.e. it replaces the standard | 145 | verbatim at the bottom of all pages (i.e. it replaces the standard |
146 | "generated by..." message. Default value: none. | 146 | "generated by..." message. Default value: none. |
147 | 147 | ||
148 | head-include:: | 148 | head-include:: |
149 | The content of the file specified with this option will be included | 149 | The content of the file specified with this option will be included |
150 | verbatim in the html HEAD section on all pages. Default value: none. | 150 | verbatim in the html HEAD section on all pages. Default value: none. |
151 | 151 | ||
152 | header:: | 152 | header:: |
153 | The content of the file specified with this option will be included | 153 | The content of the file specified with this option will be included |
154 | verbatim at the top of all pages. Default value: none. | 154 | verbatim at the top of all pages. Default value: none. |
155 | 155 | ||
156 | include:: | 156 | include:: |
157 | Name of a configfile to include before the rest of the current config- | 157 | Name of a configfile to include before the rest of the current config- |
158 | file is parsed. Default value: none. | 158 | file is parsed. Default value: none. |
159 | 159 | ||
160 | index-header:: | 160 | index-header:: |
161 | The content of the file specified with this option will be included | 161 | The content of the file specified with this option will be included |
162 | verbatim above the repository index. This setting is deprecated, and | 162 | verbatim above the repository index. This setting is deprecated, and |
163 | will not be supported by cgit-1.0 (use root-readme instead). Default | 163 | will not be supported by cgit-1.0 (use root-readme instead). Default |
164 | value: none. | 164 | value: none. |
165 | 165 | ||
166 | index-info:: | 166 | index-info:: |
167 | The content of the file specified with this option will be included | 167 | The content of the file specified with this option will be included |
168 | verbatim below the heading on the repository index page. This setting | 168 | verbatim below the heading on the repository index page. This setting |
169 | is deprecated, and will not be supported by cgit-1.0 (use root-desc | 169 | is deprecated, and will not be supported by cgit-1.0 (use root-desc |
170 | instead). Default value: none. | 170 | instead). Default value: none. |
171 | 171 | ||
172 | local-time:: | 172 | local-time:: |
173 | Flag which, if set to "1", makes cgit print commit and tag times in the | 173 | Flag which, if set to "1", makes cgit print commit and tag times in the |
174 | servers timezone. Default value: "0". | 174 | servers timezone. Default value: "0". |
175 | 175 | ||
176 | logo:: | 176 | logo:: |
177 | Url which specifies the source of an image which will be used as a logo | 177 | Url which specifies the source of an image which will be used as a logo |
178 | on all cgit pages. Default value: "/cgit.png". | 178 | on all cgit pages. Default value: "/cgit.png". |
179 | 179 | ||
180 | logo-link:: | 180 | 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:: | 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:: |
356 | A list of space-separated urls which can be used to clone this repo. | 357 | A list of space-separated urls which can be used to clone this repo. |
357 | Default value: none. | 358 | Default value: none. |
358 | 359 | ||
359 | repo.commit-filter:: | 360 | repo.commit-filter:: |
360 | Override the default commit-filter. Default value: none. See also: | 361 | Override the default commit-filter. Default value: none. See also: |
361 | "enable-filter-overrides". | 362 | "enable-filter-overrides". |
362 | 363 | ||
363 | repo.defbranch:: | 364 | repo.defbranch:: |
364 | The name of the default branch for this repository. If no such branch | 365 | The name of the default branch for this repository. If no such branch |
365 | exists in the repository, the first branch name (when sorted) is used | 366 | exists in the repository, the first branch name (when sorted) is used |
366 | as default instead. Default value: "master". | 367 | as default instead. Default value: "master". |
367 | 368 | ||
368 | repo.desc:: | 369 | repo.desc:: |
369 | The value to show as repository description. Default value: none. | 370 | The value to show as repository description. Default value: none. |
370 | 371 | ||
371 | repo.enable-commit-graph:: | 372 | repo.enable-commit-graph:: |
372 | A flag which can be used to disable the global setting | 373 | A flag which can be used to disable the global setting |
373 | `enable-commit-graph'. Default value: none. | 374 | `enable-commit-graph'. Default value: none. |
374 | 375 | ||
375 | repo.enable-log-filecount:: | 376 | repo.enable-log-filecount:: |
376 | A flag which can be used to disable the global setting | 377 | A flag which can be used to disable the global setting |
377 | `enable-log-filecount'. Default value: none. | 378 | `enable-log-filecount'. Default value: none. |
378 | 379 | ||
379 | repo.enable-log-linecount:: | 380 | repo.enable-log-linecount:: |
380 | A flag which can be used to disable the global setting | 381 | A flag which can be used to disable the global setting |
381 | `enable-log-linecount'. Default value: none. | 382 | `enable-log-linecount'. Default value: none. |
382 | 383 | ||
383 | repo.enable-remote-branches:: | 384 | repo.enable-remote-branches:: |
384 | Flag which, when set to "1", will make cgit display remote branches | 385 | Flag which, when set to "1", will make cgit display remote branches |
385 | in the summary and refs views. Default value: <enable-remote-branches>. | 386 | in the summary and refs views. Default value: <enable-remote-branches>. |
386 | 387 | ||
387 | repo.enable-subject-links:: | 388 | repo.enable-subject-links:: |
388 | A flag which can be used to override the global setting | 389 | A flag which can be used to override the global setting |
389 | `enable-subject-links'. Default value: none. | 390 | `enable-subject-links'. Default value: none. |
390 | 391 | ||
391 | repo.logo:: | 392 | repo.logo:: |
392 | Url which specifies the source of an image which will be used as a logo | 393 | Url which specifies the source of an image which will be used as a logo |
393 | on this repo's pages. Default value: global logo. | 394 | on this repo's pages. Default value: global logo. |
394 | 395 | ||
395 | repo.logo-link:: | 396 | repo.logo-link:: |
396 | Url loaded when clicking on the cgit logo image. If unspecified the | 397 | Url loaded when clicking on the cgit logo image. If unspecified the |
397 | calculated url of the repository index page will be used. Default | 398 | calculated url of the repository index page will be used. Default |
398 | value: global logo-link. | 399 | value: global logo-link. |
399 | 400 | ||
400 | repo.max-stats:: | 401 | repo.max-stats:: |
401 | Override the default maximum statistics period. Valid values are equal | 402 | Override the default maximum statistics period. Valid values are equal |
402 | to the values specified for the global "max-stats" setting. Default | 403 | to the values specified for the global "max-stats" setting. Default |
403 | value: none. | 404 | value: none. |
404 | 405 | ||
405 | repo.name:: | 406 | repo.name:: |
406 | The value to show as repository name. Default value: <repo.url>. | 407 | The value to show as repository name. Default value: <repo.url>. |
407 | 408 | ||
408 | repo.owner:: | 409 | repo.owner:: |
409 | A value used to identify the owner of the repository. Default value: | 410 | A value used to identify the owner of the repository. Default value: |
410 | none. | 411 | none. |
411 | 412 | ||
412 | repo.path:: | 413 | repo.path:: |
413 | An absolute path to the repository directory. For non-bare repositories | 414 | An absolute path to the repository directory. For non-bare repositories |
414 | this is the .git-directory. Default value: none. | 415 | this is the .git-directory. Default value: none. |
415 | 416 | ||
416 | repo.readme:: | 417 | repo.readme:: |
417 | A path (relative to <repo.path>) which specifies a file to include | 418 | A path (relative to <repo.path>) which specifies a file to include |
418 | verbatim as the "About" page for this repo. You may also specify a | 419 | verbatim as the "About" page for this repo. You may also specify a |
419 | git refspec by head or by hash by prepending the refspec followed by | 420 | git refspec by head or by hash by prepending the refspec followed by |
420 | a colon. For example, "master:docs/readme.mkd" Default value: <readme>. | 421 | a colon. For example, "master:docs/readme.mkd" Default value: <readme>. |
421 | 422 | ||
422 | repo.snapshots:: | 423 | repo.snapshots:: |
423 | A mask of allowed snapshot-formats for this repo, restricted by the | 424 | A mask of allowed snapshot-formats for this repo, restricted by the |
424 | "snapshots" global setting. Default value: <snapshots>. | 425 | "snapshots" global setting. Default value: <snapshots>. |
425 | 426 | ||
426 | repo.section:: | 427 | repo.section:: |
427 | Override the current section name for this repository. Default value: | 428 | Override the current section name for this repository. Default value: |
428 | none. | 429 | none. |
429 | 430 | ||
430 | repo.source-filter:: | 431 | repo.source-filter:: |
431 | Override the default source-filter. Default value: none. See also: | 432 | Override the default source-filter. Default value: none. See also: |
432 | "enable-filter-overrides". | 433 | "enable-filter-overrides". |
433 | 434 | ||
434 | repo.url:: | 435 | repo.url:: |
435 | The relative url used to access the repository. This must be the first | 436 | The relative url used to access the repository. This must be the first |
436 | setting specified for each repo. Default value: none. | 437 | setting specified for each repo. Default value: none. |
437 | 438 | ||
438 | 439 | ||
439 | REPOSITORY-SPECIFIC CGITRC FILE | 440 | REPOSITORY-SPECIFIC CGITRC FILE |
440 | ------------------------------- | 441 | ------------------------------- |
441 | When the option "scan-path" is used to auto-discover git repositories, cgit | 442 | When the option "scan-path" is used to auto-discover git repositories, cgit |
442 | will try to parse the file "cgitrc" within any found repository. Such a | 443 | will try to parse the file "cgitrc" within any found repository. Such a |
443 | repo-specific config file may contain any of the repo-specific options | 444 | repo-specific config file may contain any of the repo-specific options |
444 | described above, except "repo.url" and "repo.path". Additionally, the "filter" | 445 | described above, except "repo.url" and "repo.path". Additionally, the "filter" |
445 | options are only acknowledged in repo-specific config files when | 446 | options are only acknowledged in repo-specific config files when |
446 | "enable-filter-overrides" is set to "1". | 447 | "enable-filter-overrides" is set to "1". |
447 | 448 | ||
448 | Note: the "repo." prefix is dropped from the option names in repo-specific | 449 | Note: the "repo." prefix is dropped from the option names in repo-specific |
449 | config files, e.g. "repo.desc" becomes "desc". | 450 | config files, e.g. "repo.desc" becomes "desc". |
450 | 451 | ||
451 | 452 | ||
452 | EXAMPLE CGITRC FILE | 453 | EXAMPLE CGITRC FILE |
453 | ------------------- | 454 | ------------------- |
454 | 455 | ||
455 | .... | 456 | .... |
456 | # Enable caching of up to 1000 output entriess | 457 | # Enable caching of up to 1000 output entriess |
457 | cache-size=1000 | 458 | cache-size=1000 |
458 | 459 | ||
459 | 460 | ||
460 | # Specify some default clone prefixes | 461 | # Specify some default clone prefixes |
461 | clone-prefix=git://example.com ssh://example.com/pub/git http://example.com/git | 462 | clone-prefix=git://example.com ssh://example.com/pub/git http://example.com/git |
462 | 463 | ||
463 | # Specify the css url | 464 | # Specify the css url |
464 | css=/css/cgit.css | 465 | css=/css/cgit.css |
465 | 466 | ||
466 | 467 | ||
467 | # Show extra links for each repository on the index page | 468 | # Show extra links for each repository on the index page |
468 | enable-index-links=1 | 469 | enable-index-links=1 |
469 | 470 | ||
470 | 471 | ||
471 | # Enable ASCII art commit history graph on the log pages | 472 | # Enable ASCII art commit history graph on the log pages |
472 | enable-commit-graph=1 | 473 | enable-commit-graph=1 |
473 | 474 | ||
474 | 475 | ||
475 | # Show number of affected files per commit on the log pages | 476 | # Show number of affected files per commit on the log pages |
476 | enable-log-filecount=1 | 477 | enable-log-filecount=1 |
477 | 478 | ||
478 | 479 | ||
479 | # Show number of added/removed lines per commit on the log pages | 480 | # Show number of added/removed lines per commit on the log pages |
480 | enable-log-linecount=1 | 481 | enable-log-linecount=1 |
481 | 482 | ||
482 | 483 | ||
483 | # Add a cgit favicon | 484 | # Add a cgit favicon |