author | Lars Hjemli <hjemli@gmail.com> | 2009-08-10 16:14:12 (UTC) |
---|---|---|
committer | Lars Hjemli <hjemli@gmail.com> | 2009-08-10 16:59:31 (UTC) |
commit | 92f9b53c4211cd2c8241b62db37affd91dab358d (patch) (unidiff) | |
tree | 262c16d1bf1b581df8c5336392f1c68ae20730a2 /cgitrc.5.txt | |
parent | 4c228e3c3b9d457b603f2a65bd98aaedb3c16b3a (diff) | |
download | cgit-92f9b53c4211cd2c8241b62db37affd91dab358d.zip cgit-92f9b53c4211cd2c8241b62db37affd91dab358d.tar.gz cgit-92f9b53c4211cd2c8241b62db37affd91dab358d.tar.bz2 |
cgit.c: make '/cgit.png' the default value for 'logo' option
Signed-off-by: Lars Hjemli <hjemli@gmail.com>
-rw-r--r-- | cgitrc.5.txt | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt index 4d656fe..54490eb 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt | |||
@@ -7,257 +7,257 @@ NAME | |||
7 | cgitrc - runtime configuration for cgit | 7 | cgitrc - runtime configuration for cgit |
8 | 8 | ||
9 | 9 | ||
10 | SYNOPSIS | 10 | SYNOPSIS |
11 | -------- | 11 | -------- |
12 | Cgitrc contains all runtime settings for cgit, including the list of git | 12 | Cgitrc contains all runtime settings for cgit, including the list of git |
13 | repositories, formatted as a line-separated list of NAME=VALUE pairs. Blank | 13 | repositories, formatted as a line-separated list of NAME=VALUE pairs. Blank |
14 | lines, and lines starting with '#', are ignored. | 14 | lines, and lines starting with '#', are ignored. |
15 | 15 | ||
16 | 16 | ||
17 | GLOBAL SETTINGS | 17 | GLOBAL SETTINGS |
18 | --------------- | 18 | --------------- |
19 | about-filter:: | 19 | about-filter:: |
20 | Specifies a command which will be invoked to format the content of | 20 | Specifies a command which will be invoked to format the content of |
21 | about pages (both top-level and for each repository). The command will | 21 | about pages (both top-level and for each repository). The command will |
22 | get the content of the about-file on its STDIN, and the STDOUT from the | 22 | get the content of the about-file on its STDIN, and the STDOUT from the |
23 | command will be included verbatim on the about page. Default value: | 23 | command will be included verbatim on the about page. Default value: |
24 | none. | 24 | none. |
25 | 25 | ||
26 | agefile:: | 26 | agefile:: |
27 | Specifies a path, relative to each repository path, which can be used | 27 | Specifies a path, relative to each repository path, which can be used |
28 | to specify the date and time of the youngest commit in the repository. | 28 | to specify the date and time of the youngest commit in the repository. |
29 | The first line in the file is used as input to the "parse_date" | 29 | The first line in the file is used as input to the "parse_date" |
30 | function in libgit. Recommended timestamp-format is "yyyy-mm-dd | 30 | function in libgit. Recommended timestamp-format is "yyyy-mm-dd |
31 | hh:mm:ss". Default value: "info/web/last-modified". | 31 | hh:mm:ss". Default value: "info/web/last-modified". |
32 | 32 | ||
33 | cache-root:: | 33 | cache-root:: |
34 | Path used to store the cgit cache entries. Default value: | 34 | Path used to store the cgit cache entries. Default value: |
35 | "/var/cache/cgit". | 35 | "/var/cache/cgit". |
36 | 36 | ||
37 | cache-dynamic-ttl:: | 37 | cache-dynamic-ttl:: |
38 | Number which specifies the time-to-live, in minutes, for the cached | 38 | Number which specifies the time-to-live, in minutes, for the cached |
39 | version of repository pages accessed without a fixed SHA1. Default | 39 | version of repository pages accessed without a fixed SHA1. Default |
40 | value: "5". | 40 | value: "5". |
41 | 41 | ||
42 | cache-repo-ttl:: | 42 | cache-repo-ttl:: |
43 | Number which specifies the time-to-live, in minutes, for the cached | 43 | Number which specifies the time-to-live, in minutes, for the cached |
44 | version of the repository summary page. Default value: "5". | 44 | version of the repository summary page. Default value: "5". |
45 | 45 | ||
46 | cache-root-ttl:: | 46 | cache-root-ttl:: |
47 | Number which specifies the time-to-live, in minutes, for the cached | 47 | Number which specifies the time-to-live, in minutes, for the cached |
48 | version of the repository index page. Default value: "5". | 48 | version of the repository index page. Default value: "5". |
49 | 49 | ||
50 | cache-size:: | 50 | cache-size:: |
51 | The maximum number of entries in the cgit cache. Default value: "0" | 51 | The maximum number of entries in the cgit cache. Default value: "0" |
52 | (i.e. caching is disabled). | 52 | (i.e. caching is disabled). |
53 | 53 | ||
54 | cache-static-ttl:: | 54 | cache-static-ttl:: |
55 | Number which specifies the time-to-live, in minutes, for the cached | 55 | Number which specifies the time-to-live, in minutes, for the cached |
56 | version of repository pages accessed with a fixed SHA1. Default value: | 56 | version of repository pages accessed with a fixed SHA1. Default value: |
57 | "5". | 57 | "5". |
58 | 58 | ||
59 | clone-prefix:: | 59 | clone-prefix:: |
60 | Space-separated list of common prefixes which, when combined with a | 60 | Space-separated list of common prefixes which, when combined with a |
61 | repository url, generates valid clone urls for the repository. This | 61 | repository url, generates valid clone urls for the repository. This |
62 | setting is only used if `repo.clone-url` is unspecified. Default value: | 62 | setting is only used if `repo.clone-url` is unspecified. Default value: |
63 | none. | 63 | none. |
64 | 64 | ||
65 | commit-filter:: | 65 | commit-filter:: |
66 | Specifies a command which will be invoked to format commit messages. | 66 | Specifies a command which will be invoked to format commit messages. |
67 | The command will get the message on its STDIN, and the STDOUT from the | 67 | The command will get the message on its STDIN, and the STDOUT from the |
68 | command will be included verbatim as the commit message, i.e. this can | 68 | command will be included verbatim as the commit message, i.e. this can |
69 | be used to implement bugtracker integration. Default value: none. | 69 | be used to implement bugtracker integration. Default value: none. |
70 | 70 | ||
71 | css:: | 71 | css:: |
72 | Url which specifies the css document to include in all cgit pages. | 72 | Url which specifies the css document to include in all cgit pages. |
73 | Default value: "/cgit.css". | 73 | Default value: "/cgit.css". |
74 | 74 | ||
75 | embedded:: | 75 | embedded:: |
76 | Flag which, when set to "1", will make cgit generate a html fragment | 76 | Flag which, when set to "1", will make cgit generate a html fragment |
77 | suitable for embedding in other html pages. Default value: none. See | 77 | suitable for embedding in other html pages. Default value: none. See |
78 | also: "noheader". | 78 | also: "noheader". |
79 | 79 | ||
80 | enable-index-links:: | 80 | enable-index-links:: |
81 | Flag which, when set to "1", will make cgit generate extra links for | 81 | Flag which, when set to "1", will make cgit generate extra links for |
82 | each repo in the repository index (specifically, to the "summary", | 82 | each repo in the repository index (specifically, to the "summary", |
83 | "commit" and "tree" pages). Default value: "0". | 83 | "commit" and "tree" pages). Default value: "0". |
84 | 84 | ||
85 | enable-log-filecount:: | 85 | enable-log-filecount:: |
86 | Flag which, when set to "1", will make cgit print the number of | 86 | Flag which, when set to "1", will make cgit print the number of |
87 | modified files for each commit on the repository log page. Default | 87 | modified files for each commit on the repository log page. Default |
88 | value: "0". | 88 | value: "0". |
89 | 89 | ||
90 | enable-log-linecount:: | 90 | enable-log-linecount:: |
91 | Flag which, when set to "1", will make cgit print the number of added | 91 | Flag which, when set to "1", will make cgit print the number of added |
92 | and removed lines for each commit on the repository log page. Default | 92 | and removed lines for each commit on the repository log page. Default |
93 | value: "0". | 93 | value: "0". |
94 | 94 | ||
95 | favicon:: | 95 | favicon:: |
96 | Url used as link to a shortcut icon for cgit. If specified, it is | 96 | Url used as link to a shortcut icon for cgit. If specified, it is |
97 | suggested to use the value "/favicon.ico" since certain browsers will | 97 | suggested to use the value "/favicon.ico" since certain browsers will |
98 | ignore other values. Default value: none. | 98 | ignore other values. Default value: none. |
99 | 99 | ||
100 | footer:: | 100 | footer:: |
101 | The content of the file specified with this option will be included | 101 | The content of the file specified with this option will be included |
102 | verbatim at the bottom of all pages (i.e. it replaces the standard | 102 | verbatim at the bottom of all pages (i.e. it replaces the standard |
103 | "generated by..." message. Default value: none. | 103 | "generated by..." message. Default value: none. |
104 | 104 | ||
105 | head-include:: | 105 | head-include:: |
106 | The content of the file specified with this option will be included | 106 | The content of the file specified with this option will be included |
107 | verbatim in the html HEAD section on all pages. Default value: none. | 107 | verbatim in the html HEAD section on all pages. Default value: none. |
108 | 108 | ||
109 | header:: | 109 | header:: |
110 | The content of the file specified with this option will be included | 110 | The content of the file specified with this option will be included |
111 | verbatim at the top of all pages. Default value: none. | 111 | verbatim at the top of all pages. Default value: none. |
112 | 112 | ||
113 | include:: | 113 | include:: |
114 | Name of a configfile to include before the rest of the current config- | 114 | Name of a configfile to include before the rest of the current config- |
115 | file is parsed. Default value: none. | 115 | file is parsed. Default value: none. |
116 | 116 | ||
117 | index-header:: | 117 | index-header:: |
118 | The content of the file specified with this option will be included | 118 | The content of the file specified with this option will be included |
119 | verbatim above the repository index. This setting is deprecated, and | 119 | verbatim above the repository index. This setting is deprecated, and |
120 | will not be supported by cgit-1.0 (use root-readme instead). Default | 120 | will not be supported by cgit-1.0 (use root-readme instead). Default |
121 | value: none. | 121 | value: none. |
122 | 122 | ||
123 | index-info:: | 123 | index-info:: |
124 | The content of the file specified with this option will be included | 124 | The content of the file specified with this option will be included |
125 | verbatim below the heading on the repository index page. This setting | 125 | verbatim below the heading on the repository index page. This setting |
126 | is deprecated, and will not be supported by cgit-1.0 (use root-desc | 126 | is deprecated, and will not be supported by cgit-1.0 (use root-desc |
127 | instead). Default value: none. | 127 | instead). Default value: none. |
128 | 128 | ||
129 | local-time:: | 129 | local-time:: |
130 | Flag which, if set to "1", makes cgit print commit and tag times in the | 130 | Flag which, if set to "1", makes cgit print commit and tag times in the |
131 | servers timezone. Default value: "0". | 131 | servers timezone. Default value: "0". |
132 | 132 | ||
133 | logo:: | 133 | logo:: |
134 | Url which specifies the source of an image which will be used as a logo | 134 | Url which specifies the source of an image which will be used as a logo |
135 | on all cgit pages. | 135 | on all cgit pages. Default value: "/cgit.png". |
136 | 136 | ||
137 | logo-link:: | 137 | logo-link:: |
138 | Url loaded when clicking on the cgit logo image. If unspecified the | 138 | Url loaded when clicking on the cgit logo image. If unspecified the |
139 | calculated url of the repository index page will be used. Default | 139 | calculated url of the repository index page will be used. Default |
140 | value: none. | 140 | value: none. |
141 | 141 | ||
142 | max-commit-count:: | 142 | max-commit-count:: |
143 | Specifies the number of entries to list per page in "log" view. Default | 143 | Specifies the number of entries to list per page in "log" view. Default |
144 | value: "50". | 144 | value: "50". |
145 | 145 | ||
146 | max-message-length:: | 146 | max-message-length:: |
147 | Specifies the maximum number of commit message characters to display in | 147 | Specifies the maximum number of commit message characters to display in |
148 | "log" view. Default value: "80". | 148 | "log" view. Default value: "80". |
149 | 149 | ||
150 | max-repo-count:: | 150 | max-repo-count:: |
151 | Specifies the number of entries to list per page on therepository | 151 | Specifies the number of entries to list per page on therepository |
152 | index page. Default value: "50". | 152 | index page. Default value: "50". |
153 | 153 | ||
154 | max-repodesc-length:: | 154 | max-repodesc-length:: |
155 | Specifies the maximum number of repo description characters to display | 155 | Specifies the maximum number of repo description characters to display |
156 | on the repository index page. Default value: "80". | 156 | on the repository index page. Default value: "80". |
157 | 157 | ||
158 | max-stats:: | 158 | max-stats:: |
159 | Set the default maximum statistics period. Valid values are "week", | 159 | Set the default maximum statistics period. Valid values are "week", |
160 | "month", "quarter" and "year". If unspecified, statistics are | 160 | "month", "quarter" and "year". If unspecified, statistics are |
161 | disabled. Default value: none. See also: "repo.max-stats". | 161 | disabled. Default value: none. See also: "repo.max-stats". |
162 | 162 | ||
163 | mimetype.<ext>:: | 163 | mimetype.<ext>:: |
164 | Set the mimetype for the specified filename extension. This is used | 164 | Set the mimetype for the specified filename extension. This is used |
165 | by the `plain` command when returning blob content. | 165 | by the `plain` command when returning blob content. |
166 | 166 | ||
167 | module-link:: | 167 | module-link:: |
168 | Text which will be used as the formatstring for a hyperlink when a | 168 | Text which will be used as the formatstring for a hyperlink when a |
169 | submodule is printed in a directory listing. The arguments for the | 169 | submodule is printed in a directory listing. The arguments for the |
170 | formatstring are the path and SHA1 of the submodule commit. Default | 170 | formatstring are the path and SHA1 of the submodule commit. Default |
171 | value: "./?repo=%s&page=commit&id=%s" | 171 | value: "./?repo=%s&page=commit&id=%s" |
172 | 172 | ||
173 | nocache:: | 173 | nocache:: |
174 | If set to the value "1" caching will be disabled. This settings is | 174 | If set to the value "1" caching will be disabled. This settings is |
175 | deprecated, and will not be honored starting with cgit-1.0. Default | 175 | deprecated, and will not be honored starting with cgit-1.0. Default |
176 | value: "0". | 176 | value: "0". |
177 | 177 | ||
178 | noplainemail:: | 178 | noplainemail:: |
179 | If set to "1" showing full author email adresses will be disabled. | 179 | If set to "1" showing full author email adresses will be disabled. |
180 | Default value: "0". | 180 | Default value: "0". |
181 | 181 | ||
182 | noheader:: | 182 | noheader:: |
183 | Flag which, when set to "1", will make cgit omit the standard header | 183 | Flag which, when set to "1", will make cgit omit the standard header |
184 | on all pages. Default value: none. See also: "embedded". | 184 | on all pages. Default value: none. See also: "embedded". |
185 | 185 | ||
186 | renamelimit:: | 186 | renamelimit:: |
187 | Maximum number of files to consider when detecting renames. The value | 187 | Maximum number of files to consider when detecting renames. The value |
188 | "-1" uses the compiletime value in git (for further info, look at | 188 | "-1" uses the compiletime value in git (for further info, look at |
189 | `man git-diff`). Default value: "-1". | 189 | `man git-diff`). Default value: "-1". |
190 | 190 | ||
191 | repo.group:: | 191 | repo.group:: |
192 | A value for the current repository group, which all repositories | 192 | A value for the current repository group, which all repositories |
193 | specified after this setting will inherit. Default value: none. | 193 | specified after this setting will inherit. Default value: none. |
194 | 194 | ||
195 | robots:: | 195 | robots:: |
196 | Text used as content for the "robots" meta-tag. Default value: | 196 | Text used as content for the "robots" meta-tag. Default value: |
197 | "index, nofollow". | 197 | "index, nofollow". |
198 | 198 | ||
199 | root-desc:: | 199 | root-desc:: |
200 | Text printed below the heading on the repository index page. Default | 200 | Text printed below the heading on the repository index page. Default |
201 | value: "a fast webinterface for the git dscm". | 201 | value: "a fast webinterface for the git dscm". |
202 | 202 | ||
203 | root-readme:: | 203 | root-readme:: |
204 | The content of the file specified with this option will be included | 204 | The content of the file specified with this option will be included |
205 | verbatim below the "about" link on the repository index page. Default | 205 | verbatim below the "about" link on the repository index page. Default |
206 | value: none. | 206 | value: none. |
207 | 207 | ||
208 | root-title:: | 208 | root-title:: |
209 | Text printed as heading on the repository index page. Default value: | 209 | Text printed as heading on the repository index page. Default value: |
210 | "Git Repository Browser". | 210 | "Git Repository Browser". |
211 | 211 | ||
212 | snapshots:: | 212 | snapshots:: |
213 | Text which specifies the default (and allowed) set of snapshot formats | 213 | Text which specifies the default (and allowed) set of snapshot formats |
214 | supported by cgit. The value is a space-separated list of zero or more | 214 | supported by cgit. The value is a space-separated list of zero or more |
215 | of the following values: | 215 | of the following values: |
216 | "tar" uncompressed tar-file | 216 | "tar" uncompressed tar-file |
217 | "tar.gz"gzip-compressed tar-file | 217 | "tar.gz"gzip-compressed tar-file |
218 | "tar.bz2"bzip-compressed tar-file | 218 | "tar.bz2"bzip-compressed tar-file |
219 | "zip" zip-file | 219 | "zip" zip-file |
220 | Default value: none. | 220 | Default value: none. |
221 | 221 | ||
222 | source-filter:: | 222 | source-filter:: |
223 | Specifies a command which will be invoked to format plaintext blobs | 223 | Specifies a command which will be invoked to format plaintext blobs |
224 | in the tree view. The command will get the blob content on its STDIN | 224 | in the tree view. The command will get the blob content on its STDIN |
225 | and the name of the blob as its only command line argument. The STDOUT | 225 | and the name of the blob as its only command line argument. The STDOUT |
226 | from the command will be included verbatim as the blob contents, i.e. | 226 | from the command will be included verbatim as the blob contents, i.e. |
227 | this can be used to implement e.g. syntax highlighting. Default value: | 227 | this can be used to implement e.g. syntax highlighting. Default value: |
228 | none. | 228 | none. |
229 | 229 | ||
230 | summary-branches:: | 230 | summary-branches:: |
231 | Specifies the number of branches to display in the repository "summary" | 231 | Specifies the number of branches to display in the repository "summary" |
232 | view. Default value: "10". | 232 | view. Default value: "10". |
233 | 233 | ||
234 | summary-log:: | 234 | summary-log:: |
235 | Specifies the number of log entries to display in the repository | 235 | Specifies the number of log entries to display in the repository |
236 | "summary" view. Default value: "10". | 236 | "summary" view. Default value: "10". |
237 | 237 | ||
238 | summary-tags:: | 238 | summary-tags:: |
239 | Specifies the number of tags to display in the repository "summary" | 239 | Specifies the number of tags to display in the repository "summary" |
240 | view. Default value: "10". | 240 | view. Default value: "10". |
241 | 241 | ||
242 | virtual-root:: | 242 | virtual-root:: |
243 | Url which, if specified, will be used as root for all cgit links. It | 243 | Url which, if specified, will be used as root for all cgit links. It |
244 | will also cause cgit to generate 'virtual urls', i.e. urls like | 244 | will also cause cgit to generate 'virtual urls', i.e. urls like |
245 | '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default | 245 | '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default |
246 | value: none. | 246 | value: none. |
247 | NOTE: cgit has recently learned how to use PATH_INFO to achieve the | 247 | NOTE: cgit has recently learned how to use PATH_INFO to achieve the |
248 | same kind of virtual urls, so this option will probably be deprecated. | 248 | same kind of virtual urls, so this option will probably be deprecated. |
249 | 249 | ||
250 | REPOSITORY SETTINGS | 250 | REPOSITORY SETTINGS |
251 | ------------------- | 251 | ------------------- |
252 | repo.about-filter:: | 252 | repo.about-filter:: |
253 | Override the default about-filter. Default value: <about-filter>. | 253 | Override the default about-filter. Default value: <about-filter>. |
254 | 254 | ||
255 | repo.clone-url:: | 255 | repo.clone-url:: |
256 | A list of space-separated urls which can be used to clone this repo. | 256 | A list of space-separated urls which can be used to clone this repo. |
257 | Default value: none. | 257 | Default value: none. |
258 | 258 | ||
259 | repo.commit-filter:: | 259 | repo.commit-filter:: |
260 | Override the default commit-filter. Default value: <commit-filter>. | 260 | Override the default commit-filter. Default value: <commit-filter>. |
261 | 261 | ||
262 | repo.defbranch:: | 262 | repo.defbranch:: |
263 | The name of the default branch for this repository. If no such branch | 263 | The name of the default branch for this repository. If no such branch |