summaryrefslogtreecommitdiffabout
path: root/cgitrc.5.txt
authorLars Hjemli <hjemli@gmail.com>2010-06-19 09:42:12 (UTC)
committer Lars Hjemli <hjemli@gmail.com>2010-06-19 09:42:12 (UTC)
commitc2766deb67acb1eae2b36dc0f5811a9cabb6db20 (patch) (unidiff)
tree463ea4a4388f2c449dec9eb49b33f9c0942030d1 /cgitrc.5.txt
parentcaf0825d97582d137387b8879867247e92cca022 (diff)
parent80476b0d2873eb212fad38487fd6189bd6629cbe (diff)
downloadcgit-c2766deb67acb1eae2b36dc0f5811a9cabb6db20.zip
cgit-c2766deb67acb1eae2b36dc0f5811a9cabb6db20.tar.gz
cgit-c2766deb67acb1eae2b36dc0f5811a9cabb6db20.tar.bz2
Merge branch 'ag/atom-fixes'
Diffstat (limited to 'cgitrc.5.txt') (more/less context) (ignore whitespace changes)
-rw-r--r--cgitrc.5.txt4
1 files changed, 4 insertions, 0 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index fcd4308..5c24381 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -79,192 +79,196 @@ clone-prefix::
79commit-filter:: 79commit-filter::
80 Specifies a command which will be invoked to format commit messages. 80 Specifies a command which will be invoked to format commit messages.
81 The command will get the message on its STDIN, and the STDOUT from the 81 The command will get the message on its STDIN, and the STDOUT from the
82 command will be included verbatim as the commit message, i.e. this can 82 command will be included verbatim as the commit message, i.e. this can
83 be used to implement bugtracker integration. Default value: none. 83 be used to implement bugtracker integration. Default value: none.
84 84
85css:: 85css::
86 Url which specifies the css document to include in all cgit pages. 86 Url which specifies the css document to include in all cgit pages.
87 Default value: "/cgit.css". 87 Default value: "/cgit.css".
88 88
89embedded:: 89embedded::
90 Flag which, when set to "1", will make cgit generate a html fragment 90 Flag which, when set to "1", will make cgit generate a html fragment
91 suitable for embedding in other html pages. Default value: none. See 91 suitable for embedding in other html pages. Default value: none. See
92 also: "noheader". 92 also: "noheader".
93 93
94enable-filter-overrides:: 94enable-filter-overrides::
95 Flag which, when set to "1", allows all filter settings to be 95 Flag which, when set to "1", allows all filter settings to be
96 overridden in repository-specific cgitrc files. Default value: none. 96 overridden in repository-specific cgitrc files. Default value: none.
97 97
98enable-index-links:: 98enable-index-links::
99 Flag which, when set to "1", will make cgit generate extra links for 99 Flag which, when set to "1", will make cgit generate extra links for
100 each repo in the repository index (specifically, to the "summary", 100 each repo in the repository index (specifically, to the "summary",
101 "commit" and "tree" pages). Default value: "0". 101 "commit" and "tree" pages). Default value: "0".
102 102
103enable-log-filecount:: 103enable-log-filecount::
104 Flag which, when set to "1", will make cgit print the number of 104 Flag which, when set to "1", will make cgit print the number of
105 modified files for each commit on the repository log page. Default 105 modified files for each commit on the repository log page. Default
106 value: "0". 106 value: "0".
107 107
108enable-log-linecount:: 108enable-log-linecount::
109 Flag which, when set to "1", will make cgit print the number of added 109 Flag which, when set to "1", will make cgit print the number of added
110 and removed lines for each commit on the repository log page. Default 110 and removed lines for each commit on the repository log page. Default
111 value: "0". 111 value: "0".
112 112
113enable-remote-branches:: 113enable-remote-branches::
114 Flag which, when set to "1", will make cgit display remote branches 114 Flag which, when set to "1", will make cgit display remote branches
115 in the summary and refs views. Default value: "0". See also: 115 in the summary and refs views. Default value: "0". See also:
116 "repo.enable-remote-branches". 116 "repo.enable-remote-branches".
117 117
118enable-subject-links:: 118enable-subject-links::
119 Flag which, when set to "1", will make cgit use the subject of the 119 Flag which, when set to "1", will make cgit use the subject of the
120 parent commit as link text when generating links to parent commits 120 parent commit as link text when generating links to parent commits
121 in commit view. Default value: "0". See also: 121 in commit view. Default value: "0". See also:
122 "repo.enable-subject-links". 122 "repo.enable-subject-links".
123 123
124enable-tree-linenumbers:: 124enable-tree-linenumbers::
125 Flag which, when set to "1", will make cgit generate linenumber links 125 Flag which, when set to "1", will make cgit generate linenumber links
126 for plaintext blobs printed in the tree view. Default value: "1". 126 for plaintext blobs printed in the tree view. Default value: "1".
127 127
128favicon:: 128favicon::
129 Url used as link to a shortcut icon for cgit. If specified, it is 129 Url used as link to a shortcut icon for cgit. If specified, it is
130 suggested to use the value "/favicon.ico" since certain browsers will 130 suggested to use the value "/favicon.ico" since certain browsers will
131 ignore other values. Default value: none. 131 ignore other values. Default value: none.
132 132
133footer:: 133footer::
134 The content of the file specified with this option will be included 134 The content of the file specified with this option will be included
135 verbatim at the bottom of all pages (i.e. it replaces the standard 135 verbatim at the bottom of all pages (i.e. it replaces the standard
136 "generated by..." message. Default value: none. 136 "generated by..." message. Default value: none.
137 137
138head-include:: 138head-include::
139 The content of the file specified with this option will be included 139 The content of the file specified with this option will be included
140 verbatim in the html HEAD section on all pages. Default value: none. 140 verbatim in the html HEAD section on all pages. Default value: none.
141 141
142header:: 142header::
143 The content of the file specified with this option will be included 143 The content of the file specified with this option will be included
144 verbatim at the top of all pages. Default value: none. 144 verbatim at the top of all pages. Default value: none.
145 145
146include:: 146include::
147 Name of a configfile to include before the rest of the current config- 147 Name of a configfile to include before the rest of the current config-
148 file is parsed. Default value: none. 148 file is parsed. Default value: none.
149 149
150index-header:: 150index-header::
151 The content of the file specified with this option will be included 151 The content of the file specified with this option will be included
152 verbatim above the repository index. This setting is deprecated, and 152 verbatim above the repository index. This setting is deprecated, and
153 will not be supported by cgit-1.0 (use root-readme instead). Default 153 will not be supported by cgit-1.0 (use root-readme instead). Default
154 value: none. 154 value: none.
155 155
156index-info:: 156index-info::
157 The content of the file specified with this option will be included 157 The content of the file specified with this option will be included
158 verbatim below the heading on the repository index page. This setting 158 verbatim below the heading on the repository index page. This setting
159 is deprecated, and will not be supported by cgit-1.0 (use root-desc 159 is deprecated, and will not be supported by cgit-1.0 (use root-desc
160 instead). Default value: none. 160 instead). Default value: none.
161 161
162local-time:: 162local-time::
163 Flag which, if set to "1", makes cgit print commit and tag times in the 163 Flag which, if set to "1", makes cgit print commit and tag times in the
164 servers timezone. Default value: "0". 164 servers timezone. Default value: "0".
165 165
166logo:: 166logo::
167 Url which specifies the source of an image which will be used as a logo 167 Url which specifies the source of an image which will be used as a logo
168 on all cgit pages. Default value: "/cgit.png". 168 on all cgit pages. Default value: "/cgit.png".
169 169
170logo-link:: 170logo-link::
171 Url loaded when clicking on the cgit logo image. If unspecified the 171 Url loaded when clicking on the cgit logo image. If unspecified the
172 calculated url of the repository index page will be used. Default 172 calculated url of the repository index page will be used. Default
173 value: none. 173 value: none.
174 174
175max-atom-items::
176 Specifies the number of items to display in atom feeds view. Default
177 value: "10".
178
175max-commit-count:: 179max-commit-count::
176 Specifies the number of entries to list per page in "log" view. Default 180 Specifies the number of entries to list per page in "log" view. Default
177 value: "50". 181 value: "50".
178 182
179max-message-length:: 183max-message-length::
180 Specifies the maximum number of commit message characters to display in 184 Specifies the maximum number of commit message characters to display in
181 "log" view. Default value: "80". 185 "log" view. Default value: "80".
182 186
183max-repo-count:: 187max-repo-count::
184 Specifies the number of entries to list per page on therepository 188 Specifies the number of entries to list per page on therepository
185 index page. Default value: "50". 189 index page. Default value: "50".
186 190
187max-repodesc-length:: 191max-repodesc-length::
188 Specifies the maximum number of repo description characters to display 192 Specifies the maximum number of repo description characters to display
189 on the repository index page. Default value: "80". 193 on the repository index page. Default value: "80".
190 194
191max-blob-size:: 195max-blob-size::
192 Specifies the maximum size of a blob to display HTML for in KBytes. 196 Specifies the maximum size of a blob to display HTML for in KBytes.
193 Default value: "0" (limit disabled). 197 Default value: "0" (limit disabled).
194 198
195max-stats:: 199max-stats::
196 Set the default maximum statistics period. Valid values are "week", 200 Set the default maximum statistics period. Valid values are "week",
197 "month", "quarter" and "year". If unspecified, statistics are 201 "month", "quarter" and "year". If unspecified, statistics are
198 disabled. Default value: none. See also: "repo.max-stats". 202 disabled. Default value: none. See also: "repo.max-stats".
199 203
200mimetype.<ext>:: 204mimetype.<ext>::
201 Set the mimetype for the specified filename extension. This is used 205 Set the mimetype for the specified filename extension. This is used
202 by the `plain` command when returning blob content. 206 by the `plain` command when returning blob content.
203 207
204module-link:: 208module-link::
205 Text which will be used as the formatstring for a hyperlink when a 209 Text which will be used as the formatstring for a hyperlink when a
206 submodule is printed in a directory listing. The arguments for the 210 submodule is printed in a directory listing. The arguments for the
207 formatstring are the path and SHA1 of the submodule commit. Default 211 formatstring are the path and SHA1 of the submodule commit. Default
208 value: "./?repo=%s&page=commit&id=%s" 212 value: "./?repo=%s&page=commit&id=%s"
209 213
210nocache:: 214nocache::
211 If set to the value "1" caching will be disabled. This settings is 215 If set to the value "1" caching will be disabled. This settings is
212 deprecated, and will not be honored starting with cgit-1.0. Default 216 deprecated, and will not be honored starting with cgit-1.0. Default
213 value: "0". 217 value: "0".
214 218
215noplainemail:: 219noplainemail::
216 If set to "1" showing full author email adresses will be disabled. 220 If set to "1" showing full author email adresses will be disabled.
217 Default value: "0". 221 Default value: "0".
218 222
219noheader:: 223noheader::
220 Flag which, when set to "1", will make cgit omit the standard header 224 Flag which, when set to "1", will make cgit omit the standard header
221 on all pages. Default value: none. See also: "embedded". 225 on all pages. Default value: none. See also: "embedded".
222 226
223renamelimit:: 227renamelimit::
224 Maximum number of files to consider when detecting renames. The value 228 Maximum number of files to consider when detecting renames. The value
225 "-1" uses the compiletime value in git (for further info, look at 229 "-1" uses the compiletime value in git (for further info, look at
226 `man git-diff`). Default value: "-1". 230 `man git-diff`). Default value: "-1".
227 231
228repo.group:: 232repo.group::
229 Legacy alias for "section". This option is deprecated and will not be 233 Legacy alias for "section". This option is deprecated and will not be
230 supported in cgit-1.0. 234 supported in cgit-1.0.
231 235
232robots:: 236robots::
233 Text used as content for the "robots" meta-tag. Default value: 237 Text used as content for the "robots" meta-tag. Default value:
234 "index, nofollow". 238 "index, nofollow".
235 239
236root-desc:: 240root-desc::
237 Text printed below the heading on the repository index page. Default 241 Text printed below the heading on the repository index page. Default
238 value: "a fast webinterface for the git dscm". 242 value: "a fast webinterface for the git dscm".
239 243
240root-readme:: 244root-readme::
241 The content of the file specified with this option will be included 245 The content of the file specified with this option will be included
242 verbatim below the "about" link on the repository index page. Default 246 verbatim below the "about" link on the repository index page. Default
243 value: none. 247 value: none.
244 248
245root-title:: 249root-title::
246 Text printed as heading on the repository index page. Default value: 250 Text printed as heading on the repository index page. Default value:
247 "Git Repository Browser". 251 "Git Repository Browser".
248 252
249scan-path:: 253scan-path::
250 A path which will be scanned for repositories. If caching is enabled, 254 A path which will be scanned for repositories. If caching is enabled,
251 the result will be cached as a cgitrc include-file in the cache 255 the result will be cached as a cgitrc include-file in the cache
252 directory. Default value: none. See also: cache-scanrc-ttl. 256 directory. Default value: none. See also: cache-scanrc-ttl.
253 257
254section:: 258section::
255 The name of the current repository section - all repositories defined 259 The name of the current repository section - all repositories defined
256 after this option will inherit the current section name. Default value: 260 after this option will inherit the current section name. Default value:
257 none. 261 none.
258 262
259side-by-side-diffs:: 263side-by-side-diffs::
260 If set to "1" shows side-by-side diffs instead of unidiffs per 264 If set to "1" shows side-by-side diffs instead of unidiffs per
261 default. Default value: "0". 265 default. Default value: "0".
262 266
263snapshots:: 267snapshots::
264 Text which specifies the default set of snapshot formats generated by 268 Text which specifies the default set of snapshot formats generated by
265 cgit. The value is a space-separated list of zero or more of the 269 cgit. The value is a space-separated list of zero or more of the
266 values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none. 270 values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none.
267 271
268source-filter:: 272source-filter::
269 Specifies a command which will be invoked to format plaintext blobs 273 Specifies a command which will be invoked to format plaintext blobs
270 in the tree view. The command will get the blob content on its STDIN 274 in the tree view. The command will get the blob content on its STDIN