28fe6942cf867549e8d19120e339a14cb8347b1b
1 CONFIGURATION FILE
2 ------------------
4 The git configuration file contains a number of variables that affect
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
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.
12 The syntax is fairly flexible and permissive; whitespaces are mostly
13 ignored. The '#' and ';' characters begin comments to the end of line,
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.
21 Example
22 ~~~~~~~
24 # Core variables
25 [core]
26 ; Don't trust file modes
27 filemode = false
29 # Our diff algorithm
30 [diff]
31 external = "/usr/local/bin/gnu-diff -u"
32 renames = true
34 [branch "devel"]
35 remote = origin
36 merge = refs/heads/devel
39 Variables
40 ~~~~~~~~~
42 Note that this list is non-comprehensive and not necessarily complete.
43 For command-specific variables, you will find a more detailed description
44 in the appropriate manual page. You will find a description of non-core
45 porcelain configuration variables in the respective porcelain documentation.
47 core.fileMode::
48 If false, the executable bit differences between the index and
49 the working copy are ignored; useful on broken filesystems like FAT.
50 See gitlink:git-update-index[1]. True by default.
52 core.gitProxy::
53 A "proxy command" to execute (as 'command host port') instead
54 of establishing direct connection to the remote server when
55 using the git protocol for fetching. If the variable value is
56 in the "COMMAND for DOMAIN" format, the command is applied only
57 on hostnames ending with the specified domain string. This variable
58 may be set multiple times and is matched in the given order;
59 the first match wins.
60 +
61 Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
62 (which always applies universally, without the special "for"
63 handling).
65 core.ignoreStat::
66 The working copy files are assumed to stay unchanged until you
67 mark them otherwise manually - Git will not detect the file changes
68 by lstat() calls. This is useful on systems where those are very
69 slow, such as Microsoft Windows. See gitlink:git-update-index[1].
70 False by default.
72 core.preferSymlinkRefs::
73 Instead of the default "symref" format for HEAD
74 and other symbolic reference files, use symbolic links.
75 This is sometimes needed to work with old scripts that
76 expect HEAD to be a symbolic link.
78 core.logAllRefUpdates::
79 Updates to a ref <ref> is logged to the file
80 "$GIT_DIR/logs/<ref>", by appending the new and old
81 SHA1, the date/time and the reason of the update, but
82 only when the file exists. If this configuration
83 variable is set to true, missing "$GIT_DIR/logs/<ref>"
84 file is automatically created for branch heads.
86 This information can be used to determine what commit
87 was the tip of a branch "2 days ago".
89 This value is true by default in a repository that has
90 a working directory associated with it, and false by
91 default in a bare repository.
93 core.repositoryFormatVersion::
94 Internal variable identifying the repository format and layout
95 version.
97 core.sharedRepository::
98 When 'group' (or 'true'), the repository is made shareable between
99 several users in a group (making sure all the files and objects are
100 group-writable). When 'all' (or 'world' or 'everybody'), the
101 repository will be readable by all users, additionally to being
102 group-shareable. When 'umask' (or 'false'), git will use permissions
103 reported by umask(2). See gitlink:git-init-db[1]. False by default.
105 core.warnAmbiguousRefs::
106 If true, git will warn you if the ref name you passed it is ambiguous
107 and might match multiple refs in the .git/refs/ tree. True by default.
109 core.compression::
110 An integer -1..9, indicating the compression level for objects that
111 are not in a pack file. -1 is the zlib and git default. 0 means no
112 compression, and 1..9 are various speed/size tradeoffs, 9 being
113 slowest.
115 core.legacyheaders::
116 A boolean which enables the legacy object header format in case
117 you want to interoperate with old clients accessing the object
118 database directly (where the "http://" and "rsync://" protocols
119 count as direct access).
121 core.packedGitLimit::
122 Maximum number of bytes to map simultaneously into memory
123 from pack files. If Git needs to access more than this many
124 bytes at once to complete an operation it will unmap existing
125 regions to reclaim virtual address space within the process.
126 Default is 256 MiB, which should be reasonable for all
127 users/operating systems, except on largest Git projects.
128 You probably do not need to adjust this value.
130 alias.*::
131 Command aliases for the gitlink:git[1] command wrapper - e.g.
132 after defining "alias.last = cat-file commit HEAD", the invocation
133 "git last" is equivalent to "git cat-file commit HEAD". To avoid
134 confusion and troubles with script usage, aliases that
135 hide existing git commands are ignored. Arguments are split by
136 spaces, the usual shell quoting and escaping is supported.
137 quote pair and a backslash can be used to quote them.
139 apply.whitespace::
140 Tells `git-apply` how to handle whitespaces, in the same way
141 as the '--whitespace' option. See gitlink:git-apply[1].
143 branch.<name>.remote::
144 When in branch <name>, it tells `git fetch` which remote to fetch.
145 If this option is not given, `git fetch` defaults to remote "origin".
147 branch.<name>.merge::
148 When in branch <name>, it tells `git fetch` the default refspec to
149 be marked for merging in FETCH_HEAD. The value has exactly to match
150 a remote part of one of the refspecs which are fetched from the remote
151 given by "branch.<name>.remote".
152 The merge information is used by `git pull` (which at first calls
153 `git fetch`) to lookup the default branch for merging. Without
154 this option, `git pull` defaults to merge the first refspec fetched.
155 Specify multiple values to get an octopus merge.
157 color.diff::
158 When true (or `always`), always use colors in patch.
159 When false (or `never`), never. When set to `auto`, use
160 colors only when the output is to the terminal.
162 color.diff.<slot>::
163 Use customized color for diff colorization. `<slot>`
164 specifies which part of the patch to use the specified
165 color, and is one of `plain` (context text), `meta`
166 (metainformation), `frag` (hunk header), `old` (removed
167 lines), or `new` (added lines). The value for these
168 configuration variables can be one of: `normal`, `bold`,
169 `dim`, `ul`, `blink`, `reverse`, `reset`, `black`,
170 `red`, `green`, `yellow`, `blue`, `magenta`, `cyan`, or
171 `white`.
173 color.pager::
174 A boolean to enable/disable colored output when the pager is in
175 use (default is true).
177 color.status::
178 A boolean to enable/disable color in the output of
179 gitlink:git-status[1]. May be set to `true` (or `always`),
180 `false` (or `never`) or `auto`, in which case colors are used
181 only when the output is to a terminal. Defaults to false.
183 color.status.<slot>::
184 Use customized color for status colorization. `<slot>` is
185 one of `header` (the header text of the status message),
186 `added` or `updated` (files which are added but not committed),
187 `changed` (files which are changed but not added in the index),
188 or `untracked` (files which are not tracked by git). The values of
189 these variables may be specified as in color.diff.<slot>.
191 diff.renameLimit::
192 The number of files to consider when performing the copy/rename
193 detection; equivalent to the git diff option '-l'.
195 diff.renames::
196 Tells git to detect renames. If set to any boolean value, it
197 will enable basic rename detection. If set to "copies" or
198 "copy", it will detect copies, as well.
200 format.headers::
201 Additional email headers to include in a patch to be submitted
202 by mail. See gitlink:git-format-patch[1].
204 gc.reflogexpire::
205 `git reflog expire` removes reflog entries older than
206 this time; defaults to 90 days.
208 gc.reflogexpireunreachable::
209 `git reflog expire` removes reflog entries older than
210 this time and are not reachable from the current tip;
211 defaults to 30 days.
213 gc.rerereresolved::
214 Records of conflicted merge you resolved earlier are
215 kept for this many days when `git rerere gc` is run.
216 The default is 60 days. See gitlink:git-rerere[1].
218 gc.rerereunresolved::
219 Records of conflicted merge you have not resolved are
220 kept for this many days when `git rerere gc` is run.
221 The default is 15 days. See gitlink:git-rerere[1].
223 gitcvs.enabled::
224 Whether the cvs pserver interface is enabled for this repository.
225 See gitlink:git-cvsserver[1].
227 gitcvs.logfile::
228 Path to a log file where the cvs pserver interface well... logs
229 various stuff. See gitlink:git-cvsserver[1].
231 http.sslVerify::
232 Whether to verify the SSL certificate when fetching or pushing
233 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
234 variable.
236 http.sslCert::
237 File containing the SSL certificate when fetching or pushing
238 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
239 variable.
241 http.sslKey::
242 File containing the SSL private key when fetching or pushing
243 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
244 variable.
246 http.sslCAInfo::
247 File containing the certificates to verify the peer with when
248 fetching or pushing over HTTPS. Can be overridden by the
249 'GIT_SSL_CAINFO' environment variable.
251 http.sslCAPath::
252 Path containing files with the CA certificates to verify the peer
253 with when fetching or pushing over HTTPS. Can be overridden
254 by the 'GIT_SSL_CAPATH' environment variable.
256 http.maxRequests::
257 How many HTTP requests to launch in parallel. Can be overridden
258 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
260 http.lowSpeedLimit, http.lowSpeedTime::
261 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
262 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
263 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
264 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
266 http.noEPSV::
267 A boolean which disables using of EPSV ftp command by curl.
268 This can helpful with some "poor" ftp servers which doesn't
269 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
270 environment variable. Default is false (curl will use EPSV).
272 i18n.commitEncoding::
273 Character encoding the commit messages are stored in; git itself
274 does not care per se, but this information is necessary e.g. when
275 importing commits from emails or in the gitk graphical history
276 browser (and possibly at other places in the future or in other
277 porcelains). See e.g. gitlink:git-mailinfo[1]. Defaults to 'utf-8'.
279 i18n.logOutputEncoding::
280 Character encoding the commit messages are converted to when
281 running `git-log` and friends.
283 log.showroot::
284 If true, the initial commit will be shown as a big creation event.
285 This is equivalent to a diff against an empty tree.
286 Tools like gitlink:git-log[1] or gitlink:git-whatchanged[1], which
287 normally hide the root commit will now show it. True by default.
289 merge.summary::
290 Whether to include summaries of merged commits in newly created
291 merge commit messages. False by default.
293 pack.window::
294 The size of the window used by gitlink:git-pack-objects[1] when no
295 window size is given on the command line. Defaults to 10.
297 pull.octopus::
298 The default merge strategy to use when pulling multiple branches
299 at once.
301 pull.twohead::
302 The default merge strategy to use when pulling a single branch.
304 remote.<name>.url::
305 The URL of a remote repository. See gitlink:git-fetch[1] or
306 gitlink:git-push[1].
308 remote.<name>.fetch::
309 The default set of "refspec" for gitlink:git-fetch[1]. See
310 gitlink:git-fetch[1].
312 remote.<name>.push::
313 The default set of "refspec" for gitlink:git-push[1]. See
314 gitlink:git-push[1].
316 repack.usedeltabaseoffset::
317 Allow gitlink:git-repack[1] to create packs that uses
318 delta-base offset. Defaults to false.
320 show.difftree::
321 The default gitlink:git-diff-tree[1] arguments to be used
322 for gitlink:git-show[1].
324 showbranch.default::
325 The default set of branches for gitlink:git-show-branch[1].
326 See gitlink:git-show-branch[1].
328 tar.umask::
329 By default, gitlink:git-tar-tree[1] sets file and directories modes
330 to 0666 or 0777. While this is both useful and acceptable for projects
331 such as the Linux Kernel, it might be excessive for other projects.
332 With this variable, it becomes possible to tell
333 gitlink:git-tar-tree[1] to apply a specific umask to the modes above.
334 The special value "user" indicates that the user's current umask will
335 be used. This should be enough for most projects, as it will lead to
336 the same permissions as gitlink:git-checkout[1] would use. The default
337 value remains 0, which means world read-write.
339 user.email::
340 Your email address to be recorded in any newly created commits.
341 Can be overridden by the 'GIT_AUTHOR_EMAIL' and 'GIT_COMMITTER_EMAIL'
342 environment variables. See gitlink:git-commit-tree[1].
344 user.name::
345 Your full name to be recorded in any newly created commits.
346 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
347 environment variables. See gitlink:git-commit-tree[1].
349 whatchanged.difftree::
350 The default gitlink:git-diff-tree[1] arguments to be used
351 for gitlink:git-whatchanged[1].
353 imap::
354 The configuration variables in the 'imap' section are described
355 in gitlink:git-imap-send[1].
357 receive.unpackLimit::
358 If the number of objects received in a push is below this
359 limit then the objects will be unpacked into loose object
360 files. However if the number of received objects equals or
361 exceeds this limit then the received pack will be stored as
362 a pack, after adding any missing delta bases. Storing the
363 pack from a push can make the push operation complete faster,
364 especially on slow filesystems.
366 receive.denyNonFastForwards::
367 If set to true, git-receive-pack will deny a ref update which is
368 not a fast forward. Use this to prevent such an update via a push,
369 even if that push is forced. This configuration variable is
370 set when initializing a shared repository.