summaryrefslogtreecommitdiffabout
path: root/cgitrc.5.txt
Unidiff
Diffstat (limited to 'cgitrc.5.txt') (more/less context) (ignore whitespace changes)
-rw-r--r--cgitrc.5.txt10
1 files changed, 9 insertions, 1 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index a853522..ec004d4 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -131,222 +131,230 @@ favicon::
131 ignore other values. Default value: none. 131 ignore other values. Default value: none.
132 132
133footer:: 133footer::
134 The content of the file specified with this option will be included 134 The content of the file specified with this option will be included
135 verbatim at the bottom of all pages (i.e. it replaces the standard 135 verbatim at the bottom of all pages (i.e. it replaces the standard
136 "generated by..." message. Default value: none. 136 "generated by..." message. Default value: none.
137 137
138head-include:: 138head-include::
139 The content of the file specified with this option will be included 139 The content of the file specified with this option will be included
140 verbatim in the html HEAD section on all pages. Default value: none. 140 verbatim in the html HEAD section on all pages. Default value: none.
141 141
142header:: 142header::
143 The content of the file specified with this option will be included 143 The content of the file specified with this option will be included
144 verbatim at the top of all pages. Default value: none. 144 verbatim at the top of all pages. Default value: none.
145 145
146include:: 146include::
147 Name of a configfile to include before the rest of the current config- 147 Name of a configfile to include before the rest of the current config-
148 file is parsed. Default value: none. 148 file is parsed. Default value: none.
149 149
150index-header:: 150index-header::
151 The content of the file specified with this option will be included 151 The content of the file specified with this option will be included
152 verbatim above the repository index. This setting is deprecated, and 152 verbatim above the repository index. This setting is deprecated, and
153 will not be supported by cgit-1.0 (use root-readme instead). Default 153 will not be supported by cgit-1.0 (use root-readme instead). Default
154 value: none. 154 value: none.
155 155
156index-info:: 156index-info::
157 The content of the file specified with this option will be included 157 The content of the file specified with this option will be included
158 verbatim below the heading on the repository index page. This setting 158 verbatim below the heading on the repository index page. This setting
159 is deprecated, and will not be supported by cgit-1.0 (use root-desc 159 is deprecated, and will not be supported by cgit-1.0 (use root-desc
160 instead). Default value: none. 160 instead). Default value: none.
161 161
162local-time:: 162local-time::
163 Flag which, if set to "1", makes cgit print commit and tag times in the 163 Flag which, if set to "1", makes cgit print commit and tag times in the
164 servers timezone. Default value: "0". 164 servers timezone. Default value: "0".
165 165
166logo:: 166logo::
167 Url which specifies the source of an image which will be used as a logo 167 Url which specifies the source of an image which will be used as a logo
168 on all cgit pages. Default value: "/cgit.png". 168 on all cgit pages. Default value: "/cgit.png".
169 169
170logo-link:: 170logo-link::
171 Url loaded when clicking on the cgit logo image. If unspecified the 171 Url loaded when clicking on the cgit logo image. If unspecified the
172 calculated url of the repository index page will be used. Default 172 calculated url of the repository index page will be used. Default
173 value: none. 173 value: none.
174 174
175max-atom-items:: 175max-atom-items::
176 Specifies the number of items to display in atom feeds view. Default 176 Specifies the number of items to display in atom feeds view. Default
177 value: "10". 177 value: "10".
178 178
179max-commit-count:: 179max-commit-count::
180 Specifies the number of entries to list per page in "log" view. Default 180 Specifies the number of entries to list per page in "log" view. Default
181 value: "50". 181 value: "50".
182 182
183max-message-length:: 183max-message-length::
184 Specifies the maximum number of commit message characters to display in 184 Specifies the maximum number of commit message characters to display in
185 "log" view. Default value: "80". 185 "log" view. Default value: "80".
186 186
187max-repo-count:: 187max-repo-count::
188 Specifies the number of entries to list per page on therepository 188 Specifies the number of entries to list per page on therepository
189 index page. Default value: "50". 189 index page. Default value: "50".
190 190
191max-repodesc-length:: 191max-repodesc-length::
192 Specifies the maximum number of repo description characters to display 192 Specifies the maximum number of repo description characters to display
193 on the repository index page. Default value: "80". 193 on the repository index page. Default value: "80".
194 194
195max-blob-size:: 195max-blob-size::
196 Specifies the maximum size of a blob to display HTML for in KBytes. 196 Specifies the maximum size of a blob to display HTML for in KBytes.
197 Default value: "0" (limit disabled). 197 Default value: "0" (limit disabled).
198 198
199max-stats:: 199max-stats::
200 Set the default maximum statistics period. Valid values are "week", 200 Set the default maximum statistics period. Valid values are "week",
201 "month", "quarter" and "year". If unspecified, statistics are 201 "month", "quarter" and "year". If unspecified, statistics are
202 disabled. Default value: none. See also: "repo.max-stats". 202 disabled. Default value: none. See also: "repo.max-stats".
203 203
204mimetype.<ext>:: 204mimetype.<ext>::
205 Set the mimetype for the specified filename extension. This is used 205 Set the mimetype for the specified filename extension. This is used
206 by the `plain` command when returning blob content. 206 by the `plain` command when returning blob content.
207 207
208module-link:: 208module-link::
209 Text which will be used as the formatstring for a hyperlink when a 209 Text which will be used as the formatstring for a hyperlink when a
210 submodule is printed in a directory listing. The arguments for the 210 submodule is printed in a directory listing. The arguments for the
211 formatstring are the path and SHA1 of the submodule commit. Default 211 formatstring are the path and SHA1 of the submodule commit. Default
212 value: "./?repo=%s&page=commit&id=%s" 212 value: "./?repo=%s&page=commit&id=%s"
213 213
214nocache:: 214nocache::
215 If set to the value "1" caching will be disabled. This settings is 215 If set to the value "1" caching will be disabled. This settings is
216 deprecated, and will not be honored starting with cgit-1.0. Default 216 deprecated, and will not be honored starting with cgit-1.0. Default
217 value: "0". 217 value: "0".
218 218
219noplainemail:: 219noplainemail::
220 If set to "1" showing full author email adresses will be disabled. 220 If set to "1" showing full author email adresses will be disabled.
221 Default value: "0". 221 Default value: "0".
222 222
223noheader:: 223noheader::
224 Flag which, when set to "1", will make cgit omit the standard header 224 Flag which, when set to "1", will make cgit omit the standard header
225 on all pages. Default value: none. See also: "embedded". 225 on all pages. Default value: none. See also: "embedded".
226 226
227project-list::
228 A list of subdirectories inside of scan-path, relative to it, that
229 should loaded as git repositories. This must be defined prior to
230 scan-path. Default value: none. See also: scan-path.
231
227renamelimit:: 232renamelimit::
228 Maximum number of files to consider when detecting renames. The value 233 Maximum number of files to consider when detecting renames. The value
229 "-1" uses the compiletime value in git (for further info, look at 234 "-1" uses the compiletime value in git (for further info, look at
230 `man git-diff`). Default value: "-1". 235 `man git-diff`). Default value: "-1".
231 236
232repo.group:: 237repo.group::
233 Legacy alias for "section". This option is deprecated and will not be 238 Legacy alias for "section". This option is deprecated and will not be
234 supported in cgit-1.0. 239 supported in cgit-1.0.
235 240
236robots:: 241robots::
237 Text used as content for the "robots" meta-tag. Default value: 242 Text used as content for the "robots" meta-tag. Default value:
238 "index, nofollow". 243 "index, nofollow".
239 244
240root-desc:: 245root-desc::
241 Text printed below the heading on the repository index page. Default 246 Text printed below the heading on the repository index page. Default
242 value: "a fast webinterface for the git dscm". 247 value: "a fast webinterface for the git dscm".
243 248
244root-readme:: 249root-readme::
245 The content of the file specified with this option will be included 250 The content of the file specified with this option will be included
246 verbatim below the "about" link on the repository index page. Default 251 verbatim below the "about" link on the repository index page. Default
247 value: none. 252 value: none.
248 253
249root-title:: 254root-title::
250 Text printed as heading on the repository index page. Default value: 255 Text printed as heading on the repository index page. Default value:
251 "Git Repository Browser". 256 "Git Repository Browser".
252 257
253scan-path:: 258scan-path::
254 A path which will be scanned for repositories. If caching is enabled, 259 A path which will be scanned for repositories. If caching is enabled,
255 the result will be cached as a cgitrc include-file in the cache 260 the result will be cached as a cgitrc include-file in the cache
256 directory. Default value: none. See also: cache-scanrc-ttl. 261 directory. If project-list has been defined prior to scan-path,
262 scan-path loads only the directories listed in the file pointed to by
263 project-list. Default value: none. See also: cache-scanrc-ttl,
264 project-list.
257 265
258section:: 266section::
259 The name of the current repository section - all repositories defined 267 The name of the current repository section - all repositories defined
260 after this option will inherit the current section name. Default value: 268 after this option will inherit the current section name. Default value:
261 none. 269 none.
262 270
263side-by-side-diffs:: 271side-by-side-diffs::
264 If set to "1" shows side-by-side diffs instead of unidiffs per 272 If set to "1" shows side-by-side diffs instead of unidiffs per
265 default. Default value: "0". 273 default. Default value: "0".
266 274
267snapshots:: 275snapshots::
268 Text which specifies the default set of snapshot formats generated by 276 Text which specifies the default set of snapshot formats generated by
269 cgit. The value is a space-separated list of zero or more of the 277 cgit. The value is a space-separated list of zero or more of the
270 values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none. 278 values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none.
271 279
272source-filter:: 280source-filter::
273 Specifies a command which will be invoked to format plaintext blobs 281 Specifies a command which will be invoked to format plaintext blobs
274 in the tree view. The command will get the blob content on its STDIN 282 in the tree view. The command will get the blob content on its STDIN
275 and the name of the blob as its only command line argument. The STDOUT 283 and the name of the blob as its only command line argument. The STDOUT
276 from the command will be included verbatim as the blob contents, i.e. 284 from the command will be included verbatim as the blob contents, i.e.
277 this can be used to implement e.g. syntax highlighting. Default value: 285 this can be used to implement e.g. syntax highlighting. Default value:
278 none. 286 none.
279 287
280summary-branches:: 288summary-branches::
281 Specifies the number of branches to display in the repository "summary" 289 Specifies the number of branches to display in the repository "summary"
282 view. Default value: "10". 290 view. Default value: "10".
283 291
284summary-log:: 292summary-log::
285 Specifies the number of log entries to display in the repository 293 Specifies the number of log entries to display in the repository
286 "summary" view. Default value: "10". 294 "summary" view. Default value: "10".
287 295
288summary-tags:: 296summary-tags::
289 Specifies the number of tags to display in the repository "summary" 297 Specifies the number of tags to display in the repository "summary"
290 view. Default value: "10". 298 view. Default value: "10".
291 299
292virtual-root:: 300virtual-root::
293 Url which, if specified, will be used as root for all cgit links. It 301 Url which, if specified, will be used as root for all cgit links. It
294 will also cause cgit to generate 'virtual urls', i.e. urls like 302 will also cause cgit to generate 'virtual urls', i.e. urls like
295 '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default 303 '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default
296 value: none. 304 value: none.
297 NOTE: cgit has recently learned how to use PATH_INFO to achieve the 305 NOTE: cgit has recently learned how to use PATH_INFO to achieve the
298 same kind of virtual urls, so this option will probably be deprecated. 306 same kind of virtual urls, so this option will probably be deprecated.
299 307
300REPOSITORY SETTINGS 308REPOSITORY SETTINGS
301------------------- 309-------------------
302repo.about-filter:: 310repo.about-filter::
303 Override the default about-filter. Default value: none. See also: 311 Override the default about-filter. Default value: none. See also:
304 "enable-filter-overrides". 312 "enable-filter-overrides".
305 313
306repo.clone-url:: 314repo.clone-url::
307 A list of space-separated urls which can be used to clone this repo. 315 A list of space-separated urls which can be used to clone this repo.
308 Default value: none. 316 Default value: none.
309 317
310repo.commit-filter:: 318repo.commit-filter::
311 Override the default commit-filter. Default value: none. See also: 319 Override the default commit-filter. Default value: none. See also:
312 "enable-filter-overrides". 320 "enable-filter-overrides".
313 321
314repo.defbranch:: 322repo.defbranch::
315 The name of the default branch for this repository. If no such branch 323 The name of the default branch for this repository. If no such branch
316 exists in the repository, the first branch name (when sorted) is used 324 exists in the repository, the first branch name (when sorted) is used
317 as default instead. Default value: "master". 325 as default instead. Default value: "master".
318 326
319repo.desc:: 327repo.desc::
320 The value to show as repository description. Default value: none. 328 The value to show as repository description. Default value: none.
321 329
322repo.enable-log-filecount:: 330repo.enable-log-filecount::
323 A flag which can be used to disable the global setting 331 A flag which can be used to disable the global setting
324 `enable-log-filecount'. Default value: none. 332 `enable-log-filecount'. Default value: none.
325 333
326repo.enable-log-linecount:: 334repo.enable-log-linecount::
327 A flag which can be used to disable the global setting 335 A flag which can be used to disable the global setting
328 `enable-log-linecount'. Default value: none. 336 `enable-log-linecount'. Default value: none.
329 337
330repo.enable-remote-branches:: 338repo.enable-remote-branches::
331 Flag which, when set to "1", will make cgit display remote branches 339 Flag which, when set to "1", will make cgit display remote branches
332 in the summary and refs views. Default value: <enable-remote-branches>. 340 in the summary and refs views. Default value: <enable-remote-branches>.
333 341
334repo.enable-subject-links:: 342repo.enable-subject-links::
335 A flag which can be used to override the global setting 343 A flag which can be used to override the global setting
336 `enable-subject-links'. Default value: none. 344 `enable-subject-links'. Default value: none.
337 345
338repo.max-stats:: 346repo.max-stats::
339 Override the default maximum statistics period. Valid values are equal 347 Override the default maximum statistics period. Valid values are equal
340 to the values specified for the global "max-stats" setting. Default 348 to the values specified for the global "max-stats" setting. Default
341 value: none. 349 value: none.
342 350
343repo.name:: 351repo.name::
344 The value to show as repository name. Default value: <repo.url>. 352 The value to show as repository name. Default value: <repo.url>.
345 353
346repo.owner:: 354repo.owner::
347 A value used to identify the owner of the repository. Default value: 355 A value used to identify the owner of the repository. Default value:
348 none. 356 none.
349 357
350repo.path:: 358repo.path::
351 An absolute path to the repository directory. For non-bare repositories 359 An absolute path to the repository directory. For non-bare repositories
352 this is the .git-directory. Default value: none. 360 this is the .git-directory. Default value: none.