author | Lars Hjemli <hjemli@gmail.com> | 2010-09-19 16:46:17 (UTC) |
---|---|---|
committer | Lars Hjemli <hjemli@gmail.com> | 2010-09-19 16:46:17 (UTC) |
commit | 536c7a1eb201b44b9266babe087cb6f2b75e4a7f (patch) (unidiff) | |
tree | 899ecd47f770b1909d107b0f1c777e8b032b25fc /cgitrc.5.txt | |
parent | e76a1ea427792aaa331cdec70d7d4ff1fb3422e0 (diff) | |
parent | 797110e39d5d433638c82cf27d584ed9b8b93bb7 (diff) | |
download | cgit-536c7a1eb201b44b9266babe087cb6f2b75e4a7f.zip cgit-536c7a1eb201b44b9266babe087cb6f2b75e4a7f.tar.gz cgit-536c7a1eb201b44b9266babe087cb6f2b75e4a7f.tar.bz2 |
Merge branch 'lh/section-from-path'
Conflicts:
scan-tree.c
-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 187031a..ce78d41 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt | |||
@@ -189,192 +189,198 @@ max-message-length:: | |||
189 | Specifies the maximum number of commit message characters to display in | 189 | Specifies the maximum number of commit message characters to display in |
190 | "log" view. Default value: "80". | 190 | "log" view. Default value: "80". |
191 | 191 | ||
192 | max-repo-count:: | 192 | max-repo-count:: |
193 | Specifies the number of entries to list per page on therepository | 193 | Specifies the number of entries to list per page on therepository |
194 | index page. Default value: "50". | 194 | index page. Default value: "50". |
195 | 195 | ||
196 | max-repodesc-length:: | 196 | max-repodesc-length:: |
197 | Specifies the maximum number of repo description characters to display | 197 | Specifies the maximum number of repo description characters to display |
198 | on the repository index page. Default value: "80". | 198 | on the repository index page. Default value: "80". |
199 | 199 | ||
200 | max-blob-size:: | 200 | max-blob-size:: |
201 | Specifies the maximum size of a blob to display HTML for in KBytes. | 201 | Specifies the maximum size of a blob to display HTML for in KBytes. |
202 | Default value: "0" (limit disabled). | 202 | Default value: "0" (limit disabled). |
203 | 203 | ||
204 | max-stats:: | 204 | max-stats:: |
205 | Set the default maximum statistics period. Valid values are "week", | 205 | Set the default maximum statistics period. Valid values are "week", |
206 | "month", "quarter" and "year". If unspecified, statistics are | 206 | "month", "quarter" and "year". If unspecified, statistics are |
207 | disabled. Default value: none. See also: "repo.max-stats". | 207 | disabled. Default value: none. See also: "repo.max-stats". |
208 | 208 | ||
209 | mimetype.<ext>:: | 209 | mimetype.<ext>:: |
210 | Set the mimetype for the specified filename extension. This is used | 210 | Set the mimetype for the specified filename extension. This is used |
211 | by the `plain` command when returning blob content. | 211 | by the `plain` command when returning blob content. |
212 | 212 | ||
213 | module-link:: | 213 | module-link:: |
214 | Text which will be used as the formatstring for a hyperlink when a | 214 | Text which will be used as the formatstring for a hyperlink when a |
215 | submodule is printed in a directory listing. The arguments for the | 215 | submodule is printed in a directory listing. The arguments for the |
216 | formatstring are the path and SHA1 of the submodule commit. Default | 216 | formatstring are the path and SHA1 of the submodule commit. Default |
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 | readme:: | 237 | readme:: |
238 | Text which will be used as default value for "repo.readme". Default | 238 | Text which will be used as default value for "repo.readme". Default |
239 | value: none. | 239 | value: none. |
240 | 240 | ||
241 | remove-suffix:: | 241 | remove-suffix:: |
242 | If set to "1" and scan-path is enabled, if any repositories are found | 242 | If set to "1" and scan-path is enabled, if any repositories are found |
243 | with a suffix of ".git", this suffix will be removed for the url and | 243 | with a suffix of ".git", this suffix will be removed for the url and |
244 | name. Default value: "0". See also: scan-path. | 244 | name. Default value: "0". See also: scan-path. |
245 | 245 | ||
246 | renamelimit:: | 246 | renamelimit:: |
247 | Maximum number of files to consider when detecting renames. The value | 247 | Maximum number of files to consider when detecting renames. The value |
248 | "-1" uses the compiletime value in git (for further info, look at | 248 | "-1" uses the compiletime value in git (for further info, look at |
249 | `man git-diff`). Default value: "-1". | 249 | `man git-diff`). Default value: "-1". |
250 | 250 | ||
251 | repo.group:: | 251 | repo.group:: |
252 | Legacy alias for "section". This option is deprecated and will not be | 252 | Legacy alias for "section". This option is deprecated and will not be |
253 | supported in cgit-1.0. | 253 | supported in cgit-1.0. |
254 | 254 | ||
255 | robots:: | 255 | robots:: |
256 | Text used as content for the "robots" meta-tag. Default value: | 256 | Text used as content for the "robots" meta-tag. Default value: |
257 | "index, nofollow". | 257 | "index, nofollow". |
258 | 258 | ||
259 | root-desc:: | 259 | root-desc:: |
260 | Text printed below the heading on the repository index page. Default | 260 | Text printed below the heading on the repository index page. Default |
261 | value: "a fast webinterface for the git dscm". | 261 | value: "a fast webinterface for the git dscm". |
262 | 262 | ||
263 | root-readme:: | 263 | root-readme:: |
264 | The content of the file specified with this option will be included | 264 | The content of the file specified with this option will be included |
265 | verbatim below the "about" link on the repository index page. Default | 265 | verbatim below the "about" link on the repository index page. Default |
266 | value: none. | 266 | value: none. |
267 | 267 | ||
268 | root-title:: | 268 | root-title:: |
269 | Text printed as heading on the repository index page. Default value: | 269 | Text printed as heading on the repository index page. Default value: |
270 | "Git Repository Browser". | 270 | "Git Repository Browser". |
271 | 271 | ||
272 | scan-path:: | 272 | scan-path:: |
273 | A path which will be scanned for repositories. If caching is enabled, | 273 | A path which will be scanned for repositories. If caching is enabled, |
274 | the result will be cached as a cgitrc include-file in the cache | 274 | the result will be cached as a cgitrc include-file in the cache |
275 | directory. If project-list has been defined prior to scan-path, | 275 | directory. If project-list has been defined prior to scan-path, |
276 | scan-path loads only the directories listed in the file pointed to by | 276 | scan-path loads only the directories listed in the file pointed to by |
277 | project-list. Default value: none. See also: cache-scanrc-ttl, | 277 | project-list. Default value: none. See also: cache-scanrc-ttl, |
278 | project-list. | 278 | project-list. |
279 | 279 | ||
280 | section:: | 280 | section:: |
281 | The name of the current repository section - all repositories defined | 281 | The name of the current repository section - all repositories defined |
282 | after this option will inherit the current section name. Default value: | 282 | after this option will inherit the current section name. Default value: |
283 | none. | 283 | none. |
284 | 284 | ||
285 | section-from-path:: | ||
286 | A number which, if specified before scan-path, specifies how many | ||
287 | path elements from each repo path to use as a default section name. | ||
288 | If negative, cgit will discard the specified number of path elements | ||
289 | above the repo directory. Default value: 0. | ||
290 | |||
285 | side-by-side-diffs:: | 291 | side-by-side-diffs:: |
286 | If set to "1" shows side-by-side diffs instead of unidiffs per | 292 | If set to "1" shows side-by-side diffs instead of unidiffs per |
287 | default. Default value: "0". | 293 | default. Default value: "0". |
288 | 294 | ||
289 | snapshots:: | 295 | snapshots:: |
290 | Text which specifies the default set of snapshot formats generated by | 296 | Text which specifies the default set of snapshot formats generated by |
291 | cgit. The value is a space-separated list of zero or more of the | 297 | cgit. The value is a space-separated list of zero or more of the |
292 | values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none. | 298 | values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none. |
293 | 299 | ||
294 | source-filter:: | 300 | source-filter:: |
295 | Specifies a command which will be invoked to format plaintext blobs | 301 | Specifies a command which will be invoked to format plaintext blobs |
296 | in the tree view. The command will get the blob content on its STDIN | 302 | in the tree view. The command will get the blob content on its STDIN |
297 | and the name of the blob as its only command line argument. The STDOUT | 303 | and the name of the blob as its only command line argument. The STDOUT |
298 | from the command will be included verbatim as the blob contents, i.e. | 304 | from the command will be included verbatim as the blob contents, i.e. |
299 | this can be used to implement e.g. syntax highlighting. Default value: | 305 | this can be used to implement e.g. syntax highlighting. Default value: |
300 | none. | 306 | none. |
301 | 307 | ||
302 | summary-branches:: | 308 | summary-branches:: |
303 | Specifies the number of branches to display in the repository "summary" | 309 | Specifies the number of branches to display in the repository "summary" |
304 | view. Default value: "10". | 310 | view. Default value: "10". |
305 | 311 | ||
306 | summary-log:: | 312 | summary-log:: |
307 | Specifies the number of log entries to display in the repository | 313 | Specifies the number of log entries to display in the repository |
308 | "summary" view. Default value: "10". | 314 | "summary" view. Default value: "10". |
309 | 315 | ||
310 | summary-tags:: | 316 | summary-tags:: |
311 | Specifies the number of tags to display in the repository "summary" | 317 | Specifies the number of tags to display in the repository "summary" |
312 | view. Default value: "10". | 318 | view. Default value: "10". |
313 | 319 | ||
314 | virtual-root:: | 320 | virtual-root:: |
315 | Url which, if specified, will be used as root for all cgit links. It | 321 | Url which, if specified, will be used as root for all cgit links. It |
316 | will also cause cgit to generate 'virtual urls', i.e. urls like | 322 | will also cause cgit to generate 'virtual urls', i.e. urls like |
317 | '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default | 323 | '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default |
318 | value: none. | 324 | value: none. |
319 | NOTE: cgit has recently learned how to use PATH_INFO to achieve the | 325 | NOTE: cgit has recently learned how to use PATH_INFO to achieve the |
320 | same kind of virtual urls, so this option will probably be deprecated. | 326 | same kind of virtual urls, so this option will probably be deprecated. |
321 | 327 | ||
322 | REPOSITORY SETTINGS | 328 | REPOSITORY SETTINGS |
323 | ------------------- | 329 | ------------------- |
324 | repo.about-filter:: | 330 | repo.about-filter:: |
325 | Override the default about-filter. Default value: none. See also: | 331 | Override the default about-filter. Default value: none. See also: |
326 | "enable-filter-overrides". | 332 | "enable-filter-overrides". |
327 | 333 | ||
328 | repo.clone-url:: | 334 | repo.clone-url:: |
329 | A list of space-separated urls which can be used to clone this repo. | 335 | A list of space-separated urls which can be used to clone this repo. |
330 | Default value: none. | 336 | Default value: none. |
331 | 337 | ||
332 | repo.commit-filter:: | 338 | repo.commit-filter:: |
333 | Override the default commit-filter. Default value: none. See also: | 339 | Override the default commit-filter. Default value: none. See also: |
334 | "enable-filter-overrides". | 340 | "enable-filter-overrides". |
335 | 341 | ||
336 | repo.defbranch:: | 342 | repo.defbranch:: |
337 | The name of the default branch for this repository. If no such branch | 343 | The name of the default branch for this repository. If no such branch |
338 | exists in the repository, the first branch name (when sorted) is used | 344 | exists in the repository, the first branch name (when sorted) is used |
339 | as default instead. Default value: "master". | 345 | as default instead. Default value: "master". |
340 | 346 | ||
341 | repo.desc:: | 347 | repo.desc:: |
342 | The value to show as repository description. Default value: none. | 348 | The value to show as repository description. Default value: none. |
343 | 349 | ||
344 | repo.enable-log-filecount:: | 350 | repo.enable-log-filecount:: |
345 | A flag which can be used to disable the global setting | 351 | A flag which can be used to disable the global setting |
346 | `enable-log-filecount'. Default value: none. | 352 | `enable-log-filecount'. Default value: none. |
347 | 353 | ||
348 | repo.enable-log-linecount:: | 354 | repo.enable-log-linecount:: |
349 | A flag which can be used to disable the global setting | 355 | A flag which can be used to disable the global setting |
350 | `enable-log-linecount'. Default value: none. | 356 | `enable-log-linecount'. Default value: none. |
351 | 357 | ||
352 | repo.enable-remote-branches:: | 358 | repo.enable-remote-branches:: |
353 | Flag which, when set to "1", will make cgit display remote branches | 359 | Flag which, when set to "1", will make cgit display remote branches |
354 | in the summary and refs views. Default value: <enable-remote-branches>. | 360 | in the summary and refs views. Default value: <enable-remote-branches>. |
355 | 361 | ||
356 | repo.enable-subject-links:: | 362 | repo.enable-subject-links:: |
357 | A flag which can be used to override the global setting | 363 | A flag which can be used to override the global setting |
358 | `enable-subject-links'. Default value: none. | 364 | `enable-subject-links'. Default value: none. |
359 | 365 | ||
360 | repo.max-stats:: | 366 | repo.max-stats:: |
361 | Override the default maximum statistics period. Valid values are equal | 367 | Override the default maximum statistics period. Valid values are equal |
362 | to the values specified for the global "max-stats" setting. Default | 368 | to the values specified for the global "max-stats" setting. Default |
363 | value: none. | 369 | value: none. |
364 | 370 | ||
365 | repo.name:: | 371 | repo.name:: |
366 | The value to show as repository name. Default value: <repo.url>. | 372 | The value to show as repository name. Default value: <repo.url>. |
367 | 373 | ||
368 | repo.owner:: | 374 | repo.owner:: |
369 | A value used to identify the owner of the repository. Default value: | 375 | A value used to identify the owner of the repository. Default value: |
370 | none. | 376 | none. |
371 | 377 | ||
372 | repo.path:: | 378 | repo.path:: |
373 | An absolute path to the repository directory. For non-bare repositories | 379 | An absolute path to the repository directory. For non-bare repositories |
374 | this is the .git-directory. Default value: none. | 380 | this is the .git-directory. Default value: none. |
375 | 381 | ||
376 | repo.readme:: | 382 | repo.readme:: |
377 | A path (relative to <repo.path>) which specifies a file to include | 383 | A path (relative to <repo.path>) which specifies a file to include |
378 | verbatim as the "About" page for this repo. You may also specify a | 384 | verbatim as the "About" page for this repo. You may also specify a |
379 | git refspec by head or by hash by prepending the refspec followed by | 385 | git refspec by head or by hash by prepending the refspec followed by |
380 | a colon. For example, "master:docs/readme.mkd" Default value: <readme>. | 386 | a colon. For example, "master:docs/readme.mkd" Default value: <readme>. |