-rw-r--r-- | cgitrc.5.txt | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt index e69140b..70e4c78 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt | |||
@@ -184,128 +184,132 @@ max-blob-size:: | |||
184 | max-stats:: | 184 | max-stats:: |
185 | Set the default maximum statistics period. Valid values are "week", | 185 | Set the default maximum statistics period. Valid values are "week", |
186 | "month", "quarter" and "year". If unspecified, statistics are | 186 | "month", "quarter" and "year". If unspecified, statistics are |
187 | disabled. Default value: none. See also: "repo.max-stats". | 187 | disabled. Default value: none. See also: "repo.max-stats". |
188 | 188 | ||
189 | mimetype.<ext>:: | 189 | mimetype.<ext>:: |
190 | Set the mimetype for the specified filename extension. This is used | 190 | Set the mimetype for the specified filename extension. This is used |
191 | by the `plain` command when returning blob content. | 191 | by the `plain` command when returning blob content. |
192 | 192 | ||
193 | module-link:: | 193 | module-link:: |
194 | Text which will be used as the formatstring for a hyperlink when a | 194 | Text which will be used as the formatstring for a hyperlink when a |
195 | submodule is printed in a directory listing. The arguments for the | 195 | submodule is printed in a directory listing. The arguments for the |
196 | formatstring are the path and SHA1 of the submodule commit. Default | 196 | formatstring are the path and SHA1 of the submodule commit. Default |
197 | value: "./?repo=%s&page=commit&id=%s" | 197 | value: "./?repo=%s&page=commit&id=%s" |
198 | 198 | ||
199 | nocache:: | 199 | nocache:: |
200 | If set to the value "1" caching will be disabled. This settings is | 200 | If set to the value "1" caching will be disabled. This settings is |
201 | deprecated, and will not be honored starting with cgit-1.0. Default | 201 | deprecated, and will not be honored starting with cgit-1.0. Default |
202 | value: "0". | 202 | value: "0". |
203 | 203 | ||
204 | noplainemail:: | 204 | noplainemail:: |
205 | If set to "1" showing full author email adresses will be disabled. | 205 | If set to "1" showing full author email adresses will be disabled. |
206 | Default value: "0". | 206 | Default value: "0". |
207 | 207 | ||
208 | noheader:: | 208 | noheader:: |
209 | Flag which, when set to "1", will make cgit omit the standard header | 209 | Flag which, when set to "1", will make cgit omit the standard header |
210 | on all pages. Default value: none. See also: "embedded". | 210 | on all pages. Default value: none. See also: "embedded". |
211 | 211 | ||
212 | renamelimit:: | 212 | renamelimit:: |
213 | Maximum number of files to consider when detecting renames. The value | 213 | Maximum number of files to consider when detecting renames. The value |
214 | "-1" uses the compiletime value in git (for further info, look at | 214 | "-1" uses the compiletime value in git (for further info, look at |
215 | `man git-diff`). Default value: "-1". | 215 | `man git-diff`). Default value: "-1". |
216 | 216 | ||
217 | repo.group:: | 217 | repo.group:: |
218 | Legacy alias for "section". This option is deprecated and will not be | 218 | Legacy alias for "section". This option is deprecated and will not be |
219 | supported in cgit-1.0. | 219 | supported in cgit-1.0. |
220 | 220 | ||
221 | robots:: | 221 | robots:: |
222 | Text used as content for the "robots" meta-tag. Default value: | 222 | Text used as content for the "robots" meta-tag. Default value: |
223 | "index, nofollow". | 223 | "index, nofollow". |
224 | 224 | ||
225 | root-desc:: | 225 | root-desc:: |
226 | Text printed below the heading on the repository index page. Default | 226 | Text printed below the heading on the repository index page. Default |
227 | value: "a fast webinterface for the git dscm". | 227 | value: "a fast webinterface for the git dscm". |
228 | 228 | ||
229 | root-readme:: | 229 | root-readme:: |
230 | The content of the file specified with this option will be included | 230 | The content of the file specified with this option will be included |
231 | verbatim below the "about" link on the repository index page. Default | 231 | verbatim below the "about" link on the repository index page. Default |
232 | value: none. | 232 | value: none. |
233 | 233 | ||
234 | root-title:: | 234 | root-title:: |
235 | Text printed as heading on the repository index page. Default value: | 235 | Text printed as heading on the repository index page. Default value: |
236 | "Git Repository Browser". | 236 | "Git Repository Browser". |
237 | 237 | ||
238 | scan-path:: | 238 | scan-path:: |
239 | A path which will be scanned for repositories. If caching is enabled, | 239 | A path which will be scanned for repositories. If caching is enabled, |
240 | the result will be cached as a cgitrc include-file in the cache | 240 | the result will be cached as a cgitrc include-file in the cache |
241 | directory. Default value: none. See also: cache-scanrc-ttl. | 241 | directory. Default value: none. See also: cache-scanrc-ttl. |
242 | 242 | ||
243 | section:: | 243 | section:: |
244 | The name of the current repository section - all repositories defined | 244 | The name of the current repository section - all repositories defined |
245 | after this option will inherit the current section name. Default value: | 245 | after this option will inherit the current section name. Default value: |
246 | none. | 246 | none. |
247 | 247 | ||
248 | side-by-side-diffs:: | ||
249 | If set to "1" shows side-by-side diffs instead of unidiffs per | ||
250 | default. Default value: "0". | ||
251 | |||
248 | snapshots:: | 252 | snapshots:: |
249 | Text which specifies the default set of snapshot formats generated by | 253 | Text which specifies the default set of snapshot formats generated by |
250 | cgit. The value is a space-separated list of zero or more of the | 254 | cgit. The value is a space-separated list of zero or more of the |
251 | values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none. | 255 | values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none. |
252 | 256 | ||
253 | source-filter:: | 257 | source-filter:: |
254 | Specifies a command which will be invoked to format plaintext blobs | 258 | Specifies a command which will be invoked to format plaintext blobs |
255 | in the tree view. The command will get the blob content on its STDIN | 259 | in the tree view. The command will get the blob content on its STDIN |
256 | and the name of the blob as its only command line argument. The STDOUT | 260 | and the name of the blob as its only command line argument. The STDOUT |
257 | from the command will be included verbatim as the blob contents, i.e. | 261 | from the command will be included verbatim as the blob contents, i.e. |
258 | this can be used to implement e.g. syntax highlighting. Default value: | 262 | this can be used to implement e.g. syntax highlighting. Default value: |
259 | none. | 263 | none. |
260 | 264 | ||
261 | summary-branches:: | 265 | summary-branches:: |
262 | Specifies the number of branches to display in the repository "summary" | 266 | Specifies the number of branches to display in the repository "summary" |
263 | view. Default value: "10". | 267 | view. Default value: "10". |
264 | 268 | ||
265 | summary-log:: | 269 | summary-log:: |
266 | Specifies the number of log entries to display in the repository | 270 | Specifies the number of log entries to display in the repository |
267 | "summary" view. Default value: "10". | 271 | "summary" view. Default value: "10". |
268 | 272 | ||
269 | summary-tags:: | 273 | summary-tags:: |
270 | Specifies the number of tags to display in the repository "summary" | 274 | Specifies the number of tags to display in the repository "summary" |
271 | view. Default value: "10". | 275 | view. Default value: "10". |
272 | 276 | ||
273 | virtual-root:: | 277 | virtual-root:: |
274 | Url which, if specified, will be used as root for all cgit links. It | 278 | Url which, if specified, will be used as root for all cgit links. It |
275 | will also cause cgit to generate 'virtual urls', i.e. urls like | 279 | will also cause cgit to generate 'virtual urls', i.e. urls like |
276 | '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default | 280 | '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default |
277 | value: none. | 281 | value: none. |
278 | NOTE: cgit has recently learned how to use PATH_INFO to achieve the | 282 | NOTE: cgit has recently learned how to use PATH_INFO to achieve the |
279 | same kind of virtual urls, so this option will probably be deprecated. | 283 | same kind of virtual urls, so this option will probably be deprecated. |
280 | 284 | ||
281 | REPOSITORY SETTINGS | 285 | REPOSITORY SETTINGS |
282 | ------------------- | 286 | ------------------- |
283 | repo.about-filter:: | 287 | repo.about-filter:: |
284 | Override the default about-filter. Default value: none. See also: | 288 | Override the default about-filter. Default value: none. See also: |
285 | "enable-filter-overrides". | 289 | "enable-filter-overrides". |
286 | 290 | ||
287 | repo.clone-url:: | 291 | repo.clone-url:: |
288 | A list of space-separated urls which can be used to clone this repo. | 292 | A list of space-separated urls which can be used to clone this repo. |
289 | Default value: none. | 293 | Default value: none. |
290 | 294 | ||
291 | repo.commit-filter:: | 295 | repo.commit-filter:: |
292 | Override the default commit-filter. Default value: none. See also: | 296 | Override the default commit-filter. Default value: none. See also: |
293 | "enable-filter-overrides". | 297 | "enable-filter-overrides". |
294 | 298 | ||
295 | repo.defbranch:: | 299 | repo.defbranch:: |
296 | The name of the default branch for this repository. If no such branch | 300 | The name of the default branch for this repository. If no such branch |
297 | exists in the repository, the first branch name (when sorted) is used | 301 | exists in the repository, the first branch name (when sorted) is used |
298 | as default instead. Default value: "master". | 302 | as default instead. Default value: "master". |
299 | 303 | ||
300 | repo.desc:: | 304 | repo.desc:: |
301 | The value to show as repository description. Default value: none. | 305 | The value to show as repository description. Default value: none. |
302 | 306 | ||
303 | repo.enable-log-filecount:: | 307 | repo.enable-log-filecount:: |
304 | A flag which can be used to disable the global setting | 308 | A flag which can be used to disable the global setting |
305 | `enable-log-filecount'. Default value: none. | 309 | `enable-log-filecount'. Default value: none. |
306 | 310 | ||
307 | repo.enable-log-linecount:: | 311 | repo.enable-log-linecount:: |
308 | A flag which can be used to disable the global setting | 312 | A flag which can be used to disable the global setting |
309 | `enable-log-linecount'. Default value: none. | 313 | `enable-log-linecount'. Default value: none. |
310 | 314 | ||
311 | repo.max-stats:: | 315 | repo.max-stats:: |