author | Lars Hjemli <hjemli@gmail.com> | 2010-08-04 01:10:29 (UTC) |
---|---|---|
committer | Lars Hjemli <hjemli@gmail.com> | 2010-08-04 01:10:29 (UTC) |
commit | aec9c245e7eaf444c7ae1851e3eda3b30748950f (patch) (unidiff) | |
tree | 04d5e945781441f2589ae8eb44bee8d5a2b17c2b /cgitrc.5.txt | |
parent | e6c960c7c0f0d2e54b51cc43ef190df3ce52755e (diff) | |
parent | 119397b175874bd606952e93b7249ae4ffb9afbe (diff) | |
download | cgit-aec9c245e7eaf444c7ae1851e3eda3b30748950f.zip cgit-aec9c245e7eaf444c7ae1851e3eda3b30748950f.tar.gz cgit-aec9c245e7eaf444c7ae1851e3eda3b30748950f.tar.bz2 |
Merge branch 'jd/gitolite'
-rw-r--r-- | cgitrc.5.txt | 21 |
1 files changed, 20 insertions, 1 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt index a853522..5d77973 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt | |||
@@ -86,24 +86,29 @@ css:: | |||
86 | Url which specifies the css document to include in all cgit pages. | 86 | Url which specifies the css document to include in all cgit pages. |
87 | Default value: "/cgit.css". | 87 | Default value: "/cgit.css". |
88 | 88 | ||
89 | embedded:: | 89 | embedded:: |
90 | Flag which, when set to "1", will make cgit generate a html fragment | 90 | Flag which, when set to "1", will make cgit generate a html fragment |
91 | suitable for embedding in other html pages. Default value: none. See | 91 | suitable for embedding in other html pages. Default value: none. See |
92 | also: "noheader". | 92 | also: "noheader". |
93 | 93 | ||
94 | enable-filter-overrides:: | 94 | enable-filter-overrides:: |
95 | Flag which, when set to "1", allows all filter settings to be | 95 | Flag which, when set to "1", allows all filter settings to be |
96 | overridden in repository-specific cgitrc files. Default value: none. | 96 | overridden in repository-specific cgitrc files. Default value: none. |
97 | 97 | ||
98 | enable-gitweb-owner:: | ||
99 | If set to "1" and scan-path is enabled, we first check each repository | ||
100 | for the git config value "gitweb.owner" to determine the owner. | ||
101 | Default value: "1". See also: scan-path. | ||
102 | |||
98 | enable-index-links:: | 103 | enable-index-links:: |
99 | Flag which, when set to "1", will make cgit generate extra links for | 104 | Flag which, when set to "1", will make cgit generate extra links for |
100 | each repo in the repository index (specifically, to the "summary", | 105 | each repo in the repository index (specifically, to the "summary", |
101 | "commit" and "tree" pages). Default value: "0". | 106 | "commit" and "tree" pages). Default value: "0". |
102 | 107 | ||
103 | enable-log-filecount:: | 108 | enable-log-filecount:: |
104 | Flag which, when set to "1", will make cgit print the number of | 109 | Flag which, when set to "1", will make cgit print the number of |
105 | modified files for each commit on the repository log page. Default | 110 | modified files for each commit on the repository log page. Default |
106 | value: "0". | 111 | value: "0". |
107 | 112 | ||
108 | enable-log-linecount:: | 113 | enable-log-linecount:: |
109 | Flag which, when set to "1", will make cgit print the number of added | 114 | Flag which, when set to "1", will make cgit print the number of added |
@@ -215,24 +220,34 @@ nocache:: | |||
215 | 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 |
216 | 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 |
217 | value: "0". | 222 | value: "0". |
218 | 223 | ||
219 | noplainemail:: | 224 | noplainemail:: |
220 | 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. |
221 | Default value: "0". | 226 | Default value: "0". |
222 | 227 | ||
223 | noheader:: | 228 | noheader:: |
224 | 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 |
225 | on all pages. Default value: none. See also: "embedded". | 230 | on all pages. Default value: none. See also: "embedded". |
226 | 231 | ||
232 | project-list:: | ||
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 | ||
235 | scan-path. Default value: none. See also: scan-path. | ||
236 | |||
237 | remove-suffix:: | ||
238 | If set to "1" and scan-path is enabled, if any repositories are found | ||
239 | with a suffix of ".git", this suffix will be removed for the url and | ||
240 | name. Default value: "0". See also: scan-path. | ||
241 | |||
227 | renamelimit:: | 242 | renamelimit:: |
228 | Maximum number of files to consider when detecting renames. The value | 243 | Maximum number of files to consider when detecting renames. The value |
229 | "-1" uses the compiletime value in git (for further info, look at | 244 | "-1" uses the compiletime value in git (for further info, look at |
230 | `man git-diff`). Default value: "-1". | 245 | `man git-diff`). Default value: "-1". |
231 | 246 | ||
232 | repo.group:: | 247 | repo.group:: |
233 | Legacy alias for "section". This option is deprecated and will not be | 248 | Legacy alias for "section". This option is deprecated and will not be |
234 | supported in cgit-1.0. | 249 | supported in cgit-1.0. |
235 | 250 | ||
236 | robots:: | 251 | robots:: |
237 | Text used as content for the "robots" meta-tag. Default value: | 252 | Text used as content for the "robots" meta-tag. Default value: |
238 | "index, nofollow". | 253 | "index, nofollow". |
@@ -244,25 +259,28 @@ root-desc:: | |||
244 | root-readme:: | 259 | root-readme:: |
245 | The content of the file specified with this option will be included | 260 | The content of the file specified with this option will be included |
246 | verbatim below the "about" link on the repository index page. Default | 261 | verbatim below the "about" link on the repository index page. Default |
247 | value: none. | 262 | value: none. |
248 | 263 | ||
249 | root-title:: | 264 | root-title:: |
250 | Text printed as heading on the repository index page. Default value: | 265 | Text printed as heading on the repository index page. Default value: |
251 | "Git Repository Browser". | 266 | "Git Repository Browser". |
252 | 267 | ||
253 | scan-path:: | 268 | scan-path:: |
254 | A path which will be scanned for repositories. If caching is enabled, | 269 | A path which will be scanned for repositories. If caching is enabled, |
255 | the result will be cached as a cgitrc include-file in the cache | 270 | the result will be cached as a cgitrc include-file in the cache |
256 | directory. Default value: none. See also: cache-scanrc-ttl. | 271 | directory. If project-list has been defined prior to scan-path, |
272 | scan-path loads only the directories listed in the file pointed to by | ||
273 | project-list. Default value: none. See also: cache-scanrc-ttl, | ||
274 | project-list. | ||
257 | 275 | ||
258 | section:: | 276 | section:: |
259 | The name of the current repository section - all repositories defined | 277 | The name of the current repository section - all repositories defined |
260 | after this option will inherit the current section name. Default value: | 278 | after this option will inherit the current section name. Default value: |
261 | none. | 279 | none. |
262 | 280 | ||
263 | side-by-side-diffs:: | 281 | side-by-side-diffs:: |
264 | If set to "1" shows side-by-side diffs instead of unidiffs per | 282 | If set to "1" shows side-by-side diffs instead of unidiffs per |
265 | default. Default value: "0". | 283 | default. Default value: "0". |
266 | 284 | ||
267 | snapshots:: | 285 | snapshots:: |
268 | Text which specifies the default set of snapshot formats generated by | 286 | Text which specifies the default set of snapshot formats generated by |
@@ -521,12 +539,13 @@ will be included as part of the value. E.g. this line: | |||
521 | 539 | ||
522 | robots=index # allow indexing | 540 | robots=index # allow indexing |
523 | 541 | ||
524 | will generate the following html element: | 542 | will generate the following html element: |
525 | 543 | ||
526 | <meta name='robots' content='index # allow indexing'/> | 544 | <meta name='robots' content='index # allow indexing'/> |
527 | 545 | ||
528 | 546 | ||
529 | 547 | ||
530 | AUTHOR | 548 | AUTHOR |
531 | ------ | 549 | ------ |
532 | Lars Hjemli <hjemli@gmail.com> | 550 | Lars Hjemli <hjemli@gmail.com> |
551 | Jason A. Donenfeld <Jason@zx2c4.com> | ||