1 CONFIGURATION FILE
2 ------------------
4 The git configuration file contains a number of variables that affect
5 the git command's behavior. The `.git/config` file in each repository
6 is used to store the configuration for that repository, and
7 `$HOME/.gitconfig` is used to store a per-user configuration as
8 fallback values for the `.git/config` file. The file `/etc/gitconfig`
9 can be used to store a system-wide default configuration.
11 The configuration variables are used by both the git plumbing
12 and the porcelains. The variables are divided into sections, wherein
13 the fully qualified variable name of the variable itself is the last
14 dot-separated segment and the section name is everything before the last
15 dot. The variable names are case-insensitive and only alphanumeric
16 characters are allowed. Some variables may appear multiple times.
18 Syntax
19 ~~~~~~
21 The syntax is fairly flexible and permissive; whitespaces are mostly
22 ignored. The '#' and ';' characters begin comments to the end of line,
23 blank lines are ignored.
25 The file consists of sections and variables. A section begins with
26 the name of the section in square brackets and continues until the next
27 section begins. Section names are not case sensitive. Only alphanumeric
28 characters, `-` and `.` are allowed in section names. Each variable
29 must belong to some section, which means that there must be a section
30 header before the first setting of a variable.
32 Sections can be further divided into subsections. To begin a subsection
33 put its name in double quotes, separated by space from the section name,
34 in the section header, like in the example below:
36 --------
37 [section "subsection"]
39 --------
41 Subsection names are case sensitive and can contain any characters except
42 newline (doublequote `"` and backslash have to be escaped as `\"` and `\\`,
43 respectively). Section headers cannot span multiple
44 lines. Variables may belong directly to a section or to a given subsection.
45 You can have `[section]` if you have `[section "subsection"]`, but you
46 don't need to.
48 There is also a case insensitive alternative `[section.subsection]` syntax.
49 In this syntax, subsection names follow the same restrictions as for section
50 names.
52 All the other lines (and the remainder of the line after the section
53 header) are recognized as setting variables, in the form
54 'name = value'. If there is no equal sign on the line, the entire line
55 is taken as 'name' and the variable is recognized as boolean "true".
56 The variable names are case-insensitive and only alphanumeric
57 characters and `-` are allowed. There can be more than one value
58 for a given variable; we say then that variable is multivalued.
60 Leading and trailing whitespace in a variable value is discarded.
61 Internal whitespace within a variable value is retained verbatim.
63 The values following the equals sign in variable assign are all either
64 a string, an integer, or a boolean. Boolean values may be given as yes/no,
65 0/1, true/false or on/off. Case is not significant in boolean values, when
66 converting value to the canonical form using '--bool' type specifier;
67 'git config' will ensure that the output is "true" or "false".
69 String values may be entirely or partially enclosed in double quotes.
70 You need to enclose variable values in double quotes if you want to
71 preserve leading or trailing whitespace, or if the variable value contains
72 comment characters (i.e. it contains '#' or ';').
73 Double quote `"` and backslash `\` characters in variable values must
74 be escaped: use `\"` for `"` and `\\` for `\`.
76 The following escape sequences (beside `\"` and `\\`) are recognized:
77 `\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
78 and `\b` for backspace (BS). No other char escape sequence, nor octal
79 char sequences are valid.
81 Variable values ending in a `\` are continued on the next line in the
82 customary UNIX fashion.
84 Some variables may require a special value format.
86 Example
87 ~~~~~~~
89 # Core variables
90 [core]
91 ; Don't trust file modes
92 filemode = false
94 # Our diff algorithm
95 [diff]
96 external = /usr/local/bin/diff-wrapper
97 renames = true
99 [branch "devel"]
100 remote = origin
101 merge = refs/heads/devel
103 # Proxy settings
104 [core]
105 gitProxy="ssh" for "kernel.org"
106 gitProxy=default-proxy ; for the rest
108 Variables
109 ~~~~~~~~~
111 Note that this list is non-comprehensive and not necessarily complete.
112 For command-specific variables, you will find a more detailed description
113 in the appropriate manual page. You will find a description of non-core
114 porcelain configuration variables in the respective porcelain documentation.
116 advice.*::
117 When set to 'true', display the given optional help message.
118 When set to 'false', do not display. The configuration variables
119 are:
120 +
121 --
122 pushNonFastForward::
123 Advice shown when linkgit:git-push[1] refuses
124 non-fast-forward refs. Default: true.
125 statusHints::
126 Directions on how to stage/unstage/add shown in the
127 output of linkgit:git-status[1] and the template shown
128 when writing commit messages. Default: true.
129 commitBeforeMerge::
130 Advice shown when linkgit:git-merge[1] refuses to
131 merge to avoid overwritting local changes.
132 Default: true.
133 resolveConflict::
134 Advices shown by various commands when conflicts
135 prevent the operation from being performed.
136 Default: true.
137 implicitIdentity::
138 Advice on how to set your identity configuration when
139 your information is guessed from the system username and
140 domain name. Default: true.
142 detachedHead::
143 Advice shown when you used linkgit::git-checkout[1] to
144 move to the detach HEAD state, to instruct how to create
145 a local branch after the fact. Default: true.
146 --
148 core.fileMode::
149 If false, the executable bit differences between the index and
150 the working copy are ignored; useful on broken filesystems like FAT.
151 See linkgit:git-update-index[1].
152 +
153 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
154 will probe and set core.fileMode false if appropriate when the
155 repository is created.
157 core.ignoreCygwinFSTricks::
158 This option is only used by Cygwin implementation of Git. If false,
159 the Cygwin stat() and lstat() functions are used. This may be useful
160 if your repository consists of a few separate directories joined in
161 one hierarchy using Cygwin mount. If true, Git uses native Win32 API
162 whenever it is possible and falls back to Cygwin functions only to
163 handle symbol links. The native mode is more than twice faster than
164 normal Cygwin l/stat() functions. True by default, unless core.filemode
165 is true, in which case ignoreCygwinFSTricks is ignored as Cygwin's
166 POSIX emulation is required to support core.filemode.
168 core.ignorecase::
169 If true, this option enables various workarounds to enable
170 git to work better on filesystems that are not case sensitive,
171 like FAT. For example, if a directory listing finds
172 "makefile" when git expects "Makefile", git will assume
173 it is really the same file, and continue to remember it as
174 "Makefile".
175 +
176 The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
177 will probe and set core.ignorecase true if appropriate when the repository
178 is created.
180 core.trustctime::
181 If false, the ctime differences between the index and the
182 working copy are ignored; useful when the inode change time
183 is regularly modified by something outside Git (file system
184 crawlers and some backup systems).
185 See linkgit:git-update-index[1]. True by default.
187 core.quotepath::
188 The commands that output paths (e.g. 'ls-files',
189 'diff'), when not given the `-z` option, will quote
190 "unusual" characters in the pathname by enclosing the
191 pathname in a double-quote pair and with backslashes the
192 same way strings in C source code are quoted. If this
193 variable is set to false, the bytes higher than 0x80 are
194 not quoted but output as verbatim. Note that double
195 quote, backslash and control characters are always
196 quoted without `-z` regardless of the setting of this
197 variable.
199 core.autocrlf::
200 If true, makes git convert `CRLF` at the end of lines in text files to
201 `LF` when reading from the work tree, and convert in reverse when
202 writing to the work tree. The variable can be set to
203 'input', in which case the conversion happens only while
204 reading from the work tree but files are written out to the work
205 tree with `LF` at the end of lines. A file is considered
206 "text" (i.e. be subjected to the autocrlf mechanism) based on
207 the file's `crlf` attribute, or if `crlf` is unspecified,
208 based on the file's contents. See linkgit:gitattributes[5].
210 core.safecrlf::
211 If true, makes git check if converting `CRLF` as controlled by
212 `core.autocrlf` is reversible. Git will verify if a command
213 modifies a file in the work tree either directly or indirectly.
214 For example, committing a file followed by checking out the
215 same file should yield the original file in the work tree. If
216 this is not the case for the current setting of
217 `core.autocrlf`, git will reject the file. The variable can
218 be set to "warn", in which case git will only warn about an
219 irreversible conversion but continue the operation.
220 +
221 CRLF conversion bears a slight chance of corrupting data.
222 autocrlf=true will convert CRLF to LF during commit and LF to
223 CRLF during checkout. A file that contains a mixture of LF and
224 CRLF before the commit cannot be recreated by git. For text
225 files this is the right thing to do: it corrects line endings
226 such that we have only LF line endings in the repository.
227 But for binary files that are accidentally classified as text the
228 conversion can corrupt data.
229 +
230 If you recognize such corruption early you can easily fix it by
231 setting the conversion type explicitly in .gitattributes. Right
232 after committing you still have the original file in your work
233 tree and this file is not yet corrupted. You can explicitly tell
234 git that this file is binary and git will handle the file
235 appropriately.
236 +
237 Unfortunately, the desired effect of cleaning up text files with
238 mixed line endings and the undesired effect of corrupting binary
239 files cannot be distinguished. In both cases CRLFs are removed
240 in an irreversible way. For text files this is the right thing
241 to do because CRLFs are line endings, while for binary files
242 converting CRLFs corrupts data.
243 +
244 Note, this safety check does not mean that a checkout will generate a
245 file identical to the original file for a different setting of
246 `core.autocrlf`, but only for the current one. For example, a text
247 file with `LF` would be accepted with `core.autocrlf=input` and could
248 later be checked out with `core.autocrlf=true`, in which case the
249 resulting file would contain `CRLF`, although the original file
250 contained `LF`. However, in both work trees the line endings would be
251 consistent, that is either all `LF` or all `CRLF`, but never mixed. A
252 file with mixed line endings would be reported by the `core.safecrlf`
253 mechanism.
255 core.symlinks::
256 If false, symbolic links are checked out as small plain files that
257 contain the link text. linkgit:git-update-index[1] and
258 linkgit:git-add[1] will not change the recorded type to regular
259 file. Useful on filesystems like FAT that do not support
260 symbolic links.
261 +
262 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
263 will probe and set core.symlinks false if appropriate when the repository
264 is created.
266 core.gitProxy::
267 A "proxy command" to execute (as 'command host port') instead
268 of establishing direct connection to the remote server when
269 using the git protocol for fetching. If the variable value is
270 in the "COMMAND for DOMAIN" format, the command is applied only
271 on hostnames ending with the specified domain string. This variable
272 may be set multiple times and is matched in the given order;
273 the first match wins.
274 +
275 Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
276 (which always applies universally, without the special "for"
277 handling).
278 +
279 The special string `none` can be used as the proxy command to
280 specify that no proxy be used for a given domain pattern.
281 This is useful for excluding servers inside a firewall from
282 proxy use, while defaulting to a common proxy for external domains.
284 core.ignoreStat::
285 If true, commands which modify both the working tree and the index
286 will mark the updated paths with the "assume unchanged" bit in the
287 index. These marked files are then assumed to stay unchanged in the
288 working copy, until you mark them otherwise manually - Git will not
289 detect the file changes by lstat() calls. This is useful on systems
290 where those are very slow, such as Microsoft Windows.
291 See linkgit:git-update-index[1].
292 False by default.
294 core.preferSymlinkRefs::
295 Instead of the default "symref" format for HEAD
296 and other symbolic reference files, use symbolic links.
297 This is sometimes needed to work with old scripts that
298 expect HEAD to be a symbolic link.
300 core.bare::
301 If true this repository is assumed to be 'bare' and has no
302 working directory associated with it. If this is the case a
303 number of commands that require a working directory will be
304 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
305 +
306 This setting is automatically guessed by linkgit:git-clone[1] or
307 linkgit:git-init[1] when the repository was created. By default a
308 repository that ends in "/.git" is assumed to be not bare (bare =
309 false), while all other repositories are assumed to be bare (bare
310 = true).
312 core.worktree::
313 Set the path to the root of the work tree.
314 This can be overridden by the GIT_WORK_TREE environment
315 variable and the '--work-tree' command line option. It can be
316 an absolute path or a relative path to the .git directory,
317 either specified by --git-dir or GIT_DIR, or automatically
318 discovered.
319 If --git-dir or GIT_DIR are specified but none of
320 --work-tree, GIT_WORK_TREE and core.worktree is specified,
321 the current working directory is regarded as the root of the
322 work tree.
323 +
324 Note that this variable is honored even when set in a configuration
325 file in a ".git" subdirectory of a directory, and its value differs
326 from the latter directory (e.g. "/path/to/.git/config" has
327 core.worktree set to "/different/path"), which is most likely a
328 misconfiguration. Running git commands in "/path/to" directory will
329 still use "/different/path" as the root of the work tree and can cause
330 great confusion to the users.
332 core.logAllRefUpdates::
333 Enable the reflog. Updates to a ref <ref> is logged to the file
334 "$GIT_DIR/logs/<ref>", by appending the new and old
335 SHA1, the date/time and the reason of the update, but
336 only when the file exists. If this configuration
337 variable is set to true, missing "$GIT_DIR/logs/<ref>"
338 file is automatically created for branch heads.
339 +
340 This information can be used to determine what commit
341 was the tip of a branch "2 days ago".
342 +
343 This value is true by default in a repository that has
344 a working directory associated with it, and false by
345 default in a bare repository.
347 core.repositoryFormatVersion::
348 Internal variable identifying the repository format and layout
349 version.
351 core.sharedRepository::
352 When 'group' (or 'true'), the repository is made shareable between
353 several users in a group (making sure all the files and objects are
354 group-writable). When 'all' (or 'world' or 'everybody'), the
355 repository will be readable by all users, additionally to being
356 group-shareable. When 'umask' (or 'false'), git will use permissions
357 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
358 files in the repository will have this mode value. '0xxx' will override
359 user's umask value (whereas the other options will only override
360 requested parts of the user's umask value). Examples: '0660' will make
361 the repo read/write-able for the owner and group, but inaccessible to
362 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
363 repository that is group-readable but not group-writable.
364 See linkgit:git-init[1]. False by default.
366 core.warnAmbiguousRefs::
367 If true, git will warn you if the ref name you passed it is ambiguous
368 and might match multiple refs in the .git/refs/ tree. True by default.
370 core.compression::
371 An integer -1..9, indicating a default compression level.
372 -1 is the zlib default. 0 means no compression,
373 and 1..9 are various speed/size tradeoffs, 9 being slowest.
374 If set, this provides a default to other compression variables,
375 such as 'core.loosecompression' and 'pack.compression'.
377 core.loosecompression::
378 An integer -1..9, indicating the compression level for objects that
379 are not in a pack file. -1 is the zlib default. 0 means no
380 compression, and 1..9 are various speed/size tradeoffs, 9 being
381 slowest. If not set, defaults to core.compression. If that is
382 not set, defaults to 1 (best speed).
384 core.packedGitWindowSize::
385 Number of bytes of a pack file to map into memory in a
386 single mapping operation. Larger window sizes may allow
387 your system to process a smaller number of large pack files
388 more quickly. Smaller window sizes will negatively affect
389 performance due to increased calls to the operating system's
390 memory manager, but may improve performance when accessing
391 a large number of large pack files.
392 +
393 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
394 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
395 be reasonable for all users/operating systems. You probably do
396 not need to adjust this value.
397 +
398 Common unit suffixes of 'k', 'm', or 'g' are supported.
400 core.packedGitLimit::
401 Maximum number of bytes to map simultaneously into memory
402 from pack files. If Git needs to access more than this many
403 bytes at once to complete an operation it will unmap existing
404 regions to reclaim virtual address space within the process.
405 +
406 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
407 This should be reasonable for all users/operating systems, except on
408 the largest projects. You probably do not need to adjust this value.
409 +
410 Common unit suffixes of 'k', 'm', or 'g' are supported.
412 core.deltaBaseCacheLimit::
413 Maximum number of bytes to reserve for caching base objects
414 that multiple deltafied objects reference. By storing the
415 entire decompressed base objects in a cache Git is able
416 to avoid unpacking and decompressing frequently used base
417 objects multiple times.
418 +
419 Default is 16 MiB on all platforms. This should be reasonable
420 for all users/operating systems, except on the largest projects.
421 You probably do not need to adjust this value.
422 +
423 Common unit suffixes of 'k', 'm', or 'g' are supported.
425 core.bigFileThreshold::
426 Files larger than this size are stored deflated, without
427 attempting delta compression. Storing large files without
428 delta compression avoids excessive memory usage, at the
429 slight expense of increased disk usage.
430 +
431 Default is 512 MiB on all platforms. This should be reasonable
432 for most projects as source code and other text files can still
433 be delta compressed, but larger binary media files won't be.
434 +
435 Common unit suffixes of 'k', 'm', or 'g' are supported.
436 +
437 Currently only linkgit:git-fast-import[1] honors this setting.
439 core.excludesfile::
440 In addition to '.gitignore' (per-directory) and
441 '.git/info/exclude', git looks into this file for patterns
442 of files which are not meant to be tracked. "{tilde}/" is expanded
443 to the value of `$HOME` and "{tilde}user/" to the specified user's
444 home directory. See linkgit:gitignore[5].
446 core.editor::
447 Commands such as `commit` and `tag` that lets you edit
448 messages by launching an editor uses the value of this
449 variable when it is set, and the environment variable
450 `GIT_EDITOR` is not set. See linkgit:git-var[1].
452 core.pager::
453 The command that git will use to paginate output. Can
454 be overridden with the `GIT_PAGER` environment
455 variable. Note that git sets the `LESS` environment
456 variable to `FRSX` if it is unset when it runs the
457 pager. One can change these settings by setting the
458 `LESS` variable to some other value. Alternately,
459 these settings can be overridden on a project or
460 global basis by setting the `core.pager` option.
461 Setting `core.pager` has no affect on the `LESS`
462 environment variable behaviour above, so if you want
463 to override git's default settings this way, you need
464 to be explicit. For example, to disable the S option
465 in a backward compatible manner, set `core.pager`
466 to `less -+$LESS -FRX`. This will be passed to the
467 shell by git, which will translate the final command to
468 `LESS=FRSX less -+FRSX -FRX`.
470 core.whitespace::
471 A comma separated list of common whitespace problems to
472 notice. 'git diff' will use `color.diff.whitespace` to
473 highlight them, and 'git apply --whitespace=error' will
474 consider them as errors. You can prefix `-` to disable
475 any of them (e.g. `-trailing-space`):
476 +
477 * `blank-at-eol` treats trailing whitespaces at the end of the line
478 as an error (enabled by default).
479 * `space-before-tab` treats a space character that appears immediately
480 before a tab character in the initial indent part of the line as an
481 error (enabled by default).
482 * `indent-with-non-tab` treats a line that is indented with 8 or more
483 space characters as an error (not enabled by default).
484 * `tab-in-indent` treats a tab character in the initial indent part of
485 the line as an error (not enabled by default).
486 * `blank-at-eof` treats blank lines added at the end of file as an error
487 (enabled by default).
488 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
489 `blank-at-eof`.
490 * `cr-at-eol` treats a carriage-return at the end of line as
491 part of the line terminator, i.e. with it, `trailing-space`
492 does not trigger if the character before such a carriage-return
493 is not a whitespace (not enabled by default).
495 core.fsyncobjectfiles::
496 This boolean will enable 'fsync()' when writing object files.
497 +
498 This is a total waste of time and effort on a filesystem that orders
499 data writes properly, but can be useful for filesystems that do not use
500 journalling (traditional UNIX filesystems) or that only journal metadata
501 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
503 core.preloadindex::
504 Enable parallel index preload for operations like 'git diff'
505 +
506 This can speed up operations like 'git diff' and 'git status' especially
507 on filesystems like NFS that have weak caching semantics and thus
508 relatively high IO latencies. With this set to 'true', git will do the
509 index comparison to the filesystem data in parallel, allowing
510 overlapping IO's.
512 core.createObject::
513 You can set this to 'link', in which case a hardlink followed by
514 a delete of the source are used to make sure that object creation
515 will not overwrite existing objects.
516 +
517 On some file system/operating system combinations, this is unreliable.
518 Set this config setting to 'rename' there; However, This will remove the
519 check that makes sure that existing object files will not get overwritten.
521 core.notesRef::
522 When showing commit messages, also show notes which are stored in
523 the given ref. This ref is expected to contain files named
524 after the full SHA-1 of the commit they annotate. The ref
525 must be fully qualified.
526 +
527 If such a file exists in the given ref, the referenced blob is read, and
528 appended to the commit message, separated by a "Notes (<refname>):"
529 line (shortened to "Notes:" in the case of "refs/notes/commits"). If the
530 given ref itself does not exist, it is not an error, but means that no
531 notes should be printed.
532 +
533 This setting defaults to "refs/notes/commits", and can be overridden by
534 the `GIT_NOTES_REF` environment variable.
536 core.sparseCheckout::
537 Enable "sparse checkout" feature. See section "Sparse checkout" in
538 linkgit:git-read-tree[1] for more information.
540 add.ignore-errors::
541 Tells 'git add' to continue adding files when some files cannot be
542 added due to indexing errors. Equivalent to the '--ignore-errors'
543 option of linkgit:git-add[1].
545 alias.*::
546 Command aliases for the linkgit:git[1] command wrapper - e.g.
547 after defining "alias.last = cat-file commit HEAD", the invocation
548 "git last" is equivalent to "git cat-file commit HEAD". To avoid
549 confusion and troubles with script usage, aliases that
550 hide existing git commands are ignored. Arguments are split by
551 spaces, the usual shell quoting and escaping is supported.
552 quote pair and a backslash can be used to quote them.
553 +
554 If the alias expansion is prefixed with an exclamation point,
555 it will be treated as a shell command. For example, defining
556 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
557 "git new" is equivalent to running the shell command
558 "gitk --all --not ORIG_HEAD". Note that shell commands will be
559 executed from the top-level directory of a repository, which may
560 not necessarily be the current directory.
562 am.keepcr::
563 If true, git-am will call git-mailsplit for patches in mbox format
564 with parameter '--keep-cr'. In this case git-mailsplit will
565 not remove `\r` from lines ending with `\r\n`. Can be overrriden
566 by giving '--no-keep-cr' from the command line.
567 See linkgit:git-am[1], linkgit:git-mailsplit[1].
569 apply.ignorewhitespace::
570 When set to 'change', tells 'git apply' to ignore changes in
571 whitespace, in the same way as the '--ignore-space-change'
572 option.
573 When set to one of: no, none, never, false tells 'git apply' to
574 respect all whitespace differences.
575 See linkgit:git-apply[1].
577 apply.whitespace::
578 Tells 'git apply' how to handle whitespaces, in the same way
579 as the '--whitespace' option. See linkgit:git-apply[1].
581 branch.autosetupmerge::
582 Tells 'git branch' and 'git checkout' to set up new branches
583 so that linkgit:git-pull[1] will appropriately merge from the
584 starting point branch. Note that even if this option is not set,
585 this behavior can be chosen per-branch using the `--track`
586 and `--no-track` options. The valid settings are: `false` -- no
587 automatic setup is done; `true` -- automatic setup is done when the
588 starting point is a remote branch; `always` -- automatic setup is
589 done when the starting point is either a local branch or remote
590 branch. This option defaults to true.
592 branch.autosetuprebase::
593 When a new branch is created with 'git branch' or 'git checkout'
594 that tracks another branch, this variable tells git to set
595 up pull to rebase instead of merge (see "branch.<name>.rebase").
596 When `never`, rebase is never automatically set to true.
597 When `local`, rebase is set to true for tracked branches of
598 other local branches.
599 When `remote`, rebase is set to true for tracked branches of
600 remote branches.
601 When `always`, rebase will be set to true for all tracking
602 branches.
603 See "branch.autosetupmerge" for details on how to set up a
604 branch to track another branch.
605 This option defaults to never.
607 branch.<name>.remote::
608 When in branch <name>, it tells 'git fetch' and 'git push' which
609 remote to fetch from/push to. It defaults to `origin` if no remote is
610 configured. `origin` is also used if you are not on any branch.
612 branch.<name>.merge::
613 Defines, together with branch.<name>.remote, the upstream branch
614 for the given branch. It tells 'git fetch'/'git pull' which
615 branch to merge and can also affect 'git push' (see push.default).
616 When in branch <name>, it tells 'git fetch' the default
617 refspec to be marked for merging in FETCH_HEAD. The value is
618 handled like the remote part of a refspec, and must match a
619 ref which is fetched from the remote given by
620 "branch.<name>.remote".
621 The merge information is used by 'git pull' (which at first calls
622 'git fetch') to lookup the default branch for merging. Without
623 this option, 'git pull' defaults to merge the first refspec fetched.
624 Specify multiple values to get an octopus merge.
625 If you wish to setup 'git pull' so that it merges into <name> from
626 another branch in the local repository, you can point
627 branch.<name>.merge to the desired branch, and use the special setting
628 `.` (a period) for branch.<name>.remote.
630 branch.<name>.mergeoptions::
631 Sets default options for merging into branch <name>. The syntax and
632 supported options are the same as those of linkgit:git-merge[1], but
633 option values containing whitespace characters are currently not
634 supported.
636 branch.<name>.rebase::
637 When true, rebase the branch <name> on top of the fetched branch,
638 instead of merging the default branch from the default remote when
639 "git pull" is run.
640 *NOTE*: this is a possibly dangerous operation; do *not* use
641 it unless you understand the implications (see linkgit:git-rebase[1]
642 for details).
644 browser.<tool>.cmd::
645 Specify the command to invoke the specified browser. The
646 specified command is evaluated in shell with the URLs passed
647 as arguments. (See linkgit:git-web--browse[1].)
649 browser.<tool>.path::
650 Override the path for the given tool that may be used to
651 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
652 working repository in gitweb (see linkgit:git-instaweb[1]).
654 clean.requireForce::
655 A boolean to make git-clean do nothing unless given -f
656 or -n. Defaults to true.
658 color.branch::
659 A boolean to enable/disable color in the output of
660 linkgit:git-branch[1]. May be set to `always`,
661 `false` (or `never`) or `auto` (or `true`), in which case colors are used
662 only when the output is to a terminal. Defaults to false.
664 color.branch.<slot>::
665 Use customized color for branch coloration. `<slot>` is one of
666 `current` (the current branch), `local` (a local branch),
667 `remote` (a tracking branch in refs/remotes/), `plain` (other
668 refs).
669 +
670 The value for these configuration variables is a list of colors (at most
671 two) and attributes (at most one), separated by spaces. The colors
672 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
673 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
674 `blink` and `reverse`. The first color given is the foreground; the
675 second is the background. The position of the attribute, if any,
676 doesn't matter.
678 color.diff::
679 When set to `always`, always use colors in patch.
680 When false (or `never`), never. When set to `true` or `auto`, use
681 colors only when the output is to the terminal. Defaults to false.
683 color.diff.<slot>::
684 Use customized color for diff colorization. `<slot>` specifies
685 which part of the patch to use the specified color, and is one
686 of `plain` (context text), `meta` (metainformation), `frag`
687 (hunk header), 'func' (function in hunk header), `old` (removed lines),
688 `new` (added lines), `commit` (commit headers), or `whitespace`
689 (highlighting whitespace errors). The values of these variables may be
690 specified as in color.branch.<slot>.
692 color.grep::
693 When set to `always`, always highlight matches. When `false` (or
694 `never`), never. When set to `true` or `auto`, use color only
695 when the output is written to the terminal. Defaults to `false`.
697 color.grep.<slot>::
698 Use customized color for grep colorization. `<slot>` specifies which
699 part of the line to use the specified color, and is one of
700 +
701 --
702 `context`;;
703 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
704 `filename`;;
705 filename prefix (when not using `-h`)
706 `function`;;
707 function name lines (when using `-p`)
708 `linenumber`;;
709 line number prefix (when using `-n`)
710 `match`;;
711 matching text
712 `selected`;;
713 non-matching text in selected lines
714 `separator`;;
715 separators between fields on a line (`:`, `-`, and `=`)
716 and between hunks (`--`)
717 --
718 +
719 The values of these variables may be specified as in color.branch.<slot>.
721 color.interactive::
722 When set to `always`, always use colors for interactive prompts
723 and displays (such as those used by "git-add --interactive").
724 When false (or `never`), never. When set to `true` or `auto`, use
725 colors only when the output is to the terminal. Defaults to false.
727 color.interactive.<slot>::
728 Use customized color for 'git add --interactive'
729 output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
730 four distinct types of normal output from interactive
731 commands. The values of these variables may be specified as
732 in color.branch.<slot>.
734 color.pager::
735 A boolean to enable/disable colored output when the pager is in
736 use (default is true).
738 color.showbranch::
739 A boolean to enable/disable color in the output of
740 linkgit:git-show-branch[1]. May be set to `always`,
741 `false` (or `never`) or `auto` (or `true`), in which case colors are used
742 only when the output is to a terminal. Defaults to false.
744 color.status::
745 A boolean to enable/disable color in the output of
746 linkgit:git-status[1]. May be set to `always`,
747 `false` (or `never`) or `auto` (or `true`), in which case colors are used
748 only when the output is to a terminal. Defaults to false.
750 color.status.<slot>::
751 Use customized color for status colorization. `<slot>` is
752 one of `header` (the header text of the status message),
753 `added` or `updated` (files which are added but not committed),
754 `changed` (files which are changed but not added in the index),
755 `untracked` (files which are not tracked by git), or
756 `nobranch` (the color the 'no branch' warning is shown in, defaulting
757 to red). The values of these variables may be specified as in
758 color.branch.<slot>.
760 color.ui::
761 When set to `always`, always use colors in all git commands which
762 are capable of colored output. When false (or `never`), never. When
763 set to `true` or `auto`, use colors only when the output is to the
764 terminal. When more specific variables of color.* are set, they always
765 take precedence over this setting. Defaults to false.
767 commit.status::
768 A boolean to enable/disable inclusion of status information in the
769 commit message template when using an editor to prepare the commit
770 message. Defaults to true.
772 commit.template::
773 Specify a file to use as the template for new commit messages.
774 "{tilde}/" is expanded to the value of `$HOME` and "{tilde}user/" to the
775 specified user's home directory.
777 diff.autorefreshindex::
778 When using 'git diff' to compare with work tree
779 files, do not consider stat-only change as changed.
780 Instead, silently run `git update-index --refresh` to
781 update the cached stat information for paths whose
782 contents in the work tree match the contents in the
783 index. This option defaults to true. Note that this
784 affects only 'git diff' Porcelain, and not lower level
785 'diff' commands such as 'git diff-files'.
787 diff.external::
788 If this config variable is set, diff generation is not
789 performed using the internal diff machinery, but using the
790 given command. Can be overridden with the `GIT_EXTERNAL_DIFF'
791 environment variable. The command is called with parameters
792 as described under "git Diffs" in linkgit:git[1]. Note: if
793 you want to use an external diff program only on a subset of
794 your files, you might want to use linkgit:gitattributes[5] instead.
796 diff.mnemonicprefix::
797 If set, 'git diff' uses a prefix pair that is different from the
798 standard "a/" and "b/" depending on what is being compared. When
799 this configuration is in effect, reverse diff output also swaps
800 the order of the prefixes:
801 `git diff`;;
802 compares the (i)ndex and the (w)ork tree;
803 `git diff HEAD`;;
804 compares a (c)ommit and the (w)ork tree;
805 `git diff --cached`;;
806 compares a (c)ommit and the (i)ndex;
807 `git diff HEAD:file1 file2`;;
808 compares an (o)bject and a (w)ork tree entity;
809 `git diff --no-index a b`;;
810 compares two non-git things (1) and (2).
812 diff.renameLimit::
813 The number of files to consider when performing the copy/rename
814 detection; equivalent to the 'git diff' option '-l'.
816 diff.renames::
817 Tells git to detect renames. If set to any boolean value, it
818 will enable basic rename detection. If set to "copies" or
819 "copy", it will detect copies, as well.
821 diff.suppressBlankEmpty::
822 A boolean to inhibit the standard behavior of printing a space
823 before each empty output line. Defaults to false.
825 diff.tool::
826 Controls which diff tool is used. `diff.tool` overrides
827 `merge.tool` when used by linkgit:git-difftool[1] and has
828 the same valid values as `merge.tool` minus "tortoisemerge"
829 and plus "kompare".
831 difftool.<tool>.path::
832 Override the path for the given tool. This is useful in case
833 your tool is not in the PATH.
835 difftool.<tool>.cmd::
836 Specify the command to invoke the specified diff tool.
837 The specified command is evaluated in shell with the following
838 variables available: 'LOCAL' is set to the name of the temporary
839 file containing the contents of the diff pre-image and 'REMOTE'
840 is set to the name of the temporary file containing the contents
841 of the diff post-image.
843 difftool.prompt::
844 Prompt before each invocation of the diff tool.
846 diff.wordRegex::
847 A POSIX Extended Regular Expression used to determine what is a "word"
848 when performing word-by-word difference calculations. Character
849 sequences that match the regular expression are "words", all other
850 characters are *ignorable* whitespace.
852 fetch.unpackLimit::
853 If the number of objects fetched over the git native
854 transfer is below this
855 limit, then the objects will be unpacked into loose object
856 files. However if the number of received objects equals or
857 exceeds this limit then the received pack will be stored as
858 a pack, after adding any missing delta bases. Storing the
859 pack from a push can make the push operation complete faster,
860 especially on slow filesystems. If not set, the value of
861 `transfer.unpackLimit` is used instead.
863 format.attach::
864 Enable multipart/mixed attachments as the default for
865 'format-patch'. The value can also be a double quoted string
866 which will enable attachments as the default and set the
867 value as the boundary. See the --attach option in
868 linkgit:git-format-patch[1].
870 format.numbered::
871 A boolean which can enable or disable sequence numbers in patch
872 subjects. It defaults to "auto" which enables it only if there
873 is more than one patch. It can be enabled or disabled for all
874 messages by setting it to "true" or "false". See --numbered
875 option in linkgit:git-format-patch[1].
877 format.headers::
878 Additional email headers to include in a patch to be submitted
879 by mail. See linkgit:git-format-patch[1].
881 format.cc::
882 Additional "Cc:" headers to include in a patch to be submitted
883 by mail. See the --cc option in linkgit:git-format-patch[1].
885 format.subjectprefix::
886 The default for format-patch is to output files with the '[PATCH]'
887 subject prefix. Use this variable to change that prefix.
889 format.suffix::
890 The default for format-patch is to output files with the suffix
891 `.patch`. Use this variable to change that suffix (make sure to
892 include the dot if you want it).
894 format.pretty::
895 The default pretty format for log/show/whatchanged command,
896 See linkgit:git-log[1], linkgit:git-show[1],
897 linkgit:git-whatchanged[1].
899 format.thread::
900 The default threading style for 'git format-patch'. Can be
901 a boolean value, or `shallow` or `deep`. `shallow` threading
902 makes every mail a reply to the head of the series,
903 where the head is chosen from the cover letter, the
904 `\--in-reply-to`, and the first patch mail, in this order.
905 `deep` threading makes every mail a reply to the previous one.
906 A true boolean value is the same as `shallow`, and a false
907 value disables threading.
909 format.signoff::
910 A boolean value which lets you enable the `-s/--signoff` option of
911 format-patch by default. *Note:* Adding the Signed-off-by: line to a
912 patch should be a conscious act and means that you certify you have
913 the rights to submit this work under the same open source license.
914 Please see the 'SubmittingPatches' document for further discussion.
916 gc.aggressiveWindow::
917 The window size parameter used in the delta compression
918 algorithm used by 'git gc --aggressive'. This defaults
919 to 250.
921 gc.auto::
922 When there are approximately more than this many loose
923 objects in the repository, `git gc --auto` will pack them.
924 Some Porcelain commands use this command to perform a
925 light-weight garbage collection from time to time. The
926 default value is 6700. Setting this to 0 disables it.
928 gc.autopacklimit::
929 When there are more than this many packs that are not
930 marked with `*.keep` file in the repository, `git gc
931 --auto` consolidates them into one larger pack. The
932 default value is 50. Setting this to 0 disables it.
934 gc.packrefs::
935 Running `git pack-refs` in a repository renders it
936 unclonable by Git versions prior to 1.5.1.2 over dumb
937 transports such as HTTP. This variable determines whether
938 'git gc' runs `git pack-refs`. This can be set to `nobare`
939 to enable it within all non-bare repos or it can be set to a
940 boolean value. The default is `true`.
942 gc.pruneexpire::
943 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
944 Override the grace period with this config variable. The value
945 "now" may be used to disable this grace period and always prune
946 unreachable objects immediately.
948 gc.reflogexpire::
949 'git reflog expire' removes reflog entries older than
950 this time; defaults to 90 days.
952 gc.reflogexpireunreachable::
953 'git reflog expire' removes reflog entries older than
954 this time and are not reachable from the current tip;
955 defaults to 30 days.
957 gc.rerereresolved::
958 Records of conflicted merge you resolved earlier are
959 kept for this many days when 'git rerere gc' is run.
960 The default is 60 days. See linkgit:git-rerere[1].
962 gc.rerereunresolved::
963 Records of conflicted merge you have not resolved are
964 kept for this many days when 'git rerere gc' is run.
965 The default is 15 days. See linkgit:git-rerere[1].
967 gitcvs.commitmsgannotation::
968 Append this string to each commit message. Set to empty string
969 to disable this feature. Defaults to "via git-CVS emulator".
971 gitcvs.enabled::
972 Whether the CVS server interface is enabled for this repository.
973 See linkgit:git-cvsserver[1].
975 gitcvs.logfile::
976 Path to a log file where the CVS server interface well... logs
977 various stuff. See linkgit:git-cvsserver[1].
979 gitcvs.usecrlfattr::
980 If true, the server will look up the `crlf` attribute for
981 files to determine the '-k' modes to use. If `crlf` is set,
982 the '-k' mode will be left blank, so cvs clients will
983 treat it as text. If `crlf` is explicitly unset, the file
984 will be set with '-kb' mode, which suppresses any newline munging
985 the client might otherwise do. If `crlf` is not specified,
986 then 'gitcvs.allbinary' is used. See linkgit:gitattributes[5].
988 gitcvs.allbinary::
989 This is used if 'gitcvs.usecrlfattr' does not resolve
990 the correct '-kb' mode to use. If true, all
991 unresolved files are sent to the client in
992 mode '-kb'. This causes the client to treat them
993 as binary files, which suppresses any newline munging it
994 otherwise might do. Alternatively, if it is set to "guess",
995 then the contents of the file are examined to decide if
996 it is binary, similar to 'core.autocrlf'.
998 gitcvs.dbname::
999 Database used by git-cvsserver to cache revision information
1000 derived from the git repository. The exact meaning depends on the
1001 used database driver, for SQLite (which is the default driver) this
1002 is a filename. Supports variable substitution (see
1003 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1004 Default: '%Ggitcvs.%m.sqlite'
1006 gitcvs.dbdriver::
1007 Used Perl DBI driver. You can specify any available driver
1008 for this here, but it might not work. git-cvsserver is tested
1009 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1010 reported *not* to work with 'DBD::mysql'. Experimental feature.
1011 May not contain double colons (`:`). Default: 'SQLite'.
1012 See linkgit:git-cvsserver[1].
1014 gitcvs.dbuser, gitcvs.dbpass::
1015 Database user and password. Only useful if setting 'gitcvs.dbdriver',
1016 since SQLite has no concept of database users and/or passwords.
1017 'gitcvs.dbuser' supports variable substitution (see
1018 linkgit:git-cvsserver[1] for details).
1020 gitcvs.dbTableNamePrefix::
1021 Database table name prefix. Prepended to the names of any
1022 database tables used, allowing a single database to be used
1023 for several repositories. Supports variable substitution (see
1024 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1025 characters will be replaced with underscores.
1027 All gitcvs variables except for 'gitcvs.usecrlfattr' and
1028 'gitcvs.allbinary' can also be specified as
1029 'gitcvs.<access_method>.<varname>' (where 'access_method'
1030 is one of "ext" and "pserver") to make them apply only for the given
1031 access method.
1033 gui.commitmsgwidth::
1034 Defines how wide the commit message window is in the
1035 linkgit:git-gui[1]. "75" is the default.
1037 gui.diffcontext::
1038 Specifies how many context lines should be used in calls to diff
1039 made by the linkgit:git-gui[1]. The default is "5".
1041 gui.encoding::
1042 Specifies the default encoding to use for displaying of
1043 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1044 It can be overridden by setting the 'encoding' attribute
1045 for relevant files (see linkgit:gitattributes[5]).
1046 If this option is not set, the tools default to the
1047 locale encoding.
1049 gui.matchtrackingbranch::
1050 Determines if new branches created with linkgit:git-gui[1] should
1051 default to tracking remote branches with matching names or
1052 not. Default: "false".
1054 gui.newbranchtemplate::
1055 Is used as suggested name when creating new branches using the
1056 linkgit:git-gui[1].
1058 gui.pruneduringfetch::
1059 "true" if linkgit:git-gui[1] should prune tracking branches when
1060 performing a fetch. The default value is "false".
1062 gui.trustmtime::
1063 Determines if linkgit:git-gui[1] should trust the file modification
1064 timestamp or not. By default the timestamps are not trusted.
1066 gui.spellingdictionary::
1067 Specifies the dictionary used for spell checking commit messages in
1068 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1069 off.
1071 gui.fastcopyblame::
1072 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1073 location detection. It makes blame significantly faster on huge
1074 repositories at the expense of less thorough copy detection.
1076 gui.copyblamethreshold::
1077 Specifies the threshold to use in 'git gui blame' original location
1078 detection, measured in alphanumeric characters. See the
1079 linkgit:git-blame[1] manual for more information on copy detection.
1081 gui.blamehistoryctx::
1082 Specifies the radius of history context in days to show in
1083 linkgit:gitk[1] for the selected commit, when the `Show History
1084 Context` menu item is invoked from 'git gui blame'. If this
1085 variable is set to zero, the whole history is shown.
1087 guitool.<name>.cmd::
1088 Specifies the shell command line to execute when the corresponding item
1089 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1090 mandatory for every tool. The command is executed from the root of
1091 the working directory, and in the environment it receives the name of
1092 the tool as 'GIT_GUITOOL', the name of the currently selected file as
1093 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1094 the head is detached, 'CUR_BRANCH' is empty).
1096 guitool.<name>.needsfile::
1097 Run the tool only if a diff is selected in the GUI. It guarantees
1098 that 'FILENAME' is not empty.
1100 guitool.<name>.noconsole::
1101 Run the command silently, without creating a window to display its
1102 output.
1104 guitool.<name>.norescan::
1105 Don't rescan the working directory for changes after the tool
1106 finishes execution.
1108 guitool.<name>.confirm::
1109 Show a confirmation dialog before actually running the tool.
1111 guitool.<name>.argprompt::
1112 Request a string argument from the user, and pass it to the tool
1113 through the 'ARGS' environment variable. Since requesting an
1114 argument implies confirmation, the 'confirm' option has no effect
1115 if this is enabled. If the option is set to 'true', 'yes', or '1',
1116 the dialog uses a built-in generic prompt; otherwise the exact
1117 value of the variable is used.
1119 guitool.<name>.revprompt::
1120 Request a single valid revision from the user, and set the
1121 'REVISION' environment variable. In other aspects this option
1122 is similar to 'argprompt', and can be used together with it.
1124 guitool.<name>.revunmerged::
1125 Show only unmerged branches in the 'revprompt' subdialog.
1126 This is useful for tools similar to merge or rebase, but not
1127 for things like checkout or reset.
1129 guitool.<name>.title::
1130 Specifies the title to use for the prompt dialog. The default
1131 is the tool name.
1133 guitool.<name>.prompt::
1134 Specifies the general prompt string to display at the top of
1135 the dialog, before subsections for 'argprompt' and 'revprompt'.
1136 The default value includes the actual command.
1138 help.browser::
1139 Specify the browser that will be used to display help in the
1140 'web' format. See linkgit:git-help[1].
1142 help.format::
1143 Override the default help format used by linkgit:git-help[1].
1144 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1145 the default. 'web' and 'html' are the same.
1147 help.autocorrect::
1148 Automatically correct and execute mistyped commands after
1149 waiting for the given number of deciseconds (0.1 sec). If more
1150 than one command can be deduced from the entered text, nothing
1151 will be executed. If the value of this option is negative,
1152 the corrected command will be executed immediately. If the
1153 value is 0 - the command will be just shown but not executed.
1154 This is the default.
1156 http.proxy::
1157 Override the HTTP proxy, normally configured using the 'http_proxy'
1158 environment variable (see linkgit:curl[1]). This can be overridden
1159 on a per-remote basis; see remote.<name>.proxy
1161 http.sslVerify::
1162 Whether to verify the SSL certificate when fetching or pushing
1163 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1164 variable.
1166 http.sslCert::
1167 File containing the SSL certificate when fetching or pushing
1168 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1169 variable.
1171 http.sslKey::
1172 File containing the SSL private key when fetching or pushing
1173 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1174 variable.
1176 http.sslCertPasswordProtected::
1177 Enable git's password prompt for the SSL certificate. Otherwise
1178 OpenSSL will prompt the user, possibly many times, if the
1179 certificate or private key is encrypted. Can be overridden by the
1180 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1182 http.sslCAInfo::
1183 File containing the certificates to verify the peer with when
1184 fetching or pushing over HTTPS. Can be overridden by the
1185 'GIT_SSL_CAINFO' environment variable.
1187 http.sslCAPath::
1188 Path containing files with the CA certificates to verify the peer
1189 with when fetching or pushing over HTTPS. Can be overridden
1190 by the 'GIT_SSL_CAPATH' environment variable.
1192 http.maxRequests::
1193 How many HTTP requests to launch in parallel. Can be overridden
1194 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1196 http.minSessions::
1197 The number of curl sessions (counted across slots) to be kept across
1198 requests. They will not be ended with curl_easy_cleanup() until
1199 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1200 value will be capped at 1. Defaults to 1.
1202 http.postBuffer::
1203 Maximum size in bytes of the buffer used by smart HTTP
1204 transports when POSTing data to the remote system.
1205 For requests larger than this buffer size, HTTP/1.1 and
1206 Transfer-Encoding: chunked is used to avoid creating a
1207 massive pack file locally. Default is 1 MiB, which is
1208 sufficient for most requests.
1210 http.lowSpeedLimit, http.lowSpeedTime::
1211 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1212 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1213 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1214 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1216 http.noEPSV::
1217 A boolean which disables using of EPSV ftp command by curl.
1218 This can helpful with some "poor" ftp servers which don't
1219 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1220 environment variable. Default is false (curl will use EPSV).
1222 i18n.commitEncoding::
1223 Character encoding the commit messages are stored in; git itself
1224 does not care per se, but this information is necessary e.g. when
1225 importing commits from emails or in the gitk graphical history
1226 browser (and possibly at other places in the future or in other
1227 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1229 i18n.logOutputEncoding::
1230 Character encoding the commit messages are converted to when
1231 running 'git log' and friends.
1233 imap::
1234 The configuration variables in the 'imap' section are described
1235 in linkgit:git-imap-send[1].
1237 init.templatedir::
1238 Specify the directory from which templates will be copied.
1239 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1241 instaweb.browser::
1242 Specify the program that will be used to browse your working
1243 repository in gitweb. See linkgit:git-instaweb[1].
1245 instaweb.httpd::
1246 The HTTP daemon command-line to start gitweb on your working
1247 repository. See linkgit:git-instaweb[1].
1249 instaweb.local::
1250 If true the web server started by linkgit:git-instaweb[1] will
1251 be bound to the local IP (127.0.0.1).
1253 instaweb.modulepath::
1254 The module path for an apache httpd used by linkgit:git-instaweb[1].
1256 instaweb.port::
1257 The port number to bind the gitweb httpd to. See
1258 linkgit:git-instaweb[1].
1260 interactive.singlekey::
1261 In interactive commands, allow the user to provide one-letter
1262 input with a single key (i.e., without hitting enter).
1263 Currently this is used only by the `\--patch` mode of
1264 linkgit:git-add[1]. Note that this setting is silently
1265 ignored if portable keystroke input is not available.
1267 log.date::
1268 Set default date-time mode for the log command. Setting log.date
1269 value is similar to using 'git log'\'s --date option. The value is one of the
1270 following alternatives: {relative,local,default,iso,rfc,short}.
1271 See linkgit:git-log[1].
1273 log.showroot::
1274 If true, the initial commit will be shown as a big creation event.
1275 This is equivalent to a diff against an empty tree.
1276 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1277 normally hide the root commit will now show it. True by default.
1279 mailmap.file::
1280 The location of an augmenting mailmap file. The default
1281 mailmap, located in the root of the repository, is loaded
1282 first, then the mailmap file pointed to by this variable.
1283 The location of the mailmap file may be in a repository
1284 subdirectory, or somewhere outside of the repository itself.
1285 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1287 man.viewer::
1288 Specify the programs that may be used to display help in the
1289 'man' format. See linkgit:git-help[1].
1291 man.<tool>.cmd::
1292 Specify the command to invoke the specified man viewer. The
1293 specified command is evaluated in shell with the man page
1294 passed as argument. (See linkgit:git-help[1].)
1296 man.<tool>.path::
1297 Override the path for the given tool that may be used to
1298 display help in the 'man' format. See linkgit:git-help[1].
1300 include::merge-config.txt[]
1302 mergetool.<tool>.path::
1303 Override the path for the given tool. This is useful in case
1304 your tool is not in the PATH.
1306 mergetool.<tool>.cmd::
1307 Specify the command to invoke the specified merge tool. The
1308 specified command is evaluated in shell with the following
1309 variables available: 'BASE' is the name of a temporary file
1310 containing the common base of the files to be merged, if available;
1311 'LOCAL' is the name of a temporary file containing the contents of
1312 the file on the current branch; 'REMOTE' is the name of a temporary
1313 file containing the contents of the file from the branch being
1314 merged; 'MERGED' contains the name of the file to which the merge
1315 tool should write the results of a successful merge.
1317 mergetool.<tool>.trustExitCode::
1318 For a custom merge command, specify whether the exit code of
1319 the merge command can be used to determine whether the merge was
1320 successful. If this is not set to true then the merge target file
1321 timestamp is checked and the merge assumed to have been successful
1322 if the file has been updated, otherwise the user is prompted to
1323 indicate the success of the merge.
1325 mergetool.keepBackup::
1326 After performing a merge, the original file with conflict markers
1327 can be saved as a file with a `.orig` extension. If this variable
1328 is set to `false` then this file is not preserved. Defaults to
1329 `true` (i.e. keep the backup files).
1331 mergetool.keepTemporaries::
1332 When invoking a custom merge tool, git uses a set of temporary
1333 files to pass to the tool. If the tool returns an error and this
1334 variable is set to `true`, then these temporary files will be
1335 preserved, otherwise they will be removed after the tool has
1336 exited. Defaults to `false`.
1338 mergetool.prompt::
1339 Prompt before each invocation of the merge resolution program.
1341 notes.displayRef::
1342 The (fully qualified) refname from which to show notes when
1343 showing commit messages. The value of this variable can be set
1344 to a glob, in which case notes from all matching refs will be
1345 shown. You may also specify this configuration variable
1346 several times. A warning will be issued for refs that do not
1347 exist, but a glob that does not match any refs is silently
1348 ignored.
1349 +
1350 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1351 environment variable, which must be a colon separated list of refs or
1352 globs.
1353 +
1354 The effective value of "core.notesRef" (possibly overridden by
1355 GIT_NOTES_REF) is also implicitly added to the list of refs to be
1356 displayed.
1358 notes.rewrite.<command>::
1359 When rewriting commits with <command> (currently `amend` or
1360 `rebase`) and this variable is set to `true`, git
1361 automatically copies your notes from the original to the
1362 rewritten commit. Defaults to `true`, but see
1363 "notes.rewriteRef" below.
1365 notes.rewriteMode::
1366 When copying notes during a rewrite (see the
1367 "notes.rewrite.<command>" option), determines what to do if
1368 the target commit already has a note. Must be one of
1369 `overwrite`, `concatenate`, or `ignore`. Defaults to
1370 `concatenate`.
1371 +
1372 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1373 environment variable.
1375 notes.rewriteRef::
1376 When copying notes during a rewrite, specifies the (fully
1377 qualified) ref whose notes should be copied. The ref may be a
1378 glob, in which case notes in all matching refs will be copied.
1379 You may also specify this configuration several times.
1380 +
1381 Does not have a default value; you must configure this variable to
1382 enable note rewriting.
1383 +
1384 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1385 environment variable, which must be a colon separated list of refs or
1386 globs.
1388 pack.window::
1389 The size of the window used by linkgit:git-pack-objects[1] when no
1390 window size is given on the command line. Defaults to 10.
1392 pack.depth::
1393 The maximum delta depth used by linkgit:git-pack-objects[1] when no
1394 maximum depth is given on the command line. Defaults to 50.
1396 pack.windowMemory::
1397 The window memory size limit used by linkgit:git-pack-objects[1]
1398 when no limit is given on the command line. The value can be
1399 suffixed with "k", "m", or "g". Defaults to 0, meaning no
1400 limit.
1402 pack.compression::
1403 An integer -1..9, indicating the compression level for objects
1404 in a pack file. -1 is the zlib default. 0 means no
1405 compression, and 1..9 are various speed/size tradeoffs, 9 being
1406 slowest. If not set, defaults to core.compression. If that is
1407 not set, defaults to -1, the zlib default, which is "a default
1408 compromise between speed and compression (currently equivalent
1409 to level 6)."
1411 pack.deltaCacheSize::
1412 The maximum memory in bytes used for caching deltas in
1413 linkgit:git-pack-objects[1] before writing them out to a pack.
1414 This cache is used to speed up the writing object phase by not
1415 having to recompute the final delta result once the best match
1416 for all objects is found. Repacking large repositories on machines
1417 which are tight with memory might be badly impacted by this though,
1418 especially if this cache pushes the system into swapping.
1419 A value of 0 means no limit. The smallest size of 1 byte may be
1420 used to virtually disable this cache. Defaults to 256 MiB.
1422 pack.deltaCacheLimit::
1423 The maximum size of a delta, that is cached in
1424 linkgit:git-pack-objects[1]. This cache is used to speed up the
1425 writing object phase by not having to recompute the final delta
1426 result once the best match for all objects is found. Defaults to 1000.
1428 pack.threads::
1429 Specifies the number of threads to spawn when searching for best
1430 delta matches. This requires that linkgit:git-pack-objects[1]
1431 be compiled with pthreads otherwise this option is ignored with a
1432 warning. This is meant to reduce packing time on multiprocessor
1433 machines. The required amount of memory for the delta search window
1434 is however multiplied by the number of threads.
1435 Specifying 0 will cause git to auto-detect the number of CPU's
1436 and set the number of threads accordingly.
1438 pack.indexVersion::
1439 Specify the default pack index version. Valid values are 1 for
1440 legacy pack index used by Git versions prior to 1.5.2, and 2 for
1441 the new pack index with capabilities for packs larger than 4 GB
1442 as well as proper protection against the repacking of corrupted
1443 packs. Version 2 is the default. Note that version 2 is enforced
1444 and this config option ignored whenever the corresponding pack is
1445 larger than 2 GB.
1446 +
1447 If you have an old git that does not understand the version 2 `{asterisk}.idx` file,
1448 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1449 that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the
1450 other side may give you a repository that cannot be accessed with your
1451 older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,
1452 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1453 the `{asterisk}.idx` file.
1455 pack.packSizeLimit::
1456 The maximum size of a pack. This setting only affects
1457 packing to a file when repacking, i.e. the git:// protocol
1458 is unaffected. It can be overridden by the `\--max-pack-size`
1459 option of linkgit:git-repack[1]. The minimum size allowed is
1460 limited to 1 MiB. The default is unlimited.
1461 Common unit suffixes of 'k', 'm', or 'g' are
1462 supported.
1464 pager.<cmd>::
1465 Allows turning on or off pagination of the output of a
1466 particular git subcommand when writing to a tty. If
1467 `\--paginate` or `\--no-pager` is specified on the command line,
1468 it takes precedence over this option. To disable pagination for
1469 all commands, set `core.pager` or `GIT_PAGER` to `cat`.
1471 pull.octopus::
1472 The default merge strategy to use when pulling multiple branches
1473 at once.
1475 pull.twohead::
1476 The default merge strategy to use when pulling a single branch.
1478 push.default::
1479 Defines the action git push should take if no refspec is given
1480 on the command line, no refspec is configured in the remote, and
1481 no refspec is implied by any of the options given on the command
1482 line. Possible values are:
1483 +
1484 * `nothing` do not push anything.
1485 * `matching` push all matching branches.
1486 All branches having the same name in both ends are considered to be
1487 matching. This is the default.
1488 * `tracking` push the current branch to its upstream branch.
1489 * `current` push the current branch to a branch of the same name.
1491 rebase.stat::
1492 Whether to show a diffstat of what changed upstream since the last
1493 rebase. False by default.
1495 receive.autogc::
1496 By default, git-receive-pack will run "git-gc --auto" after
1497 receiving data from git-push and updating refs. You can stop
1498 it by setting this variable to false.
1500 receive.fsckObjects::
1501 If it is set to true, git-receive-pack will check all received
1502 objects. It will abort in the case of a malformed object or a
1503 broken link. The result of an abort are only dangling objects.
1504 Defaults to false.
1506 receive.unpackLimit::
1507 If the number of objects received in a push is below this
1508 limit then the objects will be unpacked into loose object
1509 files. However if the number of received objects equals or
1510 exceeds this limit then the received pack will be stored as
1511 a pack, after adding any missing delta bases. Storing the
1512 pack from a push can make the push operation complete faster,
1513 especially on slow filesystems. If not set, the value of
1514 `transfer.unpackLimit` is used instead.
1516 receive.denyDeletes::
1517 If set to true, git-receive-pack will deny a ref update that deletes
1518 the ref. Use this to prevent such a ref deletion via a push.
1520 receive.denyCurrentBranch::
1521 If set to true or "refuse", receive-pack will deny a ref update
1522 to the currently checked out branch of a non-bare repository.
1523 Such a push is potentially dangerous because it brings the HEAD
1524 out of sync with the index and working tree. If set to "warn",
1525 print a warning of such a push to stderr, but allow the push to
1526 proceed. If set to false or "ignore", allow such pushes with no
1527 message. Defaults to "refuse".
1529 receive.denyNonFastForwards::
1530 If set to true, git-receive-pack will deny a ref update which is
1531 not a fast-forward. Use this to prevent such an update via a push,
1532 even if that push is forced. This configuration variable is
1533 set when initializing a shared repository.
1535 receive.updateserverinfo::
1536 If set to true, git-receive-pack will run git-update-server-info
1537 after receiving data from git-push and updating refs.
1539 remote.<name>.url::
1540 The URL of a remote repository. See linkgit:git-fetch[1] or
1541 linkgit:git-push[1].
1543 remote.<name>.pushurl::
1544 The push URL of a remote repository. See linkgit:git-push[1].
1546 remote.<name>.proxy::
1547 For remotes that require curl (http, https and ftp), the URL to
1548 the proxy to use for that remote. Set to the empty string to
1549 disable proxying for that remote.
1551 remote.<name>.fetch::
1552 The default set of "refspec" for linkgit:git-fetch[1]. See
1553 linkgit:git-fetch[1].
1555 remote.<name>.push::
1556 The default set of "refspec" for linkgit:git-push[1]. See
1557 linkgit:git-push[1].
1559 remote.<name>.mirror::
1560 If true, pushing to this remote will automatically behave
1561 as if the `\--mirror` option was given on the command line.
1563 remote.<name>.skipDefaultUpdate::
1564 If true, this remote will be skipped by default when updating
1565 using linkgit:git-fetch[1] or the `update` subcommand of
1566 linkgit:git-remote[1].
1568 remote.<name>.skipFetchAll::
1569 If true, this remote will be skipped by default when updating
1570 using linkgit:git-fetch[1] or the `update` subcommand of
1571 linkgit:git-remote[1].
1573 remote.<name>.receivepack::
1574 The default program to execute on the remote side when pushing. See
1575 option \--receive-pack of linkgit:git-push[1].
1577 remote.<name>.uploadpack::
1578 The default program to execute on the remote side when fetching. See
1579 option \--upload-pack of linkgit:git-fetch-pack[1].
1581 remote.<name>.tagopt::
1582 Setting this value to \--no-tags disables automatic tag following when
1583 fetching from remote <name>
1585 remote.<name>.vcs::
1586 Setting this to a value <vcs> will cause git to interact with
1587 the remote with the git-remote-<vcs> helper.
1589 remotes.<group>::
1590 The list of remotes which are fetched by "git remote update
1591 <group>". See linkgit:git-remote[1].
1593 repack.usedeltabaseoffset::
1594 By default, linkgit:git-repack[1] creates packs that use
1595 delta-base offset. If you need to share your repository with
1596 git older than version 1.4.4, either directly or via a dumb
1597 protocol such as http, then you need to set this option to
1598 "false" and repack. Access from old git versions over the
1599 native protocol are unaffected by this option.
1601 rerere.autoupdate::
1602 When set to true, `git-rerere` updates the index with the
1603 resulting contents after it cleanly resolves conflicts using
1604 previously recorded resolution. Defaults to false.
1606 rerere.enabled::
1607 Activate recording of resolved conflicts, so that identical
1608 conflict hunks can be resolved automatically, should they
1609 be encountered again. linkgit:git-rerere[1] command is by
1610 default enabled if you create `rr-cache` directory under
1611 `$GIT_DIR`, but can be disabled by setting this option to false.
1613 sendemail.identity::
1614 A configuration identity. When given, causes values in the
1615 'sendemail.<identity>' subsection to take precedence over
1616 values in the 'sendemail' section. The default identity is
1617 the value of 'sendemail.identity'.
1619 sendemail.smtpencryption::
1620 See linkgit:git-send-email[1] for description. Note that this
1621 setting is not subject to the 'identity' mechanism.
1623 sendemail.smtpssl::
1624 Deprecated alias for 'sendemail.smtpencryption = ssl'.
1626 sendemail.<identity>.*::
1627 Identity-specific versions of the 'sendemail.*' parameters
1628 found below, taking precedence over those when the this
1629 identity is selected, through command-line or
1630 'sendemail.identity'.
1632 sendemail.aliasesfile::
1633 sendemail.aliasfiletype::
1634 sendemail.bcc::
1635 sendemail.cc::
1636 sendemail.cccmd::
1637 sendemail.chainreplyto::
1638 sendemail.confirm::
1639 sendemail.envelopesender::
1640 sendemail.from::
1641 sendemail.multiedit::
1642 sendemail.signedoffbycc::
1643 sendemail.smtppass::
1644 sendemail.suppresscc::
1645 sendemail.suppressfrom::
1646 sendemail.to::
1647 sendemail.smtpserver::
1648 sendemail.smtpserverport::
1649 sendemail.smtpuser::
1650 sendemail.thread::
1651 sendemail.validate::
1652 See linkgit:git-send-email[1] for description.
1654 sendemail.signedoffcc::
1655 Deprecated alias for 'sendemail.signedoffbycc'.
1657 showbranch.default::
1658 The default set of branches for linkgit:git-show-branch[1].
1659 See linkgit:git-show-branch[1].
1661 status.relativePaths::
1662 By default, linkgit:git-status[1] shows paths relative to the
1663 current directory. Setting this variable to `false` shows paths
1664 relative to the repository root (this was the default for git
1665 prior to v1.5.4).
1667 status.showUntrackedFiles::
1668 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1669 files which are not currently tracked by Git. Directories which
1670 contain only untracked files, are shown with the directory name
1671 only. Showing untracked files means that Git needs to lstat() all
1672 all the files in the whole repository, which might be slow on some
1673 systems. So, this variable controls how the commands displays
1674 the untracked files. Possible values are:
1675 +
1676 --
1677 - 'no' - Show no untracked files
1678 - 'normal' - Shows untracked files and directories
1679 - 'all' - Shows also individual files in untracked directories.
1680 --
1681 +
1682 If this variable is not specified, it defaults to 'normal'.
1683 This variable can be overridden with the -u|--untracked-files option
1684 of linkgit:git-status[1] and linkgit:git-commit[1].
1686 tar.umask::
1687 This variable can be used to restrict the permission bits of
1688 tar archive entries. The default is 0002, which turns off the
1689 world write bit. The special value "user" indicates that the
1690 archiving user's umask will be used instead. See umask(2) and
1691 linkgit:git-archive[1].
1693 transfer.unpackLimit::
1694 When `fetch.unpackLimit` or `receive.unpackLimit` are
1695 not set, the value of this variable is used instead.
1696 The default value is 100.
1698 url.<base>.insteadOf::
1699 Any URL that starts with this value will be rewritten to
1700 start, instead, with <base>. In cases where some site serves a
1701 large number of repositories, and serves them with multiple
1702 access methods, and some users need to use different access
1703 methods, this feature allows people to specify any of the
1704 equivalent URLs and have git automatically rewrite the URL to
1705 the best alternative for the particular user, even for a
1706 never-before-seen repository on the site. When more than one
1707 insteadOf strings match a given URL, the longest match is used.
1709 url.<base>.pushInsteadOf::
1710 Any URL that starts with this value will not be pushed to;
1711 instead, it will be rewritten to start with <base>, and the
1712 resulting URL will be pushed to. In cases where some site serves
1713 a large number of repositories, and serves them with multiple
1714 access methods, some of which do not allow push, this feature
1715 allows people to specify a pull-only URL and have git
1716 automatically use an appropriate URL to push, even for a
1717 never-before-seen repository on the site. When more than one
1718 pushInsteadOf strings match a given URL, the longest match is
1719 used. If a remote has an explicit pushurl, git will ignore this
1720 setting for that remote.
1722 user.email::
1723 Your email address to be recorded in any newly created commits.
1724 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
1725 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
1727 user.name::
1728 Your full name to be recorded in any newly created commits.
1729 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
1730 environment variables. See linkgit:git-commit-tree[1].
1732 user.signingkey::
1733 If linkgit:git-tag[1] is not selecting the key you want it to
1734 automatically when creating a signed tag, you can override the
1735 default selection with this variable. This option is passed
1736 unchanged to gpg's --local-user parameter, so you may specify a key
1737 using any method that gpg supports.
1739 web.browser::
1740 Specify a web browser that may be used by some commands.
1741 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
1742 may use it.