author | Lars Hjemli <hjemli@gmail.com> | 2009-03-15 08:05:49 (UTC) |
---|---|---|
committer | Lars Hjemli <hjemli@gmail.com> | 2009-03-15 08:05:49 (UTC) |
commit | 942a4c200168e110ec009c3260dc5f5f050de325 (patch) (unidiff) | |
tree | 240031636e0a85d60e51b0059ee285af712a17a3 | |
parent | 6063e7b5532481ffaa7a6f080de28547983bbeb7 (diff) | |
parent | 5e57cb24fca398b1a8cbceb84d9e9649785459d2 (diff) | |
download | cgit-942a4c200168e110ec009c3260dc5f5f050de325.zip cgit-942a4c200168e110ec009c3260dc5f5f050de325.tar.gz cgit-942a4c200168e110ec009c3260dc5f5f050de325.tar.bz2 |
Merge branch 'asciidoc'
-rw-r--r-- | Makefile | 19 | ||||
-rw-r--r-- | cgit-doc.css | 3 | ||||
-rw-r--r-- | cgitrc.5.txt | 112 |
3 files changed, 77 insertions, 57 deletions
@@ -102,3 +102,4 @@ endif | |||
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 | ||
@@ -151,5 +152,19 @@ uninstall: | |||
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: |
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,3 +1,3 @@ | |||
1 | CGITRC | 1 | CGITRC(5) |
2 | ====== | 2 | ======== |
3 | 3 | ||
@@ -9,4 +9,4 @@ NAME | |||
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 |
@@ -18,3 +18,3 @@ 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 |
@@ -25,3 +25,3 @@ agefile | |||
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: |
@@ -29,3 +29,3 @@ cache-root | |||
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 |
@@ -34,3 +34,3 @@ cache-dynamic-ttl | |||
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 |
@@ -38,3 +38,3 @@ cache-repo-ttl | |||
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 |
@@ -42,3 +42,3 @@ cache-root-ttl | |||
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" |
@@ -46,3 +46,3 @@ cache-size | |||
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 |
@@ -51,3 +51,3 @@ cache-static-ttl | |||
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 |
@@ -57,3 +57,3 @@ clone-prefix | |||
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. |
@@ -61,3 +61,3 @@ 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 |
@@ -66,3 +66,3 @@ enable-index-links | |||
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 |
@@ -71,3 +71,3 @@ enable-log-filecount | |||
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 |
@@ -76,3 +76,3 @@ enable-log-linecount | |||
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 |
@@ -81,3 +81,3 @@ favicon | |||
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 |
@@ -86,3 +86,3 @@ footer | |||
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 |
@@ -90,3 +90,3 @@ header | |||
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- |
@@ -94,3 +94,3 @@ include | |||
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 |
@@ -100,3 +100,3 @@ index-header | |||
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 |
@@ -106,3 +106,3 @@ index-info | |||
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 |
@@ -110,3 +110,3 @@ local-time | |||
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 |
@@ -114,3 +114,3 @@ logo | |||
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 |
@@ -119,3 +119,3 @@ logo-link | |||
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 |
@@ -123,3 +123,3 @@ max-commit-count | |||
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 |
@@ -127,3 +127,3 @@ max-message-length | |||
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 |
@@ -131,3 +131,3 @@ max-repo-count | |||
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 |
@@ -135,3 +135,3 @@ max-repodesc-length | |||
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", |
@@ -140,3 +140,3 @@ 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 |
@@ -146,3 +146,3 @@ module-link | |||
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 |
@@ -151,3 +151,3 @@ nocache | |||
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 |
@@ -156,3 +156,3 @@ renamelimit | |||
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 |
@@ -160,3 +160,3 @@ repo.group | |||
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: |
@@ -164,3 +164,3 @@ robots | |||
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 |
@@ -168,3 +168,3 @@ root-desc | |||
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 |
@@ -173,3 +173,3 @@ root-readme: | |||
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: |
@@ -177,3 +177,3 @@ root-title | |||
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 |
@@ -187,3 +187,3 @@ snapshots | |||
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" |
@@ -191,3 +191,3 @@ summary-branches | |||
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 |
@@ -195,3 +195,3 @@ summary-log | |||
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" |
@@ -199,3 +199,3 @@ summary-tags | |||
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 |
@@ -209,3 +209,3 @@ 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. |
@@ -213,3 +213,3 @@ repo.clone-url | |||
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 |
@@ -218,6 +218,6 @@ repo.defbranch | |||
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 |
@@ -225,3 +225,3 @@ repo.enable-log-filecount | |||
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 |
@@ -229,3 +229,3 @@ repo.enable-log-linecount | |||
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 |
@@ -234,6 +234,6 @@ repo.max-stats | |||
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: |
@@ -241,3 +241,3 @@ repo.owner | |||
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 |
@@ -245,3 +245,3 @@ repo.path | |||
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 |
@@ -249,3 +249,3 @@ repo.readme | |||
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 |
@@ -253,3 +253,3 @@ repo.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 |
@@ -261,2 +261,3 @@ EXAMPLE CGITRC FILE | |||
261 | 261 | ||
262 | .... | ||
262 | # Enable caching of up to 1000 output entriess | 263 | # Enable caching of up to 1000 output entriess |
@@ -370,2 +371,3 @@ repo.enable-log-linecount=0 | |||
370 | repo.max-stats=month | 371 | repo.max-stats=month |
372 | .... | ||
371 | 373 | ||