-rw-r--r-- | cgitrc.5.txt | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt index a207fe0..d420ad4 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt | |||
@@ -73,256 +73,264 @@ enable-log-filecount:: | |||
73 | Flag which, when set to "1", will make cgit print the number of | 73 | Flag which, when set to "1", will make cgit print the number of |
74 | modified files for each commit on the repository log page. Default | 74 | modified files for each commit on the repository log page. Default |
75 | value: "0". | 75 | value: "0". |
76 | 76 | ||
77 | enable-log-linecount:: | 77 | enable-log-linecount:: |
78 | Flag which, when set to "1", will make cgit print the number of added | 78 | Flag which, when set to "1", will make cgit print the number of added |
79 | and removed lines for each commit on the repository log page. Default | 79 | and removed lines for each commit on the repository log page. Default |
80 | value: "0". | 80 | value: "0". |
81 | 81 | ||
82 | favicon:: | 82 | favicon:: |
83 | Url used as link to a shortcut icon for cgit. If specified, it is | 83 | Url used as link to a shortcut icon for cgit. If specified, it is |
84 | suggested to use the value "/favicon.ico" since certain browsers will | 84 | suggested to use the value "/favicon.ico" since certain browsers will |
85 | ignore other values. Default value: none. | 85 | ignore other values. Default value: none. |
86 | 86 | ||
87 | footer:: | 87 | footer:: |
88 | The content of the file specified with this option will be included | 88 | The content of the file specified with this option will be included |
89 | verbatim at the bottom of all pages (i.e. it replaces the standard | 89 | verbatim at the bottom of all pages (i.e. it replaces the standard |
90 | "generated by..." message. Default value: none. | 90 | "generated by..." message. Default value: none. |
91 | 91 | ||
92 | head-include:: | 92 | head-include:: |
93 | The content of the file specified with this option will be included | 93 | The content of the file specified with this option will be included |
94 | verbatim in the html HEAD section on all pages. Default value: none. | 94 | verbatim in the html HEAD section on all pages. Default value: none. |
95 | 95 | ||
96 | header:: | 96 | header:: |
97 | The content of the file specified with this option will be included | 97 | The content of the file specified with this option will be included |
98 | verbatim at the top of all pages. Default value: none. | 98 | verbatim at the top of all pages. Default value: none. |
99 | 99 | ||
100 | include:: | 100 | include:: |
101 | Name of a configfile to include before the rest of the current config- | 101 | Name of a configfile to include before the rest of the current config- |
102 | file is parsed. Default value: none. | 102 | file is parsed. Default value: none. |
103 | 103 | ||
104 | index-header:: | 104 | index-header:: |
105 | The content of the file specified with this option will be included | 105 | The content of the file specified with this option will be included |
106 | verbatim above the repository index. This setting is deprecated, and | 106 | verbatim above the repository index. This setting is deprecated, and |
107 | will not be supported by cgit-1.0 (use root-readme instead). Default | 107 | will not be supported by cgit-1.0 (use root-readme instead). Default |
108 | value: none. | 108 | value: none. |
109 | 109 | ||
110 | index-info:: | 110 | index-info:: |
111 | The content of the file specified with this option will be included | 111 | The content of the file specified with this option will be included |
112 | verbatim below the heading on the repository index page. This setting | 112 | verbatim below the heading on the repository index page. This setting |
113 | is deprecated, and will not be supported by cgit-1.0 (use root-desc | 113 | is deprecated, and will not be supported by cgit-1.0 (use root-desc |
114 | instead). Default value: none. | 114 | instead). Default value: none. |
115 | 115 | ||
116 | local-time:: | 116 | local-time:: |
117 | Flag which, if set to "1", makes cgit print commit and tag times in the | 117 | Flag which, if set to "1", makes cgit print commit and tag times in the |
118 | servers timezone. Default value: "0". | 118 | servers timezone. Default value: "0". |
119 | 119 | ||
120 | logo:: | 120 | logo:: |
121 | Url which specifies the source of an image which will be used as a logo | 121 | Url which specifies the source of an image which will be used as a logo |
122 | on all cgit pages. | 122 | on all cgit pages. |
123 | 123 | ||
124 | logo-link:: | 124 | logo-link:: |
125 | Url loaded when clicking on the cgit logo image. If unspecified the | 125 | Url loaded when clicking on the cgit logo image. If unspecified the |
126 | calculated url of the repository index page will be used. Default | 126 | calculated url of the repository index page will be used. Default |
127 | value: none. | 127 | value: none. |
128 | 128 | ||
129 | max-commit-count:: | 129 | max-commit-count:: |
130 | Specifies the number of entries to list per page in "log" view. Default | 130 | Specifies the number of entries to list per page in "log" view. Default |
131 | value: "50". | 131 | value: "50". |
132 | 132 | ||
133 | max-message-length:: | 133 | max-message-length:: |
134 | Specifies the maximum number of commit message characters to display in | 134 | Specifies the maximum number of commit message characters to display in |
135 | "log" view. Default value: "80". | 135 | "log" view. Default value: "80". |
136 | 136 | ||
137 | max-repo-count:: | 137 | max-repo-count:: |
138 | Specifies the number of entries to list per page on therepository | 138 | Specifies the number of entries to list per page on therepository |
139 | index page. Default value: "50". | 139 | index page. Default value: "50". |
140 | 140 | ||
141 | max-repodesc-length:: | 141 | max-repodesc-length:: |
142 | Specifies the maximum number of repo description characters to display | 142 | Specifies the maximum number of repo description characters to display |
143 | on the repository index page. Default value: "80". | 143 | on the repository index page. Default value: "80". |
144 | 144 | ||
145 | max-stats:: | 145 | max-stats:: |
146 | Set the default maximum statistics period. Valid values are "week", | 146 | Set the default maximum statistics period. Valid values are "week", |
147 | "month", "quarter" and "year". If unspecified, statistics are | 147 | "month", "quarter" and "year". If unspecified, statistics are |
148 | disabled. Default value: none. See also: "repo.max-stats". | 148 | disabled. Default value: none. See also: "repo.max-stats". |
149 | 149 | ||
150 | module-link:: | 150 | module-link:: |
151 | Text which will be used as the formatstring for a hyperlink when a | 151 | Text which will be used as the formatstring for a hyperlink when a |
152 | submodule is printed in a directory listing. The arguments for the | 152 | submodule is printed in a directory listing. The arguments for the |
153 | formatstring are the path and SHA1 of the submodule commit. Default | 153 | formatstring are the path and SHA1 of the submodule commit. Default |
154 | value: "./?repo=%s&page=commit&id=%s" | 154 | value: "./?repo=%s&page=commit&id=%s" |
155 | 155 | ||
156 | nocache:: | 156 | nocache:: |
157 | If set to the value "1" caching will be disabled. This settings is | 157 | If set to the value "1" caching will be disabled. This settings is |
158 | deprecated, and will not be honored starting with cgit-1.0. Default | 158 | deprecated, and will not be honored starting with cgit-1.0. Default |
159 | value: "0". | 159 | value: "0". |
160 | 160 | ||
161 | noheader:: | 161 | noheader:: |
162 | Flag which, when set to "1", will make cgit omit the standard header | 162 | Flag which, when set to "1", will make cgit omit the standard header |
163 | on all pages. Default value: none. See also: "embedded". | 163 | on all pages. Default value: none. See also: "embedded". |
164 | 164 | ||
165 | renamelimit:: | 165 | renamelimit:: |
166 | Maximum number of files to consider when detecting renames. The value | 166 | Maximum number of files to consider when detecting renames. The value |
167 | "-1" uses the compiletime value in git (for further info, look at | 167 | "-1" uses the compiletime value in git (for further info, look at |
168 | `man git-diff`). Default value: "-1". | 168 | `man git-diff`). Default value: "-1". |
169 | 169 | ||
170 | repo.group:: | 170 | repo.group:: |
171 | A value for the current repository group, which all repositories | 171 | A value for the current repository group, which all repositories |
172 | specified after this setting will inherit. Default value: none. | 172 | specified after this setting will inherit. Default value: none. |
173 | 173 | ||
174 | robots:: | 174 | robots:: |
175 | Text used as content for the "robots" meta-tag. Default value: | 175 | Text used as content for the "robots" meta-tag. Default value: |
176 | "index, nofollow". | 176 | "index, nofollow". |
177 | 177 | ||
178 | root-desc:: | 178 | root-desc:: |
179 | Text printed below the heading on the repository index page. Default | 179 | Text printed below the heading on the repository index page. Default |
180 | value: "a fast webinterface for the git dscm". | 180 | value: "a fast webinterface for the git dscm". |
181 | 181 | ||
182 | root-readme:: | 182 | root-readme:: |
183 | The content of the file specified with this option will be included | 183 | The content of the file specified with this option will be included |
184 | verbatim below the "about" link on the repository index page. Default | 184 | verbatim below the "about" link on the repository index page. Default |
185 | value: none. | 185 | value: none. |
186 | 186 | ||
187 | root-title:: | 187 | root-title:: |
188 | Text printed as heading on the repository index page. Default value: | 188 | Text printed as heading on the repository index page. Default value: |
189 | "Git Repository Browser". | 189 | "Git Repository Browser". |
190 | 190 | ||
191 | snapshots:: | 191 | snapshots:: |
192 | Text which specifies the default (and allowed) set of snapshot formats | 192 | Text which specifies the default (and allowed) set of snapshot formats |
193 | supported by cgit. The value is a space-separated list of zero or more | 193 | supported by cgit. The value is a space-separated list of zero or more |
194 | of the following values: | 194 | of the following values: |
195 | "tar" uncompressed tar-file | 195 | "tar" uncompressed tar-file |
196 | "tar.gz"gzip-compressed tar-file | 196 | "tar.gz"gzip-compressed tar-file |
197 | "tar.bz2"bzip-compressed tar-file | 197 | "tar.bz2"bzip-compressed tar-file |
198 | "zip" zip-file | 198 | "zip" zip-file |
199 | Default value: none. | 199 | Default value: none. |
200 | 200 | ||
201 | source-filter:: | ||
202 | Specifies a command which will be invoked to format plaintext blobs | ||
203 | in the tree view. The command will get the blob content on its STDIN | ||
204 | and the name of the blob as its only command line argument. The STDOUT | ||
205 | from the command will be included verbatim as the blob contents, i.e. | ||
206 | this can be used to implement e.g. syntax highlighting. Default value: | ||
207 | none. | ||
208 | |||
201 | summary-branches:: | 209 | summary-branches:: |
202 | Specifies the number of branches to display in the repository "summary" | 210 | Specifies the number of branches to display in the repository "summary" |
203 | view. Default value: "10". | 211 | view. Default value: "10". |
204 | 212 | ||
205 | summary-log:: | 213 | summary-log:: |
206 | Specifies the number of log entries to display in the repository | 214 | Specifies the number of log entries to display in the repository |
207 | "summary" view. Default value: "10". | 215 | "summary" view. Default value: "10". |
208 | 216 | ||
209 | summary-tags:: | 217 | summary-tags:: |
210 | Specifies the number of tags to display in the repository "summary" | 218 | Specifies the number of tags to display in the repository "summary" |
211 | view. Default value: "10". | 219 | view. Default value: "10". |
212 | 220 | ||
213 | virtual-root:: | 221 | virtual-root:: |
214 | Url which, if specified, will be used as root for all cgit links. It | 222 | Url which, if specified, will be used as root for all cgit links. It |
215 | will also cause cgit to generate 'virtual urls', i.e. urls like | 223 | will also cause cgit to generate 'virtual urls', i.e. urls like |
216 | '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default | 224 | '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default |
217 | value: none. | 225 | value: none. |
218 | NOTE: cgit has recently learned how to use PATH_INFO to achieve the | 226 | NOTE: cgit has recently learned how to use PATH_INFO to achieve the |
219 | same kind of virtual urls, so this option will probably be deprecated. | 227 | same kind of virtual urls, so this option will probably be deprecated. |
220 | 228 | ||
221 | REPOSITORY SETTINGS | 229 | REPOSITORY SETTINGS |
222 | ------------------- | 230 | ------------------- |
223 | repo.clone-url:: | 231 | repo.clone-url:: |
224 | A list of space-separated urls which can be used to clone this repo. | 232 | A list of space-separated urls which can be used to clone this repo. |
225 | Default value: none. | 233 | Default value: none. |
226 | 234 | ||
227 | repo.defbranch:: | 235 | repo.defbranch:: |
228 | The name of the default branch for this repository. If no such branch | 236 | The name of the default branch for this repository. If no such branch |
229 | exists in the repository, the first branch name (when sorted) is used | 237 | exists in the repository, the first branch name (when sorted) is used |
230 | as default instead. Default value: "master". | 238 | as default instead. Default value: "master". |
231 | 239 | ||
232 | repo.desc:: | 240 | repo.desc:: |
233 | The value to show as repository description. Default value: none. | 241 | The value to show as repository description. Default value: none. |
234 | 242 | ||
235 | repo.enable-log-filecount:: | 243 | repo.enable-log-filecount:: |
236 | A flag which can be used to disable the global setting | 244 | A flag which can be used to disable the global setting |
237 | `enable-log-filecount'. Default value: none. | 245 | `enable-log-filecount'. Default value: none. |
238 | 246 | ||
239 | repo.enable-log-linecount:: | 247 | repo.enable-log-linecount:: |
240 | A flag which can be used to disable the global setting | 248 | A flag which can be used to disable the global setting |
241 | `enable-log-linecount'. Default value: none. | 249 | `enable-log-linecount'. Default value: none. |
242 | 250 | ||
243 | repo.max-stats:: | 251 | repo.max-stats:: |
244 | Override the default maximum statistics period. Valid values are equal | 252 | Override the default maximum statistics period. Valid values are equal |
245 | to the values specified for the global "max-stats" setting. Default | 253 | to the values specified for the global "max-stats" setting. Default |
246 | value: none. | 254 | value: none. |
247 | 255 | ||
248 | repo.name:: | 256 | repo.name:: |
249 | The value to show as repository name. Default value: <repo.url>. | 257 | The value to show as repository name. Default value: <repo.url>. |
250 | 258 | ||
251 | repo.owner:: | 259 | repo.owner:: |
252 | A value used to identify the owner of the repository. Default value: | 260 | A value used to identify the owner of the repository. Default value: |
253 | none. | 261 | none. |
254 | 262 | ||
255 | repo.path:: | 263 | repo.path:: |
256 | An absolute path to the repository directory. For non-bare repositories | 264 | An absolute path to the repository directory. For non-bare repositories |
257 | this is the .git-directory. Default value: none. | 265 | this is the .git-directory. Default value: none. |
258 | 266 | ||
259 | repo.readme:: | 267 | repo.readme:: |
260 | A path (relative to <repo.path>) which specifies a file to include | 268 | A path (relative to <repo.path>) which specifies a file to include |
261 | verbatim as the "About" page for this repo. Default value: none. | 269 | verbatim as the "About" page for this repo. Default value: none. |
262 | 270 | ||
263 | repo.snapshots:: | 271 | repo.snapshots:: |
264 | A mask of allowed snapshot-formats for this repo, restricted by the | 272 | A mask of allowed snapshot-formats for this repo, restricted by the |
265 | "snapshots" global setting. Default value: <snapshots>. | 273 | "snapshots" global setting. Default value: <snapshots>. |
266 | 274 | ||
267 | repo.url:: | 275 | repo.url:: |
268 | The relative url used to access the repository. This must be the first | 276 | The relative url used to access the repository. This must be the first |
269 | setting specified for each repo. Default value: none. | 277 | setting specified for each repo. Default value: none. |
270 | 278 | ||
271 | 279 | ||
272 | EXAMPLE CGITRC FILE | 280 | EXAMPLE CGITRC FILE |
273 | ------------------- | 281 | ------------------- |
274 | 282 | ||
275 | .... | 283 | .... |
276 | # Enable caching of up to 1000 output entriess | 284 | # Enable caching of up to 1000 output entriess |
277 | cache-size=1000 | 285 | cache-size=1000 |
278 | 286 | ||
279 | 287 | ||
280 | # Specify some default clone prefixes | 288 | # Specify some default clone prefixes |
281 | clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git | 289 | clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git |
282 | 290 | ||
283 | # Specify the css url | 291 | # Specify the css url |
284 | css=/css/cgit.css | 292 | css=/css/cgit.css |
285 | 293 | ||
286 | 294 | ||
287 | # Show extra links for each repository on the index page | 295 | # Show extra links for each repository on the index page |
288 | enable-index-links=1 | 296 | enable-index-links=1 |
289 | 297 | ||
290 | 298 | ||
291 | # Show number of affected files per commit on the log pages | 299 | # Show number of affected files per commit on the log pages |
292 | enable-log-filecount=1 | 300 | enable-log-filecount=1 |
293 | 301 | ||
294 | 302 | ||
295 | # Show number of added/removed lines per commit on the log pages | 303 | # Show number of added/removed lines per commit on the log pages |
296 | enable-log-linecount=1 | 304 | enable-log-linecount=1 |
297 | 305 | ||
298 | 306 | ||
299 | # Add a cgit favicon | 307 | # Add a cgit favicon |
300 | favicon=/favicon.ico | 308 | favicon=/favicon.ico |
301 | 309 | ||
302 | 310 | ||
303 | # Use a custom logo | 311 | # Use a custom logo |
304 | logo=/img/mylogo.png | 312 | logo=/img/mylogo.png |
305 | 313 | ||
306 | 314 | ||
307 | # Enable statistics per week, month and quarter | 315 | # Enable statistics per week, month and quarter |
308 | max-stats=quarter | 316 | max-stats=quarter |
309 | 317 | ||
310 | 318 | ||
311 | # Set the title and heading of the repository index page | 319 | # Set the title and heading of the repository index page |
312 | root-title=foobar.com git repositories | 320 | root-title=foobar.com git repositories |
313 | 321 | ||
314 | 322 | ||
315 | # Set a subheading for the repository index page | 323 | # Set a subheading for the repository index page |
316 | root-desc=tracking the foobar development | 324 | root-desc=tracking the foobar development |
317 | 325 | ||
318 | 326 | ||
319 | # Include some more info about foobar.com on the index page | 327 | # Include some more info about foobar.com on the index page |
320 | root-readme=/var/www/htdocs/about.html | 328 | root-readme=/var/www/htdocs/about.html |
321 | 329 | ||
322 | 330 | ||
323 | # Allow download of tar.gz, tar.bz2 and zip-files | 331 | # Allow download of tar.gz, tar.bz2 and zip-files |
324 | snapshots=tar.gz tar.bz2 zip | 332 | snapshots=tar.gz tar.bz2 zip |
325 | 333 | ||
326 | 334 | ||
327 | ## | 335 | ## |
328 | ## List of repositories. | 336 | ## List of repositories. |