author | Lars Hjemli <hjemli@gmail.com> | 2009-02-12 09:02:09 (UTC) |
---|---|---|
committer | Lars Hjemli <hjemli@gmail.com> | 2009-02-12 09:02:09 (UTC) |
commit | b875a9eedaeb93f24c375a1b7650c8af7f286e9d (patch) (unidiff) | |
tree | a8290637d710f54b5c6f7b7558fb031f0a49650b | |
parent | d3b2933cfead688036b354238e947c12916575b6 (diff) | |
download | cgit-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>
-rw-r--r-- | cgitrc.5.txt | 2 |
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 | ||
169 | root-readme:: | 169 | root-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 | ||
174 | root-title:: | 174 | root-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 | ||
178 | snapshots:: | 178 | snapshots:: |
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 | ||
188 | summary-branches:: | 188 | summary-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 | ||
192 | summary-log:: | 192 | summary-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 | ||
196 | summary-tags:: | 196 | summary-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 | ||
200 | virtual-root:: | 200 | virtual-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 | ||
208 | REPOSITORY SETTINGS | 208 | REPOSITORY SETTINGS |
209 | ------------------- | 209 | ------------------- |
210 | repo.clone-url:: | 210 | repo.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 | ||
214 | repo.defbranch:: | 214 | repo.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 | ||
219 | repo.desc:: | 219 | repo.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 | ||
222 | repo.enable-log-filecount:: | 222 | repo.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 | ||
226 | repo.enable-log-linecount:: | 226 | repo.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 | ||
230 | repo.max-stats:: | 230 | repo.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 | ||
235 | repo.name:: | 235 | repo.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 | ||
238 | repo.owner:: | 238 | repo.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 | ||
242 | repo.path:: | 242 | repo.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 | ||
246 | repo.readme:: | 246 | repo.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 | ||
250 | repo.snapshots:: | 250 | repo.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 | ||
254 | repo.url:: | 254 | repo.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 | ||
259 | EXAMPLE CGITRC FILE | 259 | EXAMPLE 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 |
263 | cache-size=1000 | 264 | cache-size=1000 |
264 | 265 | ||
265 | 266 | ||
266 | # Specify some default clone prefixes | 267 | # Specify some default clone prefixes |
267 | clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git | 268 | clone-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 |
270 | css=/css/cgit.css | 271 | css=/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 |
274 | enable-index-links=1 | 275 | enable-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 |
278 | enable-log-filecount=1 | 279 | enable-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 |
282 | enable-log-linecount=1 | 283 | enable-log-linecount=1 |
283 | 284 | ||
284 | 285 | ||
285 | # Add a cgit favicon | 286 | # Add a cgit favicon |
286 | favicon=/favicon.ico | 287 | favicon=/favicon.ico |
287 | 288 | ||
288 | 289 | ||
289 | # Use a custom logo | 290 | # Use a custom logo |
290 | logo=/img/mylogo.png | 291 | logo=/img/mylogo.png |
291 | 292 | ||
292 | 293 | ||
293 | # Enable statistics per week, month and quarter | 294 | # Enable statistics per week, month and quarter |
294 | max-stats=quarter | 295 | max-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 |
298 | root-title=foobar.com git repositories | 299 | root-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 |
302 | root-desc=tracking the foobar development | 303 | root-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 |
306 | root-readme=/var/www/htdocs/about.html | 307 | root-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 |
310 | snapshots=tar.gz tar.bz2 zip | 311 | snapshots=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 | ||
323 | repo.url=foo | 324 | repo.url=foo |
324 | repo.path=/pub/git/foo.git | 325 | repo.path=/pub/git/foo.git |
325 | repo.desc=the master foo repository | 326 | repo.desc=the master foo repository |
326 | repo.owner=fooman@foobar.com | 327 | repo.owner=fooman@foobar.com |
327 | repo.readme=info/web/about.html | 328 | repo.readme=info/web/about.html |
328 | 329 | ||
329 | 330 | ||
330 | repo.url=bar | 331 | repo.url=bar |
331 | repo.path=/pub/git/bar.git | 332 | repo.path=/pub/git/bar.git |
332 | repo.desc=the bars for your foo | 333 | repo.desc=the bars for your foo |
333 | repo.owner=barman@foobar.com | 334 | repo.owner=barman@foobar.com |
334 | repo.readme=info/web/about.html | 335 | repo.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 |
338 | repo.group=extras | 339 | repo.group=extras |
339 | 340 | ||
340 | 341 | ||
341 | repo.url=baz | 342 | repo.url=baz |
342 | repo.path=/pub/git/baz.git | 343 | repo.path=/pub/git/baz.git |
343 | repo.desc=a set of extensions for bar users | 344 | repo.desc=a set of extensions for bar users |
344 | 345 | ||
345 | repo.url=wiz | 346 | repo.url=wiz |
346 | repo.path=/pub/git/wiz.git | 347 | repo.path=/pub/git/wiz.git |
347 | repo.desc=the wizard of foo | 348 | repo.desc=the wizard of foo |
348 | 349 | ||
349 | 350 | ||
350 | # Add some mirrored repositories | 351 | # Add some mirrored repositories |
351 | repo.group=mirrors | 352 | repo.group=mirrors |
352 | 353 | ||
353 | 354 | ||
354 | repo.url=git | 355 | repo.url=git |
355 | repo.path=/pub/git/git.git | 356 | repo.path=/pub/git/git.git |
356 | repo.desc=the dscm | 357 | repo.desc=the dscm |
357 | 358 | ||
358 | 359 | ||
359 | repo.url=linux | 360 | repo.url=linux |
360 | repo.path=/pub/git/linux.git | 361 | repo.path=/pub/git/linux.git |
361 | repo.desc=the kernel | 362 | repo.desc=the kernel |
362 | 363 | ||
363 | # Disable adhoc downloads of this repo | 364 | # Disable adhoc downloads of this repo |
364 | repo.snapshots=0 | 365 | repo.snapshots=0 |
365 | 366 | ||
366 | # Disable line-counts for this repo | 367 | # Disable line-counts for this repo |
367 | repo.enable-log-linecount=0 | 368 | repo.enable-log-linecount=0 |
368 | 369 | ||
369 | # Restrict the max statistics period for this repo | 370 | # Restrict the max statistics period for this repo |
370 | repo.max-stats=month | 371 | repo.max-stats=month |
372 | .... | ||
371 | 373 | ||
372 | 374 | ||
373 | BUGS | 375 | BUGS |
374 | ---- | 376 | ---- |
375 | Comments currently cannot appear on the same line as a setting; the comment | 377 | Comments currently cannot appear on the same line as a setting; the comment |
376 | will be included as part of the value. E.g. this line: | 378 | will 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 | ||
380 | will generate the following html element: | 382 | will 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 | ||
386 | AUTHOR | 388 | AUTHOR |
387 | ------ | 389 | ------ |
388 | Lars Hjemli <hjemli@gmail.com> | 390 | Lars Hjemli <hjemli@gmail.com> |