author | Lars Hjemli <hjemli@gmail.com> | 2009-09-13 20:01:52 (UTC) |
---|---|---|
committer | Lars Hjemli <hjemli@gmail.com> | 2009-09-13 20:01:52 (UTC) |
commit | 5f12e45fe3338095916a444ff106dd9fc9991d84 (patch) (unidiff) | |
tree | 26b04e10b2ea277c09620bcf119eaa8f79e2fb88 /cgitrc.5.txt | |
parent | 45c49d6cf4b819385dfee620a81e3cb095ed5cd1 (diff) | |
parent | 6638f40868ccf7806a9668560d3608324704c2b7 (diff) | |
download | cgit-5f12e45fe3338095916a444ff106dd9fc9991d84.zip cgit-5f12e45fe3338095916a444ff106dd9fc9991d84.tar.gz cgit-5f12e45fe3338095916a444ff106dd9fc9991d84.tar.bz2 |
Merge branch 'fp/linenumbers'
-rw-r--r-- | cgitrc.5.txt | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt index 0d18290..3b16db9 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt | |||
@@ -6,192 +6,196 @@ NAME | |||
6 | ---- | 6 | ---- |
7 | cgitrc - runtime configuration for cgit | 7 | cgitrc - runtime configuration for cgit |
8 | 8 | ||
9 | 9 | ||
10 | SYNOPSIS | 10 | SYNOPSIS |
11 | -------- | 11 | -------- |
12 | Cgitrc contains all runtime settings for cgit, including the list of git | 12 | 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 | 13 | 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 | LOCATION | 17 | LOCATION |
18 | -------- | 18 | -------- |
19 | The default location of cgitrc, defined at compile time, is /etc/cgitrc. At | 19 | 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 | 20 | runtime, cgit will consult the environment variable CGIT_CONFIG and, if |
21 | defined, use its value instead. | 21 | defined, use its value instead. |
22 | 22 | ||
23 | 23 | ||
24 | GLOBAL SETTINGS | 24 | 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-size:: | 57 | cache-size:: |
58 | The maximum number of entries in the cgit cache. Default value: "0" | 58 | The maximum number of entries in the cgit cache. Default value: "0" |
59 | (i.e. caching is disabled). | 59 | (i.e. caching is disabled). |
60 | 60 | ||
61 | cache-static-ttl:: | 61 | cache-static-ttl:: |
62 | Number which specifies the time-to-live, in minutes, for the cached | 62 | Number which specifies the time-to-live, in minutes, for the cached |
63 | version of repository pages accessed with a fixed SHA1. Default value: | 63 | version of repository pages accessed with a fixed SHA1. Default value: |
64 | "5". | 64 | "5". |
65 | 65 | ||
66 | clone-prefix:: | 66 | clone-prefix:: |
67 | Space-separated list of common prefixes which, when combined with a | 67 | Space-separated list of common prefixes which, when combined with a |
68 | repository url, generates valid clone urls for the repository. This | 68 | repository url, generates valid clone urls for the repository. This |
69 | setting is only used if `repo.clone-url` is unspecified. Default value: | 69 | setting is only used if `repo.clone-url` is unspecified. Default value: |
70 | none. | 70 | none. |
71 | 71 | ||
72 | commit-filter:: | 72 | commit-filter:: |
73 | Specifies a command which will be invoked to format commit messages. | 73 | 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 | 74 | 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 | 75 | command will be included verbatim as the commit message, i.e. this can |
76 | be used to implement bugtracker integration. Default value: none. | 76 | be used to implement bugtracker integration. Default value: none. |
77 | 77 | ||
78 | css:: | 78 | css:: |
79 | Url which specifies the css document to include in all cgit pages. | 79 | Url which specifies the css document to include in all cgit pages. |
80 | Default value: "/cgit.css". | 80 | Default value: "/cgit.css". |
81 | 81 | ||
82 | embedded:: | 82 | embedded:: |
83 | Flag which, when set to "1", will make cgit generate a html fragment | 83 | 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 | 84 | suitable for embedding in other html pages. Default value: none. See |
85 | also: "noheader". | 85 | also: "noheader". |
86 | 86 | ||
87 | enable-index-links:: | 87 | enable-index-links:: |
88 | Flag which, when set to "1", will make cgit generate extra links for | 88 | Flag which, when set to "1", will make cgit generate extra links for |
89 | each repo in the repository index (specifically, to the "summary", | 89 | each repo in the repository index (specifically, to the "summary", |
90 | "commit" and "tree" pages). Default value: "0". | 90 | "commit" and "tree" pages). Default value: "0". |
91 | 91 | ||
92 | enable-log-filecount:: | 92 | enable-log-filecount:: |
93 | Flag which, when set to "1", will make cgit print the number of | 93 | Flag which, when set to "1", will make cgit print the number of |
94 | modified files for each commit on the repository log page. Default | 94 | modified files for each commit on the repository log page. Default |
95 | value: "0". | 95 | value: "0". |
96 | 96 | ||
97 | enable-log-linecount:: | 97 | enable-log-linecount:: |
98 | Flag which, when set to "1", will make cgit print the number of added | 98 | Flag which, when set to "1", will make cgit print the number of added |
99 | and removed lines for each commit on the repository log page. Default | 99 | and removed lines for each commit on the repository log page. Default |
100 | value: "0". | 100 | value: "0". |
101 | 101 | ||
102 | enable-tree-linenumbers:: | ||
103 | Flag which, when set to "1", will make cgit generate linenumber links | ||
104 | for plaintext blobs printed in the tree view. Default value: "1". | ||
105 | |||
102 | favicon:: | 106 | favicon:: |
103 | Url used as link to a shortcut icon for cgit. If specified, it is | 107 | Url used as link to a shortcut icon for cgit. If specified, it is |
104 | suggested to use the value "/favicon.ico" since certain browsers will | 108 | suggested to use the value "/favicon.ico" since certain browsers will |
105 | ignore other values. Default value: none. | 109 | ignore other values. Default value: none. |
106 | 110 | ||
107 | footer:: | 111 | footer:: |
108 | The content of the file specified with this option will be included | 112 | The content of the file specified with this option will be included |
109 | verbatim at the bottom of all pages (i.e. it replaces the standard | 113 | verbatim at the bottom of all pages (i.e. it replaces the standard |
110 | "generated by..." message. Default value: none. | 114 | "generated by..." message. Default value: none. |
111 | 115 | ||
112 | head-include:: | 116 | head-include:: |
113 | The content of the file specified with this option will be included | 117 | The content of the file specified with this option will be included |
114 | verbatim in the html HEAD section on all pages. Default value: none. | 118 | verbatim in the html HEAD section on all pages. Default value: none. |
115 | 119 | ||
116 | header:: | 120 | header:: |
117 | The content of the file specified with this option will be included | 121 | The content of the file specified with this option will be included |
118 | verbatim at the top of all pages. Default value: none. | 122 | verbatim at the top of all pages. Default value: none. |
119 | 123 | ||
120 | include:: | 124 | include:: |
121 | Name of a configfile to include before the rest of the current config- | 125 | Name of a configfile to include before the rest of the current config- |
122 | file is parsed. Default value: none. | 126 | file is parsed. Default value: none. |
123 | 127 | ||
124 | index-header:: | 128 | index-header:: |
125 | The content of the file specified with this option will be included | 129 | The content of the file specified with this option will be included |
126 | verbatim above the repository index. This setting is deprecated, and | 130 | verbatim above the repository index. This setting is deprecated, and |
127 | will not be supported by cgit-1.0 (use root-readme instead). Default | 131 | will not be supported by cgit-1.0 (use root-readme instead). Default |
128 | value: none. | 132 | value: none. |
129 | 133 | ||
130 | index-info:: | 134 | index-info:: |
131 | The content of the file specified with this option will be included | 135 | The content of the file specified with this option will be included |
132 | verbatim below the heading on the repository index page. This setting | 136 | verbatim below the heading on the repository index page. This setting |
133 | is deprecated, and will not be supported by cgit-1.0 (use root-desc | 137 | is deprecated, and will not be supported by cgit-1.0 (use root-desc |
134 | instead). Default value: none. | 138 | instead). Default value: none. |
135 | 139 | ||
136 | local-time:: | 140 | local-time:: |
137 | Flag which, if set to "1", makes cgit print commit and tag times in the | 141 | Flag which, if set to "1", makes cgit print commit and tag times in the |
138 | servers timezone. Default value: "0". | 142 | servers timezone. Default value: "0". |
139 | 143 | ||
140 | logo:: | 144 | logo:: |
141 | Url which specifies the source of an image which will be used as a logo | 145 | Url which specifies the source of an image which will be used as a logo |
142 | on all cgit pages. Default value: "/cgit.png". | 146 | on all cgit pages. Default value: "/cgit.png". |
143 | 147 | ||
144 | logo-link:: | 148 | logo-link:: |
145 | Url loaded when clicking on the cgit logo image. If unspecified the | 149 | Url loaded when clicking on the cgit logo image. If unspecified the |
146 | calculated url of the repository index page will be used. Default | 150 | calculated url of the repository index page will be used. Default |
147 | value: none. | 151 | value: none. |
148 | 152 | ||
149 | max-commit-count:: | 153 | max-commit-count:: |
150 | Specifies the number of entries to list per page in "log" view. Default | 154 | Specifies the number of entries to list per page in "log" view. Default |
151 | value: "50". | 155 | value: "50". |
152 | 156 | ||
153 | max-message-length:: | 157 | max-message-length:: |
154 | Specifies the maximum number of commit message characters to display in | 158 | Specifies the maximum number of commit message characters to display in |
155 | "log" view. Default value: "80". | 159 | "log" view. Default value: "80". |
156 | 160 | ||
157 | max-repo-count:: | 161 | max-repo-count:: |
158 | Specifies the number of entries to list per page on therepository | 162 | Specifies the number of entries to list per page on therepository |
159 | index page. Default value: "50". | 163 | index page. Default value: "50". |
160 | 164 | ||
161 | max-repodesc-length:: | 165 | max-repodesc-length:: |
162 | Specifies the maximum number of repo description characters to display | 166 | Specifies the maximum number of repo description characters to display |
163 | on the repository index page. Default value: "80". | 167 | on the repository index page. Default value: "80". |
164 | 168 | ||
165 | max-stats:: | 169 | max-stats:: |
166 | Set the default maximum statistics period. Valid values are "week", | 170 | Set the default maximum statistics period. Valid values are "week", |
167 | "month", "quarter" and "year". If unspecified, statistics are | 171 | "month", "quarter" and "year". If unspecified, statistics are |
168 | disabled. Default value: none. See also: "repo.max-stats". | 172 | disabled. Default value: none. See also: "repo.max-stats". |
169 | 173 | ||
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 | ||