author | Aaron Griffin <agriffin@datalogics.com> | 2010-02-05 00:08:16 (UTC) |
---|---|---|
committer | Lars Hjemli <hjemli@gmail.com> | 2010-03-22 22:46:00 (UTC) |
commit | 80476b0d2873eb212fad38487fd6189bd6629cbe (patch) (unidiff) | |
tree | bdacb5527659ebb8296e95dfbe3ea5f74fe3a9ac /cgitrc.5.txt | |
parent | 65ced7c00907af7e8bd5d239a4fa854a84535520 (diff) | |
download | cgit-80476b0d2873eb212fad38487fd6189bd6629cbe.zip cgit-80476b0d2873eb212fad38487fd6189bd6629cbe.tar.gz cgit-80476b0d2873eb212fad38487fd6189bd6629cbe.tar.bz2 |
Add 'max-atom-items' config variable
This allows one to specify the items in the RSS feeds
Signed-off-by: Aaron Griffin <agriffin@datalogics.com>
Signed-off-by: Lars Hjemli <hjemli@gmail.com>
-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 d74d9e7..6cdfd03 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt | |||
@@ -41,256 +41,260 @@ agefile:: | |||
41 | hh:mm:ss". Default value: "info/web/last-modified". | 41 | hh:mm:ss". Default value: "info/web/last-modified". |
42 | 42 | ||
43 | cache-root:: | 43 | cache-root:: |
44 | Path used to store the cgit cache entries. Default value: | 44 | Path used to store the cgit cache entries. Default value: |
45 | "/var/cache/cgit". | 45 | "/var/cache/cgit". |
46 | 46 | ||
47 | cache-dynamic-ttl:: | 47 | cache-dynamic-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 without a fixed SHA1. Default | 49 | version of repository pages accessed without a fixed SHA1. Default |
50 | value: "5". | 50 | value: "5". |
51 | 51 | ||
52 | cache-repo-ttl:: | 52 | cache-repo-ttl:: |
53 | Number which specifies the time-to-live, in minutes, for the cached | 53 | Number which specifies the time-to-live, in minutes, for the cached |
54 | version of the repository summary page. Default value: "5". | 54 | version of the repository summary page. Default value: "5". |
55 | 55 | ||
56 | cache-root-ttl:: | 56 | cache-root-ttl:: |
57 | Number which specifies the time-to-live, in minutes, for the cached | 57 | Number which specifies the time-to-live, in minutes, for the cached |
58 | version of the repository index page. Default value: "5". | 58 | version of the repository index page. Default value: "5". |
59 | 59 | ||
60 | cache-scanrc-ttl:: | 60 | cache-scanrc-ttl:: |
61 | Number which specifies the time-to-live, in minutes, for the result | 61 | Number which specifies the time-to-live, in minutes, for the result |
62 | of scanning a path for git repositories. Default value: "15". | 62 | of scanning a path for git repositories. Default value: "15". |
63 | 63 | ||
64 | cache-size:: | 64 | cache-size:: |
65 | The maximum number of entries in the cgit cache. Default value: "0" | 65 | The maximum number of entries in the cgit cache. Default value: "0" |
66 | (i.e. caching is disabled). | 66 | (i.e. caching is disabled). |
67 | 67 | ||
68 | cache-static-ttl:: | 68 | cache-static-ttl:: |
69 | Number which specifies the time-to-live, in minutes, for the cached | 69 | Number which specifies the time-to-live, in minutes, for the cached |
70 | version of repository pages accessed with a fixed SHA1. Default value: | 70 | version of repository pages accessed with a fixed SHA1. Default value: |
71 | "5". | 71 | "5". |
72 | 72 | ||
73 | clone-prefix:: | 73 | clone-prefix:: |
74 | Space-separated list of common prefixes which, when combined with a | 74 | Space-separated list of common prefixes which, when combined with a |
75 | repository url, generates valid clone urls for the repository. This | 75 | repository url, generates valid clone urls for the repository. This |
76 | setting is only used if `repo.clone-url` is unspecified. Default value: | 76 | setting is only used if `repo.clone-url` is unspecified. Default value: |
77 | none. | 77 | none. |
78 | 78 | ||
79 | commit-filter:: | 79 | commit-filter:: |
80 | Specifies a command which will be invoked to format commit messages. | 80 | Specifies a command which will be invoked to format commit messages. |
81 | The command will get the message on its STDIN, and the STDOUT from the | 81 | The command will get the message on its STDIN, and the STDOUT from the |
82 | command will be included verbatim as the commit message, i.e. this can | 82 | command will be included verbatim as the commit message, i.e. this can |
83 | be used to implement bugtracker integration. Default value: none. | 83 | be used to implement bugtracker integration. Default value: none. |
84 | 84 | ||
85 | css:: | 85 | css:: |
86 | Url which specifies the css document to include in all cgit pages. | 86 | Url which specifies the css document to include in all cgit pages. |
87 | Default value: "/cgit.css". | 87 | Default value: "/cgit.css". |
88 | 88 | ||
89 | embedded:: | 89 | embedded:: |
90 | Flag which, when set to "1", will make cgit generate a html fragment | 90 | Flag which, when set to "1", will make cgit generate a html fragment |
91 | suitable for embedding in other html pages. Default value: none. See | 91 | suitable for embedding in other html pages. Default value: none. See |
92 | also: "noheader". | 92 | also: "noheader". |
93 | 93 | ||
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-tree-linenumbers:: | 118 | enable-tree-linenumbers:: |
119 | Flag which, when set to "1", will make cgit generate linenumber links | 119 | Flag which, when set to "1", will make cgit generate linenumber links |
120 | for plaintext blobs printed in the tree view. Default value: "1". | 120 | for plaintext blobs printed in the tree view. Default value: "1". |
121 | 121 | ||
122 | favicon:: | 122 | favicon:: |
123 | Url used as link to a shortcut icon for cgit. If specified, it is | 123 | 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 | 124 | suggested to use the value "/favicon.ico" since certain browsers will |
125 | ignore other values. Default value: none. | 125 | ignore other values. Default value: none. |
126 | 126 | ||
127 | footer:: | 127 | footer:: |
128 | The content of the file specified with this option will be included | 128 | 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 | 129 | verbatim at the bottom of all pages (i.e. it replaces the standard |
130 | "generated by..." message. Default value: none. | 130 | "generated by..." message. Default value: none. |
131 | 131 | ||
132 | head-include:: | 132 | head-include:: |
133 | The content of the file specified with this option will be included | 133 | 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. | 134 | verbatim in the html HEAD section on all pages. Default value: none. |
135 | 135 | ||
136 | header:: | 136 | header:: |
137 | The content of the file specified with this option will be included | 137 | The content of the file specified with this option will be included |
138 | verbatim at the top of all pages. Default value: none. | 138 | verbatim at the top of all pages. Default value: none. |
139 | 139 | ||
140 | include:: | 140 | include:: |
141 | Name of a configfile to include before the rest of the current config- | 141 | Name of a configfile to include before the rest of the current config- |
142 | file is parsed. Default value: none. | 142 | file is parsed. Default value: none. |
143 | 143 | ||
144 | index-header:: | 144 | index-header:: |
145 | The content of the file specified with this option will be included | 145 | The content of the file specified with this option will be included |
146 | verbatim above the repository index. This setting is deprecated, and | 146 | verbatim above the repository index. This setting is deprecated, and |
147 | will not be supported by cgit-1.0 (use root-readme instead). Default | 147 | will not be supported by cgit-1.0 (use root-readme instead). Default |
148 | value: none. | 148 | value: none. |
149 | 149 | ||
150 | index-info:: | 150 | index-info:: |
151 | 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 |
152 | verbatim below the heading on the repository index page. This setting | 152 | 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 | 153 | is deprecated, and will not be supported by cgit-1.0 (use root-desc |
154 | instead). Default value: none. | 154 | instead). Default value: none. |
155 | 155 | ||
156 | local-time:: | 156 | local-time:: |
157 | Flag which, if set to "1", makes cgit print commit and tag times in the | 157 | Flag which, if set to "1", makes cgit print commit and tag times in the |
158 | servers timezone. Default value: "0". | 158 | servers timezone. Default value: "0". |
159 | 159 | ||
160 | logo:: | 160 | logo:: |
161 | Url which specifies the source of an image which will be used as a logo | 161 | Url which specifies the source of an image which will be used as a logo |
162 | on all cgit pages. Default value: "/cgit.png". | 162 | on all cgit pages. Default value: "/cgit.png". |
163 | 163 | ||
164 | logo-link:: | 164 | logo-link:: |
165 | Url loaded when clicking on the cgit logo image. If unspecified the | 165 | Url loaded when clicking on the cgit logo image. If unspecified the |
166 | calculated url of the repository index page will be used. Default | 166 | calculated url of the repository index page will be used. Default |
167 | value: none. | 167 | value: none. |
168 | 168 | ||
169 | max-atom-items:: | ||
170 | Specifies the number of items to display in atom feeds view. Default | ||
171 | value: "10". | ||
172 | |||
169 | max-commit-count:: | 173 | max-commit-count:: |
170 | Specifies the number of entries to list per page in "log" view. Default | 174 | Specifies the number of entries to list per page in "log" view. Default |
171 | value: "50". | 175 | value: "50". |
172 | 176 | ||
173 | max-message-length:: | 177 | max-message-length:: |
174 | Specifies the maximum number of commit message characters to display in | 178 | Specifies the maximum number of commit message characters to display in |
175 | "log" view. Default value: "80". | 179 | "log" view. Default value: "80". |
176 | 180 | ||
177 | max-repo-count:: | 181 | max-repo-count:: |
178 | Specifies the number of entries to list per page on therepository | 182 | Specifies the number of entries to list per page on therepository |
179 | index page. Default value: "50". | 183 | index page. Default value: "50". |
180 | 184 | ||
181 | max-repodesc-length:: | 185 | max-repodesc-length:: |
182 | Specifies the maximum number of repo description characters to display | 186 | Specifies the maximum number of repo description characters to display |
183 | on the repository index page. Default value: "80". | 187 | on the repository index page. Default value: "80". |
184 | 188 | ||
185 | max-blob-size:: | 189 | max-blob-size:: |
186 | Specifies the maximum size of a blob to display HTML for in KBytes. | 190 | Specifies the maximum size of a blob to display HTML for in KBytes. |
187 | Default value: "0" (limit disabled). | 191 | Default value: "0" (limit disabled). |
188 | 192 | ||
189 | max-stats:: | 193 | max-stats:: |
190 | Set the default maximum statistics period. Valid values are "week", | 194 | Set the default maximum statistics period. Valid values are "week", |
191 | "month", "quarter" and "year". If unspecified, statistics are | 195 | "month", "quarter" and "year". If unspecified, statistics are |
192 | disabled. Default value: none. See also: "repo.max-stats". | 196 | disabled. Default value: none. See also: "repo.max-stats". |
193 | 197 | ||
194 | mimetype.<ext>:: | 198 | mimetype.<ext>:: |
195 | Set the mimetype for the specified filename extension. This is used | 199 | Set the mimetype for the specified filename extension. This is used |
196 | by the `plain` command when returning blob content. | 200 | by the `plain` command when returning blob content. |
197 | 201 | ||
198 | module-link:: | 202 | module-link:: |
199 | Text which will be used as the formatstring for a hyperlink when a | 203 | Text which will be used as the formatstring for a hyperlink when a |
200 | submodule is printed in a directory listing. The arguments for the | 204 | submodule is printed in a directory listing. The arguments for the |
201 | formatstring are the path and SHA1 of the submodule commit. Default | 205 | formatstring are the path and SHA1 of the submodule commit. Default |
202 | value: "./?repo=%s&page=commit&id=%s" | 206 | value: "./?repo=%s&page=commit&id=%s" |
203 | 207 | ||
204 | nocache:: | 208 | nocache:: |
205 | If set to the value "1" caching will be disabled. This settings is | 209 | If set to the value "1" caching will be disabled. This settings is |
206 | deprecated, and will not be honored starting with cgit-1.0. Default | 210 | deprecated, and will not be honored starting with cgit-1.0. Default |
207 | value: "0". | 211 | value: "0". |
208 | 212 | ||
209 | noplainemail:: | 213 | noplainemail:: |
210 | If set to "1" showing full author email adresses will be disabled. | 214 | If set to "1" showing full author email adresses will be disabled. |
211 | Default value: "0". | 215 | Default value: "0". |
212 | 216 | ||
213 | noheader:: | 217 | noheader:: |
214 | Flag which, when set to "1", will make cgit omit the standard header | 218 | Flag which, when set to "1", will make cgit omit the standard header |
215 | on all pages. Default value: none. See also: "embedded". | 219 | on all pages. Default value: none. See also: "embedded". |
216 | 220 | ||
217 | renamelimit:: | 221 | renamelimit:: |
218 | Maximum number of files to consider when detecting renames. The value | 222 | Maximum number of files to consider when detecting renames. The value |
219 | "-1" uses the compiletime value in git (for further info, look at | 223 | "-1" uses the compiletime value in git (for further info, look at |
220 | `man git-diff`). Default value: "-1". | 224 | `man git-diff`). Default value: "-1". |
221 | 225 | ||
222 | repo.group:: | 226 | repo.group:: |
223 | Legacy alias for "section". This option is deprecated and will not be | 227 | Legacy alias for "section". This option is deprecated and will not be |
224 | supported in cgit-1.0. | 228 | supported in cgit-1.0. |
225 | 229 | ||
226 | robots:: | 230 | robots:: |
227 | Text used as content for the "robots" meta-tag. Default value: | 231 | Text used as content for the "robots" meta-tag. Default value: |
228 | "index, nofollow". | 232 | "index, nofollow". |
229 | 233 | ||
230 | root-desc:: | 234 | root-desc:: |
231 | Text printed below the heading on the repository index page. Default | 235 | Text printed below the heading on the repository index page. Default |
232 | value: "a fast webinterface for the git dscm". | 236 | value: "a fast webinterface for the git dscm". |
233 | 237 | ||
234 | root-readme:: | 238 | root-readme:: |
235 | The content of the file specified with this option will be included | 239 | The content of the file specified with this option will be included |
236 | verbatim below the "about" link on the repository index page. Default | 240 | verbatim below the "about" link on the repository index page. Default |
237 | value: none. | 241 | value: none. |
238 | 242 | ||
239 | root-title:: | 243 | root-title:: |
240 | Text printed as heading on the repository index page. Default value: | 244 | Text printed as heading on the repository index page. Default value: |
241 | "Git Repository Browser". | 245 | "Git Repository Browser". |
242 | 246 | ||
243 | scan-path:: | 247 | scan-path:: |
244 | A path which will be scanned for repositories. If caching is enabled, | 248 | A path which will be scanned for repositories. If caching is enabled, |
245 | the result will be cached as a cgitrc include-file in the cache | 249 | the result will be cached as a cgitrc include-file in the cache |
246 | directory. Default value: none. See also: cache-scanrc-ttl. | 250 | directory. Default value: none. See also: cache-scanrc-ttl. |
247 | 251 | ||
248 | section:: | 252 | section:: |
249 | The name of the current repository section - all repositories defined | 253 | The name of the current repository section - all repositories defined |
250 | after this option will inherit the current section name. Default value: | 254 | after this option will inherit the current section name. Default value: |
251 | none. | 255 | none. |
252 | 256 | ||
253 | side-by-side-diffs:: | 257 | side-by-side-diffs:: |
254 | If set to "1" shows side-by-side diffs instead of unidiffs per | 258 | If set to "1" shows side-by-side diffs instead of unidiffs per |
255 | default. Default value: "0". | 259 | default. Default value: "0". |
256 | 260 | ||
257 | snapshots:: | 261 | snapshots:: |
258 | Text which specifies the default set of snapshot formats generated by | 262 | Text which specifies the default set of snapshot formats generated by |
259 | cgit. The value is a space-separated list of zero or more of the | 263 | cgit. The value is a space-separated list of zero or more of the |
260 | values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none. | 264 | values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none. |
261 | 265 | ||
262 | source-filter:: | 266 | source-filter:: |
263 | Specifies a command which will be invoked to format plaintext blobs | 267 | Specifies a command which will be invoked to format plaintext blobs |
264 | in the tree view. The command will get the blob content on its STDIN | 268 | in the tree view. The command will get the blob content on its STDIN |
265 | and the name of the blob as its only command line argument. The STDOUT | 269 | and the name of the blob as its only command line argument. The STDOUT |
266 | from the command will be included verbatim as the blob contents, i.e. | 270 | from the command will be included verbatim as the blob contents, i.e. |
267 | this can be used to implement e.g. syntax highlighting. Default value: | 271 | this can be used to implement e.g. syntax highlighting. Default value: |
268 | none. | 272 | none. |
269 | 273 | ||
270 | summary-branches:: | 274 | summary-branches:: |
271 | Specifies the number of branches to display in the repository "summary" | 275 | Specifies the number of branches to display in the repository "summary" |
272 | view. Default value: "10". | 276 | view. Default value: "10". |
273 | 277 | ||
274 | summary-log:: | 278 | summary-log:: |
275 | Specifies the number of log entries to display in the repository | 279 | Specifies the number of log entries to display in the repository |
276 | "summary" view. Default value: "10". | 280 | "summary" view. Default value: "10". |
277 | 281 | ||
278 | summary-tags:: | 282 | summary-tags:: |
279 | Specifies the number of tags to display in the repository "summary" | 283 | Specifies the number of tags to display in the repository "summary" |
280 | view. Default value: "10". | 284 | view. Default value: "10". |
281 | 285 | ||
282 | virtual-root:: | 286 | virtual-root:: |
283 | Url which, if specified, will be used as root for all cgit links. It | 287 | Url which, if specified, will be used as root for all cgit links. It |
284 | will also cause cgit to generate 'virtual urls', i.e. urls like | 288 | will also cause cgit to generate 'virtual urls', i.e. urls like |
285 | '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default | 289 | '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default |
286 | value: none. | 290 | value: none. |
287 | NOTE: cgit has recently learned how to use PATH_INFO to achieve the | 291 | NOTE: cgit has recently learned how to use PATH_INFO to achieve the |
288 | same kind of virtual urls, so this option will probably be deprecated. | 292 | same kind of virtual urls, so this option will probably be deprecated. |
289 | 293 | ||
290 | REPOSITORY SETTINGS | 294 | REPOSITORY SETTINGS |
291 | ------------------- | 295 | ------------------- |
292 | repo.about-filter:: | 296 | repo.about-filter:: |
293 | Override the default about-filter. Default value: none. See also: | 297 | Override the default about-filter. Default value: none. See also: |
294 | "enable-filter-overrides". | 298 | "enable-filter-overrides". |
295 | 299 | ||
296 | repo.clone-url:: | 300 | repo.clone-url:: |