-rw-r--r-- | cgitrc.5.txt | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt index 1f7ac1e..a853522 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt | |||
@@ -94,48 +94,54 @@ embedded:: | |||
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:: | 113 | enable-remote-branches:: |
114 | Flag which, when set to "1", will make cgit display 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: | 115 | in the summary and refs views. Default value: "0". See also: |
116 | "repo.enable-remote-branches". | 116 | "repo.enable-remote-branches". |
117 | 117 | ||
118 | enable-subject-links:: | ||
119 | Flag which, when set to "1", will make cgit use the subject of the | ||
120 | parent commit as link text when generating links to parent commits | ||
121 | in commit view. Default value: "0". See also: | ||
122 | "repo.enable-subject-links". | ||
123 | |||
118 | enable-tree-linenumbers:: | 124 | enable-tree-linenumbers:: |
119 | Flag which, when set to "1", will make cgit generate linenumber links | 125 | Flag which, when set to "1", will make cgit generate linenumber links |
120 | for plaintext blobs printed in the tree view. Default value: "1". | 126 | for plaintext blobs printed in the tree view. Default value: "1". |
121 | 127 | ||
122 | favicon:: | 128 | favicon:: |
123 | Url used as link to a shortcut icon for cgit. If specified, it is | 129 | Url used as link to a shortcut icon for cgit. If specified, it is |
124 | suggested to use the value "/favicon.ico" since certain browsers will | 130 | suggested to use the value "/favicon.ico" since certain browsers will |
125 | ignore other values. Default value: none. | 131 | ignore other values. Default value: none. |
126 | 132 | ||
127 | footer:: | 133 | footer:: |
128 | The content of the file specified with this option will be included | 134 | The content of the file specified with this option will be included |
129 | verbatim at the bottom of all pages (i.e. it replaces the standard | 135 | verbatim at the bottom of all pages (i.e. it replaces the standard |
130 | "generated by..." message. Default value: none. | 136 | "generated by..." message. Default value: none. |
131 | 137 | ||
132 | head-include:: | 138 | head-include:: |
133 | The content of the file specified with this option will be included | 139 | The content of the file specified with this option will be included |
134 | verbatim in the html HEAD section on all pages. Default value: none. | 140 | verbatim in the html HEAD section on all pages. Default value: none. |
135 | 141 | ||
136 | header:: | 142 | header:: |
137 | The content of the file specified with this option will be included | 143 | The content of the file specified with this option will be included |
138 | verbatim at the top of all pages. Default value: none. | 144 | verbatim at the top of all pages. Default value: none. |
139 | 145 | ||
140 | include:: | 146 | include:: |
141 | Name of a configfile to include before the rest of the current config- | 147 | Name of a configfile to include before the rest of the current config- |
@@ -145,48 +151,52 @@ index-header:: | |||
145 | The content of the file specified with this option will be included | 151 | The content of the file specified with this option will be included |
146 | verbatim above the repository index. This setting is deprecated, and | 152 | verbatim above the repository index. This setting is deprecated, and |
147 | will not be supported by cgit-1.0 (use root-readme instead). Default | 153 | will not be supported by cgit-1.0 (use root-readme instead). Default |
148 | value: none. | 154 | value: none. |
149 | 155 | ||
150 | index-info:: | 156 | index-info:: |
151 | The content of the file specified with this option will be included | 157 | The content of the file specified with this option will be included |
152 | verbatim below the heading on the repository index page. This setting | 158 | verbatim below the heading on the repository index page. This setting |
153 | is deprecated, and will not be supported by cgit-1.0 (use root-desc | 159 | is deprecated, and will not be supported by cgit-1.0 (use root-desc |
154 | instead). Default value: none. | 160 | instead). Default value: none. |
155 | 161 | ||
156 | local-time:: | 162 | local-time:: |
157 | Flag which, if set to "1", makes cgit print commit and tag times in the | 163 | Flag which, if set to "1", makes cgit print commit and tag times in the |
158 | servers timezone. Default value: "0". | 164 | servers timezone. Default value: "0". |
159 | 165 | ||
160 | logo:: | 166 | logo:: |
161 | Url which specifies the source of an image which will be used as a logo | 167 | Url which specifies the source of an image which will be used as a logo |
162 | on all cgit pages. Default value: "/cgit.png". | 168 | on all cgit pages. Default value: "/cgit.png". |
163 | 169 | ||
164 | logo-link:: | 170 | logo-link:: |
165 | Url loaded when clicking on the cgit logo image. If unspecified the | 171 | Url loaded when clicking on the cgit logo image. If unspecified the |
166 | calculated url of the repository index page will be used. Default | 172 | calculated url of the repository index page will be used. Default |
167 | value: none. | 173 | value: none. |
168 | 174 | ||
175 | max-atom-items:: | ||
176 | Specifies the number of items to display in atom feeds view. Default | ||
177 | value: "10". | ||
178 | |||
169 | max-commit-count:: | 179 | max-commit-count:: |
170 | Specifies the number of entries to list per page in "log" view. Default | 180 | Specifies the number of entries to list per page in "log" view. Default |
171 | value: "50". | 181 | value: "50". |
172 | 182 | ||
173 | max-message-length:: | 183 | max-message-length:: |
174 | Specifies the maximum number of commit message characters to display in | 184 | Specifies the maximum number of commit message characters to display in |
175 | "log" view. Default value: "80". | 185 | "log" view. Default value: "80". |
176 | 186 | ||
177 | max-repo-count:: | 187 | max-repo-count:: |
178 | Specifies the number of entries to list per page on therepository | 188 | Specifies the number of entries to list per page on therepository |
179 | index page. Default value: "50". | 189 | index page. Default value: "50". |
180 | 190 | ||
181 | max-repodesc-length:: | 191 | max-repodesc-length:: |
182 | Specifies the maximum number of repo description characters to display | 192 | Specifies the maximum number of repo description characters to display |
183 | on the repository index page. Default value: "80". | 193 | on the repository index page. Default value: "80". |
184 | 194 | ||
185 | max-blob-size:: | 195 | max-blob-size:: |
186 | Specifies the maximum size of a blob to display HTML for in KBytes. | 196 | Specifies the maximum size of a blob to display HTML for in KBytes. |
187 | Default value: "0" (limit disabled). | 197 | Default value: "0" (limit disabled). |
188 | 198 | ||
189 | max-stats:: | 199 | max-stats:: |
190 | Set the default maximum statistics period. Valid values are "week", | 200 | Set the default maximum statistics period. Valid values are "week", |
191 | "month", "quarter" and "year". If unspecified, statistics are | 201 | "month", "quarter" and "year". If unspecified, statistics are |
192 | disabled. Default value: none. See also: "repo.max-stats". | 202 | disabled. Default value: none. See also: "repo.max-stats". |
@@ -300,48 +310,52 @@ repo.clone-url:: | |||
300 | repo.commit-filter:: | 310 | repo.commit-filter:: |
301 | Override the default commit-filter. Default value: none. See also: | 311 | Override the default commit-filter. Default value: none. See also: |
302 | "enable-filter-overrides". | 312 | "enable-filter-overrides". |
303 | 313 | ||
304 | repo.defbranch:: | 314 | repo.defbranch:: |
305 | The name of the default branch for this repository. If no such branch | 315 | The name of the default branch for this repository. If no such branch |
306 | exists in the repository, the first branch name (when sorted) is used | 316 | exists in the repository, the first branch name (when sorted) is used |
307 | as default instead. Default value: "master". | 317 | as default instead. Default value: "master". |
308 | 318 | ||
309 | repo.desc:: | 319 | repo.desc:: |
310 | The value to show as repository description. Default value: none. | 320 | The value to show as repository description. Default value: none. |
311 | 321 | ||
312 | repo.enable-log-filecount:: | 322 | repo.enable-log-filecount:: |
313 | A flag which can be used to disable the global setting | 323 | A flag which can be used to disable the global setting |
314 | `enable-log-filecount'. Default value: none. | 324 | `enable-log-filecount'. Default value: none. |
315 | 325 | ||
316 | repo.enable-log-linecount:: | 326 | repo.enable-log-linecount:: |
317 | A flag which can be used to disable the global setting | 327 | A flag which can be used to disable the global setting |
318 | `enable-log-linecount'. Default value: none. | 328 | `enable-log-linecount'. Default value: none. |
319 | 329 | ||
320 | repo.enable-remote-branches:: | 330 | repo.enable-remote-branches:: |
321 | Flag which, when set to "1", will make cgit display remote branches | 331 | Flag which, when set to "1", will make cgit display remote branches |
322 | in the summary and refs views. Default value: <enable-remote-branches>. | 332 | in the summary and refs views. Default value: <enable-remote-branches>. |
323 | 333 | ||
334 | repo.enable-subject-links:: | ||
335 | A flag which can be used to override the global setting | ||
336 | `enable-subject-links'. Default value: none. | ||
337 | |||
324 | repo.max-stats:: | 338 | repo.max-stats:: |
325 | Override the default maximum statistics period. Valid values are equal | 339 | Override the default maximum statistics period. Valid values are equal |
326 | to the values specified for the global "max-stats" setting. Default | 340 | to the values specified for the global "max-stats" setting. Default |
327 | value: none. | 341 | value: none. |
328 | 342 | ||
329 | repo.name:: | 343 | repo.name:: |
330 | The value to show as repository name. Default value: <repo.url>. | 344 | The value to show as repository name. Default value: <repo.url>. |
331 | 345 | ||
332 | repo.owner:: | 346 | repo.owner:: |
333 | A value used to identify the owner of the repository. Default value: | 347 | A value used to identify the owner of the repository. Default value: |
334 | none. | 348 | none. |
335 | 349 | ||
336 | repo.path:: | 350 | repo.path:: |
337 | An absolute path to the repository directory. For non-bare repositories | 351 | An absolute path to the repository directory. For non-bare repositories |
338 | this is the .git-directory. Default value: none. | 352 | this is the .git-directory. Default value: none. |
339 | 353 | ||
340 | repo.readme:: | 354 | repo.readme:: |
341 | A path (relative to <repo.path>) which specifies a file to include | 355 | A path (relative to <repo.path>) which specifies a file to include |
342 | verbatim as the "About" page for this repo. Default value: none. | 356 | verbatim as the "About" page for this repo. Default value: none. |
343 | 357 | ||
344 | repo.snapshots:: | 358 | repo.snapshots:: |
345 | A mask of allowed snapshot-formats for this repo, restricted by the | 359 | A mask of allowed snapshot-formats for this repo, restricted by the |
346 | "snapshots" global setting. Default value: <snapshots>. | 360 | "snapshots" global setting. Default value: <snapshots>. |
347 | 361 | ||