author | Lars Hjemli <hjemli@gmail.com> | 2009-08-20 15:42:14 (UTC) |
---|---|---|
committer | Lars Hjemli <hjemli@gmail.com> | 2009-08-24 08:22:58 (UTC) |
commit | b4dc93dc76fabf043b7679f8fcab91cdb1f418c6 (patch) (unidiff) | |
tree | 645b27315e1b8adaefe88083f6416e0743faef9b | |
parent | d746827ec43a6dd53bce56ee8d8100a03383329e (diff) | |
download | cgit-b4dc93dc76fabf043b7679f8fcab91cdb1f418c6.zip cgit-b4dc93dc76fabf043b7679f8fcab91cdb1f418c6.tar.gz cgit-b4dc93dc76fabf043b7679f8fcab91cdb1f418c6.tar.bz2 |
cgitrc.5.txt: document repo.scan and cache-scanrc-ttl
Signed-off-by: Lars Hjemli <hjemli@gmail.com>
-rw-r--r-- | cgitrc.5.txt | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt index 0d18290..68ae2ed 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt | |||
@@ -25,64 +25,68 @@ GLOBAL SETTINGS | |||
25 | --------------- | 25 | --------------- |
26 | about-filter:: | 26 | about-filter:: |
27 | Specifies a command which will be invoked to format the content of | 27 | Specifies a command which will be invoked to format the content of |
28 | about pages (both top-level and for each repository). The command will | 28 | about pages (both top-level and for each repository). The command will |
29 | get the content of the about-file on its STDIN, and the STDOUT from the | 29 | get the content of the about-file on its STDIN, and the STDOUT from the |
30 | command will be included verbatim on the about page. Default value: | 30 | command will be included verbatim on the about page. Default value: |
31 | none. | 31 | none. |
32 | 32 | ||
33 | agefile:: | 33 | agefile:: |
34 | Specifies a path, relative to each repository path, which can be used | 34 | Specifies a path, relative to each repository path, which can be used |
35 | to specify the date and time of the youngest commit in the repository. | 35 | to specify the date and time of the youngest commit in the repository. |
36 | The first line in the file is used as input to the "parse_date" | 36 | The first line in the file is used as input to the "parse_date" |
37 | function in libgit. Recommended timestamp-format is "yyyy-mm-dd | 37 | function in libgit. Recommended timestamp-format is "yyyy-mm-dd |
38 | hh:mm:ss". Default value: "info/web/last-modified". | 38 | hh:mm:ss". Default value: "info/web/last-modified". |
39 | 39 | ||
40 | cache-root:: | 40 | cache-root:: |
41 | Path used to store the cgit cache entries. Default value: | 41 | Path used to store the cgit cache entries. Default value: |
42 | "/var/cache/cgit". | 42 | "/var/cache/cgit". |
43 | 43 | ||
44 | cache-dynamic-ttl:: | 44 | cache-dynamic-ttl:: |
45 | Number which specifies the time-to-live, in minutes, for the cached | 45 | Number which specifies the time-to-live, in minutes, for the cached |
46 | version of repository pages accessed without a fixed SHA1. Default | 46 | version of repository pages accessed without a fixed SHA1. Default |
47 | value: "5". | 47 | value: "5". |
48 | 48 | ||
49 | cache-repo-ttl:: | 49 | cache-repo-ttl:: |
50 | Number which specifies the time-to-live, in minutes, for the cached | 50 | Number which specifies the time-to-live, in minutes, for the cached |
51 | version of the repository summary page. Default value: "5". | 51 | version of the repository summary page. Default value: "5". |
52 | 52 | ||
53 | cache-root-ttl:: | 53 | cache-root-ttl:: |
54 | Number which specifies the time-to-live, in minutes, for the cached | 54 | Number which specifies the time-to-live, in minutes, for the cached |
55 | version of the repository index page. Default value: "5". | 55 | version of the repository index page. Default value: "5". |
56 | 56 | ||
57 | cache-scanrc-ttl:: | ||
58 | Number which specifies the time-to-live, in minutes, for the result | ||
59 | of scanning a path for git repositories. Default value: "15". | ||
60 | |||
57 | cache-size:: | 61 | cache-size:: |
58 | The maximum number of entries in the cgit cache. Default value: "0" | 62 | The maximum number of entries in the cgit cache. Default value: "0" |
59 | (i.e. caching is disabled). | 63 | (i.e. caching is disabled). |
60 | 64 | ||
61 | cache-static-ttl:: | 65 | cache-static-ttl:: |
62 | Number which specifies the time-to-live, in minutes, for the cached | 66 | Number which specifies the time-to-live, in minutes, for the cached |
63 | version of repository pages accessed with a fixed SHA1. Default value: | 67 | version of repository pages accessed with a fixed SHA1. Default value: |
64 | "5". | 68 | "5". |
65 | 69 | ||
66 | clone-prefix:: | 70 | clone-prefix:: |
67 | Space-separated list of common prefixes which, when combined with a | 71 | Space-separated list of common prefixes which, when combined with a |
68 | repository url, generates valid clone urls for the repository. This | 72 | repository url, generates valid clone urls for the repository. This |
69 | setting is only used if `repo.clone-url` is unspecified. Default value: | 73 | setting is only used if `repo.clone-url` is unspecified. Default value: |
70 | none. | 74 | none. |
71 | 75 | ||
72 | commit-filter:: | 76 | commit-filter:: |
73 | Specifies a command which will be invoked to format commit messages. | 77 | Specifies a command which will be invoked to format commit messages. |
74 | The command will get the message on its STDIN, and the STDOUT from the | 78 | The command will get the message on its STDIN, and the STDOUT from the |
75 | command will be included verbatim as the commit message, i.e. this can | 79 | command will be included verbatim as the commit message, i.e. this can |
76 | be used to implement bugtracker integration. Default value: none. | 80 | be used to implement bugtracker integration. Default value: none. |
77 | 81 | ||
78 | css:: | 82 | css:: |
79 | Url which specifies the css document to include in all cgit pages. | 83 | Url which specifies the css document to include in all cgit pages. |
80 | Default value: "/cgit.css". | 84 | Default value: "/cgit.css". |
81 | 85 | ||
82 | embedded:: | 86 | embedded:: |
83 | Flag which, when set to "1", will make cgit generate a html fragment | 87 | Flag which, when set to "1", will make cgit generate a html fragment |
84 | suitable for embedding in other html pages. Default value: none. See | 88 | suitable for embedding in other html pages. Default value: none. See |
85 | also: "noheader". | 89 | also: "noheader". |
86 | 90 | ||
87 | enable-index-links:: | 91 | enable-index-links:: |
88 | Flag which, when set to "1", will make cgit generate extra links for | 92 | Flag which, when set to "1", will make cgit generate extra links for |
@@ -170,64 +174,69 @@ max-stats:: | |||
170 | mimetype.<ext>:: | 174 | mimetype.<ext>:: |
171 | Set the mimetype for the specified filename extension. This is used | 175 | Set the mimetype for the specified filename extension. This is used |
172 | by the `plain` command when returning blob content. | 176 | by the `plain` command when returning blob content. |
173 | 177 | ||
174 | module-link:: | 178 | module-link:: |
175 | 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 |
176 | submodule is printed in a directory listing. The arguments for the | 180 | submodule is printed in a directory listing. The arguments for the |
177 | formatstring are the path and SHA1 of the submodule commit. Default | 181 | formatstring are the path and SHA1 of the submodule commit. Default |
178 | value: "./?repo=%s&page=commit&id=%s" | 182 | value: "./?repo=%s&page=commit&id=%s" |
179 | 183 | ||
180 | nocache:: | 184 | nocache:: |
181 | 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 |
182 | 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 |
183 | value: "0". | 187 | value: "0". |
184 | 188 | ||
185 | noplainemail:: | 189 | noplainemail:: |
186 | 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. |
187 | Default value: "0". | 191 | Default value: "0". |
188 | 192 | ||
189 | noheader:: | 193 | noheader:: |
190 | 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 |
191 | on all pages. Default value: none. See also: "embedded". | 195 | on all pages. Default value: none. See also: "embedded". |
192 | 196 | ||
193 | renamelimit:: | 197 | renamelimit:: |
194 | Maximum number of files to consider when detecting renames. The value | 198 | Maximum number of files to consider when detecting renames. The value |
195 | "-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 |
196 | `man git-diff`). Default value: "-1". | 200 | `man git-diff`). Default value: "-1". |
197 | 201 | ||
198 | repo.group:: | 202 | repo.group:: |
199 | A value for the current repository group, which all repositories | 203 | A value for the current repository group, which all repositories |
200 | specified after this setting will inherit. Default value: none. | 204 | specified after this setting will inherit. Default value: none. |
201 | 205 | ||
206 | repo.scan:: | ||
207 | A path which will be scanned for repositories. If caching is enabled, | ||
208 | the result will be cached as a cgitrc include-file in the cache | ||
209 | directory. Default value: none. See also: cache-scanrc-ttl. | ||
210 | |||
202 | robots:: | 211 | robots:: |
203 | Text used as content for the "robots" meta-tag. Default value: | 212 | Text used as content for the "robots" meta-tag. Default value: |
204 | "index, nofollow". | 213 | "index, nofollow". |
205 | 214 | ||
206 | root-desc:: | 215 | root-desc:: |
207 | Text printed below the heading on the repository index page. Default | 216 | Text printed below the heading on the repository index page. Default |
208 | value: "a fast webinterface for the git dscm". | 217 | value: "a fast webinterface for the git dscm". |
209 | 218 | ||
210 | root-readme:: | 219 | root-readme:: |
211 | The content of the file specified with this option will be included | 220 | The content of the file specified with this option will be included |
212 | verbatim below the "about" link on the repository index page. Default | 221 | verbatim below the "about" link on the repository index page. Default |
213 | value: none. | 222 | value: none. |
214 | 223 | ||
215 | root-title:: | 224 | root-title:: |
216 | Text printed as heading on the repository index page. Default value: | 225 | Text printed as heading on the repository index page. Default value: |
217 | "Git Repository Browser". | 226 | "Git Repository Browser". |
218 | 227 | ||
219 | snapshots:: | 228 | snapshots:: |
220 | Text which specifies the default set of snapshot formats generated by | 229 | Text which specifies the default set of snapshot formats generated by |
221 | cgit. The value is a space-separated list of zero or more of the | 230 | cgit. The value is a space-separated list of zero or more of the |
222 | values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none. | 231 | values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none. |
223 | 232 | ||
224 | source-filter:: | 233 | source-filter:: |
225 | Specifies a command which will be invoked to format plaintext blobs | 234 | Specifies a command which will be invoked to format plaintext blobs |
226 | in the tree view. The command will get the blob content on its STDIN | 235 | in the tree view. The command will get the blob content on its STDIN |
227 | and the name of the blob as its only command line argument. The STDOUT | 236 | and the name of the blob as its only command line argument. The STDOUT |
228 | from the command will be included verbatim as the blob contents, i.e. | 237 | from the command will be included verbatim as the blob contents, i.e. |
229 | this can be used to implement e.g. syntax highlighting. Default value: | 238 | this can be used to implement e.g. syntax highlighting. Default value: |
230 | none. | 239 | none. |
231 | 240 | ||
232 | summary-branches:: | 241 | summary-branches:: |
233 | Specifies the number of branches to display in the repository "summary" | 242 | Specifies the number of branches to display in the repository "summary" |