]>
Commit | Line | Data |
---|---|---|
1ab661dd PB |
1 | CONFIGURATION FILE |
2 | ------------------ | |
3 | ||
4 | The git configuration file contains a number of variables that affect | |
b8936cf0 FD |
5 | the git command's behavior. They can be used by both the git plumbing |
6 | and the porcelains. The variables are divided into sections, where | |
1ab661dd PB |
7 | in the fully qualified variable name the variable itself is the last |
8 | dot-separated segment and the section name is everything before the last | |
9 | dot. The variable names are case-insensitive and only alphanumeric | |
10 | characters are allowed. Some variables may appear multiple times. | |
11 | ||
12 | The syntax is fairly flexible and permissive; whitespaces are mostly | |
b8936cf0 | 13 | ignored. The '#' and ';' characters begin comments to the end of line, |
1ab661dd PB |
14 | blank lines are ignored, lines containing strings enclosed in square |
15 | brackets start sections and all the other lines are recognized | |
16 | as setting variables, in the form 'name = value'. If there is no equal | |
17 | sign on the line, the entire line is taken as 'name' and the variable | |
18 | is recognized as boolean "true". String values may be entirely or partially | |
19 | enclosed in double quotes; some variables may require special value format. | |
20 | ||
21 | Example | |
22 | ~~~~~~~ | |
23 | ||
24 | # Core variables | |
25 | [core] | |
26 | ; Don't trust file modes | |
27 | filemode = false | |
28 | ||
29 | # Our diff algorithm | |
30 | [diff] | |
31 | external = "/usr/local/bin/gnu-diff -u" | |
32 | renames = true | |
33 | ||
34 | Variables | |
35 | ~~~~~~~~~ | |
36 | ||
37 | Note that this list is non-comprehensive and not necessarily complete. | |
b8936cf0 FD |
38 | For command-specific variables, you will find a more detailed description |
39 | in the appropriate manual page. You will find a description of non-core | |
1ab661dd PB |
40 | porcelain configuration variables in the respective porcelain documentation. |
41 | ||
42 | core.fileMode:: | |
43 | If false, the executable bit differences between the index and | |
44 | the working copy are ignored; useful on broken filesystems like FAT. | |
45 | See gitlink:git-update-index[1]. True by default. | |
46 | ||
47 | core.gitProxy:: | |
48 | A "proxy command" to execute (as 'command host port') instead | |
49 | of establishing direct connection to the remote server when | |
50 | using the git protocol for fetching. If the variable value is | |
51 | in the "COMMAND for DOMAIN" format, the command is applied only | |
52 | on hostnames ending with the specified domain string. This variable | |
53 | may be set multiple times and is matched in the given order; | |
54 | the first match wins. | |
b8936cf0 FD |
55 | + |
56 | Can be overridden by the 'GIT_PROXY_COMMAND' environment variable | |
57 | (which always applies universally, without the special "for" | |
58 | handling). | |
1ab661dd PB |
59 | |
60 | core.ignoreStat:: | |
61 | The working copy files are assumed to stay unchanged until you | |
62 | mark them otherwise manually - Git will not detect the file changes | |
63 | by lstat() calls. This is useful on systems where those are very | |
64 | slow, such as Microsoft Windows. See gitlink:git-update-index[1]. | |
65 | False by default. | |
66 | ||
9f0bb90d JH |
67 | core.preferSymlinkRefs:: |
68 | Instead of the default "symref" format for HEAD | |
69 | and other symbolic reference files, use symbolic links. | |
70 | This is sometimes needed to work with old scripts that | |
71 | expect HEAD to be a symbolic link. | |
1ab661dd | 72 | |
6de08ae6 SP |
73 | core.logAllRefUpdates:: |
74 | If true, `git-update-ref` will append a line to | |
75 | "$GIT_DIR/logs/<ref>" listing the new SHA1 and the date/time | |
76 | of the update. If the file does not exist it will be | |
77 | created automatically. This information can be used to | |
78 | determine what commit was the tip of a branch "2 days ago". | |
79 | This value is false by default (no logging). | |
80 | ||
1ab661dd PB |
81 | core.repositoryFormatVersion:: |
82 | Internal variable identifying the repository format and layout | |
83 | version. | |
84 | ||
85 | core.sharedRepository:: | |
d5dc6a76 JF |
86 | When 'group' (or 'true'), the repository is made shareable between |
87 | several users in a group (making sure all the files and objects are | |
88 | group-writable). When 'all' (or 'world' or 'everybody'), the | |
89 | repository will be readable by all users, additionally to being | |
90 | group-shareable. When 'umask' (or 'false'), git will use permissions | |
91 | reported by umask(2). See gitlink:git-init-db[1]. False by default. | |
1ab661dd PB |
92 | |
93 | core.warnAmbiguousRefs:: | |
94 | If true, git will warn you if the ref name you passed it is ambiguous | |
95 | and might match multiple refs in the .git/refs/ tree. True by default. | |
96 | ||
3d3e95af | 97 | core.compression:: |
12f6c308 JBH |
98 | An integer -1..9, indicating the compression level for objects that |
99 | are not in a pack file. -1 is the zlib and git default. 0 means no | |
100 | compression, and 1..9 are various speed/size tradeoffs, 9 being | |
101 | slowest. | |
102 | ||
93821bd9 LT |
103 | core.legacyheaders:: |
104 | A boolean which enables the legacy object header format in case | |
105 | you want to interoperate with old clients accessing the object | |
106 | database directly (where the "http://" and "rsync://" protocols | |
107 | count as direct access). | |
108 | ||
4514ad4f PB |
109 | alias.*:: |
110 | Command aliases for the gitlink:git[1] command wrapper - e.g. | |
111 | after defining "alias.last = cat-file commit HEAD", the invocation | |
112 | "git last" is equivalent to "git cat-file commit HEAD". To avoid | |
99b41c84 PB |
113 | confusion and troubles with script usage, aliases that |
114 | hide existing git commands are ignored. Arguments are split by | |
115 | spaces, the usual shell quoting and escaping is supported. | |
116 | quote pair and a backslash can be used to quote them. | |
4514ad4f | 117 | |
1ab661dd PB |
118 | apply.whitespace:: |
119 | Tells `git-apply` how to handle whitespaces, in the same way | |
120 | as the '--whitespace' option. See gitlink:git-apply[1]. | |
121 | ||
aa086eb8 ML |
122 | pager.color:: |
123 | A boolean to enable/disable colored output when the pager is in | |
124 | use (default is true). | |
125 | ||
b5376648 JH |
126 | diff.color:: |
127 | When true (or `always`), always use colors in patch. | |
128 | When false (or `never`), never. When set to `auto`, use | |
129 | colors only when the output is to the terminal. | |
130 | ||
131 | diff.color.<slot>:: | |
132 | Use customized color for diff colorization. `<slot>` | |
133 | specifies which part of the patch to use the specified | |
134 | color, and is one of `plain` (context text), `meta` | |
135 | (metainformation), `frag` (hunk header), `old` (removed | |
136 | lines), or `new` (added lines). The value for these | |
137 | configuration variables can be one of: `normal`, `bold`, | |
138 | `dim`, `ul`, `blink`, `reverse`, `reset`, `black`, | |
139 | `red`, `green`, `yellow`, `blue`, `magenta`, `cyan`, or | |
140 | `white`. | |
141 | ||
1ab661dd PB |
142 | diff.renameLimit:: |
143 | The number of files to consider when performing the copy/rename | |
144 | detection; equivalent to the git diff option '-l'. | |
145 | ||
b68ea12e EW |
146 | diff.renames:: |
147 | Tells git to detect renames. If set to any boolean value, it | |
148 | will enable basic rename detection. If set to "copies" or | |
149 | "copy", it will detect copies, as well. | |
150 | ||
1ab661dd PB |
151 | format.headers:: |
152 | Additional email headers to include in a patch to be submitted | |
153 | by mail. See gitlink:git-format-patch[1]. | |
154 | ||
155 | gitcvs.enabled:: | |
156 | Whether the cvs pserver interface is enabled for this repository. | |
157 | See gitlink:git-cvsserver[1]. | |
158 | ||
159 | gitcvs.logfile:: | |
160 | Path to a log file where the cvs pserver interface well... logs | |
161 | various stuff. See gitlink:git-cvsserver[1]. | |
162 | ||
163 | http.sslVerify:: | |
164 | Whether to verify the SSL certificate when fetching or pushing | |
37425065 | 165 | over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment |
1ab661dd PB |
166 | variable. |
167 | ||
168 | http.sslCert:: | |
169 | File containing the SSL certificate when fetching or pushing | |
37425065 | 170 | over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment |
1ab661dd PB |
171 | variable. |
172 | ||
173 | http.sslKey:: | |
174 | File containing the SSL private key when fetching or pushing | |
abda1ef5 | 175 | over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment |
1ab661dd PB |
176 | variable. |
177 | ||
178 | http.sslCAInfo:: | |
179 | File containing the certificates to verify the peer with when | |
abda1ef5 | 180 | fetching or pushing over HTTPS. Can be overridden by the |
1ab661dd PB |
181 | 'GIT_SSL_CAINFO' environment variable. |
182 | ||
183 | http.sslCAPath:: | |
184 | Path containing files with the CA certificates to verify the peer | |
37425065 | 185 | with when fetching or pushing over HTTPS. Can be overridden |
1ab661dd PB |
186 | by the 'GIT_SSL_CAPATH' environment variable. |
187 | ||
188 | http.maxRequests:: | |
abda1ef5 | 189 | How many HTTP requests to launch in parallel. Can be overridden |
1ab661dd PB |
190 | by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5. |
191 | ||
192 | http.lowSpeedLimit, http.lowSpeedTime:: | |
193 | If the HTTP transfer speed is less than 'http.lowSpeedLimit' | |
194 | for longer than 'http.lowSpeedTime' seconds, the transfer is aborted. | |
abda1ef5 | 195 | Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and |
1ab661dd PB |
196 | 'GIT_HTTP_LOW_SPEED_TIME' environment variables. |
197 | ||
198 | i18n.commitEncoding:: | |
199 | Character encoding the commit messages are stored in; git itself | |
200 | does not care per se, but this information is necessary e.g. when | |
201 | importing commits from emails or in the gitk graphical history | |
202 | browser (and possibly at other places in the future or in other | |
203 | porcelains). See e.g. gitlink:git-mailinfo[1]. Defaults to 'utf-8'. | |
204 | ||
205 | merge.summary:: | |
206 | Whether to include summaries of merged commits in newly created | |
207 | merge commit messages. False by default. | |
208 | ||
4812a93a JK |
209 | pack.window:: |
210 | The size of the window used by gitlink:git-pack-objects[1] when no | |
211 | window size is given on the command line. Defaults to 10. | |
212 | ||
1ab661dd PB |
213 | pull.octopus:: |
214 | The default merge strategy to use when pulling multiple branches | |
215 | at once. | |
216 | ||
217 | pull.twohead:: | |
218 | The default merge strategy to use when pulling a single branch. | |
219 | ||
220 | show.difftree:: | |
221 | The default gitlink:git-diff-tree[1] arguments to be used | |
222 | for gitlink:git-show[1]. | |
223 | ||
224 | showbranch.default:: | |
225 | The default set of branches for gitlink:git-show-branch[1]. | |
226 | See gitlink:git-show-branch[1]. | |
227 | ||
b982592d JK |
228 | status.color:: |
229 | A boolean to enable/disable color in the output of | |
230 | gitlink:git-status[1]. May be set to `true` (or `always`), | |
231 | `false` (or `never`) or `auto`, in which case colors are used | |
232 | only when the output is to a terminal. Defaults to false. | |
233 | ||
234 | status.color.<slot>:: | |
235 | Use customized color for status colorization. `<slot>` is | |
236 | one of `header` (the header text of the status message), | |
237 | `updated` (files which are updated but not committed), | |
238 | `changed` (files which are changed but not updated in the index), | |
239 | or `untracked` (files which are not tracked by git). The values of | |
240 | these variables may be specified as in diff.color.<slot>. | |
241 | ||
ce1a79b6 | 242 | tar.umask:: |
7fe08af4 | 243 | By default, gitlink:git-tar-tree[1] sets file and directories modes |
ce1a79b6 WT |
244 | to 0666 or 0777. While this is both useful and acceptable for projects |
245 | such as the Linux Kernel, it might be excessive for other projects. | |
246 | With this variable, it becomes possible to tell | |
7fe08af4 | 247 | gitlink:git-tar-tree[1] to apply a specific umask to the modes above. |
ce1a79b6 WT |
248 | The special value "user" indicates that the user's current umask will |
249 | be used. This should be enough for most projects, as it will lead to | |
7fe08af4 | 250 | the same permissions as gitlink:git-checkout[1] would use. The default |
ce1a79b6 WT |
251 | value remains 0, which means world read-write. |
252 | ||
1ab661dd PB |
253 | user.email:: |
254 | Your email address to be recorded in any newly created commits. | |
abda1ef5 | 255 | Can be overridden by the 'GIT_AUTHOR_EMAIL' and 'GIT_COMMITTER_EMAIL' |
1ab661dd PB |
256 | environment variables. See gitlink:git-commit-tree[1]. |
257 | ||
258 | user.name:: | |
259 | Your full name to be recorded in any newly created commits. | |
abda1ef5 | 260 | Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME' |
1ab661dd PB |
261 | environment variables. See gitlink:git-commit-tree[1]. |
262 | ||
263 | whatchanged.difftree:: | |
264 | The default gitlink:git-diff-tree[1] arguments to be used | |
265 | for gitlink:git-whatchanged[1]. | |
266 | ||
267 | imap:: | |
268 | The configuration variables in the 'imap' section are described | |
269 | in gitlink:git-imap-send[1]. |