author | Lars Hjemli <hjemli@gmail.com> | 2009-08-09 11:46:01 (UTC) |
---|---|---|
committer | Lars Hjemli <hjemli@gmail.com> | 2009-08-09 11:46:01 (UTC) |
commit | db6303b58883c4417f5bcc0c1ee34fed6553dca3 (patch) (unidiff) | |
tree | ef7775ade9eef57c5a878f9588fe545a7da2c952 /cgitrc.5.txt | |
parent | 17e3ff42646f182911fd0e5d872082977538db9e (diff) | |
parent | 97b3d252629a8a3b9d356c2532dec7611438e4b9 (diff) | |
download | cgit-db6303b58883c4417f5bcc0c1ee34fed6553dca3.zip cgit-db6303b58883c4417f5bcc0c1ee34fed6553dca3.tar.gz cgit-db6303b58883c4417f5bcc0c1ee34fed6553dca3.tar.bz2 |
Merge branch 'lh/plugins'
Conflicts:
cgit.c
cgit.h
-rw-r--r-- | cgitrc.5.txt | 20 |
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 | |||
@@ -46,24 +46,30 @@ cache-size:: | |||
46 | 46 | ||
47 | cache-static-ttl:: | 47 | cache-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 | ||
52 | clone-prefix:: | 52 | clone-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 | ||
58 | commit-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 | |||
58 | css:: | 64 | css:: |
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 | ||
62 | embedded:: | 68 | embedded:: |
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 | ||
67 | enable-index-links:: | 73 | enable-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", |
@@ -197,24 +203,32 @@ root-title:: | |||
197 | "Git Repository Browser". | 203 | "Git Repository Browser". |
198 | 204 | ||
199 | snapshots:: | 205 | snapshots:: |
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 | ||
215 | source-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 | |||
209 | summary-branches:: | 223 | summary-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 | ||
213 | summary-log:: | 227 | summary-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 | ||
217 | summary-tags:: | 231 | summary-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 | ||
@@ -223,24 +237,27 @@ virtual-root:: | |||
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 | ||
229 | REPOSITORY SETTINGS | 243 | REPOSITORY SETTINGS |
230 | ------------------- | 244 | ------------------- |
231 | repo.clone-url:: | 245 | repo.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 | ||
249 | repo.commit-filter:: | ||
250 | Override the default commit-filter. Default value: <commit-filter>. | ||
251 | |||
235 | repo.defbranch:: | 252 | repo.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 | ||
240 | repo.desc:: | 257 | repo.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 | ||
243 | repo.enable-log-filecount:: | 260 | repo.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 | ||
@@ -263,24 +280,27 @@ repo.owner:: | |||
263 | repo.path:: | 280 | repo.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 | ||
267 | repo.readme:: | 284 | repo.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 | ||
271 | repo.snapshots:: | 288 | repo.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 | ||
292 | repo.source-filter:: | ||
293 | Override the default source-filter. Default value: <source-filter>. | ||
294 | |||
275 | repo.url:: | 295 | repo.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 | ||
280 | EXAMPLE CGITRC FILE | 300 | EXAMPLE 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 |
285 | cache-size=1000 | 305 | cache-size=1000 |
286 | 306 | ||