-rw-r--r-- | Makefile | 19 | ||||
-rw-r--r-- | cgit-doc.css | 3 | ||||
-rw-r--r-- | cgitrc.5.txt | 114 |
3 files changed, 78 insertions, 58 deletions
@@ -101,5 +101,6 @@ endif | |||
101 | 101 | ||
102 | 102 | ||
103 | .PHONY: all libgit test install uninstall clean force-version get-git | 103 | .PHONY: all libgit test install uninstall clean force-version get-git \ |
104 | doc man-doc html-doc clean-doc | ||
104 | 105 | ||
105 | all: cgit | 106 | all: cgit |
@@ -150,7 +151,21 @@ uninstall: | |||
150 | rm -f $(CGIT_DATA_PATH)/cgit.png | 151 | rm -f $(CGIT_DATA_PATH)/cgit.png |
151 | 152 | ||
152 | clean: | 153 | doc: man-doc html-doc pdf-doc |
154 | |||
155 | man-doc: cgitrc.5.txt | ||
156 | a2x -f manpage cgitrc.5.txt | ||
157 | |||
158 | html-doc: cgitrc.5.txt | ||
159 | a2x -f xhtml --stylesheet=cgit-doc.css cgitrc.5.txt | ||
160 | |||
161 | pdf-doc: cgitrc.5.txt | ||
162 | a2x -f pdf cgitrc.5.txt | ||
163 | |||
164 | clean: clean-doc | ||
153 | rm -f cgit VERSION *.o *.d | 165 | rm -f cgit VERSION *.o *.d |
154 | 166 | ||
167 | clean-doc: | ||
168 | rm -f cgitrc.5 cgitrc.5.xhtml cgitrc.5.pdf | ||
169 | |||
155 | get-git: | 170 | get-git: |
156 | curl $(GIT_URL) | tar -xj && rm -rf git && mv git-$(GIT_VER) git | 171 | curl $(GIT_URL) | tar -xj && rm -rf git && mv git-$(GIT_VER) git |
diff --git a/cgit-doc.css b/cgit-doc.css new file mode 100644 index 0000000..5a399b6 --- a/dev/null +++ b/cgit-doc.css | |||
@@ -0,0 +1,3 @@ | |||
1 | div.variablelist dt { | ||
2 | margin-top: 1em; | ||
3 | } | ||
diff --git a/cgitrc.5.txt b/cgitrc.5.txt index fd299ae..7879f75 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt | |||
@@ -1,13 +1,13 @@ | |||
1 | CGITRC | 1 | CGITRC(5) |
2 | ====== | 2 | ======== |
3 | 3 | ||
4 | 4 | ||
5 | NAME | 5 | NAME |
6 | ---- | 6 | ---- |
7 | cgitrc - runtime configuration for cgit | 7 | cgitrc - runtime configuration for cgit |
8 | 8 | ||
9 | 9 | ||
10 | DESCRIPTION | 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 |
@@ -17,5 +17,5 @@ lines, and lines starting with '#', are ignored. | |||
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. |
@@ -24,31 +24,31 @@ agefile | |||
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 |
@@ -56,42 +56,42 @@ clone-prefix | |||
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 | enable-index-links | 62 | enable-index-links:: |
63 | Flag which, when set to "1", will make cgit generate extra links for | 63 | Flag which, when set to "1", will make cgit generate extra links for |
64 | each repo in the repository index (specifically, to the "summary", | 64 | each repo in the repository index (specifically, to the "summary", |
65 | "commit" and "tree" pages). Default value: "0". | 65 | "commit" and "tree" pages). Default value: "0". |
66 | 66 | ||
67 | enable-log-filecount | 67 | enable-log-filecount:: |
68 | Flag which, when set to "1", will make cgit print the number of | 68 | 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 | 69 | modified files for each commit on the repository log page. Default |
70 | value: "0". | 70 | value: "0". |
71 | 71 | ||
72 | enable-log-linecount | 72 | enable-log-linecount:: |
73 | Flag which, when set to "1", will make cgit print the number of added | 73 | 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 | 74 | and removed lines for each commit on the repository log page. Default |
75 | value: "0". | 75 | value: "0". |
76 | 76 | ||
77 | favicon | 77 | favicon:: |
78 | Url used as link to a shortcut icon for cgit. If specified, it is | 78 | 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 | 79 | suggested to use the value "/favicon.ico" since certain browsers will |
80 | ignore other values. Default value: none. | 80 | ignore other values. Default value: none. |
81 | 81 | ||
82 | footer | 82 | footer:: |
83 | The content of the file specified with this option will be included | 83 | 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 | 84 | verbatim at the bottom of all pages (i.e. it replaces the standard |
85 | "generated by..." message. Default value: none. | 85 | "generated by..." message. Default value: none. |
86 | 86 | ||
87 | header | 87 | header:: |
88 | 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 |
89 | verbatim at the top of all pages. Default value: none. | 89 | verbatim at the top of all pages. Default value: none. |
90 | 90 | ||
91 | include | 91 | include:: |
92 | Name of a configfile to include before the rest of the current config- | 92 | Name of a configfile to include before the rest of the current config- |
93 | file is parsed. Default value: none. | 93 | file is parsed. Default value: none. |
94 | 94 | ||
95 | index-header | 95 | index-header:: |
96 | The content of the file specified with this option will be included | 96 | The content of the file specified with this option will be included |
97 | verbatim above the repository index. This setting is deprecated, and | 97 | verbatim above the repository index. This setting is deprecated, and |
@@ -99,5 +99,5 @@ index-header | |||
99 | value: none. | 99 | value: none. |
100 | 100 | ||
101 | index-info | 101 | index-info:: |
102 | The content of the file specified with this option will be included | 102 | The content of the file specified with this option will be included |
103 | verbatim below the heading on the repository index page. This setting | 103 | verbatim below the heading on the repository index page. This setting |
@@ -105,39 +105,39 @@ index-info | |||
105 | instead). Default value: none. | 105 | instead). Default value: none. |
106 | 106 | ||
107 | local-time | 107 | local-time:: |
108 | Flag which, if set to "1", makes cgit print commit and tag times in the | 108 | Flag which, if set to "1", makes cgit print commit and tag times in the |
109 | servers timezone. Default value: "0". | 109 | servers timezone. Default value: "0". |
110 | 110 | ||
111 | logo | 111 | logo:: |
112 | Url which specifies the source of an image which will be used as a logo | 112 | Url which specifies the source of an image which will be used as a logo |
113 | on all cgit pages. | 113 | on all cgit pages. |
114 | 114 | ||
115 | logo-link | 115 | logo-link:: |
116 | Url loaded when clicking on the cgit logo image. If unspecified the | 116 | Url loaded when clicking on the cgit logo image. If unspecified the |
117 | calculated url of the repository index page will be used. Default | 117 | calculated url of the repository index page will be used. Default |
118 | value: none. | 118 | value: none. |
119 | 119 | ||
120 | max-commit-count | 120 | max-commit-count:: |
121 | Specifies the number of entries to list per page in "log" view. Default | 121 | Specifies the number of entries to list per page in "log" view. Default |
122 | value: "50". | 122 | value: "50". |
123 | 123 | ||
124 | max-message-length | 124 | max-message-length:: |
125 | Specifies the maximum number of commit message characters to display in | 125 | Specifies the maximum number of commit message characters to display in |
126 | "log" view. Default value: "80". | 126 | "log" view. Default value: "80". |
127 | 127 | ||
128 | max-repo-count | 128 | max-repo-count:: |
129 | Specifies the number of entries to list per page on therepository | 129 | Specifies the number of entries to list per page on therepository |
130 | index page. Default value: "50". | 130 | index page. Default value: "50". |
131 | 131 | ||
132 | max-repodesc-length | 132 | max-repodesc-length:: |
133 | Specifies the maximum number of repo description characters to display | 133 | Specifies the maximum number of repo description characters to display |
134 | on the repository index page. Default value: "80". | 134 | on the repository index page. Default value: "80". |
135 | 135 | ||
136 | max-stats | 136 | max-stats:: |
137 | Set the default maximum statistics period. Valid values are "week", | 137 | Set the default maximum statistics period. Valid values are "week", |
138 | "month", "quarter" and "year". If unspecified, statistics are | 138 | "month", "quarter" and "year". If unspecified, statistics are |
139 | disabled. Default value: none. See also: "repo.max-stats". | 139 | disabled. Default value: none. See also: "repo.max-stats". |
140 | 140 | ||
141 | module-link | 141 | module-link:: |
142 | Text which will be used as the formatstring for a hyperlink when a | 142 | Text which will be used as the formatstring for a hyperlink when a |
143 | submodule is printed in a directory listing. The arguments for the | 143 | submodule is printed in a directory listing. The arguments for the |
@@ -145,36 +145,36 @@ module-link | |||
145 | value: "./?repo=%s&page=commit&id=%s" | 145 | value: "./?repo=%s&page=commit&id=%s" |
146 | 146 | ||
147 | nocache | 147 | nocache:: |
148 | If set to the value "1" caching will be disabled. This settings is | 148 | If set to the value "1" caching will be disabled. This settings is |
149 | deprecated, and will not be honored starting with cgit-1.0. Default | 149 | deprecated, and will not be honored starting with cgit-1.0. Default |
150 | value: "0". | 150 | value: "0". |
151 | 151 | ||
152 | renamelimit | 152 | renamelimit:: |
153 | Maximum number of files to consider when detecting renames. The value | 153 | Maximum number of files to consider when detecting renames. The value |
154 | "-1" uses the compiletime value in git (for further info, look at | 154 | "-1" uses the compiletime value in git (for further info, look at |
155 | `man git-diff`). Default value: "-1". | 155 | `man git-diff`). Default value: "-1". |
156 | 156 | ||
157 | repo.group | 157 | repo.group:: |
158 | A value for the current repository group, which all repositories | 158 | A value for the current repository group, which all repositories |
159 | specified after this setting will inherit. Default value: none. | 159 | specified after this setting will inherit. Default value: none. |
160 | 160 | ||
161 | robots | 161 | robots:: |
162 | Text used as content for the "robots" meta-tag. Default value: | 162 | Text used as content for the "robots" meta-tag. Default value: |
163 | "index, nofollow". | 163 | "index, nofollow". |
164 | 164 | ||
165 | root-desc | 165 | root-desc:: |
166 | Text printed below the heading on the repository index page. Default | 166 | Text printed below the heading on the repository index page. Default |
167 | value: "a fast webinterface for the git dscm". | 167 | value: "a fast webinterface for the git dscm". |
168 | 168 | ||
169 | root-readme: | 169 | root-readme:: |
170 | The content of the file specified with this option will be included | 170 | The content of the file specified with this option will be included |
171 | verbatim below the "about" link on the repository index page. Default | 171 | verbatim below the "about" link on the repository index page. Default |
172 | value: none. | 172 | value: none. |
173 | 173 | ||
174 | root-title | 174 | root-title:: |
175 | Text printed as heading on the repository index page. Default value: | 175 | Text printed as heading on the repository index page. Default value: |
176 | "Git Repository Browser". | 176 | "Git Repository Browser". |
177 | 177 | ||
178 | snapshots | 178 | snapshots:: |
179 | Text which specifies the default (and allowed) set of snapshot formats | 179 | Text which specifies the default (and allowed) set of snapshot formats |
180 | supported by cgit. The value is a space-separated list of zero or more | 180 | supported by cgit. The value is a space-separated list of zero or more |
@@ -186,17 +186,17 @@ snapshots | |||
186 | Default value: none. | 186 | Default value: none. |
187 | 187 | ||
188 | summary-branches | 188 | summary-branches:: |
189 | Specifies the number of branches to display in the repository "summary" | 189 | Specifies the number of branches to display in the repository "summary" |
190 | view. Default value: "10". | 190 | view. Default value: "10". |
191 | 191 | ||
192 | summary-log | 192 | summary-log:: |
193 | Specifies the number of log entries to display in the repository | 193 | Specifies the number of log entries to display in the repository |
194 | "summary" view. Default value: "10". | 194 | "summary" view. Default value: "10". |
195 | 195 | ||
196 | summary-tags | 196 | summary-tags:: |
197 | Specifies the number of tags to display in the repository "summary" | 197 | Specifies the number of tags to display in the repository "summary" |
198 | view. Default value: "10". | 198 | view. Default value: "10". |
199 | 199 | ||
200 | virtual-root | 200 | virtual-root:: |
201 | Url which, if specified, will be used as root for all cgit links. It | 201 | Url which, if specified, will be used as root for all cgit links. It |
202 | will also cause cgit to generate 'virtual urls', i.e. urls like | 202 | will also cause cgit to generate 'virtual urls', i.e. urls like |
@@ -208,49 +208,49 @@ virtual-root | |||
208 | REPOSITORY SETTINGS | 208 | REPOSITORY SETTINGS |
209 | ------------------- | 209 | ------------------- |
210 | repo.clone-url | 210 | repo.clone-url:: |
211 | A list of space-separated urls which can be used to clone this repo. | 211 | A list of space-separated urls which can be used to clone this repo. |
212 | Default value: none. | 212 | Default value: none. |
213 | 213 | ||
214 | repo.defbranch | 214 | repo.defbranch:: |
215 | The name of the default branch for this repository. If no such branch | 215 | The name of the default branch for this repository. If no such branch |
216 | exists in the repository, the first branch name (when sorted) is used | 216 | exists in the repository, the first branch name (when sorted) is used |
217 | as default instead. Default value: "master". | 217 | as default instead. Default value: "master". |
218 | 218 | ||
219 | repo.desc | 219 | repo.desc:: |
220 | The value to show as repository description. Default value: none. | 220 | The value to show as repository description. Default value: none. |
221 | 221 | ||
222 | repo.enable-log-filecount | 222 | repo.enable-log-filecount:: |
223 | A flag which can be used to disable the global setting | 223 | A flag which can be used to disable the global setting |
224 | `enable-log-filecount'. Default value: none. | 224 | `enable-log-filecount'. Default value: none. |
225 | 225 | ||
226 | repo.enable-log-linecount | 226 | repo.enable-log-linecount:: |
227 | A flag which can be used to disable the global setting | 227 | A flag which can be used to disable the global setting |
228 | `enable-log-linecount'. Default value: none. | 228 | `enable-log-linecount'. Default value: none. |
229 | 229 | ||
230 | repo.max-stats | 230 | repo.max-stats:: |
231 | Override the default maximum statistics period. Valid values are equal | 231 | Override the default maximum statistics period. Valid values are equal |
232 | to the values specified for the global "max-stats" setting. Default | 232 | to the values specified for the global "max-stats" setting. Default |
233 | value: none. | 233 | value: none. |
234 | 234 | ||
235 | repo.name | 235 | repo.name:: |
236 | The value to show as repository name. Default value: <repo.url>. | 236 | The value to show as repository name. Default value: <repo.url>. |
237 | 237 | ||
238 | repo.owner | 238 | repo.owner:: |
239 | A value used to identify the owner of the repository. Default value: | 239 | A value used to identify the owner of the repository. Default value: |
240 | none. | 240 | none. |
241 | 241 | ||
242 | repo.path | 242 | repo.path:: |
243 | An absolute path to the repository directory. For non-bare repositories | 243 | An absolute path to the repository directory. For non-bare repositories |
244 | this is the .git-directory. Default value: none. | 244 | this is the .git-directory. Default value: none. |
245 | 245 | ||
246 | repo.readme | 246 | repo.readme:: |
247 | A path (relative to <repo.path>) which specifies a file to include | 247 | A path (relative to <repo.path>) which specifies a file to include |
248 | verbatim as the "About" page for this repo. Default value: none. | 248 | verbatim as the "About" page for this repo. Default value: none. |
249 | 249 | ||
250 | repo.snapshots | 250 | repo.snapshots:: |
251 | A mask of allowed snapshot-formats for this repo, restricted by the | 251 | A mask of allowed snapshot-formats for this repo, restricted by the |
252 | "snapshots" global setting. Default value: <snapshots>. | 252 | "snapshots" global setting. Default value: <snapshots>. |
253 | 253 | ||
254 | repo.url | 254 | repo.url:: |
255 | The relative url used to access the repository. This must be the first | 255 | The relative url used to access the repository. This must be the first |
256 | setting specified for each repo. Default value: none. | 256 | setting specified for each repo. Default value: none. |
@@ -260,4 +260,5 @@ EXAMPLE CGITRC FILE | |||
260 | ------------------- | 260 | ------------------- |
261 | 261 | ||
262 | .... | ||
262 | # Enable caching of up to 1000 output entriess | 263 | # Enable caching of up to 1000 output entriess |
263 | cache-size=1000 | 264 | cache-size=1000 |
@@ -369,4 +370,5 @@ repo.enable-log-linecount=0 | |||
369 | # Restrict the max statistics period for this repo | 370 | # Restrict the max statistics period for this repo |
370 | repo.max-stats=month | 371 | repo.max-stats=month |
372 | .... | ||
371 | 373 | ||
372 | 374 | ||