-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 683f3b5..a207fe0 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt | |||
@@ -14,190 +14,199 @@ 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 | agefile:: | 19 | agefile:: |
20 | Specifies a path, relative to each repository path, which can be used | 20 | Specifies a path, relative to each repository path, which can be used |
21 | to specify the date and time of the youngest commit in the repository. | 21 | to specify the date and time of the youngest commit in the repository. |
22 | The first line in the file is used as input to the "parse_date" | 22 | The first line in the file is used as input to the "parse_date" |
23 | function in libgit. Recommended timestamp-format is "yyyy-mm-dd | 23 | function in libgit. Recommended timestamp-format is "yyyy-mm-dd |
24 | hh:mm:ss". Default value: "info/web/last-modified". | 24 | hh:mm:ss". Default value: "info/web/last-modified". |
25 | 25 | ||
26 | cache-root:: | 26 | cache-root:: |
27 | Path used to store the cgit cache entries. Default value: | 27 | Path used to store the cgit cache entries. Default value: |
28 | "/var/cache/cgit". | 28 | "/var/cache/cgit". |
29 | 29 | ||
30 | cache-dynamic-ttl:: | 30 | cache-dynamic-ttl:: |
31 | Number which specifies the time-to-live, in minutes, for the cached | 31 | Number which specifies the time-to-live, in minutes, for the cached |
32 | version of repository pages accessed without a fixed SHA1. Default | 32 | version of repository pages accessed without a fixed SHA1. Default |
33 | value: "5". | 33 | value: "5". |
34 | 34 | ||
35 | cache-repo-ttl:: | 35 | cache-repo-ttl:: |
36 | Number which specifies the time-to-live, in minutes, for the cached | 36 | Number which specifies the time-to-live, in minutes, for the cached |
37 | version of the repository summary page. Default value: "5". | 37 | version of the repository summary page. Default value: "5". |
38 | 38 | ||
39 | cache-root-ttl:: | 39 | cache-root-ttl:: |
40 | Number which specifies the time-to-live, in minutes, for the cached | 40 | Number which specifies the time-to-live, in minutes, for the cached |
41 | version of the repository index page. Default value: "5". | 41 | version of the repository index page. Default value: "5". |
42 | 42 | ||
43 | cache-size:: | 43 | cache-size:: |
44 | The maximum number of entries in the cgit cache. Default value: "0" | 44 | The maximum number of entries in the cgit cache. Default value: "0" |
45 | (i.e. caching is disabled). | 45 | (i.e. caching is disabled). |
46 | 46 | ||
47 | cache-static-ttl:: | 47 | cache-static-ttl:: |
48 | Number which specifies the time-to-live, in minutes, for the cached | 48 | Number which specifies the time-to-live, in minutes, for the cached |
49 | version of repository pages accessed with a fixed SHA1. Default value: | 49 | version of repository pages accessed with a fixed SHA1. Default value: |
50 | "5". | 50 | "5". |
51 | 51 | ||
52 | clone-prefix:: | 52 | clone-prefix:: |
53 | Space-separated list of common prefixes which, when combined with a | 53 | Space-separated list of common prefixes which, when combined with a |
54 | repository url, generates valid clone urls for the repository. This | 54 | repository url, generates valid clone urls for the repository. This |
55 | setting is only used if `repo.clone-url` is unspecified. Default value: | 55 | setting is only used if `repo.clone-url` is unspecified. Default value: |
56 | none. | 56 | none. |
57 | 57 | ||
58 | css:: | 58 | css:: |
59 | Url which specifies the css document to include in all cgit pages. | 59 | Url which specifies the css document to include in all cgit pages. |
60 | Default value: "/cgit.css". | 60 | Default value: "/cgit.css". |
61 | 61 | ||
62 | embedded:: | ||
63 | Flag which, when set to "1", will make cgit generate a html fragment | ||
64 | suitable for embedding in other html pages. Default value: none. See | ||
65 | also: "noheader". | ||
66 | |||
62 | enable-index-links:: | 67 | enable-index-links:: |
63 | Flag which, when set to "1", will make cgit generate extra links for | 68 | Flag which, when set to "1", will make cgit generate extra links for |
64 | each repo in the repository index (specifically, to the "summary", | 69 | each repo in the repository index (specifically, to the "summary", |
65 | "commit" and "tree" pages). Default value: "0". | 70 | "commit" and "tree" pages). Default value: "0". |
66 | 71 | ||
67 | enable-log-filecount:: | 72 | enable-log-filecount:: |
68 | Flag which, when set to "1", will make cgit print the number of | 73 | Flag which, when set to "1", will make cgit print the number of |
69 | modified files for each commit on the repository log page. Default | 74 | modified files for each commit on the repository log page. Default |
70 | value: "0". | 75 | value: "0". |
71 | 76 | ||
72 | enable-log-linecount:: | 77 | enable-log-linecount:: |
73 | Flag which, when set to "1", will make cgit print the number of added | 78 | Flag which, when set to "1", will make cgit print the number of added |
74 | and removed lines for each commit on the repository log page. Default | 79 | and removed lines for each commit on the repository log page. Default |
75 | value: "0". | 80 | value: "0". |
76 | 81 | ||
77 | favicon:: | 82 | favicon:: |
78 | Url used as link to a shortcut icon for cgit. If specified, it is | 83 | Url used as link to a shortcut icon for cgit. If specified, it is |
79 | suggested to use the value "/favicon.ico" since certain browsers will | 84 | suggested to use the value "/favicon.ico" since certain browsers will |
80 | ignore other values. Default value: none. | 85 | ignore other values. Default value: none. |
81 | 86 | ||
82 | footer:: | 87 | footer:: |
83 | The content of the file specified with this option will be included | 88 | The content of the file specified with this option will be included |
84 | verbatim at the bottom of all pages (i.e. it replaces the standard | 89 | verbatim at the bottom of all pages (i.e. it replaces the standard |
85 | "generated by..." message. Default value: none. | 90 | "generated by..." message. Default value: none. |
86 | 91 | ||
87 | head-include:: | 92 | head-include:: |
88 | The content of the file specified with this option will be included | 93 | The content of the file specified with this option will be included |
89 | verbatim in the html HEAD section on all pages. Default value: none. | 94 | verbatim in the html HEAD section on all pages. Default value: none. |
90 | 95 | ||
91 | header:: | 96 | header:: |
92 | The content of the file specified with this option will be included | 97 | The content of the file specified with this option will be included |
93 | verbatim at the top of all pages. Default value: none. | 98 | verbatim at the top of all pages. Default value: none. |
94 | 99 | ||
95 | include:: | 100 | include:: |
96 | Name of a configfile to include before the rest of the current config- | 101 | Name of a configfile to include before the rest of the current config- |
97 | file is parsed. Default value: none. | 102 | file is parsed. Default value: none. |
98 | 103 | ||
99 | index-header:: | 104 | index-header:: |
100 | The content of the file specified with this option will be included | 105 | The content of the file specified with this option will be included |
101 | verbatim above the repository index. This setting is deprecated, and | 106 | verbatim above the repository index. This setting is deprecated, and |
102 | will not be supported by cgit-1.0 (use root-readme instead). Default | 107 | will not be supported by cgit-1.0 (use root-readme instead). Default |
103 | value: none. | 108 | value: none. |
104 | 109 | ||
105 | index-info:: | 110 | index-info:: |
106 | The content of the file specified with this option will be included | 111 | The content of the file specified with this option will be included |
107 | verbatim below the heading on the repository index page. This setting | 112 | verbatim below the heading on the repository index page. This setting |
108 | is deprecated, and will not be supported by cgit-1.0 (use root-desc | 113 | is deprecated, and will not be supported by cgit-1.0 (use root-desc |
109 | instead). Default value: none. | 114 | instead). Default value: none. |
110 | 115 | ||
111 | local-time:: | 116 | local-time:: |
112 | Flag which, if set to "1", makes cgit print commit and tag times in the | 117 | Flag which, if set to "1", makes cgit print commit and tag times in the |
113 | servers timezone. Default value: "0". | 118 | servers timezone. Default value: "0". |
114 | 119 | ||
115 | logo:: | 120 | logo:: |
116 | Url which specifies the source of an image which will be used as a logo | 121 | Url which specifies the source of an image which will be used as a logo |
117 | on all cgit pages. | 122 | on all cgit pages. |
118 | 123 | ||
119 | logo-link:: | 124 | logo-link:: |
120 | Url loaded when clicking on the cgit logo image. If unspecified the | 125 | Url loaded when clicking on the cgit logo image. If unspecified the |
121 | calculated url of the repository index page will be used. Default | 126 | calculated url of the repository index page will be used. Default |
122 | value: none. | 127 | value: none. |
123 | 128 | ||
124 | max-commit-count:: | 129 | max-commit-count:: |
125 | Specifies the number of entries to list per page in "log" view. Default | 130 | Specifies the number of entries to list per page in "log" view. Default |
126 | value: "50". | 131 | value: "50". |
127 | 132 | ||
128 | max-message-length:: | 133 | max-message-length:: |
129 | Specifies the maximum number of commit message characters to display in | 134 | Specifies the maximum number of commit message characters to display in |
130 | "log" view. Default value: "80". | 135 | "log" view. Default value: "80". |
131 | 136 | ||
132 | max-repo-count:: | 137 | max-repo-count:: |
133 | Specifies the number of entries to list per page on therepository | 138 | Specifies the number of entries to list per page on therepository |
134 | index page. Default value: "50". | 139 | index page. Default value: "50". |
135 | 140 | ||
136 | max-repodesc-length:: | 141 | max-repodesc-length:: |
137 | Specifies the maximum number of repo description characters to display | 142 | Specifies the maximum number of repo description characters to display |
138 | on the repository index page. Default value: "80". | 143 | on the repository index page. Default value: "80". |
139 | 144 | ||
140 | max-stats:: | 145 | max-stats:: |
141 | Set the default maximum statistics period. Valid values are "week", | 146 | Set the default maximum statistics period. Valid values are "week", |
142 | "month", "quarter" and "year". If unspecified, statistics are | 147 | "month", "quarter" and "year". If unspecified, statistics are |
143 | disabled. Default value: none. See also: "repo.max-stats". | 148 | disabled. Default value: none. See also: "repo.max-stats". |
144 | 149 | ||
145 | module-link:: | 150 | module-link:: |
146 | Text which will be used as the formatstring for a hyperlink when a | 151 | Text which will be used as the formatstring for a hyperlink when a |
147 | submodule is printed in a directory listing. The arguments for the | 152 | submodule is printed in a directory listing. The arguments for the |
148 | formatstring are the path and SHA1 of the submodule commit. Default | 153 | formatstring are the path and SHA1 of the submodule commit. Default |
149 | value: "./?repo=%s&page=commit&id=%s" | 154 | value: "./?repo=%s&page=commit&id=%s" |
150 | 155 | ||
151 | nocache:: | 156 | nocache:: |
152 | 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 |
153 | 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 |
154 | value: "0". | 159 | value: "0". |
155 | 160 | ||
161 | noheader:: | ||
162 | Flag which, when set to "1", will make cgit omit the standard header | ||
163 | on all pages. Default value: none. See also: "embedded". | ||
164 | |||
156 | renamelimit:: | 165 | renamelimit:: |
157 | Maximum number of files to consider when detecting renames. The value | 166 | Maximum number of files to consider when detecting renames. The value |
158 | "-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 |
159 | `man git-diff`). Default value: "-1". | 168 | `man git-diff`). Default value: "-1". |
160 | 169 | ||
161 | repo.group:: | 170 | repo.group:: |
162 | A value for the current repository group, which all repositories | 171 | A value for the current repository group, which all repositories |
163 | specified after this setting will inherit. Default value: none. | 172 | specified after this setting will inherit. Default value: none. |
164 | 173 | ||
165 | robots:: | 174 | robots:: |
166 | Text used as content for the "robots" meta-tag. Default value: | 175 | Text used as content for the "robots" meta-tag. Default value: |
167 | "index, nofollow". | 176 | "index, nofollow". |
168 | 177 | ||
169 | root-desc:: | 178 | root-desc:: |
170 | Text printed below the heading on the repository index page. Default | 179 | Text printed below the heading on the repository index page. Default |
171 | value: "a fast webinterface for the git dscm". | 180 | value: "a fast webinterface for the git dscm". |
172 | 181 | ||
173 | root-readme:: | 182 | root-readme:: |
174 | 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 |
175 | verbatim below the "about" link on the repository index page. Default | 184 | verbatim below the "about" link on the repository index page. Default |
176 | value: none. | 185 | value: none. |
177 | 186 | ||
178 | root-title:: | 187 | root-title:: |
179 | Text printed as heading on the repository index page. Default value: | 188 | Text printed as heading on the repository index page. Default value: |
180 | "Git Repository Browser". | 189 | "Git Repository Browser". |
181 | 190 | ||
182 | snapshots:: | 191 | snapshots:: |
183 | Text which specifies the default (and allowed) set of snapshot formats | 192 | Text which specifies the default (and allowed) set of snapshot formats |
184 | 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 |
185 | of the following values: | 194 | of the following values: |
186 | "tar" uncompressed tar-file | 195 | "tar" uncompressed tar-file |
187 | "tar.gz"gzip-compressed tar-file | 196 | "tar.gz"gzip-compressed tar-file |
188 | "tar.bz2"bzip-compressed tar-file | 197 | "tar.bz2"bzip-compressed tar-file |
189 | "zip" zip-file | 198 | "zip" zip-file |
190 | Default value: none. | 199 | Default value: none. |
191 | 200 | ||
192 | summary-branches:: | 201 | summary-branches:: |
193 | Specifies the number of branches to display in the repository "summary" | 202 | Specifies the number of branches to display in the repository "summary" |
194 | view. Default value: "10". | 203 | view. Default value: "10". |
195 | 204 | ||
196 | summary-log:: | 205 | summary-log:: |
197 | Specifies the number of log entries to display in the repository | 206 | Specifies the number of log entries to display in the repository |
198 | "summary" view. Default value: "10". | 207 | "summary" view. Default value: "10". |
199 | 208 | ||
200 | summary-tags:: | 209 | summary-tags:: |
201 | Specifies the number of tags to display in the repository "summary" | 210 | Specifies the number of tags to display in the repository "summary" |
202 | view. Default value: "10". | 211 | view. Default value: "10". |
203 | 212 | ||