-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 7879f75..683f3b5 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt | |||
@@ -1,182 +1,186 @@ | |||
1 | CGITRC(5) | 1 | CGITRC(5) |
2 | ======== | 2 | ======== |
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 | agefile:: | 19 | agefile:: |
20 | Specifies a path, relative to each repository path, which can be used | 20 | 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. | 21 | 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" | 22 | 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 | 23 | function in libgit. Recommended timestamp-format is "yyyy-mm-dd |
24 | hh:mm:ss". Default value: "info/web/last-modified". | 24 | hh:mm:ss". Default value: "info/web/last-modified". |
25 | 25 | ||
26 | cache-root:: | 26 | cache-root:: |
27 | Path used to store the cgit cache entries. Default value: | 27 | Path used to store the cgit cache entries. Default value: |
28 | "/var/cache/cgit". | 28 | "/var/cache/cgit". |
29 | 29 | ||
30 | cache-dynamic-ttl:: | 30 | cache-dynamic-ttl:: |
31 | Number which specifies the time-to-live, in minutes, for the cached | 31 | Number which specifies the time-to-live, in minutes, for the cached |
32 | version of repository pages accessed without a fixed SHA1. Default | 32 | version of repository pages accessed without a fixed SHA1. Default |
33 | value: "5". | 33 | value: "5". |
34 | 34 | ||
35 | cache-repo-ttl:: | 35 | cache-repo-ttl:: |
36 | Number which specifies the time-to-live, in minutes, for the cached | 36 | Number which specifies the time-to-live, in minutes, for the cached |
37 | version of the repository summary page. Default value: "5". | 37 | version of the repository summary page. Default value: "5". |
38 | 38 | ||
39 | cache-root-ttl:: | 39 | cache-root-ttl:: |
40 | Number which specifies the time-to-live, in minutes, for the cached | 40 | Number which specifies the time-to-live, in minutes, for the cached |
41 | version of the repository index page. Default value: "5". | 41 | version of the repository index page. Default value: "5". |
42 | 42 | ||
43 | cache-size:: | 43 | cache-size:: |
44 | The maximum number of entries in the cgit cache. Default value: "0" | 44 | The maximum number of entries in the cgit cache. Default value: "0" |
45 | (i.e. caching is disabled). | 45 | (i.e. caching is disabled). |
46 | 46 | ||
47 | cache-static-ttl:: | 47 | cache-static-ttl:: |
48 | Number which specifies the time-to-live, in minutes, for the cached | 48 | Number which specifies the time-to-live, in minutes, for the cached |
49 | version of repository pages accessed with a fixed SHA1. Default value: | 49 | version of repository pages accessed with a fixed SHA1. Default value: |
50 | "5". | 50 | "5". |
51 | 51 | ||
52 | clone-prefix:: | 52 | clone-prefix:: |
53 | Space-separated list of common prefixes which, when combined with a | 53 | Space-separated list of common prefixes which, when combined with a |
54 | repository url, generates valid clone urls for the repository. This | 54 | repository url, generates valid clone urls for the repository. This |
55 | setting is only used if `repo.clone-url` is unspecified. Default value: | 55 | setting is only used if `repo.clone-url` is unspecified. Default value: |
56 | none. | 56 | none. |
57 | 57 | ||
58 | css:: | 58 | css:: |
59 | Url which specifies the css document to include in all cgit pages. | 59 | Url which specifies the css document to include in all cgit pages. |
60 | Default value: "/cgit.css". | 60 | Default value: "/cgit.css". |
61 | 61 | ||
62 | enable-index-links:: | 62 | enable-index-links:: |
63 | Flag which, when set to "1", will make cgit generate extra links for | 63 | Flag which, when set to "1", will make cgit generate extra links for |
64 | each repo in the repository index (specifically, to the "summary", | 64 | each repo in the repository index (specifically, to the "summary", |
65 | "commit" and "tree" pages). Default value: "0". | 65 | "commit" and "tree" pages). Default value: "0". |
66 | 66 | ||
67 | enable-log-filecount:: | 67 | enable-log-filecount:: |
68 | Flag which, when set to "1", will make cgit print the number of | 68 | Flag which, when set to "1", will make cgit print the number of |
69 | modified files for each commit on the repository log page. Default | 69 | modified files for each commit on the repository log page. Default |
70 | value: "0". | 70 | value: "0". |
71 | 71 | ||
72 | enable-log-linecount:: | 72 | enable-log-linecount:: |
73 | Flag which, when set to "1", will make cgit print the number of added | 73 | Flag which, when set to "1", will make cgit print the number of added |
74 | and removed lines for each commit on the repository log page. Default | 74 | and removed lines for each commit on the repository log page. Default |
75 | value: "0". | 75 | value: "0". |
76 | 76 | ||
77 | favicon:: | 77 | favicon:: |
78 | Url used as link to a shortcut icon for cgit. If specified, it is | 78 | Url used as link to a shortcut icon for cgit. If specified, it is |
79 | suggested to use the value "/favicon.ico" since certain browsers will | 79 | suggested to use the value "/favicon.ico" since certain browsers will |
80 | ignore other values. Default value: none. | 80 | ignore other values. Default value: none. |
81 | 81 | ||
82 | footer:: | 82 | footer:: |
83 | The content of the file specified with this option will be included | 83 | The content of the file specified with this option will be included |
84 | verbatim at the bottom of all pages (i.e. it replaces the standard | 84 | verbatim at the bottom of all pages (i.e. it replaces the standard |
85 | "generated by..." message. Default value: none. | 85 | "generated by..." message. Default value: none. |
86 | 86 | ||
87 | head-include:: | ||
88 | The content of the file specified with this option will be included | ||
89 | verbatim in the html HEAD section on all pages. Default value: none. | ||
90 | |||
87 | header:: | 91 | header:: |
88 | The content of the file specified with this option will be included | 92 | The content of the file specified with this option will be included |
89 | verbatim at the top of all pages. Default value: none. | 93 | verbatim at the top of all pages. Default value: none. |
90 | 94 | ||
91 | include:: | 95 | include:: |
92 | Name of a configfile to include before the rest of the current config- | 96 | Name of a configfile to include before the rest of the current config- |
93 | file is parsed. Default value: none. | 97 | file is parsed. Default value: none. |
94 | 98 | ||
95 | index-header:: | 99 | index-header:: |
96 | The content of the file specified with this option will be included | 100 | The content of the file specified with this option will be included |
97 | verbatim above the repository index. This setting is deprecated, and | 101 | verbatim above the repository index. This setting is deprecated, and |
98 | will not be supported by cgit-1.0 (use root-readme instead). Default | 102 | will not be supported by cgit-1.0 (use root-readme instead). Default |
99 | value: none. | 103 | value: none. |
100 | 104 | ||
101 | index-info:: | 105 | index-info:: |
102 | The content of the file specified with this option will be included | 106 | The content of the file specified with this option will be included |
103 | verbatim below the heading on the repository index page. This setting | 107 | verbatim below the heading on the repository index page. This setting |
104 | is deprecated, and will not be supported by cgit-1.0 (use root-desc | 108 | is deprecated, and will not be supported by cgit-1.0 (use root-desc |
105 | instead). Default value: none. | 109 | instead). Default value: none. |
106 | 110 | ||
107 | local-time:: | 111 | local-time:: |
108 | Flag which, if set to "1", makes cgit print commit and tag times in the | 112 | Flag which, if set to "1", makes cgit print commit and tag times in the |
109 | servers timezone. Default value: "0". | 113 | servers timezone. Default value: "0". |
110 | 114 | ||
111 | logo:: | 115 | logo:: |
112 | Url which specifies the source of an image which will be used as a logo | 116 | Url which specifies the source of an image which will be used as a logo |
113 | on all cgit pages. | 117 | on all cgit pages. |
114 | 118 | ||
115 | logo-link:: | 119 | logo-link:: |
116 | Url loaded when clicking on the cgit logo image. If unspecified the | 120 | Url loaded when clicking on the cgit logo image. If unspecified the |
117 | calculated url of the repository index page will be used. Default | 121 | calculated url of the repository index page will be used. Default |
118 | value: none. | 122 | value: none. |
119 | 123 | ||
120 | max-commit-count:: | 124 | max-commit-count:: |
121 | Specifies the number of entries to list per page in "log" view. Default | 125 | Specifies the number of entries to list per page in "log" view. Default |
122 | value: "50". | 126 | value: "50". |
123 | 127 | ||
124 | max-message-length:: | 128 | max-message-length:: |
125 | Specifies the maximum number of commit message characters to display in | 129 | Specifies the maximum number of commit message characters to display in |
126 | "log" view. Default value: "80". | 130 | "log" view. Default value: "80". |
127 | 131 | ||
128 | max-repo-count:: | 132 | max-repo-count:: |
129 | Specifies the number of entries to list per page on therepository | 133 | Specifies the number of entries to list per page on therepository |
130 | index page. Default value: "50". | 134 | index page. Default value: "50". |
131 | 135 | ||
132 | max-repodesc-length:: | 136 | max-repodesc-length:: |
133 | Specifies the maximum number of repo description characters to display | 137 | Specifies the maximum number of repo description characters to display |
134 | on the repository index page. Default value: "80". | 138 | on the repository index page. Default value: "80". |
135 | 139 | ||
136 | max-stats:: | 140 | max-stats:: |
137 | Set the default maximum statistics period. Valid values are "week", | 141 | Set the default maximum statistics period. Valid values are "week", |
138 | "month", "quarter" and "year". If unspecified, statistics are | 142 | "month", "quarter" and "year". If unspecified, statistics are |
139 | disabled. Default value: none. See also: "repo.max-stats". | 143 | disabled. Default value: none. See also: "repo.max-stats". |
140 | 144 | ||
141 | module-link:: | 145 | module-link:: |
142 | Text which will be used as the formatstring for a hyperlink when a | 146 | Text which will be used as the formatstring for a hyperlink when a |
143 | submodule is printed in a directory listing. The arguments for the | 147 | submodule is printed in a directory listing. The arguments for the |
144 | formatstring are the path and SHA1 of the submodule commit. Default | 148 | formatstring are the path and SHA1 of the submodule commit. Default |
145 | value: "./?repo=%s&page=commit&id=%s" | 149 | value: "./?repo=%s&page=commit&id=%s" |
146 | 150 | ||
147 | nocache:: | 151 | nocache:: |
148 | If set to the value "1" caching will be disabled. This settings is | 152 | If set to the value "1" caching will be disabled. This settings is |
149 | deprecated, and will not be honored starting with cgit-1.0. Default | 153 | deprecated, and will not be honored starting with cgit-1.0. Default |
150 | value: "0". | 154 | value: "0". |
151 | 155 | ||
152 | renamelimit:: | 156 | renamelimit:: |
153 | Maximum number of files to consider when detecting renames. The value | 157 | Maximum number of files to consider when detecting renames. The value |
154 | "-1" uses the compiletime value in git (for further info, look at | 158 | "-1" uses the compiletime value in git (for further info, look at |
155 | `man git-diff`). Default value: "-1". | 159 | `man git-diff`). Default value: "-1". |
156 | 160 | ||
157 | repo.group:: | 161 | repo.group:: |
158 | A value for the current repository group, which all repositories | 162 | A value for the current repository group, which all repositories |
159 | specified after this setting will inherit. Default value: none. | 163 | specified after this setting will inherit. Default value: none. |
160 | 164 | ||
161 | robots:: | 165 | robots:: |
162 | Text used as content for the "robots" meta-tag. Default value: | 166 | Text used as content for the "robots" meta-tag. Default value: |
163 | "index, nofollow". | 167 | "index, nofollow". |
164 | 168 | ||
165 | root-desc:: | 169 | root-desc:: |
166 | Text printed below the heading on the repository index page. Default | 170 | Text printed below the heading on the repository index page. Default |
167 | value: "a fast webinterface for the git dscm". | 171 | value: "a fast webinterface for the git dscm". |
168 | 172 | ||
169 | root-readme:: | 173 | root-readme:: |
170 | The content of the file specified with this option will be included | 174 | The content of the file specified with this option will be included |
171 | verbatim below the "about" link on the repository index page. Default | 175 | verbatim below the "about" link on the repository index page. Default |
172 | value: none. | 176 | value: none. |
173 | 177 | ||
174 | root-title:: | 178 | root-title:: |
175 | Text printed as heading on the repository index page. Default value: | 179 | Text printed as heading on the repository index page. Default value: |
176 | "Git Repository Browser". | 180 | "Git Repository Browser". |
177 | 181 | ||
178 | snapshots:: | 182 | snapshots:: |
179 | Text which specifies the default (and allowed) set of snapshot formats | 183 | Text which specifies the default (and allowed) set of snapshot formats |
180 | supported by cgit. The value is a space-separated list of zero or more | 184 | supported by cgit. The value is a space-separated list of zero or more |
181 | of the following values: | 185 | of the following values: |
182 | "tar" uncompressed tar-file | 186 | "tar" uncompressed tar-file |