-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 09f56a6..fd299ae 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt | |||
@@ -23,128 +23,132 @@ agefile | |||
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 | ||
88 | The content of the file specified with this option will be included | ||
89 | verbatim at the top of all pages. Default value: none. | ||
90 | |||
87 | include | 91 | include |
88 | 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- |
89 | file is parsed. Default value: none. | 93 | file is parsed. Default value: none. |
90 | 94 | ||
91 | index-header | 95 | index-header |
92 | 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 |
93 | verbatim above the repository index. This setting is deprecated, and | 97 | verbatim above the repository index. This setting is deprecated, and |
94 | 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 |
95 | value: none. | 99 | value: none. |
96 | 100 | ||
97 | index-info | 101 | index-info |
98 | 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 |
99 | verbatim below the heading on the repository index page. This setting | 103 | verbatim below the heading on the repository index page. This setting |
100 | 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 |
101 | instead). Default value: none. | 105 | instead). Default value: none. |
102 | 106 | ||
103 | local-time | 107 | local-time |
104 | 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 |
105 | servers timezone. Default value: "0". | 109 | servers timezone. Default value: "0". |
106 | 110 | ||
107 | logo | 111 | logo |
108 | 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 |
109 | on all cgit pages. | 113 | on all cgit pages. |
110 | 114 | ||
111 | logo-link | 115 | logo-link |
112 | 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 |
113 | calculated url of the repository index page will be used. Default | 117 | calculated url of the repository index page will be used. Default |
114 | value: none. | 118 | value: none. |
115 | 119 | ||
116 | max-commit-count | 120 | max-commit-count |
117 | 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 |
118 | value: "50". | 122 | value: "50". |
119 | 123 | ||
120 | max-message-length | 124 | max-message-length |
121 | Specifies the maximum number of commit message characters to display in | 125 | Specifies the maximum number of commit message characters to display in |
122 | "log" view. Default value: "80". | 126 | "log" view. Default value: "80". |
123 | 127 | ||
124 | max-repo-count | 128 | max-repo-count |
125 | Specifies the number of entries to list per page on therepository | 129 | Specifies the number of entries to list per page on therepository |
126 | index page. Default value: "50". | 130 | index page. Default value: "50". |
127 | 131 | ||
128 | max-repodesc-length | 132 | max-repodesc-length |
129 | Specifies the maximum number of repo description characters to display | 133 | Specifies the maximum number of repo description characters to display |
130 | on the repository index page. Default value: "80". | 134 | on the repository index page. Default value: "80". |
131 | 135 | ||
132 | max-stats | 136 | max-stats |
133 | Set the default maximum statistics period. Valid values are "week", | 137 | Set the default maximum statistics period. Valid values are "week", |
134 | "month", "quarter" and "year". If unspecified, statistics are | 138 | "month", "quarter" and "year". If unspecified, statistics are |
135 | disabled. Default value: none. See also: "repo.max-stats". | 139 | disabled. Default value: none. See also: "repo.max-stats". |
136 | 140 | ||
137 | module-link | 141 | module-link |
138 | 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 |
139 | submodule is printed in a directory listing. The arguments for the | 143 | submodule is printed in a directory listing. The arguments for the |
140 | formatstring are the path and SHA1 of the submodule commit. Default | 144 | formatstring are the path and SHA1 of the submodule commit. Default |
141 | value: "./?repo=%s&page=commit&id=%s" | 145 | value: "./?repo=%s&page=commit&id=%s" |
142 | 146 | ||
143 | nocache | 147 | nocache |
144 | 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 |
145 | 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 |
146 | value: "0". | 150 | value: "0". |
147 | 151 | ||
148 | renamelimit | 152 | renamelimit |
149 | Maximum number of files to consider when detecting renames. The value | 153 | Maximum number of files to consider when detecting renames. The value |
150 | "-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 |