-rw-r--r-- | cgitrc.5.txt | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt index 8e51ca5..1dc3cce 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt | |||
@@ -224,96 +224,104 @@ nocache:: | |||
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-hidden-path:: | ||
273 | If set to "1" and scan-path is enabled, scan-path will recurse into | ||
274 | directories whose name starts with a period ('.'). Otherwise, | ||
275 | scan-path will stay away from such directories (considered as | ||
276 | "hidden"). Note that this does not apply to the ".git" directory in | ||
277 | non-bare repos. This must be defined prior to scan-path. | ||
278 | Default value: 0. See also: scan-path. | ||
279 | |||
272 | scan-path:: | 280 | scan-path:: |
273 | A path which will be scanned for repositories. If caching is enabled, | 281 | 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 | 282 | 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, | 283 | 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 | 284 | scan-path loads only the directories listed in the file pointed to by |
277 | project-list. Default value: none. See also: cache-scanrc-ttl, | 285 | project-list. Default value: none. See also: cache-scanrc-ttl, |
278 | project-list. | 286 | project-list. |
279 | 287 | ||
280 | section:: | 288 | section:: |
281 | The name of the current repository section - all repositories defined | 289 | The name of the current repository section - all repositories defined |
282 | after this option will inherit the current section name. Default value: | 290 | after this option will inherit the current section name. Default value: |
283 | none. | 291 | none. |
284 | 292 | ||
285 | section-from-path:: | 293 | section-from-path:: |
286 | A number which, if specified before scan-path, specifies how many | 294 | 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. | 295 | 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 | 296 | If negative, cgit will discard the specified number of path elements |
289 | above the repo directory. Default value: 0. | 297 | above the repo directory. Default value: 0. |
290 | 298 | ||
291 | side-by-side-diffs:: | 299 | side-by-side-diffs:: |
292 | If set to "1" shows side-by-side diffs instead of unidiffs per | 300 | If set to "1" shows side-by-side diffs instead of unidiffs per |
293 | default. Default value: "0". | 301 | default. Default value: "0". |
294 | 302 | ||
295 | snapshots:: | 303 | snapshots:: |
296 | Text which specifies the default set of snapshot formats generated by | 304 | Text which specifies the default set of snapshot formats generated by |
297 | cgit. The value is a space-separated list of zero or more of the | 305 | cgit. The value is a space-separated list of zero or more of the |
298 | values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none. | 306 | values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none. |
299 | 307 | ||
300 | source-filter:: | 308 | source-filter:: |
301 | Specifies a command which will be invoked to format plaintext blobs | 309 | Specifies a command which will be invoked to format plaintext blobs |
302 | in the tree view. The command will get the blob content on its STDIN | 310 | in the tree view. The command will get the blob content on its STDIN |
303 | and the name of the blob as its only command line argument. The STDOUT | 311 | and the name of the blob as its only command line argument. The STDOUT |
304 | from the command will be included verbatim as the blob contents, i.e. | 312 | from the command will be included verbatim as the blob contents, i.e. |
305 | this can be used to implement e.g. syntax highlighting. Default value: | 313 | this can be used to implement e.g. syntax highlighting. Default value: |
306 | none. | 314 | none. |
307 | 315 | ||
308 | summary-branches:: | 316 | summary-branches:: |
309 | Specifies the number of branches to display in the repository "summary" | 317 | Specifies the number of branches to display in the repository "summary" |
310 | view. Default value: "10". | 318 | view. Default value: "10". |
311 | 319 | ||
312 | summary-log:: | 320 | summary-log:: |
313 | Specifies the number of log entries to display in the repository | 321 | Specifies the number of log entries to display in the repository |
314 | "summary" view. Default value: "10". | 322 | "summary" view. Default value: "10". |
315 | 323 | ||
316 | summary-tags:: | 324 | summary-tags:: |
317 | Specifies the number of tags to display in the repository "summary" | 325 | Specifies the number of tags to display in the repository "summary" |
318 | view. Default value: "10". | 326 | view. Default value: "10". |
319 | 327 | ||