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