summaryrefslogtreecommitdiffabout
authorLars Hjemli <hjemli@gmail.com>2009-08-24 05:51:48 (UTC)
committer Lars Hjemli <hjemli@gmail.com>2009-08-24 08:22:58 (UTC)
commit007df98d2114fac4e9134cd7bc7e2960d0d730b4 (patch) (unidiff)
tree67a3669f91a69675157d631e90cdafcd4db4e554
parente01229cf80bc618a132d2154c0ebd71792d31c64 (diff)
downloadcgit-007df98d2114fac4e9134cd7bc7e2960d0d730b4.zip
cgit-007df98d2114fac4e9134cd7bc7e2960d0d730b4.tar.gz
cgit-007df98d2114fac4e9134cd7bc7e2960d0d730b4.tar.bz2
cgitrc.5.txt: fix markup errors
Signed-off-by: Lars Hjemli <hjemli@gmail.com>
Diffstat (more/less context) (ignore whitespace changes)
-rw-r--r--cgitrc.5.txt19
1 files changed, 10 insertions, 9 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index df494aa..46df291 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -139,261 +139,262 @@ index-info::
139 139
140local-time:: 140local-time::
141 Flag which, if set to "1", makes cgit print commit and tag times in the 141 Flag which, if set to "1", makes cgit print commit and tag times in the
142 servers timezone. Default value: "0". 142 servers timezone. Default value: "0".
143 143
144logo:: 144logo::
145 Url which specifies the source of an image which will be used as a logo 145 Url which specifies the source of an image which will be used as a logo
146 on all cgit pages. Default value: "/cgit.png". 146 on all cgit pages. Default value: "/cgit.png".
147 147
148logo-link:: 148logo-link::
149 Url loaded when clicking on the cgit logo image. If unspecified the 149 Url loaded when clicking on the cgit logo image. If unspecified the
150 calculated url of the repository index page will be used. Default 150 calculated url of the repository index page will be used. Default
151 value: none. 151 value: none.
152 152
153max-commit-count:: 153max-commit-count::
154 Specifies the number of entries to list per page in "log" view. Default 154 Specifies the number of entries to list per page in "log" view. Default
155 value: "50". 155 value: "50".
156 156
157max-message-length:: 157max-message-length::
158 Specifies the maximum number of commit message characters to display in 158 Specifies the maximum number of commit message characters to display in
159 "log" view. Default value: "80". 159 "log" view. Default value: "80".
160 160
161max-repo-count:: 161max-repo-count::
162 Specifies the number of entries to list per page on therepository 162 Specifies the number of entries to list per page on therepository
163 index page. Default value: "50". 163 index page. Default value: "50".
164 164
165max-repodesc-length:: 165max-repodesc-length::
166 Specifies the maximum number of repo description characters to display 166 Specifies the maximum number of repo description characters to display
167 on the repository index page. Default value: "80". 167 on the repository index page. Default value: "80".
168 168
169max-stats:: 169max-stats::
170 Set the default maximum statistics period. Valid values are "week", 170 Set the default maximum statistics period. Valid values are "week",
171 "month", "quarter" and "year". If unspecified, statistics are 171 "month", "quarter" and "year". If unspecified, statistics are
172 disabled. Default value: none. See also: "repo.max-stats". 172 disabled. Default value: none. See also: "repo.max-stats".
173 173
174mimetype.<ext>:: 174mimetype.<ext>::
175 Set the mimetype for the specified filename extension. This is used 175 Set the mimetype for the specified filename extension. This is used
176 by the `plain` command when returning blob content. 176 by the `plain` command when returning blob content.
177 177
178module-link:: 178module-link::
179 Text which will be used as the formatstring for a hyperlink when a 179 Text which will be used as the formatstring for a hyperlink when a
180 submodule is printed in a directory listing. The arguments for the 180 submodule is printed in a directory listing. The arguments for the
181 formatstring are the path and SHA1 of the submodule commit. Default 181 formatstring are the path and SHA1 of the submodule commit. Default
182 value: "./?repo=%s&page=commit&id=%s" 182 value: "./?repo=%s&page=commit&id=%s"
183 183
184nocache:: 184nocache::
185 If set to the value "1" caching will be disabled. This settings is 185 If set to the value "1" caching will be disabled. This settings is
186 deprecated, and will not be honored starting with cgit-1.0. Default 186 deprecated, and will not be honored starting with cgit-1.0. Default
187 value: "0". 187 value: "0".
188 188
189noplainemail:: 189noplainemail::
190 If set to "1" showing full author email adresses will be disabled. 190 If set to "1" showing full author email adresses will be disabled.
191 Default value: "0". 191 Default value: "0".
192 192
193noheader:: 193noheader::
194 Flag which, when set to "1", will make cgit omit the standard header 194 Flag which, when set to "1", will make cgit omit the standard header
195 on all pages. Default value: none. See also: "embedded". 195 on all pages. Default value: none. See also: "embedded".
196 196
197renamelimit:: 197renamelimit::
198 Maximum number of files to consider when detecting renames. The value 198 Maximum number of files to consider when detecting renames. The value
199 "-1" uses the compiletime value in git (for further info, look at 199 "-1" uses the compiletime value in git (for further info, look at
200 `man git-diff`). Default value: "-1". 200 `man git-diff`). Default value: "-1".
201 201
202repo.group:: 202repo.group::
203 Legacy alias for 'section' which will be deprecated starting with 203 Legacy alias for "section". This option is deprecated and will not be
204 cgit-1.0. 204 supported in cgit-1.0.
205 205
206robots:: 206robots::
207 Text used as content for the "robots" meta-tag. Default value: 207 Text used as content for the "robots" meta-tag. Default value:
208 "index, nofollow". 208 "index, nofollow".
209 209
210root-desc:: 210root-desc::
211 Text printed below the heading on the repository index page. Default 211 Text printed below the heading on the repository index page. Default
212 value: "a fast webinterface for the git dscm". 212 value: "a fast webinterface for the git dscm".
213 213
214root-readme:: 214root-readme::
215 The content of the file specified with this option will be included 215 The content of the file specified with this option will be included
216 verbatim below the "about" link on the repository index page. Default 216 verbatim below the "about" link on the repository index page. Default
217 value: none. 217 value: none.
218 218
219root-title:: 219root-title::
220 Text printed as heading on the repository index page. Default value: 220 Text printed as heading on the repository index page. Default value:
221 "Git Repository Browser". 221 "Git Repository Browser".
222 222
223scan-path:: 223scan-path::
224 A path which will be scanned for repositories. If caching is enabled, 224 A path which will be scanned for repositories. If caching is enabled,
225 the result will be cached as a cgitrc include-file in the cache 225 the result will be cached as a cgitrc include-file in the cache
226 directory. Default value: none. See also: cache-scanrc-ttl. 226 directory. Default value: none. See also: cache-scanrc-ttl.
227 227
228section: 228section::
229 The name of the current repository section - all repositories defined 229 The name of the current repository section - all repositories defined
230 after this option will inherit the current section name. Default value: 230 after this option will inherit the current section name. Default value:
231 none. 231 none.
232 232
233snapshots:: 233snapshots::
234 Text which specifies the default set of snapshot formats generated by 234 Text which specifies the default set of snapshot formats generated by
235 cgit. The value is a space-separated list of zero or more of the 235 cgit. The value is a space-separated list of zero or more of the
236 values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none. 236 values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none.
237 237
238source-filter:: 238source-filter::
239 Specifies a command which will be invoked to format plaintext blobs 239 Specifies a command which will be invoked to format plaintext blobs
240 in the tree view. The command will get the blob content on its STDIN 240 in the tree view. The command will get the blob content on its STDIN
241 and the name of the blob as its only command line argument. The STDOUT 241 and the name of the blob as its only command line argument. The STDOUT
242 from the command will be included verbatim as the blob contents, i.e. 242 from the command will be included verbatim as the blob contents, i.e.
243 this can be used to implement e.g. syntax highlighting. Default value: 243 this can be used to implement e.g. syntax highlighting. Default value:
244 none. 244 none.
245 245
246summary-branches:: 246summary-branches::
247 Specifies the number of branches to display in the repository "summary" 247 Specifies the number of branches to display in the repository "summary"
248 view. Default value: "10". 248 view. Default value: "10".
249 249
250summary-log:: 250summary-log::
251 Specifies the number of log entries to display in the repository 251 Specifies the number of log entries to display in the repository
252 "summary" view. Default value: "10". 252 "summary" view. Default value: "10".
253 253
254summary-tags:: 254summary-tags::
255 Specifies the number of tags to display in the repository "summary" 255 Specifies the number of tags to display in the repository "summary"
256 view. Default value: "10". 256 view. Default value: "10".
257 257
258virtual-root:: 258virtual-root::
259 Url which, if specified, will be used as root for all cgit links. It 259 Url which, if specified, will be used as root for all cgit links. It
260 will also cause cgit to generate 'virtual urls', i.e. urls like 260 will also cause cgit to generate 'virtual urls', i.e. urls like
261 '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default 261 '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default
262 value: none. 262 value: none.
263 NOTE: cgit has recently learned how to use PATH_INFO to achieve the 263 NOTE: cgit has recently learned how to use PATH_INFO to achieve the
264 same kind of virtual urls, so this option will probably be deprecated. 264 same kind of virtual urls, so this option will probably be deprecated.
265 265
266REPOSITORY SETTINGS 266REPOSITORY SETTINGS
267------------------- 267-------------------
268repo.about-filter:: 268repo.about-filter::
269 Override the default about-filter. Default value: <about-filter>. 269 Override the default about-filter. Default value: <about-filter>.
270 270
271repo.clone-url:: 271repo.clone-url::
272 A list of space-separated urls which can be used to clone this repo. 272 A list of space-separated urls which can be used to clone this repo.
273 Default value: none. 273 Default value: none.
274 274
275repo.commit-filter:: 275repo.commit-filter::
276 Override the default commit-filter. Default value: <commit-filter>. 276 Override the default commit-filter. Default value: <commit-filter>.
277 277
278repo.defbranch:: 278repo.defbranch::
279 The name of the default branch for this repository. If no such branch 279 The name of the default branch for this repository. If no such branch
280 exists in the repository, the first branch name (when sorted) is used 280 exists in the repository, the first branch name (when sorted) is used
281 as default instead. Default value: "master". 281 as default instead. Default value: "master".
282 282
283repo.desc:: 283repo.desc::
284 The value to show as repository description. Default value: none. 284 The value to show as repository description. Default value: none.
285 285
286repo.enable-log-filecount:: 286repo.enable-log-filecount::
287 A flag which can be used to disable the global setting 287 A flag which can be used to disable the global setting
288 `enable-log-filecount'. Default value: none. 288 `enable-log-filecount'. Default value: none.
289 289
290repo.enable-log-linecount:: 290repo.enable-log-linecount::
291 A flag which can be used to disable the global setting 291 A flag which can be used to disable the global setting
292 `enable-log-linecount'. Default value: none. 292 `enable-log-linecount'. Default value: none.
293 293
294repo.max-stats:: 294repo.max-stats::
295 Override the default maximum statistics period. Valid values are equal 295 Override the default maximum statistics period. Valid values are equal
296 to the values specified for the global "max-stats" setting. Default 296 to the values specified for the global "max-stats" setting. Default
297 value: none. 297 value: none.
298 298
299repo.name:: 299repo.name::
300 The value to show as repository name. Default value: <repo.url>. 300 The value to show as repository name. Default value: <repo.url>.
301 301
302repo.owner:: 302repo.owner::
303 A value used to identify the owner of the repository. Default value: 303 A value used to identify the owner of the repository. Default value:
304 none. 304 none.
305 305
306repo.path:: 306repo.path::
307 An absolute path to the repository directory. For non-bare repositories 307 An absolute path to the repository directory. For non-bare repositories
308 this is the .git-directory. Default value: none. 308 this is the .git-directory. Default value: none.
309 309
310repo.readme:: 310repo.readme::
311 A path (relative to <repo.path>) which specifies a file to include 311 A path (relative to <repo.path>) which specifies a file to include
312 verbatim as the "About" page for this repo. Default value: none. 312 verbatim as the "About" page for this repo. Default value: none.
313 313
314repo.snapshots:: 314repo.snapshots::
315 A mask of allowed snapshot-formats for this repo, restricted by the 315 A mask of allowed snapshot-formats for this repo, restricted by the
316 "snapshots" global setting. Default value: <snapshots>. 316 "snapshots" global setting. Default value: <snapshots>.
317 317
318repo.section:: 318repo.section::
319 Override the current section for this repository. Default value: none. 319 Override the current section name for this repository. Default value:
320 none.
320 321
321repo.source-filter:: 322repo.source-filter::
322 Override the default source-filter. Default value: <source-filter>. 323 Override the default source-filter. Default value: <source-filter>.
323 324
324repo.url:: 325repo.url::
325 The relative url used to access the repository. This must be the first 326 The relative url used to access the repository. This must be the first
326 setting specified for each repo. Default value: none. 327 setting specified for each repo. Default value: none.
327 328
328 329
329REPOSITORY-SPECIFIC CGITRC FILE 330REPOSITORY-SPECIFIC CGITRC FILE
330------------------------------- 331-------------------------------
331When the option 'scan-path' is used to auto-discover git repositories, cgit 332When the option "scan-path" is used to auto-discover git repositories, cgit
332will try to parse the file 'cgitrc' within any found repository. Such a repo- 333will try to parse the file "cgitrc" within any found repository. Such a
333specific config file may contain any of the repo-specific options described 334repo-specific config file may contain any of the repo-specific options
334above, except 'repo.url' and 'repo.path'. Also, in a repo-specific config 335described above, except "repo.url" and "repo.path". Also, in a repo-specific
335file, the 'repo.' prefix is dropped from the config option names. 336config file, the "repo." prefix is dropped from the config option names.
336 337
337 338
338EXAMPLE CGITRC FILE 339EXAMPLE CGITRC FILE
339------------------- 340-------------------
340 341
341.... 342....
342# Enable caching of up to 1000 output entriess 343# Enable caching of up to 1000 output entriess
343cache-size=1000 344cache-size=1000
344 345
345 346
346# Specify some default clone prefixes 347# Specify some default clone prefixes
347clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git 348clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git
348 349
349# Specify the css url 350# Specify the css url
350css=/css/cgit.css 351css=/css/cgit.css
351 352
352 353
353# Show extra links for each repository on the index page 354# Show extra links for each repository on the index page
354enable-index-links=1 355enable-index-links=1
355 356
356 357
357# Show number of affected files per commit on the log pages 358# Show number of affected files per commit on the log pages
358enable-log-filecount=1 359enable-log-filecount=1
359 360
360 361
361# Show number of added/removed lines per commit on the log pages 362# Show number of added/removed lines per commit on the log pages
362enable-log-linecount=1 363enable-log-linecount=1
363 364
364 365
365# Add a cgit favicon 366# Add a cgit favicon
366favicon=/favicon.ico 367favicon=/favicon.ico
367 368
368 369
369# Use a custom logo 370# Use a custom logo
370logo=/img/mylogo.png 371logo=/img/mylogo.png
371 372
372 373
373# Enable statistics per week, month and quarter 374# Enable statistics per week, month and quarter
374max-stats=quarter 375max-stats=quarter
375 376
376 377
377# Set the title and heading of the repository index page 378# Set the title and heading of the repository index page
378root-title=foobar.com git repositories 379root-title=foobar.com git repositories
379 380
380 381
381# Set a subheading for the repository index page 382# Set a subheading for the repository index page
382root-desc=tracking the foobar development 383root-desc=tracking the foobar development
383 384
384 385
385# Include some more info about foobar.com on the index page 386# Include some more info about foobar.com on the index page
386root-readme=/var/www/htdocs/about.html 387root-readme=/var/www/htdocs/about.html
387 388
388 389
389# Allow download of tar.gz, tar.bz2 and zip-files 390# Allow download of tar.gz, tar.bz2 and zip-files
390snapshots=tar.gz tar.bz2 zip 391snapshots=tar.gz tar.bz2 zip
391 392
392 393
393## 394##
394## List of common mimetypes 395## List of common mimetypes
395## 396##
396 397
397mimetype.git=image/git 398mimetype.git=image/git
398mimetype.html=text/html 399mimetype.html=text/html
399mimetype.jpg=image/jpeg 400mimetype.jpg=image/jpeg