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, 5 insertions, 5 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 68ae2ed..2abbd41 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -158,118 +158,118 @@ max-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 A value for the current repository group, which all repositories 203 A value for the current repository group, which all repositories
204 specified after this setting will inherit. Default value: none. 204 specified after this setting will inherit. Default value: none.
205 205
206repo.scan::
207 A path which will be scanned for repositories. If caching is enabled,
208 the result will be cached as a cgitrc include-file in the cache
209 directory. Default value: none. See also: cache-scanrc-ttl.
210
211robots:: 206robots::
212 Text used as content for the "robots" meta-tag. Default value: 207 Text used as content for the "robots" meta-tag. Default value:
213 "index, nofollow". 208 "index, nofollow".
214 209
215root-desc:: 210root-desc::
216 Text printed below the heading on the repository index page. Default 211 Text printed below the heading on the repository index page. Default
217 value: "a fast webinterface for the git dscm". 212 value: "a fast webinterface for the git dscm".
218 213
219root-readme:: 214root-readme::
220 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
221 verbatim below the "about" link on the repository index page. Default 216 verbatim below the "about" link on the repository index page. Default
222 value: none. 217 value: none.
223 218
224root-title:: 219root-title::
225 Text printed as heading on the repository index page. Default value: 220 Text printed as heading on the repository index page. Default value:
226 "Git Repository Browser". 221 "Git Repository Browser".
227 222
223scan-path::
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
226 directory. Default value: none. See also: cache-scanrc-ttl.
227
228snapshots:: 228snapshots::
229 Text which specifies the default set of snapshot formats generated by 229 Text which specifies the default set of snapshot formats generated by
230 cgit. The value is a space-separated list of zero or more of the 230 cgit. The value is a space-separated list of zero or more of the
231 values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none. 231 values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none.
232 232
233source-filter:: 233source-filter::
234 Specifies a command which will be invoked to format plaintext blobs 234 Specifies a command which will be invoked to format plaintext blobs
235 in the tree view. The command will get the blob content on its STDIN 235 in the tree view. The command will get the blob content on its STDIN
236 and the name of the blob as its only command line argument. The STDOUT 236 and the name of the blob as its only command line argument. The STDOUT
237 from the command will be included verbatim as the blob contents, i.e. 237 from the command will be included verbatim as the blob contents, i.e.
238 this can be used to implement e.g. syntax highlighting. Default value: 238 this can be used to implement e.g. syntax highlighting. Default value:
239 none. 239 none.
240 240
241summary-branches:: 241summary-branches::
242 Specifies the number of branches to display in the repository "summary" 242 Specifies the number of branches to display in the repository "summary"
243 view. Default value: "10". 243 view. Default value: "10".
244 244
245summary-log:: 245summary-log::
246 Specifies the number of log entries to display in the repository 246 Specifies the number of log entries to display in the repository
247 "summary" view. Default value: "10". 247 "summary" view. Default value: "10".
248 248
249summary-tags:: 249summary-tags::
250 Specifies the number of tags to display in the repository "summary" 250 Specifies the number of tags to display in the repository "summary"
251 view. Default value: "10". 251 view. Default value: "10".
252 252
253virtual-root:: 253virtual-root::
254 Url which, if specified, will be used as root for all cgit links. It 254 Url which, if specified, will be used as root for all cgit links. It
255 will also cause cgit to generate 'virtual urls', i.e. urls like 255 will also cause cgit to generate 'virtual urls', i.e. urls like
256 '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default 256 '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default
257 value: none. 257 value: none.
258 NOTE: cgit has recently learned how to use PATH_INFO to achieve the 258 NOTE: cgit has recently learned how to use PATH_INFO to achieve the
259 same kind of virtual urls, so this option will probably be deprecated. 259 same kind of virtual urls, so this option will probably be deprecated.
260 260
261REPOSITORY SETTINGS 261REPOSITORY SETTINGS
262------------------- 262-------------------
263repo.about-filter:: 263repo.about-filter::
264 Override the default about-filter. Default value: <about-filter>. 264 Override the default about-filter. Default value: <about-filter>.
265 265
266repo.clone-url:: 266repo.clone-url::
267 A list of space-separated urls which can be used to clone this repo. 267 A list of space-separated urls which can be used to clone this repo.
268 Default value: none. 268 Default value: none.
269 269
270repo.commit-filter:: 270repo.commit-filter::
271 Override the default commit-filter. Default value: <commit-filter>. 271 Override the default commit-filter. Default value: <commit-filter>.
272 272
273repo.defbranch:: 273repo.defbranch::
274 The name of the default branch for this repository. If no such branch 274 The name of the default branch for this repository. If no such branch
275 exists in the repository, the first branch name (when sorted) is used 275 exists in the repository, the first branch name (when sorted) is used