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