summaryrefslogtreecommitdiffabout
path: root/cgitrc.5.txt
Unidiff
Diffstat (limited to 'cgitrc.5.txt') (more/less context) (ignore whitespace changes)
-rw-r--r--cgitrc.5.txt20
1 files changed, 20 insertions, 0 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 0412f64..dc63637 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -34,48 +34,54 @@ cache-dynamic-ttl::
34 34
35cache-repo-ttl:: 35cache-repo-ttl::
36 Number which specifies the time-to-live, in minutes, for the cached 36 Number which specifies the time-to-live, in minutes, for the cached
37 version of the repository summary page. Default value: "5". 37 version of the repository summary page. Default value: "5".
38 38
39cache-root-ttl:: 39cache-root-ttl::
40 Number which specifies the time-to-live, in minutes, for the cached 40 Number which specifies the time-to-live, in minutes, for the cached
41 version of the repository index page. Default value: "5". 41 version of the repository index page. Default value: "5".
42 42
43cache-size:: 43cache-size::
44 The maximum number of entries in the cgit cache. Default value: "0" 44 The maximum number of entries in the cgit cache. Default value: "0"
45 (i.e. caching is disabled). 45 (i.e. caching is disabled).
46 46
47cache-static-ttl:: 47cache-static-ttl::
48 Number which specifies the time-to-live, in minutes, for the cached 48 Number which specifies the time-to-live, in minutes, for the cached
49 version of repository pages accessed with a fixed SHA1. Default value: 49 version of repository pages accessed with a fixed SHA1. Default value:
50 "5". 50 "5".
51 51
52clone-prefix:: 52clone-prefix::
53 Space-separated list of common prefixes which, when combined with a 53 Space-separated list of common prefixes which, when combined with a
54 repository url, generates valid clone urls for the repository. This 54 repository url, generates valid clone urls for the repository. This
55 setting is only used if `repo.clone-url` is unspecified. Default value: 55 setting is only used if `repo.clone-url` is unspecified. Default value:
56 none. 56 none.
57 57
58commit-filter::
59 Specifies a command which will be invoked to format commit messages.
60 The command will get the message on its STDIN, and the STDOUT from the
61 command will be included verbatim as the commit message, i.e. this can
62 be used to implement bugtracker integration. Default value: none.
63
58css:: 64css::
59 Url which specifies the css document to include in all cgit pages. 65 Url which specifies the css document to include in all cgit pages.
60 Default value: "/cgit.css". 66 Default value: "/cgit.css".
61 67
62embedded:: 68embedded::
63 Flag which, when set to "1", will make cgit generate a html fragment 69 Flag which, when set to "1", will make cgit generate a html fragment
64 suitable for embedding in other html pages. Default value: none. See 70 suitable for embedding in other html pages. Default value: none. See
65 also: "noheader". 71 also: "noheader".
66 72
67enable-index-links:: 73enable-index-links::
68 Flag which, when set to "1", will make cgit generate extra links for 74 Flag which, when set to "1", will make cgit generate extra links for
69 each repo in the repository index (specifically, to the "summary", 75 each repo in the repository index (specifically, to the "summary",
70 "commit" and "tree" pages). Default value: "0". 76 "commit" and "tree" pages). Default value: "0".
71 77
72enable-log-filecount:: 78enable-log-filecount::
73 Flag which, when set to "1", will make cgit print the number of 79 Flag which, when set to "1", will make cgit print the number of
74 modified files for each commit on the repository log page. Default 80 modified files for each commit on the repository log page. Default
75 value: "0". 81 value: "0".
76 82
77enable-log-linecount:: 83enable-log-linecount::
78 Flag which, when set to "1", will make cgit print the number of added 84 Flag which, when set to "1", will make cgit print the number of added
79 and removed lines for each commit on the repository log page. Default 85 and removed lines for each commit on the repository log page. Default
80 value: "0". 86 value: "0".
81 87
@@ -185,114 +191,128 @@ robots::
185 191
186root-desc:: 192root-desc::
187 Text printed below the heading on the repository index page. Default 193 Text printed below the heading on the repository index page. Default
188 value: "a fast webinterface for the git dscm". 194 value: "a fast webinterface for the git dscm".
189 195
190root-readme:: 196root-readme::
191 The content of the file specified with this option will be included 197 The content of the file specified with this option will be included
192 verbatim below the "about" link on the repository index page. Default 198 verbatim below the "about" link on the repository index page. Default
193 value: none. 199 value: none.
194 200
195root-title:: 201root-title::
196 Text printed as heading on the repository index page. Default value: 202 Text printed as heading on the repository index page. Default value:
197 "Git Repository Browser". 203 "Git Repository Browser".
198 204
199snapshots:: 205snapshots::
200 Text which specifies the default (and allowed) set of snapshot formats 206 Text which specifies the default (and allowed) set of snapshot formats
201 supported by cgit. The value is a space-separated list of zero or more 207 supported by cgit. The value is a space-separated list of zero or more
202 of the following values: 208 of the following values:
203 "tar" uncompressed tar-file 209 "tar" uncompressed tar-file
204 "tar.gz"gzip-compressed tar-file 210 "tar.gz"gzip-compressed tar-file
205 "tar.bz2"bzip-compressed tar-file 211 "tar.bz2"bzip-compressed tar-file
206 "zip" zip-file 212 "zip" zip-file
207 Default value: none. 213 Default value: none.
208 214
215source-filter::
216 Specifies a command which will be invoked to format plaintext blobs
217 in the tree view. The command will get the blob content on its STDIN
218 and the name of the blob as its only command line argument. The STDOUT
219 from the command will be included verbatim as the blob contents, i.e.
220 this can be used to implement e.g. syntax highlighting. Default value:
221 none.
222
209summary-branches:: 223summary-branches::
210 Specifies the number of branches to display in the repository "summary" 224 Specifies the number of branches to display in the repository "summary"
211 view. Default value: "10". 225 view. Default value: "10".
212 226
213summary-log:: 227summary-log::
214 Specifies the number of log entries to display in the repository 228 Specifies the number of log entries to display in the repository
215 "summary" view. Default value: "10". 229 "summary" view. Default value: "10".
216 230
217summary-tags:: 231summary-tags::
218 Specifies the number of tags to display in the repository "summary" 232 Specifies the number of tags to display in the repository "summary"
219 view. Default value: "10". 233 view. Default value: "10".
220 234
221virtual-root:: 235virtual-root::
222 Url which, if specified, will be used as root for all cgit links. It 236 Url which, if specified, will be used as root for all cgit links. It
223 will also cause cgit to generate 'virtual urls', i.e. urls like 237 will also cause cgit to generate 'virtual urls', i.e. urls like
224 '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default 238 '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default
225 value: none. 239 value: none.
226 NOTE: cgit has recently learned how to use PATH_INFO to achieve the 240 NOTE: cgit has recently learned how to use PATH_INFO to achieve the
227 same kind of virtual urls, so this option will probably be deprecated. 241 same kind of virtual urls, so this option will probably be deprecated.
228 242
229REPOSITORY SETTINGS 243REPOSITORY SETTINGS
230------------------- 244-------------------
231repo.clone-url:: 245repo.clone-url::
232 A list of space-separated urls which can be used to clone this repo. 246 A list of space-separated urls which can be used to clone this repo.
233 Default value: none. 247 Default value: none.
234 248
249repo.commit-filter::
250 Override the default commit-filter. Default value: <commit-filter>.
251
235repo.defbranch:: 252repo.defbranch::
236 The name of the default branch for this repository. If no such branch 253 The name of the default branch for this repository. If no such branch
237 exists in the repository, the first branch name (when sorted) is used 254 exists in the repository, the first branch name (when sorted) is used
238 as default instead. Default value: "master". 255 as default instead. Default value: "master".
239 256
240repo.desc:: 257repo.desc::
241 The value to show as repository description. Default value: none. 258 The value to show as repository description. Default value: none.
242 259
243repo.enable-log-filecount:: 260repo.enable-log-filecount::
244 A flag which can be used to disable the global setting 261 A flag which can be used to disable the global setting
245 `enable-log-filecount'. Default value: none. 262 `enable-log-filecount'. Default value: none.
246 263
247repo.enable-log-linecount:: 264repo.enable-log-linecount::
248 A flag which can be used to disable the global setting 265 A flag which can be used to disable the global setting
249 `enable-log-linecount'. Default value: none. 266 `enable-log-linecount'. Default value: none.
250 267
251repo.max-stats:: 268repo.max-stats::
252 Override the default maximum statistics period. Valid values are equal 269 Override the default maximum statistics period. Valid values are equal
253 to the values specified for the global "max-stats" setting. Default 270 to the values specified for the global "max-stats" setting. Default
254 value: none. 271 value: none.
255 272
256repo.name:: 273repo.name::
257 The value to show as repository name. Default value: <repo.url>. 274 The value to show as repository name. Default value: <repo.url>.
258 275
259repo.owner:: 276repo.owner::
260 A value used to identify the owner of the repository. Default value: 277 A value used to identify the owner of the repository. Default value:
261 none. 278 none.
262 279
263repo.path:: 280repo.path::
264 An absolute path to the repository directory. For non-bare repositories 281 An absolute path to the repository directory. For non-bare repositories
265 this is the .git-directory. Default value: none. 282 this is the .git-directory. Default value: none.
266 283
267repo.readme:: 284repo.readme::
268 A path (relative to <repo.path>) which specifies a file to include 285 A path (relative to <repo.path>) which specifies a file to include
269 verbatim as the "About" page for this repo. Default value: none. 286 verbatim as the "About" page for this repo. Default value: none.
270 287
271repo.snapshots:: 288repo.snapshots::
272 A mask of allowed snapshot-formats for this repo, restricted by the 289 A mask of allowed snapshot-formats for this repo, restricted by the
273 "snapshots" global setting. Default value: <snapshots>. 290 "snapshots" global setting. Default value: <snapshots>.
274 291
292repo.source-filter::
293 Override the default source-filter. Default value: <source-filter>.
294
275repo.url:: 295repo.url::
276 The relative url used to access the repository. This must be the first 296 The relative url used to access the repository. This must be the first
277 setting specified for each repo. Default value: none. 297 setting specified for each repo. Default value: none.
278 298
279 299
280EXAMPLE CGITRC FILE 300EXAMPLE CGITRC FILE
281------------------- 301-------------------
282 302
283.... 303....
284# Enable caching of up to 1000 output entriess 304# Enable caching of up to 1000 output entriess
285cache-size=1000 305cache-size=1000
286 306
287 307
288# Specify some default clone prefixes 308# Specify some default clone prefixes
289clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git 309clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git
290 310
291# Specify the css url 311# Specify the css url
292css=/css/cgit.css 312css=/css/cgit.css
293 313
294 314
295# Show extra links for each repository on the index page 315# Show extra links for each repository on the index page
296enable-index-links=1 316enable-index-links=1
297 317
298 318