diff options
-rw-r--r-- | .gitignore | 5 | ||||
-rw-r--r-- | Makefile | 19 | ||||
-rw-r--r-- | cgit-doc.css | 3 | ||||
-rw-r--r-- | cgitrc.5.txt | 114 |
4 files changed, 83 insertions, 58 deletions
@@ -2,5 +2,10 @@ | |||
2 | cgit | 2 | cgit |
3 | cgit.conf | 3 | cgit.conf |
4 | VERSION | 4 | VERSION |
5 | cgitrc.5 | ||
6 | cgitrc.5.fo | ||
7 | cgitrc.5.html | ||
8 | cgitrc.5.pdf | ||
9 | cgitrc.5.xml | ||
5 | *.o | 10 | *.o |
6 | *.d | 11 | *.d |
@@ -100,7 +100,8 @@ ifdef NEEDS_LIBICONV | |||
100 | endif | 100 | 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 |
106 | 107 | ||
@@ -149,8 +150,22 @@ uninstall: | |||
149 | rm -f $(CGIT_DATA_PATH)/cgit.css | 150 | rm -f $(CGIT_DATA_PATH)/cgit.css |
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.html cgitrc.5.pdf cgitrc.5.xml cgitrc.5.fo | ||
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 --- /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,14 +1,14 @@ | |||
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 |
14 | lines, and lines starting with '#', are ignored. | 14 | lines, and lines starting with '#', are ignored. |
@@ -16,166 +16,166 @@ lines, and lines starting with '#', are ignored. | |||
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 | 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 |
98 | will not be supported by cgit-1.0 (use root-readme instead). Default | 98 | will not be supported by cgit-1.0 (use root-readme instead). Default |
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 |
104 | is deprecated, and will not be supported by cgit-1.0 (use root-desc | 104 | is deprecated, and will not be supported by cgit-1.0 (use root-desc |
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 the repository | 129 | Specifies the number of entries to list per page on the repository |
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 |
144 | formatstring are the path and SHA1 of the submodule commit. Default | 144 | formatstring are the path and SHA1 of the submodule commit. Default |
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 |