-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 | |||
@@ -153,96 +153,104 @@ module-link:: | |||
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:: |