author | Lars Hjemli <hjemli@gmail.com> | 2009-08-23 20:58:39 (UTC) |
---|---|---|
committer | Lars Hjemli <hjemli@gmail.com> | 2009-08-24 08:22:58 (UTC) |
commit | e7af002d5c405c82652f739d08ced3908d1f57e7 (patch) (unidiff) | |
tree | 1e31e5dd8d33ca4a8392c4d6207b2ff6bf8a0d76 /cgitrc.5.txt | |
parent | 50d5af3adcdd90424b70e9472af24356ed50aa9b (diff) | |
download | cgit-e7af002d5c405c82652f739d08ced3908d1f57e7.zip cgit-e7af002d5c405c82652f739d08ced3908d1f57e7.tar.gz cgit-e7af002d5c405c82652f739d08ced3908d1f57e7.tar.bz2 |
Introduce 'section' as canonical spelling for 'repo.group'
The 'repo.' prefix should be reserved for repo-specific options, but
the option 'repo.group' must still be honored to stay backwards
compatible.
Signed-off-by: Lars Hjemli <hjemli@gmail.com>
-rw-r--r-- | cgitrc.5.txt | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt index 2abbd41..4d009f9 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt | |||
@@ -107,217 +107,222 @@ favicon:: | |||
107 | Url used as link to a shortcut icon for cgit. If specified, it is | 107 | Url used as link to a shortcut icon for cgit. If specified, it is |
108 | suggested to use the value "/favicon.ico" since certain browsers will | 108 | suggested to use the value "/favicon.ico" since certain browsers will |
109 | ignore other values. Default value: none. | 109 | ignore other values. Default value: none. |
110 | 110 | ||
111 | footer:: | 111 | footer:: |
112 | The content of the file specified with this option will be included | 112 | The content of the file specified with this option will be included |
113 | verbatim at the bottom of all pages (i.e. it replaces the standard | 113 | verbatim at the bottom of all pages (i.e. it replaces the standard |
114 | "generated by..." message. Default value: none. | 114 | "generated by..." message. Default value: none. |
115 | 115 | ||
116 | head-include:: | 116 | head-include:: |
117 | The content of the file specified with this option will be included | 117 | The content of the file specified with this option will be included |
118 | verbatim in the html HEAD section on all pages. Default value: none. | 118 | verbatim in the html HEAD section on all pages. Default value: none. |
119 | 119 | ||
120 | header:: | 120 | header:: |
121 | The content of the file specified with this option will be included | 121 | The content of the file specified with this option will be included |
122 | verbatim at the top of all pages. Default value: none. | 122 | verbatim at the top of all pages. Default value: none. |
123 | 123 | ||
124 | include:: | 124 | include:: |
125 | Name of a configfile to include before the rest of the current config- | 125 | Name of a configfile to include before the rest of the current config- |
126 | file is parsed. Default value: none. | 126 | file is parsed. Default value: none. |
127 | 127 | ||
128 | index-header:: | 128 | index-header:: |
129 | The content of the file specified with this option will be included | 129 | The content of the file specified with this option will be included |
130 | verbatim above the repository index. This setting is deprecated, and | 130 | verbatim above the repository index. This setting is deprecated, and |
131 | will not be supported by cgit-1.0 (use root-readme instead). Default | 131 | will not be supported by cgit-1.0 (use root-readme instead). Default |
132 | value: none. | 132 | value: none. |
133 | 133 | ||
134 | index-info:: | 134 | index-info:: |
135 | The content of the file specified with this option will be included | 135 | The content of the file specified with this option will be included |
136 | verbatim below the heading on the repository index page. This setting | 136 | verbatim below the heading on the repository index page. This setting |
137 | is deprecated, and will not be supported by cgit-1.0 (use root-desc | 137 | is deprecated, and will not be supported by cgit-1.0 (use root-desc |
138 | instead). Default value: none. | 138 | instead). Default value: none. |
139 | 139 | ||
140 | local-time:: | 140 | local-time:: |
141 | Flag which, if set to "1", makes cgit print commit and tag times in the | 141 | Flag which, if set to "1", makes cgit print commit and tag times in the |
142 | servers timezone. Default value: "0". | 142 | servers timezone. Default value: "0". |
143 | 143 | ||
144 | logo:: | 144 | logo:: |
145 | Url which specifies the source of an image which will be used as a logo | 145 | Url which specifies the source of an image which will be used as a logo |
146 | on all cgit pages. Default value: "/cgit.png". | 146 | on all cgit pages. Default value: "/cgit.png". |
147 | 147 | ||
148 | logo-link:: | 148 | logo-link:: |
149 | Url loaded when clicking on the cgit logo image. If unspecified the | 149 | Url loaded when clicking on the cgit logo image. If unspecified the |
150 | calculated url of the repository index page will be used. Default | 150 | calculated url of the repository index page will be used. Default |
151 | value: none. | 151 | value: none. |
152 | 152 | ||
153 | max-commit-count:: | 153 | max-commit-count:: |
154 | Specifies the number of entries to list per page in "log" view. Default | 154 | Specifies the number of entries to list per page in "log" view. Default |
155 | value: "50". | 155 | value: "50". |
156 | 156 | ||
157 | max-message-length:: | 157 | 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 | ||
161 | max-repo-count:: | 161 | max-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 | ||
165 | max-repodesc-length:: | 165 | max-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 | ||
169 | max-stats:: | 169 | max-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 | ||
174 | mimetype.<ext>:: | 174 | mimetype.<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 | ||
178 | module-link:: | 178 | module-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 | ||
184 | nocache:: | 184 | nocache:: |
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 | ||
189 | noplainemail:: | 189 | noplainemail:: |
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 | ||
193 | noheader:: | 193 | noheader:: |
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 | ||
197 | renamelimit:: | 197 | renamelimit:: |
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 | ||
202 | repo.group:: | 202 | repo.group:: |
203 | A value for the current repository group, which all repositories | 203 | Legacy alias for 'section' which will be deprecated starting with |
204 | specified after this setting will inherit. Default value: none. | 204 | cgit-1.0. |
205 | 205 | ||
206 | robots:: | 206 | robots:: |
207 | Text used as content for the "robots" meta-tag. Default value: | 207 | Text used as content for the "robots" meta-tag. Default value: |
208 | "index, nofollow". | 208 | "index, nofollow". |
209 | 209 | ||
210 | root-desc:: | 210 | root-desc:: |
211 | Text printed below the heading on the repository index page. Default | 211 | Text printed below the heading on the repository index page. Default |
212 | value: "a fast webinterface for the git dscm". | 212 | value: "a fast webinterface for the git dscm". |
213 | 213 | ||
214 | root-readme:: | 214 | root-readme:: |
215 | 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 |
216 | verbatim below the "about" link on the repository index page. Default | 216 | verbatim below the "about" link on the repository index page. Default |
217 | value: none. | 217 | value: none. |
218 | 218 | ||
219 | root-title:: | 219 | root-title:: |
220 | Text printed as heading on the repository index page. Default value: | 220 | Text printed as heading on the repository index page. Default value: |
221 | "Git Repository Browser". | 221 | "Git Repository Browser". |
222 | 222 | ||
223 | scan-path:: | 223 | scan-path:: |
224 | A path which will be scanned for repositories. If caching is enabled, | 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 | 225 | the result will be cached as a cgitrc include-file in the cache |
226 | directory. Default value: none. See also: cache-scanrc-ttl. | 226 | directory. Default value: none. See also: cache-scanrc-ttl. |
227 | 227 | ||
228 | section: | ||
229 | The name of the current repository section - all repositories defined | ||
230 | after this option will inherit the current section name. Default value: | ||
231 | none. | ||
232 | |||
228 | snapshots:: | 233 | snapshots:: |
229 | Text which specifies the default set of snapshot formats generated by | 234 | 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 | 235 | 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. | 236 | values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none. |
232 | 237 | ||
233 | source-filter:: | 238 | source-filter:: |
234 | Specifies a command which will be invoked to format plaintext blobs | 239 | 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 | 240 | 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 | 241 | 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. | 242 | 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: | 243 | this can be used to implement e.g. syntax highlighting. Default value: |
239 | none. | 244 | none. |
240 | 245 | ||
241 | summary-branches:: | 246 | summary-branches:: |
242 | Specifies the number of branches to display in the repository "summary" | 247 | Specifies the number of branches to display in the repository "summary" |
243 | view. Default value: "10". | 248 | view. Default value: "10". |
244 | 249 | ||
245 | summary-log:: | 250 | summary-log:: |
246 | Specifies the number of log entries to display in the repository | 251 | Specifies the number of log entries to display in the repository |
247 | "summary" view. Default value: "10". | 252 | "summary" view. Default value: "10". |
248 | 253 | ||
249 | summary-tags:: | 254 | summary-tags:: |
250 | Specifies the number of tags to display in the repository "summary" | 255 | Specifies the number of tags to display in the repository "summary" |
251 | view. Default value: "10". | 256 | view. Default value: "10". |
252 | 257 | ||
253 | virtual-root:: | 258 | virtual-root:: |
254 | Url which, if specified, will be used as root for all cgit links. It | 259 | 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 | 260 | 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 | 261 | '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default |
257 | value: none. | 262 | value: none. |
258 | NOTE: cgit has recently learned how to use PATH_INFO to achieve the | 263 | 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. | 264 | same kind of virtual urls, so this option will probably be deprecated. |
260 | 265 | ||
261 | REPOSITORY SETTINGS | 266 | REPOSITORY SETTINGS |
262 | ------------------- | 267 | ------------------- |
263 | repo.about-filter:: | 268 | repo.about-filter:: |
264 | Override the default about-filter. Default value: <about-filter>. | 269 | Override the default about-filter. Default value: <about-filter>. |
265 | 270 | ||
266 | repo.clone-url:: | 271 | repo.clone-url:: |
267 | A list of space-separated urls which can be used to clone this repo. | 272 | A list of space-separated urls which can be used to clone this repo. |
268 | Default value: none. | 273 | Default value: none. |
269 | 274 | ||
270 | repo.commit-filter:: | 275 | repo.commit-filter:: |
271 | Override the default commit-filter. Default value: <commit-filter>. | 276 | Override the default commit-filter. Default value: <commit-filter>. |
272 | 277 | ||
273 | repo.defbranch:: | 278 | repo.defbranch:: |
274 | The name of the default branch for this repository. If no such branch | 279 | 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 | 280 | exists in the repository, the first branch name (when sorted) is used |
276 | as default instead. Default value: "master". | 281 | as default instead. Default value: "master". |
277 | 282 | ||
278 | repo.desc:: | 283 | repo.desc:: |
279 | The value to show as repository description. Default value: none. | 284 | The value to show as repository description. Default value: none. |
280 | 285 | ||
281 | repo.enable-log-filecount:: | 286 | repo.enable-log-filecount:: |
282 | A flag which can be used to disable the global setting | 287 | A flag which can be used to disable the global setting |
283 | `enable-log-filecount'. Default value: none. | 288 | `enable-log-filecount'. Default value: none. |
284 | 289 | ||
285 | repo.enable-log-linecount:: | 290 | repo.enable-log-linecount:: |
286 | A flag which can be used to disable the global setting | 291 | A flag which can be used to disable the global setting |
287 | `enable-log-linecount'. Default value: none. | 292 | `enable-log-linecount'. Default value: none. |
288 | 293 | ||
289 | repo.max-stats:: | 294 | repo.max-stats:: |
290 | Override the default maximum statistics period. Valid values are equal | 295 | Override the default maximum statistics period. Valid values are equal |
291 | to the values specified for the global "max-stats" setting. Default | 296 | to the values specified for the global "max-stats" setting. Default |
292 | value: none. | 297 | value: none. |
293 | 298 | ||
294 | repo.name:: | 299 | repo.name:: |
295 | The value to show as repository name. Default value: <repo.url>. | 300 | The value to show as repository name. Default value: <repo.url>. |
296 | 301 | ||
297 | repo.owner:: | 302 | repo.owner:: |
298 | A value used to identify the owner of the repository. Default value: | 303 | A value used to identify the owner of the repository. Default value: |
299 | none. | 304 | none. |
300 | 305 | ||
301 | repo.path:: | 306 | repo.path:: |
302 | An absolute path to the repository directory. For non-bare repositories | 307 | An absolute path to the repository directory. For non-bare repositories |
303 | this is the .git-directory. Default value: none. | 308 | this is the .git-directory. Default value: none. |
304 | 309 | ||
305 | repo.readme:: | 310 | repo.readme:: |
306 | A path (relative to <repo.path>) which specifies a file to include | 311 | A path (relative to <repo.path>) which specifies a file to include |
307 | verbatim as the "About" page for this repo. Default value: none. | 312 | verbatim as the "About" page for this repo. Default value: none. |
308 | 313 | ||
309 | repo.snapshots:: | 314 | repo.snapshots:: |
310 | A mask of allowed snapshot-formats for this repo, restricted by the | 315 | A mask of allowed snapshot-formats for this repo, restricted by the |
311 | "snapshots" global setting. Default value: <snapshots>. | 316 | "snapshots" global setting. Default value: <snapshots>. |
312 | 317 | ||
313 | repo.source-filter:: | 318 | repo.source-filter:: |
314 | Override the default source-filter. Default value: <source-filter>. | 319 | Override the default source-filter. Default value: <source-filter>. |
315 | 320 | ||
316 | repo.url:: | 321 | repo.url:: |
317 | The relative url used to access the repository. This must be the first | 322 | The relative url used to access the repository. This must be the first |
318 | setting specified for each repo. Default value: none. | 323 | setting specified for each repo. Default value: none. |
319 | 324 | ||
320 | 325 | ||
321 | EXAMPLE CGITRC FILE | 326 | EXAMPLE CGITRC FILE |
322 | ------------------- | 327 | ------------------- |
323 | 328 | ||