-rw-r--r-- | cgitrc.5.txt | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt index ffb3e0f..d8e4b97 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt | |||
@@ -3,32 +3,39 @@ CGITRC(5) | |||
3 | 3 | ||
4 | 4 | ||
5 | NAME | 5 | NAME |
6 | ---- | 6 | ---- |
7 | cgitrc - runtime configuration for cgit | 7 | cgitrc - runtime configuration for cgit |
8 | 8 | ||
9 | 9 | ||
10 | SYNOPSIS | 10 | SYNOPSIS |
11 | -------- | 11 | -------- |
12 | Cgitrc contains all runtime settings for cgit, including the list of git | 12 | Cgitrc contains all runtime settings for cgit, including the list of git |
13 | repositories, formatted as a line-separated list of NAME=VALUE pairs. Blank | 13 | repositories, formatted as a line-separated list of NAME=VALUE pairs. Blank |
14 | lines, and lines starting with '#', are ignored. | 14 | lines, and lines starting with '#', are ignored. |
15 | 15 | ||
16 | 16 | ||
17 | GLOBAL SETTINGS | 17 | GLOBAL SETTINGS |
18 | --------------- | 18 | --------------- |
19 | about-filter:: | ||
20 | Specifies a command which will be invoked to format the content of | ||
21 | about pages (both top-level and for each repository). The command will | ||
22 | get the content of the about-file on its STDIN, and the STDOUT from the | ||
23 | command will be included verbatim on the about page. Default value: | ||
24 | none. | ||
25 | |||
19 | agefile:: | 26 | agefile:: |
20 | Specifies a path, relative to each repository path, which can be used | 27 | Specifies a path, relative to each repository path, which can be used |
21 | to specify the date and time of the youngest commit in the repository. | 28 | to specify the date and time of the youngest commit in the repository. |
22 | The first line in the file is used as input to the "parse_date" | 29 | The first line in the file is used as input to the "parse_date" |
23 | function in libgit. Recommended timestamp-format is "yyyy-mm-dd | 30 | function in libgit. Recommended timestamp-format is "yyyy-mm-dd |
24 | hh:mm:ss". Default value: "info/web/last-modified". | 31 | hh:mm:ss". Default value: "info/web/last-modified". |
25 | 32 | ||
26 | cache-root:: | 33 | cache-root:: |
27 | Path used to store the cgit cache entries. Default value: | 34 | Path used to store the cgit cache entries. Default value: |
28 | "/var/cache/cgit". | 35 | "/var/cache/cgit". |
29 | 36 | ||
30 | cache-dynamic-ttl:: | 37 | cache-dynamic-ttl:: |
31 | Number which specifies the time-to-live, in minutes, for the cached | 38 | Number which specifies the time-to-live, in minutes, for the cached |
32 | version of repository pages accessed without a fixed SHA1. Default | 39 | version of repository pages accessed without a fixed SHA1. Default |
33 | value: "5". | 40 | value: "5". |
34 | 41 | ||
@@ -221,32 +228,35 @@ summary-log:: | |||
221 | "summary" view. Default value: "10". | 228 | "summary" view. Default value: "10". |
222 | 229 | ||
223 | summary-tags:: | 230 | summary-tags:: |
224 | Specifies the number of tags to display in the repository "summary" | 231 | Specifies the number of tags to display in the repository "summary" |
225 | view. Default value: "10". | 232 | view. Default value: "10". |
226 | 233 | ||
227 | virtual-root:: | 234 | virtual-root:: |
228 | Url which, if specified, will be used as root for all cgit links. It | 235 | Url which, if specified, will be used as root for all cgit links. It |
229 | will also cause cgit to generate 'virtual urls', i.e. urls like | 236 | will also cause cgit to generate 'virtual urls', i.e. urls like |
230 | '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default | 237 | '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default |
231 | value: none. | 238 | value: none. |
232 | NOTE: cgit has recently learned how to use PATH_INFO to achieve the | 239 | NOTE: cgit has recently learned how to use PATH_INFO to achieve the |
233 | same kind of virtual urls, so this option will probably be deprecated. | 240 | same kind of virtual urls, so this option will probably be deprecated. |
234 | 241 | ||
235 | REPOSITORY SETTINGS | 242 | REPOSITORY SETTINGS |
236 | ------------------- | 243 | ------------------- |
244 | repo.about-filter:: | ||
245 | Override the default about-filter. Default value: <about-filter>. | ||
246 | |||
237 | repo.clone-url:: | 247 | repo.clone-url:: |
238 | A list of space-separated urls which can be used to clone this repo. | 248 | A list of space-separated urls which can be used to clone this repo. |
239 | Default value: none. | 249 | Default value: none. |
240 | 250 | ||
241 | repo.commit-filter:: | 251 | repo.commit-filter:: |
242 | Override the default commit-filter. Default value: <commit-filter>. | 252 | Override the default commit-filter. Default value: <commit-filter>. |
243 | 253 | ||
244 | repo.defbranch:: | 254 | repo.defbranch:: |
245 | The name of the default branch for this repository. If no such branch | 255 | The name of the default branch for this repository. If no such branch |
246 | exists in the repository, the first branch name (when sorted) is used | 256 | exists in the repository, the first branch name (when sorted) is used |
247 | as default instead. Default value: "master". | 257 | as default instead. Default value: "master". |
248 | 258 | ||
249 | repo.desc:: | 259 | repo.desc:: |
250 | The value to show as repository description. Default value: none. | 260 | The value to show as repository description. Default value: none. |
251 | 261 | ||
252 | repo.enable-log-filecount:: | 262 | repo.enable-log-filecount:: |