summaryrefslogtreecommitdiffabout
path: root/cgitrc.5.txt
Unidiff
Diffstat (limited to 'cgitrc.5.txt') (more/less context) (ignore whitespace changes)
-rw-r--r--cgitrc.5.txt17
1 files changed, 17 insertions, 0 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 0c13485..d74d9e7 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -89,48 +89,53 @@ css::
89embedded:: 89embedded::
90 Flag which, when set to "1", will make cgit generate a html fragment 90 Flag which, when set to "1", will make cgit generate a html fragment
91 suitable for embedding in other html pages. Default value: none. See 91 suitable for embedding in other html pages. Default value: none. See
92 also: "noheader". 92 also: "noheader".
93 93
94enable-filter-overrides:: 94enable-filter-overrides::
95 Flag which, when set to "1", allows all filter settings to be 95 Flag which, when set to "1", allows all filter settings to be
96 overridden in repository-specific cgitrc files. Default value: none. 96 overridden in repository-specific cgitrc files. Default value: none.
97 97
98enable-index-links:: 98enable-index-links::
99 Flag which, when set to "1", will make cgit generate extra links for 99 Flag which, when set to "1", will make cgit generate extra links for
100 each repo in the repository index (specifically, to the "summary", 100 each repo in the repository index (specifically, to the "summary",
101 "commit" and "tree" pages). Default value: "0". 101 "commit" and "tree" pages). Default value: "0".
102 102
103enable-log-filecount:: 103enable-log-filecount::
104 Flag which, when set to "1", will make cgit print the number of 104 Flag which, when set to "1", will make cgit print the number of
105 modified files for each commit on the repository log page. Default 105 modified files for each commit on the repository log page. Default
106 value: "0". 106 value: "0".
107 107
108enable-log-linecount:: 108enable-log-linecount::
109 Flag which, when set to "1", will make cgit print the number of added 109 Flag which, when set to "1", will make cgit print the number of added
110 and removed lines for each commit on the repository log page. Default 110 and removed lines for each commit on the repository log page. Default
111 value: "0". 111 value: "0".
112 112
113enable-remote-branches::
114 Flag which, when set to "1", will make cgit display remote branches
115 in the summary and refs views. Default value: "0". See also:
116 "repo.enable-remote-branches".
117
113enable-tree-linenumbers:: 118enable-tree-linenumbers::
114 Flag which, when set to "1", will make cgit generate linenumber links 119 Flag which, when set to "1", will make cgit generate linenumber links
115 for plaintext blobs printed in the tree view. Default value: "1". 120 for plaintext blobs printed in the tree view. Default value: "1".
116 121
117favicon:: 122favicon::
118 Url used as link to a shortcut icon for cgit. If specified, it is 123 Url used as link to a shortcut icon for cgit. If specified, it is
119 suggested to use the value "/favicon.ico" since certain browsers will 124 suggested to use the value "/favicon.ico" since certain browsers will
120 ignore other values. Default value: none. 125 ignore other values. Default value: none.
121 126
122footer:: 127footer::
123 The content of the file specified with this option will be included 128 The content of the file specified with this option will be included
124 verbatim at the bottom of all pages (i.e. it replaces the standard 129 verbatim at the bottom of all pages (i.e. it replaces the standard
125 "generated by..." message. Default value: none. 130 "generated by..." message. Default value: none.
126 131
127head-include:: 132head-include::
128 The content of the file specified with this option will be included 133 The content of the file specified with this option will be included
129 verbatim in the html HEAD section on all pages. Default value: none. 134 verbatim in the html HEAD section on all pages. Default value: none.
130 135
131header:: 136header::
132 The content of the file specified with this option will be included 137 The content of the file specified with this option will be included
133 verbatim at the top of all pages. Default value: none. 138 verbatim at the top of all pages. Default value: none.
134 139
135include:: 140include::
136 Name of a configfile to include before the rest of the current config- 141 Name of a configfile to include before the rest of the current config-
@@ -156,48 +161,52 @@ logo::
156 Url which specifies the source of an image which will be used as a logo 161 Url which specifies the source of an image which will be used as a logo
157 on all cgit pages. Default value: "/cgit.png". 162 on all cgit pages. Default value: "/cgit.png".
158 163
159logo-link:: 164logo-link::
160 Url loaded when clicking on the cgit logo image. If unspecified the 165 Url loaded when clicking on the cgit logo image. If unspecified the
161 calculated url of the repository index page will be used. Default 166 calculated url of the repository index page will be used. Default
162 value: none. 167 value: none.
163 168
164max-commit-count:: 169max-commit-count::
165 Specifies the number of entries to list per page in "log" view. Default 170 Specifies the number of entries to list per page in "log" view. Default
166 value: "50". 171 value: "50".
167 172
168max-message-length:: 173max-message-length::
169 Specifies the maximum number of commit message characters to display in 174 Specifies the maximum number of commit message characters to display in
170 "log" view. Default value: "80". 175 "log" view. Default value: "80".
171 176
172max-repo-count:: 177max-repo-count::
173 Specifies the number of entries to list per page on therepository 178 Specifies the number of entries to list per page on therepository
174 index page. Default value: "50". 179 index page. Default value: "50".
175 180
176max-repodesc-length:: 181max-repodesc-length::
177 Specifies the maximum number of repo description characters to display 182 Specifies the maximum number of repo description characters to display
178 on the repository index page. Default value: "80". 183 on the repository index page. Default value: "80".
179 184
185max-blob-size::
186 Specifies the maximum size of a blob to display HTML for in KBytes.
187 Default value: "0" (limit disabled).
188
180max-stats:: 189max-stats::
181 Set the default maximum statistics period. Valid values are "week", 190 Set the default maximum statistics period. Valid values are "week",
182 "month", "quarter" and "year". If unspecified, statistics are 191 "month", "quarter" and "year". If unspecified, statistics are
183 disabled. Default value: none. See also: "repo.max-stats". 192 disabled. Default value: none. See also: "repo.max-stats".
184 193
185mimetype.<ext>:: 194mimetype.<ext>::
186 Set the mimetype for the specified filename extension. This is used 195 Set the mimetype for the specified filename extension. This is used
187 by the `plain` command when returning blob content. 196 by the `plain` command when returning blob content.
188 197
189module-link:: 198module-link::
190 Text which will be used as the formatstring for a hyperlink when a 199 Text which will be used as the formatstring for a hyperlink when a
191 submodule is printed in a directory listing. The arguments for the 200 submodule is printed in a directory listing. The arguments for the
192 formatstring are the path and SHA1 of the submodule commit. Default 201 formatstring are the path and SHA1 of the submodule commit. Default
193 value: "./?repo=%s&page=commit&id=%s" 202 value: "./?repo=%s&page=commit&id=%s"
194 203
195nocache:: 204nocache::
196 If set to the value "1" caching will be disabled. This settings is 205 If set to the value "1" caching will be disabled. This settings is
197 deprecated, and will not be honored starting with cgit-1.0. Default 206 deprecated, and will not be honored starting with cgit-1.0. Default
198 value: "0". 207 value: "0".
199 208
200noplainemail:: 209noplainemail::
201 If set to "1" showing full author email adresses will be disabled. 210 If set to "1" showing full author email adresses will be disabled.
202 Default value: "0". 211 Default value: "0".
203 212
@@ -220,48 +229,52 @@ robots::
220 229
221root-desc:: 230root-desc::
222 Text printed below the heading on the repository index page. Default 231 Text printed below the heading on the repository index page. Default
223 value: "a fast webinterface for the git dscm". 232 value: "a fast webinterface for the git dscm".
224 233
225root-readme:: 234root-readme::
226 The content of the file specified with this option will be included 235 The content of the file specified with this option will be included
227 verbatim below the "about" link on the repository index page. Default 236 verbatim below the "about" link on the repository index page. Default
228 value: none. 237 value: none.
229 238
230root-title:: 239root-title::
231 Text printed as heading on the repository index page. Default value: 240 Text printed as heading on the repository index page. Default value:
232 "Git Repository Browser". 241 "Git Repository Browser".
233 242
234scan-path:: 243scan-path::
235 A path which will be scanned for repositories. If caching is enabled, 244 A path which will be scanned for repositories. If caching is enabled,
236 the result will be cached as a cgitrc include-file in the cache 245 the result will be cached as a cgitrc include-file in the cache
237 directory. Default value: none. See also: cache-scanrc-ttl. 246 directory. Default value: none. See also: cache-scanrc-ttl.
238 247
239section:: 248section::
240 The name of the current repository section - all repositories defined 249 The name of the current repository section - all repositories defined
241 after this option will inherit the current section name. Default value: 250 after this option will inherit the current section name. Default value:
242 none. 251 none.
243 252
253side-by-side-diffs::
254 If set to "1" shows side-by-side diffs instead of unidiffs per
255 default. Default value: "0".
256
244snapshots:: 257snapshots::
245 Text which specifies the default set of snapshot formats generated by 258 Text which specifies the default set of snapshot formats generated by
246 cgit. The value is a space-separated list of zero or more of the 259 cgit. The value is a space-separated list of zero or more of the
247 values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none. 260 values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none.
248 261
249source-filter:: 262source-filter::
250 Specifies a command which will be invoked to format plaintext blobs 263 Specifies a command which will be invoked to format plaintext blobs
251 in the tree view. The command will get the blob content on its STDIN 264 in the tree view. The command will get the blob content on its STDIN
252 and the name of the blob as its only command line argument. The STDOUT 265 and the name of the blob as its only command line argument. The STDOUT
253 from the command will be included verbatim as the blob contents, i.e. 266 from the command will be included verbatim as the blob contents, i.e.
254 this can be used to implement e.g. syntax highlighting. Default value: 267 this can be used to implement e.g. syntax highlighting. Default value:
255 none. 268 none.
256 269
257summary-branches:: 270summary-branches::
258 Specifies the number of branches to display in the repository "summary" 271 Specifies the number of branches to display in the repository "summary"
259 view. Default value: "10". 272 view. Default value: "10".
260 273
261summary-log:: 274summary-log::
262 Specifies the number of log entries to display in the repository 275 Specifies the number of log entries to display in the repository
263 "summary" view. Default value: "10". 276 "summary" view. Default value: "10".
264 277
265summary-tags:: 278summary-tags::
266 Specifies the number of tags to display in the repository "summary" 279 Specifies the number of tags to display in the repository "summary"
267 view. Default value: "10". 280 view. Default value: "10".
@@ -283,48 +296,52 @@ repo.about-filter::
283repo.clone-url:: 296repo.clone-url::
284 A list of space-separated urls which can be used to clone this repo. 297 A list of space-separated urls which can be used to clone this repo.
285 Default value: none. 298 Default value: none.
286 299
287repo.commit-filter:: 300repo.commit-filter::
288 Override the default commit-filter. Default value: none. See also: 301 Override the default commit-filter. Default value: none. See also:
289 "enable-filter-overrides". 302 "enable-filter-overrides".
290 303
291repo.defbranch:: 304repo.defbranch::
292 The name of the default branch for this repository. If no such branch 305 The name of the default branch for this repository. If no such branch
293 exists in the repository, the first branch name (when sorted) is used 306 exists in the repository, the first branch name (when sorted) is used
294 as default instead. Default value: "master". 307 as default instead. Default value: "master".
295 308
296repo.desc:: 309repo.desc::
297 The value to show as repository description. Default value: none. 310 The value to show as repository description. Default value: none.
298 311
299repo.enable-log-filecount:: 312repo.enable-log-filecount::
300 A flag which can be used to disable the global setting 313 A flag which can be used to disable the global setting
301 `enable-log-filecount'. Default value: none. 314 `enable-log-filecount'. Default value: none.
302 315
303repo.enable-log-linecount:: 316repo.enable-log-linecount::
304 A flag which can be used to disable the global setting 317 A flag which can be used to disable the global setting
305 `enable-log-linecount'. Default value: none. 318 `enable-log-linecount'. Default value: none.
306 319
320repo.enable-remote-branches::
321 Flag which, when set to "1", will make cgit display remote branches
322 in the summary and refs views. Default value: <enable-remote-branches>.
323
307repo.max-stats:: 324repo.max-stats::
308 Override the default maximum statistics period. Valid values are equal 325 Override the default maximum statistics period. Valid values are equal
309 to the values specified for the global "max-stats" setting. Default 326 to the values specified for the global "max-stats" setting. Default
310 value: none. 327 value: none.
311 328
312repo.name:: 329repo.name::
313 The value to show as repository name. Default value: <repo.url>. 330 The value to show as repository name. Default value: <repo.url>.
314 331
315repo.owner:: 332repo.owner::
316 A value used to identify the owner of the repository. Default value: 333 A value used to identify the owner of the repository. Default value:
317 none. 334 none.
318 335
319repo.path:: 336repo.path::
320 An absolute path to the repository directory. For non-bare repositories 337 An absolute path to the repository directory. For non-bare repositories
321 this is the .git-directory. Default value: none. 338 this is the .git-directory. Default value: none.
322 339
323repo.readme:: 340repo.readme::
324 A path (relative to <repo.path>) which specifies a file to include 341 A path (relative to <repo.path>) which specifies a file to include
325 verbatim as the "About" page for this repo. Default value: none. 342 verbatim as the "About" page for this repo. Default value: none.
326 343
327repo.snapshots:: 344repo.snapshots::
328 A mask of allowed snapshot-formats for this repo, restricted by the 345 A mask of allowed snapshot-formats for this repo, restricted by the
329 "snapshots" global setting. Default value: <snapshots>. 346 "snapshots" global setting. Default value: <snapshots>.
330 347