summaryrefslogtreecommitdiffabout
authorTodd Zullinger <tmz@pobox.com>2009-01-11 23:23:39 (UTC)
committer Lars Hjemli <hjemli@gmail.com>2009-01-12 07:21:58 (UTC)
commit3796c2d8d21099007ea4b0572522003ceafb4eab (patch) (unidiff)
tree6c08d087045a20b0719fc44d589b81ce72912e19
parenteb14609dc46461728a065c0a243b338fc32fd762 (diff)
downloadcgit-3796c2d8d21099007ea4b0572522003ceafb4eab.zip
cgit-3796c2d8d21099007ea4b0572522003ceafb4eab.tar.gz
cgit-3796c2d8d21099007ea4b0572522003ceafb4eab.tar.bz2
Fix tar.bz2 snapshot example
Signed-off-by: Lars Hjemli <hjemli@gmail.com>
Diffstat (more/less context) (ignore whitespace changes)
-rw-r--r--cgitrc.5.txt4
1 files changed, 2 insertions, 2 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 7887b02..ab9ab66 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -163,205 +163,205 @@ root-readme:
163 value: none. 163 value: none.
164 164
165root-title 165root-title
166 Text printed as heading on the repository index page. Default value: 166 Text printed as heading on the repository index page. Default value:
167 "Git Repository Browser". 167 "Git Repository Browser".
168 168
169snapshots 169snapshots
170 Text which specifies the default (and allowed) set of snapshot formats 170 Text which specifies the default (and allowed) set of snapshot formats
171 supported by cgit. The value is a space-separated list of zero or more 171 supported by cgit. The value is a space-separated list of zero or more
172 of the following values: 172 of the following values:
173 "tar" uncompressed tar-file 173 "tar" uncompressed tar-file
174 "tar.gz"gzip-compressed tar-file 174 "tar.gz"gzip-compressed tar-file
175 "tar.bz2"bzip-compressed tar-file 175 "tar.bz2"bzip-compressed tar-file
176 "zip" zip-file 176 "zip" zip-file
177 Default value: none. 177 Default value: none.
178 178
179summary-branches 179summary-branches
180 Specifies the number of branches to display in the repository "summary" 180 Specifies the number of branches to display in the repository "summary"
181 view. Default value: "10". 181 view. Default value: "10".
182 182
183summary-log 183summary-log
184 Specifies the number of log entries to display in the repository 184 Specifies the number of log entries to display in the repository
185 "summary" view. Default value: "10". 185 "summary" view. Default value: "10".
186 186
187summary-tags 187summary-tags
188 Specifies the number of tags to display in the repository "summary" 188 Specifies the number of tags to display in the repository "summary"
189 view. Default value: "10". 189 view. Default value: "10".
190 190
191virtual-root 191virtual-root
192 Url which, if specified, will be used as root for all cgit links. It 192 Url which, if specified, will be used as root for all cgit links. It
193 will also cause cgit to generate 'virtual urls', i.e. urls like 193 will also cause cgit to generate 'virtual urls', i.e. urls like
194 '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default 194 '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default
195 value: none. 195 value: none.
196 NOTE: cgit has recently learned how to use PATH_INFO to achieve the 196 NOTE: cgit has recently learned how to use PATH_INFO to achieve the
197 same kind of virtual urls, so this option will probably be deprecated. 197 same kind of virtual urls, so this option will probably be deprecated.
198 198
199REPOSITORY SETTINGS 199REPOSITORY SETTINGS
200------------------- 200-------------------
201repo.clone-url 201repo.clone-url
202 A list of space-separated urls which can be used to clone this repo. 202 A list of space-separated urls which can be used to clone this repo.
203 Default value: none. 203 Default value: none.
204 204
205repo.defbranch 205repo.defbranch
206 The name of the default branch for this repository. If no such branch 206 The name of the default branch for this repository. If no such branch
207 exists in the repository, the first branch name (when sorted) is used 207 exists in the repository, the first branch name (when sorted) is used
208 as default instead. Default value: "master". 208 as default instead. Default value: "master".
209 209
210repo.desc 210repo.desc
211 The value to show as repository description. Default value: none. 211 The value to show as repository description. Default value: none.
212 212
213repo.enable-log-filecount 213repo.enable-log-filecount
214 A flag which can be used to disable the global setting 214 A flag which can be used to disable the global setting
215 `enable-log-filecount'. Default value: none. 215 `enable-log-filecount'. Default value: none.
216 216
217repo.enable-log-linecount 217repo.enable-log-linecount
218 A flag which can be used to disable the global setting 218 A flag which can be used to disable the global setting
219 `enable-log-linecount'. Default value: none. 219 `enable-log-linecount'. Default value: none.
220 220
221repo.name 221repo.name
222 The value to show as repository name. Default value: <repo.url>. 222 The value to show as repository name. Default value: <repo.url>.
223 223
224repo.owner 224repo.owner
225 A value used to identify the owner of the repository. Default value: 225 A value used to identify the owner of the repository. Default value:
226 none. 226 none.
227 227
228repo.path 228repo.path
229 An absolute path to the repository directory. For non-bare repositories 229 An absolute path to the repository directory. For non-bare repositories
230 this is the .git-directory. Default value: none. 230 this is the .git-directory. Default value: none.
231 231
232repo.readme 232repo.readme
233 A path (relative to <repo.path>) which specifies a file to include 233 A path (relative to <repo.path>) which specifies a file to include
234 verbatim as the "About" page for this repo. Default value: none. 234 verbatim as the "About" page for this repo. Default value: none.
235 235
236repo.snapshots 236repo.snapshots
237 A mask of allowed snapshot-formats for this repo, restricted by the 237 A mask of allowed snapshot-formats for this repo, restricted by the
238 "snapshots" global setting. Default value: <snapshots>. 238 "snapshots" global setting. Default value: <snapshots>.
239 239
240repo.url 240repo.url
241 The relative url used to access the repository. This must be the first 241 The relative url used to access the repository. This must be the first
242 setting specified for each repo. Default value: none. 242 setting specified for each repo. Default value: none.
243 243
244 244
245EXAMPLE CGITRC FILE 245EXAMPLE CGITRC FILE
246------------------- 246-------------------
247 247
248# Enable caching of up to 1000 output entriess 248# Enable caching of up to 1000 output entriess
249cache-size=1000 249cache-size=1000
250 250
251 251
252# Specify some default clone prefixes 252# Specify some default clone prefixes
253clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git 253clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git
254 254
255# Specify the css url 255# Specify the css url
256css=/css/cgit.css 256css=/css/cgit.css
257 257
258 258
259# Show extra links for each repository on the index page 259# Show extra links for each repository on the index page
260enable-index-links=1 260enable-index-links=1
261 261
262 262
263# Show number of affected files per commit on the log pages 263# Show number of affected files per commit on the log pages
264enable-log-filecount=1 264enable-log-filecount=1
265 265
266 266
267# Show number of added/removed lines per commit on the log pages 267# Show number of added/removed lines per commit on the log pages
268enable-log-linecount=1 268enable-log-linecount=1
269 269
270 270
271# Add a cgit favicon 271# Add a cgit favicon
272favicon=/favicon.ico 272favicon=/favicon.ico
273 273
274 274
275# Use a custom logo 275# Use a custom logo
276logo=/img/mylogo.png 276logo=/img/mylogo.png
277 277
278 278
279# Set the title and heading of the repository index page 279# Set the title and heading of the repository index page
280root-title=foobar.com git repositories 280root-title=foobar.com git repositories
281 281
282 282
283# Set a subheading for the repository index page 283# Set a subheading for the repository index page
284root-desc=tracking the foobar development 284root-desc=tracking the foobar development
285 285
286 286
287# Include some more info about foobar.com on the index page 287# Include some more info about foobar.com on the index page
288root-readme=/var/www/htdocs/about.html 288root-readme=/var/www/htdocs/about.html
289 289
290 290
291# Allow download of tar.gz, tar.bz and zip-files 291# Allow download of tar.gz, tar.bz2 and zip-files
292snapshots=tar.gz tar.bz zip 292snapshots=tar.gz tar.bz2 zip
293 293
294 294
295## 295##
296## List of repositories. 296## List of repositories.
297## PS: Any repositories listed when repo.group is unset will not be 297## PS: Any repositories listed when repo.group is unset will not be
298## displayed under a group heading 298## displayed under a group heading
299## PPS: This list could be kept in a different file (e.g. '/etc/cgitrepos') 299## PPS: This list could be kept in a different file (e.g. '/etc/cgitrepos')
300## and included like this: 300## and included like this:
301## include=/etc/cgitrepos 301## include=/etc/cgitrepos
302## 302##
303 303
304 304
305repo.url=foo 305repo.url=foo
306repo.path=/pub/git/foo.git 306repo.path=/pub/git/foo.git
307repo.desc=the master foo repository 307repo.desc=the master foo repository
308repo.owner=fooman@foobar.com 308repo.owner=fooman@foobar.com
309repo.readme=info/web/about.html 309repo.readme=info/web/about.html
310 310
311 311
312repo.url=bar 312repo.url=bar
313repo.path=/pub/git/bar.git 313repo.path=/pub/git/bar.git
314repo.desc=the bars for your foo 314repo.desc=the bars for your foo
315repo.owner=barman@foobar.com 315repo.owner=barman@foobar.com
316repo.readme=info/web/about.html 316repo.readme=info/web/about.html
317 317
318 318
319# The next repositories will be displayed under the 'extras' heading 319# The next repositories will be displayed under the 'extras' heading
320repo.group=extras 320repo.group=extras
321 321
322 322
323repo.url=baz 323repo.url=baz
324repo.path=/pub/git/baz.git 324repo.path=/pub/git/baz.git
325repo.desc=a set of extensions for bar users 325repo.desc=a set of extensions for bar users
326 326
327repo.url=wiz 327repo.url=wiz
328repo.path=/pub/git/wiz.git 328repo.path=/pub/git/wiz.git
329repo.desc=the wizard of foo 329repo.desc=the wizard of foo
330 330
331 331
332# Add some mirrored repositories 332# Add some mirrored repositories
333repo.group=mirrors 333repo.group=mirrors
334 334
335 335
336repo.url=git 336repo.url=git
337repo.path=/pub/git/git.git 337repo.path=/pub/git/git.git
338repo.desc=the dscm 338repo.desc=the dscm
339 339
340 340
341repo.url=linux 341repo.url=linux
342repo.path=/pub/git/linux.git 342repo.path=/pub/git/linux.git
343repo.desc=the kernel 343repo.desc=the kernel
344 344
345# Disable adhoc downloads of this repo 345# Disable adhoc downloads of this repo
346repo.snapshots=0 346repo.snapshots=0
347 347
348# Disable line-counts for this repo 348# Disable line-counts for this repo
349repo.enable-log-linecount=0 349repo.enable-log-linecount=0
350 350
351 351
352BUGS 352BUGS
353---- 353----
354Comments currently cannot appear on the same line as a setting; the comment 354Comments currently cannot appear on the same line as a setting; the comment
355will be included as part of the value. E.g. this line: 355will be included as part of the value. E.g. this line:
356 356
357 robots=index # allow indexing 357 robots=index # allow indexing
358 358
359will generate the following html element: 359will generate the following html element:
360 360
361 <meta name='robots' content='index # allow indexing'/> 361 <meta name='robots' content='index # allow indexing'/>
362 362
363 363
364 364
365AUTHOR 365AUTHOR
366------ 366------
367Lars Hjemli <hjemli@gmail.com> 367Lars Hjemli <hjemli@gmail.com>