author | Lars Hjemli <hjemli@gmail.com> | 2009-08-24 06:00:37 (UTC) |
---|---|---|
committer | Lars Hjemli <hjemli@gmail.com> | 2009-08-24 06:00:37 (UTC) |
commit | b44c40ea720aee9ba4412e192877e9632a70a259 (patch) (unidiff) | |
tree | 12ee7b595c12454792ee54fb29da6a198839153b | |
parent | 6445a3ad0987ba66eef555c9caa3fc378f99ee22 (diff) | |
download | cgit-b44c40ea720aee9ba4412e192877e9632a70a259.zip cgit-b44c40ea720aee9ba4412e192877e9632a70a259.tar.gz cgit-b44c40ea720aee9ba4412e192877e9632a70a259.tar.bz2 |
cgitrc.5.txt: fix description and markup for 'snapshots' option
Signed-off-by: Lars Hjemli <hjemli@gmail.com>
-rw-r--r-- | cgitrc.5.txt | 11 |
1 files changed, 3 insertions, 8 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt index 3c35b02..0d18290 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt | |||
@@ -92,264 +92,259 @@ enable-index-links:: | |||
92 | enable-log-filecount:: | 92 | enable-log-filecount:: |
93 | Flag which, when set to "1", will make cgit print the number of | 93 | Flag which, when set to "1", will make cgit print the number of |
94 | modified files for each commit on the repository log page. Default | 94 | modified files for each commit on the repository log page. Default |
95 | value: "0". | 95 | value: "0". |
96 | 96 | ||
97 | enable-log-linecount:: | 97 | enable-log-linecount:: |
98 | Flag which, when set to "1", will make cgit print the number of added | 98 | Flag which, when set to "1", will make cgit print the number of added |
99 | and removed lines for each commit on the repository log page. Default | 99 | and removed lines for each commit on the repository log page. Default |
100 | value: "0". | 100 | value: "0". |
101 | 101 | ||
102 | favicon:: | 102 | favicon:: |
103 | Url used as link to a shortcut icon for cgit. If specified, it is | 103 | Url used as link to a shortcut icon for cgit. If specified, it is |
104 | suggested to use the value "/favicon.ico" since certain browsers will | 104 | suggested to use the value "/favicon.ico" since certain browsers will |
105 | ignore other values. Default value: none. | 105 | ignore other values. Default value: none. |
106 | 106 | ||
107 | footer:: | 107 | footer:: |
108 | The content of the file specified with this option will be included | 108 | The content of the file specified with this option will be included |
109 | verbatim at the bottom of all pages (i.e. it replaces the standard | 109 | verbatim at the bottom of all pages (i.e. it replaces the standard |
110 | "generated by..." message. Default value: none. | 110 | "generated by..." message. Default value: none. |
111 | 111 | ||
112 | head-include:: | 112 | head-include:: |
113 | The content of the file specified with this option will be included | 113 | The content of the file specified with this option will be included |
114 | verbatim in the html HEAD section on all pages. Default value: none. | 114 | verbatim in the html HEAD section on all pages. Default value: none. |
115 | 115 | ||
116 | header:: | 116 | header:: |
117 | The content of the file specified with this option will be included | 117 | The content of the file specified with this option will be included |
118 | verbatim at the top of all pages. Default value: none. | 118 | verbatim at the top of all pages. Default value: none. |
119 | 119 | ||
120 | include:: | 120 | include:: |
121 | Name of a configfile to include before the rest of the current config- | 121 | Name of a configfile to include before the rest of the current config- |
122 | file is parsed. Default value: none. | 122 | file is parsed. Default value: none. |
123 | 123 | ||
124 | index-header:: | 124 | index-header:: |
125 | The content of the file specified with this option will be included | 125 | The content of the file specified with this option will be included |
126 | verbatim above the repository index. This setting is deprecated, and | 126 | verbatim above the repository index. This setting is deprecated, and |
127 | will not be supported by cgit-1.0 (use root-readme instead). Default | 127 | will not be supported by cgit-1.0 (use root-readme instead). Default |
128 | value: none. | 128 | value: none. |
129 | 129 | ||
130 | index-info:: | 130 | index-info:: |
131 | The content of the file specified with this option will be included | 131 | The content of the file specified with this option will be included |
132 | verbatim below the heading on the repository index page. This setting | 132 | verbatim below the heading on the repository index page. This setting |
133 | is deprecated, and will not be supported by cgit-1.0 (use root-desc | 133 | is deprecated, and will not be supported by cgit-1.0 (use root-desc |
134 | instead). Default value: none. | 134 | instead). Default value: none. |
135 | 135 | ||
136 | local-time:: | 136 | local-time:: |
137 | Flag which, if set to "1", makes cgit print commit and tag times in the | 137 | Flag which, if set to "1", makes cgit print commit and tag times in the |
138 | servers timezone. Default value: "0". | 138 | servers timezone. Default value: "0". |
139 | 139 | ||
140 | logo:: | 140 | logo:: |
141 | Url which specifies the source of an image which will be used as a logo | 141 | Url which specifies the source of an image which will be used as a logo |
142 | on all cgit pages. Default value: "/cgit.png". | 142 | on all cgit pages. Default value: "/cgit.png". |
143 | 143 | ||
144 | logo-link:: | 144 | logo-link:: |
145 | Url loaded when clicking on the cgit logo image. If unspecified the | 145 | Url loaded when clicking on the cgit logo image. If unspecified the |
146 | calculated url of the repository index page will be used. Default | 146 | calculated url of the repository index page will be used. Default |
147 | value: none. | 147 | value: none. |
148 | 148 | ||
149 | max-commit-count:: | 149 | max-commit-count:: |
150 | Specifies the number of entries to list per page in "log" view. Default | 150 | Specifies the number of entries to list per page in "log" view. Default |
151 | value: "50". | 151 | value: "50". |
152 | 152 | ||
153 | max-message-length:: | 153 | max-message-length:: |
154 | Specifies the maximum number of commit message characters to display in | 154 | Specifies the maximum number of commit message characters to display in |
155 | "log" view. Default value: "80". | 155 | "log" view. Default value: "80". |
156 | 156 | ||
157 | max-repo-count:: | 157 | max-repo-count:: |
158 | Specifies the number of entries to list per page on therepository | 158 | Specifies the number of entries to list per page on therepository |
159 | index page. Default value: "50". | 159 | index page. Default value: "50". |
160 | 160 | ||
161 | max-repodesc-length:: | 161 | max-repodesc-length:: |
162 | Specifies the maximum number of repo description characters to display | 162 | Specifies the maximum number of repo description characters to display |
163 | on the repository index page. Default value: "80". | 163 | on the repository index page. Default value: "80". |
164 | 164 | ||
165 | max-stats:: | 165 | max-stats:: |
166 | Set the default maximum statistics period. Valid values are "week", | 166 | Set the default maximum statistics period. Valid values are "week", |
167 | "month", "quarter" and "year". If unspecified, statistics are | 167 | "month", "quarter" and "year". If unspecified, statistics are |
168 | disabled. Default value: none. See also: "repo.max-stats". | 168 | disabled. Default value: none. See also: "repo.max-stats". |
169 | 169 | ||
170 | mimetype.<ext>:: | 170 | mimetype.<ext>:: |
171 | Set the mimetype for the specified filename extension. This is used | 171 | Set the mimetype for the specified filename extension. This is used |
172 | by the `plain` command when returning blob content. | 172 | by the `plain` command when returning blob content. |
173 | 173 | ||
174 | module-link:: | 174 | module-link:: |
175 | Text which will be used as the formatstring for a hyperlink when a | 175 | Text which will be used as the formatstring for a hyperlink when a |
176 | submodule is printed in a directory listing. The arguments for the | 176 | submodule is printed in a directory listing. The arguments for the |
177 | formatstring are the path and SHA1 of the submodule commit. Default | 177 | formatstring are the path and SHA1 of the submodule commit. Default |
178 | value: "./?repo=%s&page=commit&id=%s" | 178 | value: "./?repo=%s&page=commit&id=%s" |
179 | 179 | ||
180 | nocache:: | 180 | nocache:: |
181 | If set to the value "1" caching will be disabled. This settings is | 181 | If set to the value "1" caching will be disabled. This settings is |
182 | deprecated, and will not be honored starting with cgit-1.0. Default | 182 | deprecated, and will not be honored starting with cgit-1.0. Default |
183 | value: "0". | 183 | value: "0". |
184 | 184 | ||
185 | noplainemail:: | 185 | noplainemail:: |
186 | If set to "1" showing full author email adresses will be disabled. | 186 | If set to "1" showing full author email adresses will be disabled. |
187 | Default value: "0". | 187 | Default value: "0". |
188 | 188 | ||
189 | noheader:: | 189 | noheader:: |
190 | Flag which, when set to "1", will make cgit omit the standard header | 190 | Flag which, when set to "1", will make cgit omit the standard header |
191 | on all pages. Default value: none. See also: "embedded". | 191 | on all pages. Default value: none. See also: "embedded". |
192 | 192 | ||
193 | renamelimit:: | 193 | renamelimit:: |
194 | Maximum number of files to consider when detecting renames. The value | 194 | Maximum number of files to consider when detecting renames. The value |
195 | "-1" uses the compiletime value in git (for further info, look at | 195 | "-1" uses the compiletime value in git (for further info, look at |
196 | `man git-diff`). Default value: "-1". | 196 | `man git-diff`). Default value: "-1". |
197 | 197 | ||
198 | repo.group:: | 198 | repo.group:: |
199 | A value for the current repository group, which all repositories | 199 | A value for the current repository group, which all repositories |
200 | specified after this setting will inherit. Default value: none. | 200 | specified after this setting will inherit. Default value: none. |
201 | 201 | ||
202 | robots:: | 202 | robots:: |
203 | Text used as content for the "robots" meta-tag. Default value: | 203 | Text used as content for the "robots" meta-tag. Default value: |
204 | "index, nofollow". | 204 | "index, nofollow". |
205 | 205 | ||
206 | root-desc:: | 206 | root-desc:: |
207 | Text printed below the heading on the repository index page. Default | 207 | Text printed below the heading on the repository index page. Default |
208 | value: "a fast webinterface for the git dscm". | 208 | value: "a fast webinterface for the git dscm". |
209 | 209 | ||
210 | root-readme:: | 210 | root-readme:: |
211 | The content of the file specified with this option will be included | 211 | The content of the file specified with this option will be included |
212 | verbatim below the "about" link on the repository index page. Default | 212 | verbatim below the "about" link on the repository index page. Default |
213 | value: none. | 213 | value: none. |
214 | 214 | ||
215 | root-title:: | 215 | root-title:: |
216 | Text printed as heading on the repository index page. Default value: | 216 | Text printed as heading on the repository index page. Default value: |
217 | "Git Repository Browser". | 217 | "Git Repository Browser". |
218 | 218 | ||
219 | snapshots:: | 219 | snapshots:: |
220 | Text which specifies the default (and allowed) set of snapshot formats | 220 | Text which specifies the default set of snapshot formats generated by |
221 | supported by cgit. The value is a space-separated list of zero or more | 221 | cgit. The value is a space-separated list of zero or more of the |
222 | of the following values: | 222 | values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none. |
223 | "tar" uncompressed tar-file | ||
224 | "tar.gz"gzip-compressed tar-file | ||
225 | "tar.bz2"bzip-compressed tar-file | ||
226 | "zip" zip-file | ||
227 | Default value: none. | ||
228 | 223 | ||
229 | source-filter:: | 224 | source-filter:: |
230 | Specifies a command which will be invoked to format plaintext blobs | 225 | Specifies a command which will be invoked to format plaintext blobs |
231 | in the tree view. The command will get the blob content on its STDIN | 226 | in the tree view. The command will get the blob content on its STDIN |
232 | and the name of the blob as its only command line argument. The STDOUT | 227 | and the name of the blob as its only command line argument. The STDOUT |
233 | from the command will be included verbatim as the blob contents, i.e. | 228 | from the command will be included verbatim as the blob contents, i.e. |
234 | this can be used to implement e.g. syntax highlighting. Default value: | 229 | this can be used to implement e.g. syntax highlighting. Default value: |
235 | none. | 230 | none. |
236 | 231 | ||
237 | summary-branches:: | 232 | summary-branches:: |
238 | Specifies the number of branches to display in the repository "summary" | 233 | Specifies the number of branches to display in the repository "summary" |
239 | view. Default value: "10". | 234 | view. Default value: "10". |
240 | 235 | ||
241 | summary-log:: | 236 | summary-log:: |
242 | Specifies the number of log entries to display in the repository | 237 | Specifies the number of log entries to display in the repository |
243 | "summary" view. Default value: "10". | 238 | "summary" view. Default value: "10". |
244 | 239 | ||
245 | summary-tags:: | 240 | summary-tags:: |
246 | Specifies the number of tags to display in the repository "summary" | 241 | Specifies the number of tags to display in the repository "summary" |
247 | view. Default value: "10". | 242 | view. Default value: "10". |
248 | 243 | ||
249 | virtual-root:: | 244 | virtual-root:: |
250 | Url which, if specified, will be used as root for all cgit links. It | 245 | Url which, if specified, will be used as root for all cgit links. It |
251 | will also cause cgit to generate 'virtual urls', i.e. urls like | 246 | will also cause cgit to generate 'virtual urls', i.e. urls like |
252 | '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default | 247 | '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default |
253 | value: none. | 248 | value: none. |
254 | NOTE: cgit has recently learned how to use PATH_INFO to achieve the | 249 | NOTE: cgit has recently learned how to use PATH_INFO to achieve the |
255 | same kind of virtual urls, so this option will probably be deprecated. | 250 | same kind of virtual urls, so this option will probably be deprecated. |
256 | 251 | ||
257 | REPOSITORY SETTINGS | 252 | REPOSITORY SETTINGS |
258 | ------------------- | 253 | ------------------- |
259 | repo.about-filter:: | 254 | repo.about-filter:: |
260 | Override the default about-filter. Default value: <about-filter>. | 255 | Override the default about-filter. Default value: <about-filter>. |
261 | 256 | ||
262 | repo.clone-url:: | 257 | repo.clone-url:: |
263 | A list of space-separated urls which can be used to clone this repo. | 258 | A list of space-separated urls which can be used to clone this repo. |
264 | Default value: none. | 259 | Default value: none. |
265 | 260 | ||
266 | repo.commit-filter:: | 261 | repo.commit-filter:: |
267 | Override the default commit-filter. Default value: <commit-filter>. | 262 | Override the default commit-filter. Default value: <commit-filter>. |
268 | 263 | ||
269 | repo.defbranch:: | 264 | repo.defbranch:: |
270 | The name of the default branch for this repository. If no such branch | 265 | The name of the default branch for this repository. If no such branch |
271 | exists in the repository, the first branch name (when sorted) is used | 266 | exists in the repository, the first branch name (when sorted) is used |
272 | as default instead. Default value: "master". | 267 | as default instead. Default value: "master". |
273 | 268 | ||
274 | repo.desc:: | 269 | repo.desc:: |
275 | The value to show as repository description. Default value: none. | 270 | The value to show as repository description. Default value: none. |
276 | 271 | ||
277 | repo.enable-log-filecount:: | 272 | repo.enable-log-filecount:: |
278 | A flag which can be used to disable the global setting | 273 | A flag which can be used to disable the global setting |
279 | `enable-log-filecount'. Default value: none. | 274 | `enable-log-filecount'. Default value: none. |
280 | 275 | ||
281 | repo.enable-log-linecount:: | 276 | repo.enable-log-linecount:: |
282 | A flag which can be used to disable the global setting | 277 | A flag which can be used to disable the global setting |
283 | `enable-log-linecount'. Default value: none. | 278 | `enable-log-linecount'. Default value: none. |
284 | 279 | ||
285 | repo.max-stats:: | 280 | repo.max-stats:: |
286 | Override the default maximum statistics period. Valid values are equal | 281 | Override the default maximum statistics period. Valid values are equal |
287 | to the values specified for the global "max-stats" setting. Default | 282 | to the values specified for the global "max-stats" setting. Default |
288 | value: none. | 283 | value: none. |
289 | 284 | ||
290 | repo.name:: | 285 | repo.name:: |
291 | The value to show as repository name. Default value: <repo.url>. | 286 | The value to show as repository name. Default value: <repo.url>. |
292 | 287 | ||
293 | repo.owner:: | 288 | repo.owner:: |
294 | A value used to identify the owner of the repository. Default value: | 289 | A value used to identify the owner of the repository. Default value: |
295 | none. | 290 | none. |
296 | 291 | ||
297 | repo.path:: | 292 | repo.path:: |
298 | An absolute path to the repository directory. For non-bare repositories | 293 | An absolute path to the repository directory. For non-bare repositories |
299 | this is the .git-directory. Default value: none. | 294 | this is the .git-directory. Default value: none. |
300 | 295 | ||
301 | repo.readme:: | 296 | repo.readme:: |
302 | A path (relative to <repo.path>) which specifies a file to include | 297 | A path (relative to <repo.path>) which specifies a file to include |
303 | verbatim as the "About" page for this repo. Default value: none. | 298 | verbatim as the "About" page for this repo. Default value: none. |
304 | 299 | ||
305 | repo.snapshots:: | 300 | repo.snapshots:: |
306 | A mask of allowed snapshot-formats for this repo, restricted by the | 301 | A mask of allowed snapshot-formats for this repo, restricted by the |
307 | "snapshots" global setting. Default value: <snapshots>. | 302 | "snapshots" global setting. Default value: <snapshots>. |
308 | 303 | ||
309 | repo.source-filter:: | 304 | repo.source-filter:: |
310 | Override the default source-filter. Default value: <source-filter>. | 305 | Override the default source-filter. Default value: <source-filter>. |
311 | 306 | ||
312 | repo.url:: | 307 | repo.url:: |
313 | The relative url used to access the repository. This must be the first | 308 | The relative url used to access the repository. This must be the first |
314 | setting specified for each repo. Default value: none. | 309 | setting specified for each repo. Default value: none. |
315 | 310 | ||
316 | 311 | ||
317 | EXAMPLE CGITRC FILE | 312 | EXAMPLE CGITRC FILE |
318 | ------------------- | 313 | ------------------- |
319 | 314 | ||
320 | .... | 315 | .... |
321 | # Enable caching of up to 1000 output entriess | 316 | # Enable caching of up to 1000 output entriess |
322 | cache-size=1000 | 317 | cache-size=1000 |
323 | 318 | ||
324 | 319 | ||
325 | # Specify some default clone prefixes | 320 | # Specify some default clone prefixes |
326 | clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git | 321 | clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git |
327 | 322 | ||
328 | # Specify the css url | 323 | # Specify the css url |
329 | css=/css/cgit.css | 324 | css=/css/cgit.css |
330 | 325 | ||
331 | 326 | ||
332 | # Show extra links for each repository on the index page | 327 | # Show extra links for each repository on the index page |
333 | enable-index-links=1 | 328 | enable-index-links=1 |
334 | 329 | ||
335 | 330 | ||
336 | # Show number of affected files per commit on the log pages | 331 | # Show number of affected files per commit on the log pages |
337 | enable-log-filecount=1 | 332 | enable-log-filecount=1 |
338 | 333 | ||
339 | 334 | ||
340 | # Show number of added/removed lines per commit on the log pages | 335 | # Show number of added/removed lines per commit on the log pages |
341 | enable-log-linecount=1 | 336 | enable-log-linecount=1 |
342 | 337 | ||
343 | 338 | ||
344 | # Add a cgit favicon | 339 | # Add a cgit favicon |
345 | favicon=/favicon.ico | 340 | favicon=/favicon.ico |
346 | 341 | ||
347 | 342 | ||
348 | # Use a custom logo | 343 | # Use a custom logo |
349 | logo=/img/mylogo.png | 344 | logo=/img/mylogo.png |
350 | 345 | ||
351 | 346 | ||
352 | # Enable statistics per week, month and quarter | 347 | # Enable statistics per week, month and quarter |
353 | max-stats=quarter | 348 | max-stats=quarter |
354 | 349 | ||
355 | 350 | ||