-rw-r--r-- | cgitrc.5.txt | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt index 2efd6aa..ffb3e0f 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt | |||
@@ -193,136 +193,142 @@ root-readme:: | |||
193 | root-title:: | 193 | root-title:: |
194 | Text printed as heading on the repository index page. Default value: | 194 | Text printed as heading on the repository index page. Default value: |
195 | "Git Repository Browser". | 195 | "Git Repository Browser". |
196 | 196 | ||
197 | snapshots:: | 197 | snapshots:: |
198 | Text which specifies the default (and allowed) set of snapshot formats | 198 | Text which specifies the default (and allowed) set of snapshot formats |
199 | supported by cgit. The value is a space-separated list of zero or more | 199 | supported by cgit. The value is a space-separated list of zero or more |
200 | of the following values: | 200 | of the following values: |
201 | "tar" uncompressed tar-file | 201 | "tar" uncompressed tar-file |
202 | "tar.gz"gzip-compressed tar-file | 202 | "tar.gz"gzip-compressed tar-file |
203 | "tar.bz2"bzip-compressed tar-file | 203 | "tar.bz2"bzip-compressed tar-file |
204 | "zip" zip-file | 204 | "zip" zip-file |
205 | Default value: none. | 205 | Default value: none. |
206 | 206 | ||
207 | source-filter:: | 207 | source-filter:: |
208 | Specifies a command which will be invoked to format plaintext blobs | 208 | Specifies a command which will be invoked to format plaintext blobs |
209 | in the tree view. The command will get the blob content on its STDIN | 209 | in the tree view. The command will get the blob content on its STDIN |
210 | and the name of the blob as its only command line argument. The STDOUT | 210 | and the name of the blob as its only command line argument. The STDOUT |
211 | from the command will be included verbatim as the blob contents, i.e. | 211 | from the command will be included verbatim as the blob contents, i.e. |
212 | this can be used to implement e.g. syntax highlighting. Default value: | 212 | this can be used to implement e.g. syntax highlighting. Default value: |
213 | none. | 213 | none. |
214 | 214 | ||
215 | summary-branches:: | 215 | summary-branches:: |
216 | Specifies the number of branches to display in the repository "summary" | 216 | Specifies the number of branches to display in the repository "summary" |
217 | view. Default value: "10". | 217 | view. Default value: "10". |
218 | 218 | ||
219 | summary-log:: | 219 | summary-log:: |
220 | Specifies the number of log entries to display in the repository | 220 | Specifies the number of log entries to display in the repository |
221 | "summary" view. Default value: "10". | 221 | "summary" view. Default value: "10". |
222 | 222 | ||
223 | summary-tags:: | 223 | summary-tags:: |
224 | Specifies the number of tags to display in the repository "summary" | 224 | Specifies the number of tags to display in the repository "summary" |
225 | view. Default value: "10". | 225 | view. Default value: "10". |
226 | 226 | ||
227 | virtual-root:: | 227 | virtual-root:: |
228 | Url which, if specified, will be used as root for all cgit links. It | 228 | Url which, if specified, will be used as root for all cgit links. It |
229 | will also cause cgit to generate 'virtual urls', i.e. urls like | 229 | will also cause cgit to generate 'virtual urls', i.e. urls like |
230 | '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default | 230 | '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default |
231 | value: none. | 231 | value: none. |
232 | NOTE: cgit has recently learned how to use PATH_INFO to achieve the | 232 | NOTE: cgit has recently learned how to use PATH_INFO to achieve the |
233 | same kind of virtual urls, so this option will probably be deprecated. | 233 | same kind of virtual urls, so this option will probably be deprecated. |
234 | 234 | ||
235 | REPOSITORY SETTINGS | 235 | REPOSITORY SETTINGS |
236 | ------------------- | 236 | ------------------- |
237 | repo.clone-url:: | 237 | repo.clone-url:: |
238 | A list of space-separated urls which can be used to clone this repo. | 238 | A list of space-separated urls which can be used to clone this repo. |
239 | Default value: none. | 239 | Default value: none. |
240 | 240 | ||
241 | repo.commit-filter:: | ||
242 | Override the default commit-filter. Default value: <commit-filter>. | ||
243 | |||
241 | repo.defbranch:: | 244 | repo.defbranch:: |
242 | The name of the default branch for this repository. If no such branch | 245 | The name of the default branch for this repository. If no such branch |
243 | exists in the repository, the first branch name (when sorted) is used | 246 | exists in the repository, the first branch name (when sorted) is used |
244 | as default instead. Default value: "master". | 247 | as default instead. Default value: "master". |
245 | 248 | ||
246 | repo.desc:: | 249 | repo.desc:: |
247 | The value to show as repository description. Default value: none. | 250 | The value to show as repository description. Default value: none. |
248 | 251 | ||
249 | repo.enable-log-filecount:: | 252 | repo.enable-log-filecount:: |
250 | A flag which can be used to disable the global setting | 253 | A flag which can be used to disable the global setting |
251 | `enable-log-filecount'. Default value: none. | 254 | `enable-log-filecount'. Default value: none. |
252 | 255 | ||
253 | repo.enable-log-linecount:: | 256 | repo.enable-log-linecount:: |
254 | A flag which can be used to disable the global setting | 257 | A flag which can be used to disable the global setting |
255 | `enable-log-linecount'. Default value: none. | 258 | `enable-log-linecount'. Default value: none. |
256 | 259 | ||
257 | repo.max-stats:: | 260 | repo.max-stats:: |
258 | Override the default maximum statistics period. Valid values are equal | 261 | Override the default maximum statistics period. Valid values are equal |
259 | to the values specified for the global "max-stats" setting. Default | 262 | to the values specified for the global "max-stats" setting. Default |
260 | value: none. | 263 | value: none. |
261 | 264 | ||
262 | repo.name:: | 265 | repo.name:: |
263 | The value to show as repository name. Default value: <repo.url>. | 266 | The value to show as repository name. Default value: <repo.url>. |
264 | 267 | ||
265 | repo.owner:: | 268 | repo.owner:: |
266 | A value used to identify the owner of the repository. Default value: | 269 | A value used to identify the owner of the repository. Default value: |
267 | none. | 270 | none. |
268 | 271 | ||
269 | repo.path:: | 272 | repo.path:: |
270 | An absolute path to the repository directory. For non-bare repositories | 273 | An absolute path to the repository directory. For non-bare repositories |
271 | this is the .git-directory. Default value: none. | 274 | this is the .git-directory. Default value: none. |
272 | 275 | ||
273 | repo.readme:: | 276 | repo.readme:: |
274 | A path (relative to <repo.path>) which specifies a file to include | 277 | A path (relative to <repo.path>) which specifies a file to include |
275 | verbatim as the "About" page for this repo. Default value: none. | 278 | verbatim as the "About" page for this repo. Default value: none. |
276 | 279 | ||
277 | repo.snapshots:: | 280 | repo.snapshots:: |
278 | A mask of allowed snapshot-formats for this repo, restricted by the | 281 | A mask of allowed snapshot-formats for this repo, restricted by the |
279 | "snapshots" global setting. Default value: <snapshots>. | 282 | "snapshots" global setting. Default value: <snapshots>. |
280 | 283 | ||
284 | repo.source-filter:: | ||
285 | Override the default source-filter. Default value: <source-filter>. | ||
286 | |||
281 | repo.url:: | 287 | repo.url:: |
282 | The relative url used to access the repository. This must be the first | 288 | The relative url used to access the repository. This must be the first |
283 | setting specified for each repo. Default value: none. | 289 | setting specified for each repo. Default value: none. |
284 | 290 | ||
285 | 291 | ||
286 | EXAMPLE CGITRC FILE | 292 | EXAMPLE CGITRC FILE |
287 | ------------------- | 293 | ------------------- |
288 | 294 | ||
289 | .... | 295 | .... |
290 | # Enable caching of up to 1000 output entriess | 296 | # Enable caching of up to 1000 output entriess |
291 | cache-size=1000 | 297 | cache-size=1000 |
292 | 298 | ||
293 | 299 | ||
294 | # Specify some default clone prefixes | 300 | # Specify some default clone prefixes |
295 | clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git | 301 | clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git |
296 | 302 | ||
297 | # Specify the css url | 303 | # Specify the css url |
298 | css=/css/cgit.css | 304 | css=/css/cgit.css |
299 | 305 | ||
300 | 306 | ||
301 | # Show extra links for each repository on the index page | 307 | # Show extra links for each repository on the index page |
302 | enable-index-links=1 | 308 | enable-index-links=1 |
303 | 309 | ||
304 | 310 | ||
305 | # Show number of affected files per commit on the log pages | 311 | # Show number of affected files per commit on the log pages |
306 | enable-log-filecount=1 | 312 | enable-log-filecount=1 |
307 | 313 | ||
308 | 314 | ||
309 | # Show number of added/removed lines per commit on the log pages | 315 | # Show number of added/removed lines per commit on the log pages |
310 | enable-log-linecount=1 | 316 | enable-log-linecount=1 |
311 | 317 | ||
312 | 318 | ||
313 | # Add a cgit favicon | 319 | # Add a cgit favicon |
314 | favicon=/favicon.ico | 320 | favicon=/favicon.ico |
315 | 321 | ||
316 | 322 | ||
317 | # Use a custom logo | 323 | # Use a custom logo |
318 | logo=/img/mylogo.png | 324 | logo=/img/mylogo.png |
319 | 325 | ||
320 | 326 | ||
321 | # Enable statistics per week, month and quarter | 327 | # Enable statistics per week, month and quarter |
322 | max-stats=quarter | 328 | max-stats=quarter |
323 | 329 | ||
324 | 330 | ||
325 | # Set the title and heading of the repository index page | 331 | # Set the title and heading of the repository index page |
326 | root-title=foobar.com git repositories | 332 | root-title=foobar.com git repositories |
327 | 333 | ||
328 | 334 | ||