summaryrefslogtreecommitdiffabout
authorLars Hjemli <hjemli@gmail.com>2009-07-25 10:23:30 (UTC)
committer Lars Hjemli <hjemli@gmail.com>2009-07-25 10:23:30 (UTC)
commit86b753cbc076855f06a7d44490b2ba9f2b07d879 (patch) (unidiff)
tree9f9f199686c2fc3326b1e6ed41edde1f56d6f161
parentef0c6aadf70e33ef63f0a68ca16338a49d0a3f1f (diff)
downloadcgit-86b753cbc076855f06a7d44490b2ba9f2b07d879.zip
cgit-86b753cbc076855f06a7d44490b2ba9f2b07d879.tar.gz
cgit-86b753cbc076855f06a7d44490b2ba9f2b07d879.tar.bz2
cgitrc.5.txt: document 'embedded' and 'noheader'
Signed-off-by: Lars Hjemli <hjemli@gmail.com>
Diffstat (more/less context) (ignore whitespace changes)
-rw-r--r--cgitrc.5.txt9
1 files changed, 9 insertions, 0 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index fd299ae..771bb7d 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -38,48 +38,53 @@ cache-repo-ttl
38 38
39cache-root-ttl 39cache-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
43cache-size 43cache-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
47cache-static-ttl 47cache-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
52clone-prefix 52clone-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
58css 58css
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
62embedded
63 Flag which, when set to "1", will make cgit generate a html fragment
64 suitable for embedding in other html pages. Default value: none. See
65 also: "noheader".
66
62enable-index-links 67enable-index-links
63 Flag which, when set to "1", will make cgit generate extra links for 68 Flag which, when set to "1", will make cgit generate extra links for
64 each repo in the repository index (specifically, to the "summary", 69 each repo in the repository index (specifically, to the "summary",
65 "commit" and "tree" pages). Default value: "0". 70 "commit" and "tree" pages). Default value: "0".
66 71
67enable-log-filecount 72enable-log-filecount
68 Flag which, when set to "1", will make cgit print the number of 73 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 74 modified files for each commit on the repository log page. Default
70 value: "0". 75 value: "0".
71 76
72enable-log-linecount 77enable-log-linecount
73 Flag which, when set to "1", will make cgit print the number of added 78 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 79 and removed lines for each commit on the repository log page. Default
75 value: "0". 80 value: "0".
76 81
77favicon 82favicon
78 Url used as link to a shortcut icon for cgit. If specified, it is 83 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 84 suggested to use the value "/favicon.ico" since certain browsers will
80 ignore other values. Default value: none. 85 ignore other values. Default value: none.
81 86
82footer 87footer
83 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
84 verbatim at the bottom of all pages (i.e. it replaces the standard 89 verbatim at the bottom of all pages (i.e. it replaces the standard
85 "generated by..." message. Default value: none. 90 "generated by..." message. Default value: none.
@@ -128,48 +133,52 @@ max-message-length
128max-repo-count 133max-repo-count
129 Specifies the number of entries to list per page on therepository 134 Specifies the number of entries to list per page on therepository
130 index page. Default value: "50". 135 index page. Default value: "50".
131 136
132max-repodesc-length 137max-repodesc-length
133 Specifies the maximum number of repo description characters to display 138 Specifies the maximum number of repo description characters to display
134 on the repository index page. Default value: "80". 139 on the repository index page. Default value: "80".
135 140
136max-stats 141max-stats
137 Set the default maximum statistics period. Valid values are "week", 142 Set the default maximum statistics period. Valid values are "week",
138 "month", "quarter" and "year". If unspecified, statistics are 143 "month", "quarter" and "year". If unspecified, statistics are
139 disabled. Default value: none. See also: "repo.max-stats". 144 disabled. Default value: none. See also: "repo.max-stats".
140 145
141module-link 146module-link
142 Text which will be used as the formatstring for a hyperlink when a 147 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 148 submodule is printed in a directory listing. The arguments for the
144 formatstring are the path and SHA1 of the submodule commit. Default 149 formatstring are the path and SHA1 of the submodule commit. Default
145 value: "./?repo=%s&page=commit&id=%s" 150 value: "./?repo=%s&page=commit&id=%s"
146 151
147nocache 152nocache
148 If set to the value "1" caching will be disabled. This settings is 153 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 154 deprecated, and will not be honored starting with cgit-1.0. Default
150 value: "0". 155 value: "0".
151 156
157noheader
158 Flag which, when set to "1", will make cgit omit the standard header
159 on all pages. Default value: none. See also: "embedded".
160
152renamelimit 161renamelimit
153 Maximum number of files to consider when detecting renames. The value 162 Maximum number of files to consider when detecting renames. The value
154 "-1" uses the compiletime value in git (for further info, look at 163 "-1" uses the compiletime value in git (for further info, look at
155 `man git-diff`). Default value: "-1". 164 `man git-diff`). Default value: "-1".
156 165
157repo.group 166repo.group
158 A value for the current repository group, which all repositories 167 A value for the current repository group, which all repositories
159 specified after this setting will inherit. Default value: none. 168 specified after this setting will inherit. Default value: none.
160 169
161robots 170robots
162 Text used as content for the "robots" meta-tag. Default value: 171 Text used as content for the "robots" meta-tag. Default value:
163 "index, nofollow". 172 "index, nofollow".
164 173
165root-desc 174root-desc
166 Text printed below the heading on the repository index page. Default 175 Text printed below the heading on the repository index page. Default
167 value: "a fast webinterface for the git dscm". 176 value: "a fast webinterface for the git dscm".
168 177
169root-readme: 178root-readme:
170 The content of the file specified with this option will be included 179 The content of the file specified with this option will be included
171 verbatim below the "about" link on the repository index page. Default 180 verbatim below the "about" link on the repository index page. Default
172 value: none. 181 value: none.
173 182
174root-title 183root-title
175 Text printed as heading on the repository index page. Default value: 184 Text printed as heading on the repository index page. Default value: