-rw-r--r-- | cgitrc.5.txt | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt index 70e4c78..d74d9e7 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt | |||
@@ -81,64 +81,69 @@ commit-filter:: | |||
81 | The command will get the message on its STDIN, and the STDOUT from the | 81 | The command will get the message on its STDIN, and the STDOUT from the |
82 | command will be included verbatim as the commit message, i.e. this can | 82 | command will be included verbatim as the commit message, i.e. this can |
83 | be used to implement bugtracker integration. Default value: none. | 83 | be used to implement bugtracker integration. Default value: none. |
84 | 84 | ||
85 | css:: | 85 | 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-index-links:: | 98 | enable-index-links:: |
99 | Flag which, when set to "1", will make cgit generate extra links for | 99 | Flag which, when set to "1", will make cgit generate extra links for |
100 | each repo in the repository index (specifically, to the "summary", | 100 | each repo in the repository index (specifically, to the "summary", |
101 | "commit" and "tree" pages). Default value: "0". | 101 | "commit" and "tree" pages). Default value: "0". |
102 | 102 | ||
103 | enable-log-filecount:: | 103 | enable-log-filecount:: |
104 | Flag which, when set to "1", will make cgit print the number of | 104 | 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 | 105 | modified files for each commit on the repository log page. Default |
106 | value: "0". | 106 | value: "0". |
107 | 107 | ||
108 | enable-log-linecount:: | 108 | enable-log-linecount:: |
109 | Flag which, when set to "1", will make cgit print the number of added | 109 | Flag which, when set to "1", will make cgit print the number of added |
110 | and removed lines for each commit on the repository log page. Default | 110 | and removed lines for each commit on the repository log page. Default |
111 | value: "0". | 111 | value: "0". |
112 | 112 | ||
113 | enable-remote-branches:: | ||
114 | Flag which, when set to "1", will make cgit display remote branches | ||
115 | in the summary and refs views. Default value: "0". See also: | ||
116 | "repo.enable-remote-branches". | ||
117 | |||
113 | enable-tree-linenumbers:: | 118 | enable-tree-linenumbers:: |
114 | Flag which, when set to "1", will make cgit generate linenumber links | 119 | Flag which, when set to "1", will make cgit generate linenumber links |
115 | for plaintext blobs printed in the tree view. Default value: "1". | 120 | for plaintext blobs printed in the tree view. Default value: "1". |
116 | 121 | ||
117 | favicon:: | 122 | favicon:: |
118 | Url used as link to a shortcut icon for cgit. If specified, it is | 123 | Url used as link to a shortcut icon for cgit. If specified, it is |
119 | suggested to use the value "/favicon.ico" since certain browsers will | 124 | suggested to use the value "/favicon.ico" since certain browsers will |
120 | ignore other values. Default value: none. | 125 | ignore other values. Default value: none. |
121 | 126 | ||
122 | footer:: | 127 | footer:: |
123 | The content of the file specified with this option will be included | 128 | The content of the file specified with this option will be included |
124 | verbatim at the bottom of all pages (i.e. it replaces the standard | 129 | verbatim at the bottom of all pages (i.e. it replaces the standard |
125 | "generated by..." message. Default value: none. | 130 | "generated by..." message. Default value: none. |
126 | 131 | ||
127 | head-include:: | 132 | head-include:: |
128 | The content of the file specified with this option will be included | 133 | The content of the file specified with this option will be included |
129 | verbatim in the html HEAD section on all pages. Default value: none. | 134 | verbatim in the html HEAD section on all pages. Default value: none. |
130 | 135 | ||
131 | header:: | 136 | header:: |
132 | The content of the file specified with this option will be included | 137 | The content of the file specified with this option will be included |
133 | verbatim at the top of all pages. Default value: none. | 138 | verbatim at the top of all pages. Default value: none. |
134 | 139 | ||
135 | include:: | 140 | include:: |
136 | Name of a configfile to include before the rest of the current config- | 141 | Name of a configfile to include before the rest of the current config- |
137 | file is parsed. Default value: none. | 142 | file is parsed. Default value: none. |
138 | 143 | ||
139 | index-header:: | 144 | index-header:: |
140 | The content of the file specified with this option will be included | 145 | The content of the file specified with this option will be included |
141 | verbatim above the repository index. This setting is deprecated, and | 146 | verbatim above the repository index. This setting is deprecated, and |
142 | will not be supported by cgit-1.0 (use root-readme instead). Default | 147 | will not be supported by cgit-1.0 (use root-readme instead). Default |
143 | value: none. | 148 | value: none. |
144 | 149 | ||
@@ -283,64 +288,68 @@ virtual-root:: | |||
283 | same kind of virtual urls, so this option will probably be deprecated. | 288 | same kind of virtual urls, so this option will probably be deprecated. |
284 | 289 | ||
285 | REPOSITORY SETTINGS | 290 | REPOSITORY SETTINGS |
286 | ------------------- | 291 | ------------------- |
287 | repo.about-filter:: | 292 | repo.about-filter:: |
288 | Override the default about-filter. Default value: none. See also: | 293 | Override the default about-filter. Default value: none. See also: |
289 | "enable-filter-overrides". | 294 | "enable-filter-overrides". |
290 | 295 | ||
291 | repo.clone-url:: | 296 | repo.clone-url:: |
292 | A list of space-separated urls which can be used to clone this repo. | 297 | A list of space-separated urls which can be used to clone this repo. |
293 | Default value: none. | 298 | Default value: none. |
294 | 299 | ||
295 | repo.commit-filter:: | 300 | repo.commit-filter:: |
296 | Override the default commit-filter. Default value: none. See also: | 301 | Override the default commit-filter. Default value: none. See also: |
297 | "enable-filter-overrides". | 302 | "enable-filter-overrides". |
298 | 303 | ||
299 | repo.defbranch:: | 304 | repo.defbranch:: |
300 | The name of the default branch for this repository. If no such branch | 305 | The name of the default branch for this repository. If no such branch |
301 | exists in the repository, the first branch name (when sorted) is used | 306 | exists in the repository, the first branch name (when sorted) is used |
302 | as default instead. Default value: "master". | 307 | as default instead. Default value: "master". |
303 | 308 | ||
304 | repo.desc:: | 309 | repo.desc:: |
305 | The value to show as repository description. Default value: none. | 310 | The value to show as repository description. Default value: none. |
306 | 311 | ||
307 | repo.enable-log-filecount:: | 312 | repo.enable-log-filecount:: |
308 | A flag which can be used to disable the global setting | 313 | A flag which can be used to disable the global setting |
309 | `enable-log-filecount'. Default value: none. | 314 | `enable-log-filecount'. Default value: none. |
310 | 315 | ||
311 | repo.enable-log-linecount:: | 316 | repo.enable-log-linecount:: |
312 | A flag which can be used to disable the global setting | 317 | A flag which can be used to disable the global setting |
313 | `enable-log-linecount'. Default value: none. | 318 | `enable-log-linecount'. Default value: none. |
314 | 319 | ||
320 | repo.enable-remote-branches:: | ||
321 | Flag which, when set to "1", will make cgit display remote branches | ||
322 | in the summary and refs views. Default value: <enable-remote-branches>. | ||
323 | |||
315 | repo.max-stats:: | 324 | repo.max-stats:: |
316 | Override the default maximum statistics period. Valid values are equal | 325 | Override the default maximum statistics period. Valid values are equal |
317 | to the values specified for the global "max-stats" setting. Default | 326 | to the values specified for the global "max-stats" setting. Default |
318 | value: none. | 327 | value: none. |
319 | 328 | ||
320 | repo.name:: | 329 | repo.name:: |
321 | The value to show as repository name. Default value: <repo.url>. | 330 | The value to show as repository name. Default value: <repo.url>. |
322 | 331 | ||
323 | repo.owner:: | 332 | repo.owner:: |
324 | A value used to identify the owner of the repository. Default value: | 333 | A value used to identify the owner of the repository. Default value: |
325 | none. | 334 | none. |
326 | 335 | ||
327 | repo.path:: | 336 | repo.path:: |
328 | An absolute path to the repository directory. For non-bare repositories | 337 | An absolute path to the repository directory. For non-bare repositories |
329 | this is the .git-directory. Default value: none. | 338 | this is the .git-directory. Default value: none. |
330 | 339 | ||
331 | repo.readme:: | 340 | repo.readme:: |
332 | A path (relative to <repo.path>) which specifies a file to include | 341 | A path (relative to <repo.path>) which specifies a file to include |
333 | verbatim as the "About" page for this repo. Default value: none. | 342 | verbatim as the "About" page for this repo. Default value: none. |
334 | 343 | ||
335 | repo.snapshots:: | 344 | repo.snapshots:: |
336 | A mask of allowed snapshot-formats for this repo, restricted by the | 345 | A mask of allowed snapshot-formats for this repo, restricted by the |
337 | "snapshots" global setting. Default value: <snapshots>. | 346 | "snapshots" global setting. Default value: <snapshots>. |
338 | 347 | ||
339 | repo.section:: | 348 | repo.section:: |
340 | Override the current section name for this repository. Default value: | 349 | Override the current section name for this repository. Default value: |
341 | none. | 350 | none. |
342 | 351 | ||
343 | repo.source-filter:: | 352 | repo.source-filter:: |
344 | Override the default source-filter. Default value: none. See also: | 353 | Override the default source-filter. Default value: none. See also: |
345 | "enable-filter-overrides". | 354 | "enable-filter-overrides". |
346 | 355 | ||