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 * `blank-at-eof` treats blank lines added at the end of file as an error
485 (enabled by default).
486 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
487 `blank-at-eof`.
488 * `cr-at-eol` treats a carriage-return at the end of line as
489 part of the line terminator, i.e. with it, `trailing-space`
490 does not trigger if the character before such a carriage-return
491 is not a whitespace (not enabled by default).
493 core.fsyncobjectfiles::
494 This boolean will enable 'fsync()' when writing object files.
495 +
496 This is a total waste of time and effort on a filesystem that orders
497 data writes properly, but can be useful for filesystems that do not use
498 journalling (traditional UNIX filesystems) or that only journal metadata
499 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
501 core.preloadindex::
502 Enable parallel index preload for operations like 'git diff'
503 +
504 This can speed up operations like 'git diff' and 'git status' especially
505 on filesystems like NFS that have weak caching semantics and thus
506 relatively high IO latencies. With this set to 'true', git will do the
507 index comparison to the filesystem data in parallel, allowing
508 overlapping IO's.
510 core.createObject::
511 You can set this to 'link', in which case a hardlink followed by
512 a delete of the source are used to make sure that object creation
513 will not overwrite existing objects.
514 +
515 On some file system/operating system combinations, this is unreliable.
516 Set this config setting to 'rename' there; However, This will remove the
517 check that makes sure that existing object files will not get overwritten.
519 core.notesRef::
520 When showing commit messages, also show notes which are stored in
521 the given ref. This ref is expected to contain files named
522 after the full SHA-1 of the commit they annotate.
523 +
524 If such a file exists in the given ref, the referenced blob is read, and
525 appended to the commit message, separated by a "Notes:" line. If the
526 given ref itself does not exist, it is not an error, but means that no
527 notes should be printed.
528 +
529 This setting defaults to "refs/notes/commits", and can be overridden by
530 the `GIT_NOTES_REF` environment variable.
532 core.sparseCheckout::
533 Enable "sparse checkout" feature. See section "Sparse checkout" in
534 linkgit:git-read-tree[1] for more information.
536 add.ignore-errors::
537 add.ignoreErrors::
538 Tells 'git add' to continue adding files when some files cannot be
539 added due to indexing errors. Equivalent to the '--ignore-errors'
540 option of linkgit:git-add[1]. Older versions of git accept only
541 `add.ignore-errors`, which does not follow the usual naming
542 convention for configuration variables. Newer versions of git
543 honor `add.ignoreErrors` as well.
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 apply.ignorewhitespace::
563 When set to 'change', tells 'git apply' to ignore changes in
564 whitespace, in the same way as the '--ignore-space-change'
565 option.
566 When set to one of: no, none, never, false tells 'git apply' to
567 respect all whitespace differences.
568 See linkgit:git-apply[1].
570 apply.whitespace::
571 Tells 'git apply' how to handle whitespaces, in the same way
572 as the '--whitespace' option. See linkgit:git-apply[1].
574 branch.autosetupmerge::
575 Tells 'git branch' and 'git checkout' to set up new branches
576 so that linkgit:git-pull[1] will appropriately merge from the
577 starting point branch. Note that even if this option is not set,
578 this behavior can be chosen per-branch using the `--track`
579 and `--no-track` options. The valid settings are: `false` -- no
580 automatic setup is done; `true` -- automatic setup is done when the
581 starting point is a remote branch; `always` -- automatic setup is
582 done when the starting point is either a local branch or remote
583 branch. This option defaults to true.
585 branch.autosetuprebase::
586 When a new branch is created with 'git branch' or 'git checkout'
587 that tracks another branch, this variable tells git to set
588 up pull to rebase instead of merge (see "branch.<name>.rebase").
589 When `never`, rebase is never automatically set to true.
590 When `local`, rebase is set to true for tracked branches of
591 other local branches.
592 When `remote`, rebase is set to true for tracked branches of
593 remote branches.
594 When `always`, rebase will be set to true for all tracking
595 branches.
596 See "branch.autosetupmerge" for details on how to set up a
597 branch to track another branch.
598 This option defaults to never.
600 branch.<name>.remote::
601 When in branch <name>, it tells 'git fetch' and 'git push' which
602 remote to fetch from/push to. It defaults to `origin` if no remote is
603 configured. `origin` is also used if you are not on any branch.
605 branch.<name>.merge::
606 Defines, together with branch.<name>.remote, the upstream branch
607 for the given branch. It tells 'git fetch'/'git pull' which
608 branch to merge and can also affect 'git push' (see push.default).
609 When in branch <name>, it tells 'git fetch' the default
610 refspec to be marked for merging in FETCH_HEAD. The value is
611 handled like the remote part of a refspec, and must match a
612 ref which is fetched from the remote given by
613 "branch.<name>.remote".
614 The merge information is used by 'git pull' (which at first calls
615 'git fetch') to lookup the default branch for merging. Without
616 this option, 'git pull' defaults to merge the first refspec fetched.
617 Specify multiple values to get an octopus merge.
618 If you wish to setup 'git pull' so that it merges into <name> from
619 another branch in the local repository, you can point
620 branch.<name>.merge to the desired branch, and use the special setting
621 `.` (a period) for branch.<name>.remote.
623 branch.<name>.mergeoptions::
624 Sets default options for merging into branch <name>. The syntax and
625 supported options are the same as those of linkgit:git-merge[1], but
626 option values containing whitespace characters are currently not
627 supported.
629 branch.<name>.rebase::
630 When true, rebase the branch <name> on top of the fetched branch,
631 instead of merging the default branch from the default remote when
632 "git pull" is run.
633 *NOTE*: this is a possibly dangerous operation; do *not* use
634 it unless you understand the implications (see linkgit:git-rebase[1]
635 for details).
637 browser.<tool>.cmd::
638 Specify the command to invoke the specified browser. The
639 specified command is evaluated in shell with the URLs passed
640 as arguments. (See linkgit:git-web--browse[1].)
642 browser.<tool>.path::
643 Override the path for the given tool that may be used to
644 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
645 working repository in gitweb (see linkgit:git-instaweb[1]).
647 clean.requireForce::
648 A boolean to make git-clean do nothing unless given -f
649 or -n. Defaults to true.
651 color.branch::
652 A boolean to enable/disable color in the output of
653 linkgit:git-branch[1]. May be set to `always`,
654 `false` (or `never`) or `auto` (or `true`), in which case colors are used
655 only when the output is to a terminal. Defaults to false.
657 color.branch.<slot>::
658 Use customized color for branch coloration. `<slot>` is one of
659 `current` (the current branch), `local` (a local branch),
660 `remote` (a tracking branch in refs/remotes/), `plain` (other
661 refs).
662 +
663 The value for these configuration variables is a list of colors (at most
664 two) and attributes (at most one), separated by spaces. The colors
665 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
666 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
667 `blink` and `reverse`. The first color given is the foreground; the
668 second is the background. The position of the attribute, if any,
669 doesn't matter.
671 color.diff::
672 When set to `always`, always use colors in patch.
673 When false (or `never`), never. When set to `true` or `auto`, use
674 colors only when the output is to the terminal. Defaults to false.
676 color.diff.<slot>::
677 Use customized color for diff colorization. `<slot>` specifies
678 which part of the patch to use the specified color, and is one
679 of `plain` (context text), `meta` (metainformation), `frag`
680 (hunk header), 'func' (function in hunk header), `old` (removed lines),
681 `new` (added lines), `commit` (commit headers), or `whitespace`
682 (highlighting whitespace errors). The values of these variables may be
683 specified as in color.branch.<slot>.
685 color.grep::
686 When set to `always`, always highlight matches. When `false` (or
687 `never`), never. When set to `true` or `auto`, use color only
688 when the output is written to the terminal. Defaults to `false`.
690 color.grep.match::
691 Use customized color for matches. The value of this variable
692 may be specified as in color.branch.<slot>.
694 color.interactive::
695 When set to `always`, always use colors for interactive prompts
696 and displays (such as those used by "git-add --interactive").
697 When false (or `never`), never. When set to `true` or `auto`, use
698 colors only when the output is to the terminal. Defaults to false.
700 color.interactive.<slot>::
701 Use customized color for 'git add --interactive'
702 output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
703 four distinct types of normal output from interactive
704 commands. The values of these variables may be specified as
705 in color.branch.<slot>.
707 color.pager::
708 A boolean to enable/disable colored output when the pager is in
709 use (default is true).
711 color.showbranch::
712 A boolean to enable/disable color in the output of
713 linkgit:git-show-branch[1]. May be set to `always`,
714 `false` (or `never`) or `auto` (or `true`), in which case colors are used
715 only when the output is to a terminal. Defaults to false.
717 color.status::
718 A boolean to enable/disable color in the output of
719 linkgit:git-status[1]. May be set to `always`,
720 `false` (or `never`) or `auto` (or `true`), in which case colors are used
721 only when the output is to a terminal. Defaults to false.
723 color.status.<slot>::
724 Use customized color for status colorization. `<slot>` is
725 one of `header` (the header text of the status message),
726 `added` or `updated` (files which are added but not committed),
727 `changed` (files which are changed but not added in the index),
728 `untracked` (files which are not tracked by git), or
729 `nobranch` (the color the 'no branch' warning is shown in, defaulting
730 to red). The values of these variables may be specified as in
731 color.branch.<slot>.
733 color.ui::
734 When set to `always`, always use colors in all git commands which
735 are capable of colored output. When false (or `never`), never. When
736 set to `true` or `auto`, use colors only when the output is to the
737 terminal. When more specific variables of color.* are set, they always
738 take precedence over this setting. Defaults to false.
740 commit.status::
741 A boolean to enable/disable inclusion of status information in the
742 commit message template when using an editor to prepare the commit
743 message. Defaults to true.
745 commit.template::
746 Specify a file to use as the template for new commit messages.
747 "{tilde}/" is expanded to the value of `$HOME` and "{tilde}user/" to the
748 specified user's home directory.
750 diff.autorefreshindex::
751 When using 'git diff' to compare with work tree
752 files, do not consider stat-only change as changed.
753 Instead, silently run `git update-index --refresh` to
754 update the cached stat information for paths whose
755 contents in the work tree match the contents in the
756 index. This option defaults to true. Note that this
757 affects only 'git diff' Porcelain, and not lower level
758 'diff' commands such as 'git diff-files'.
760 diff.external::
761 If this config variable is set, diff generation is not
762 performed using the internal diff machinery, but using the
763 given command. Can be overridden with the `GIT_EXTERNAL_DIFF'
764 environment variable. The command is called with parameters
765 as described under "git Diffs" in linkgit:git[1]. Note: if
766 you want to use an external diff program only on a subset of
767 your files, you might want to use linkgit:gitattributes[5] instead.
769 diff.mnemonicprefix::
770 If set, 'git diff' uses a prefix pair that is different from the
771 standard "a/" and "b/" depending on what is being compared. When
772 this configuration is in effect, reverse diff output also swaps
773 the order of the prefixes:
774 `git diff`;;
775 compares the (i)ndex and the (w)ork tree;
776 `git diff HEAD`;;
777 compares a (c)ommit and the (w)ork tree;
778 `git diff --cached`;;
779 compares a (c)ommit and the (i)ndex;
780 `git diff HEAD:file1 file2`;;
781 compares an (o)bject and a (w)ork tree entity;
782 `git diff --no-index a b`;;
783 compares two non-git things (1) and (2).
785 diff.renameLimit::
786 The number of files to consider when performing the copy/rename
787 detection; equivalent to the 'git diff' option '-l'.
789 diff.renames::
790 Tells git to detect renames. If set to any boolean value, it
791 will enable basic rename detection. If set to "copies" or
792 "copy", it will detect copies, as well.
794 diff.suppressBlankEmpty::
795 A boolean to inhibit the standard behavior of printing a space
796 before each empty output line. Defaults to false.
798 diff.tool::
799 Controls which diff tool is used. `diff.tool` overrides
800 `merge.tool` when used by linkgit:git-difftool[1] and has
801 the same valid values as `merge.tool` minus "tortoisemerge"
802 and plus "kompare".
804 difftool.<tool>.path::
805 Override the path for the given tool. This is useful in case
806 your tool is not in the PATH.
808 difftool.<tool>.cmd::
809 Specify the command to invoke the specified diff tool.
810 The specified command is evaluated in shell with the following
811 variables available: 'LOCAL' is set to the name of the temporary
812 file containing the contents of the diff pre-image and 'REMOTE'
813 is set to the name of the temporary file containing the contents
814 of the diff post-image.
816 difftool.prompt::
817 Prompt before each invocation of the diff tool.
819 diff.wordRegex::
820 A POSIX Extended Regular Expression used to determine what is a "word"
821 when performing word-by-word difference calculations. Character
822 sequences that match the regular expression are "words", all other
823 characters are *ignorable* whitespace.
825 fetch.unpackLimit::
826 If the number of objects fetched over the git native
827 transfer is below this
828 limit, then the objects will be unpacked into loose object
829 files. However if the number of received objects equals or
830 exceeds this limit then the received pack will be stored as
831 a pack, after adding any missing delta bases. Storing the
832 pack from a push can make the push operation complete faster,
833 especially on slow filesystems. If not set, the value of
834 `transfer.unpackLimit` is used instead.
836 format.attach::
837 Enable multipart/mixed attachments as the default for
838 'format-patch'. The value can also be a double quoted string
839 which will enable attachments as the default and set the
840 value as the boundary. See the --attach option in
841 linkgit:git-format-patch[1].
843 format.numbered::
844 A boolean which can enable or disable sequence numbers in patch
845 subjects. It defaults to "auto" which enables it only if there
846 is more than one patch. It can be enabled or disabled for all
847 messages by setting it to "true" or "false". See --numbered
848 option in linkgit:git-format-patch[1].
850 format.headers::
851 Additional email headers to include in a patch to be submitted
852 by mail. See linkgit:git-format-patch[1].
854 format.cc::
855 Additional "Cc:" headers to include in a patch to be submitted
856 by mail. See the --cc option in linkgit:git-format-patch[1].
858 format.subjectprefix::
859 The default for format-patch is to output files with the '[PATCH]'
860 subject prefix. Use this variable to change that prefix.
862 format.suffix::
863 The default for format-patch is to output files with the suffix
864 `.patch`. Use this variable to change that suffix (make sure to
865 include the dot if you want it).
867 format.pretty::
868 The default pretty format for log/show/whatchanged command,
869 See linkgit:git-log[1], linkgit:git-show[1],
870 linkgit:git-whatchanged[1].
872 format.thread::
873 The default threading style for 'git format-patch'. Can be
874 a boolean value, or `shallow` or `deep`. `shallow` threading
875 makes every mail a reply to the head of the series,
876 where the head is chosen from the cover letter, the
877 `\--in-reply-to`, and the first patch mail, in this order.
878 `deep` threading makes every mail a reply to the previous one.
879 A true boolean value is the same as `shallow`, and a false
880 value disables threading.
882 format.signoff::
883 A boolean value which lets you enable the `-s/--signoff` option of
884 format-patch by default. *Note:* Adding the Signed-off-by: line to a
885 patch should be a conscious act and means that you certify you have
886 the rights to submit this work under the same open source license.
887 Please see the 'SubmittingPatches' document for further discussion.
889 gc.aggressiveWindow::
890 The window size parameter used in the delta compression
891 algorithm used by 'git gc --aggressive'. This defaults
892 to 250.
894 gc.auto::
895 When there are approximately more than this many loose
896 objects in the repository, `git gc --auto` will pack them.
897 Some Porcelain commands use this command to perform a
898 light-weight garbage collection from time to time. The
899 default value is 6700. Setting this to 0 disables it.
901 gc.autopacklimit::
902 When there are more than this many packs that are not
903 marked with `*.keep` file in the repository, `git gc
904 --auto` consolidates them into one larger pack. The
905 default value is 50. Setting this to 0 disables it.
907 gc.packrefs::
908 Running `git pack-refs` in a repository renders it
909 unclonable by Git versions prior to 1.5.1.2 over dumb
910 transports such as HTTP. This variable determines whether
911 'git gc' runs `git pack-refs`. This can be set to `nobare`
912 to enable it within all non-bare repos or it can be set to a
913 boolean value. The default is `true`.
915 gc.pruneexpire::
916 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
917 Override the grace period with this config variable. The value
918 "now" may be used to disable this grace period and always prune
919 unreachable objects immediately.
921 gc.reflogexpire::
922 'git reflog expire' removes reflog entries older than
923 this time; defaults to 90 days.
925 gc.reflogexpireunreachable::
926 'git reflog expire' removes reflog entries older than
927 this time and are not reachable from the current tip;
928 defaults to 30 days.
930 gc.rerereresolved::
931 Records of conflicted merge you resolved earlier are
932 kept for this many days when 'git rerere gc' is run.
933 The default is 60 days. See linkgit:git-rerere[1].
935 gc.rerereunresolved::
936 Records of conflicted merge you have not resolved are
937 kept for this many days when 'git rerere gc' is run.
938 The default is 15 days. See linkgit:git-rerere[1].
940 gitcvs.commitmsgannotation::
941 Append this string to each commit message. Set to empty string
942 to disable this feature. Defaults to "via git-CVS emulator".
944 gitcvs.enabled::
945 Whether the CVS server interface is enabled for this repository.
946 See linkgit:git-cvsserver[1].
948 gitcvs.logfile::
949 Path to a log file where the CVS server interface well... logs
950 various stuff. See linkgit:git-cvsserver[1].
952 gitcvs.usecrlfattr::
953 If true, the server will look up the `crlf` attribute for
954 files to determine the '-k' modes to use. If `crlf` is set,
955 the '-k' mode will be left blank, so cvs clients will
956 treat it as text. If `crlf` is explicitly unset, the file
957 will be set with '-kb' mode, which suppresses any newline munging
958 the client might otherwise do. If `crlf` is not specified,
959 then 'gitcvs.allbinary' is used. See linkgit:gitattributes[5].
961 gitcvs.allbinary::
962 This is used if 'gitcvs.usecrlfattr' does not resolve
963 the correct '-kb' mode to use. If true, all
964 unresolved files are sent to the client in
965 mode '-kb'. This causes the client to treat them
966 as binary files, which suppresses any newline munging it
967 otherwise might do. Alternatively, if it is set to "guess",
968 then the contents of the file are examined to decide if
969 it is binary, similar to 'core.autocrlf'.
971 gitcvs.dbname::
972 Database used by git-cvsserver to cache revision information
973 derived from the git repository. The exact meaning depends on the
974 used database driver, for SQLite (which is the default driver) this
975 is a filename. Supports variable substitution (see
976 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
977 Default: '%Ggitcvs.%m.sqlite'
979 gitcvs.dbdriver::
980 Used Perl DBI driver. You can specify any available driver
981 for this here, but it might not work. git-cvsserver is tested
982 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
983 reported *not* to work with 'DBD::mysql'. Experimental feature.
984 May not contain double colons (`:`). Default: 'SQLite'.
985 See linkgit:git-cvsserver[1].
987 gitcvs.dbuser, gitcvs.dbpass::
988 Database user and password. Only useful if setting 'gitcvs.dbdriver',
989 since SQLite has no concept of database users and/or passwords.
990 'gitcvs.dbuser' supports variable substitution (see
991 linkgit:git-cvsserver[1] for details).
993 gitcvs.dbTableNamePrefix::
994 Database table name prefix. Prepended to the names of any
995 database tables used, allowing a single database to be used
996 for several repositories. Supports variable substitution (see
997 linkgit:git-cvsserver[1] for details). Any non-alphabetic
998 characters will be replaced with underscores.
1000 All gitcvs variables except for 'gitcvs.usecrlfattr' and
1001 'gitcvs.allbinary' can also be specified as
1002 'gitcvs.<access_method>.<varname>' (where 'access_method'
1003 is one of "ext" and "pserver") to make them apply only for the given
1004 access method.
1006 gui.commitmsgwidth::
1007 Defines how wide the commit message window is in the
1008 linkgit:git-gui[1]. "75" is the default.
1010 gui.diffcontext::
1011 Specifies how many context lines should be used in calls to diff
1012 made by the linkgit:git-gui[1]. The default is "5".
1014 gui.encoding::
1015 Specifies the default encoding to use for displaying of
1016 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1017 It can be overridden by setting the 'encoding' attribute
1018 for relevant files (see linkgit:gitattributes[5]).
1019 If this option is not set, the tools default to the
1020 locale encoding.
1022 gui.matchtrackingbranch::
1023 Determines if new branches created with linkgit:git-gui[1] should
1024 default to tracking remote branches with matching names or
1025 not. Default: "false".
1027 gui.newbranchtemplate::
1028 Is used as suggested name when creating new branches using the
1029 linkgit:git-gui[1].
1031 gui.pruneduringfetch::
1032 "true" if linkgit:git-gui[1] should prune tracking branches when
1033 performing a fetch. The default value is "false".
1035 gui.trustmtime::
1036 Determines if linkgit:git-gui[1] should trust the file modification
1037 timestamp or not. By default the timestamps are not trusted.
1039 gui.spellingdictionary::
1040 Specifies the dictionary used for spell checking commit messages in
1041 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1042 off.
1044 gui.fastcopyblame::
1045 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1046 location detection. It makes blame significantly faster on huge
1047 repositories at the expense of less thorough copy detection.
1049 gui.copyblamethreshold::
1050 Specifies the threshold to use in 'git gui blame' original location
1051 detection, measured in alphanumeric characters. See the
1052 linkgit:git-blame[1] manual for more information on copy detection.
1054 gui.blamehistoryctx::
1055 Specifies the radius of history context in days to show in
1056 linkgit:gitk[1] for the selected commit, when the `Show History
1057 Context` menu item is invoked from 'git gui blame'. If this
1058 variable is set to zero, the whole history is shown.
1060 guitool.<name>.cmd::
1061 Specifies the shell command line to execute when the corresponding item
1062 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1063 mandatory for every tool. The command is executed from the root of
1064 the working directory, and in the environment it receives the name of
1065 the tool as 'GIT_GUITOOL', the name of the currently selected file as
1066 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1067 the head is detached, 'CUR_BRANCH' is empty).
1069 guitool.<name>.needsfile::
1070 Run the tool only if a diff is selected in the GUI. It guarantees
1071 that 'FILENAME' is not empty.
1073 guitool.<name>.noconsole::
1074 Run the command silently, without creating a window to display its
1075 output.
1077 guitool.<name>.norescan::
1078 Don't rescan the working directory for changes after the tool
1079 finishes execution.
1081 guitool.<name>.confirm::
1082 Show a confirmation dialog before actually running the tool.
1084 guitool.<name>.argprompt::
1085 Request a string argument from the user, and pass it to the tool
1086 through the 'ARGS' environment variable. Since requesting an
1087 argument implies confirmation, the 'confirm' option has no effect
1088 if this is enabled. If the option is set to 'true', 'yes', or '1',
1089 the dialog uses a built-in generic prompt; otherwise the exact
1090 value of the variable is used.
1092 guitool.<name>.revprompt::
1093 Request a single valid revision from the user, and set the
1094 'REVISION' environment variable. In other aspects this option
1095 is similar to 'argprompt', and can be used together with it.
1097 guitool.<name>.revunmerged::
1098 Show only unmerged branches in the 'revprompt' subdialog.
1099 This is useful for tools similar to merge or rebase, but not
1100 for things like checkout or reset.
1102 guitool.<name>.title::
1103 Specifies the title to use for the prompt dialog. The default
1104 is the tool name.
1106 guitool.<name>.prompt::
1107 Specifies the general prompt string to display at the top of
1108 the dialog, before subsections for 'argprompt' and 'revprompt'.
1109 The default value includes the actual command.
1111 help.browser::
1112 Specify the browser that will be used to display help in the
1113 'web' format. See linkgit:git-help[1].
1115 help.format::
1116 Override the default help format used by linkgit:git-help[1].
1117 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1118 the default. 'web' and 'html' are the same.
1120 help.autocorrect::
1121 Automatically correct and execute mistyped commands after
1122 waiting for the given number of deciseconds (0.1 sec). If more
1123 than one command can be deduced from the entered text, nothing
1124 will be executed. If the value of this option is negative,
1125 the corrected command will be executed immediately. If the
1126 value is 0 - the command will be just shown but not executed.
1127 This is the default.
1129 http.proxy::
1130 Override the HTTP proxy, normally configured using the 'http_proxy'
1131 environment variable (see linkgit:curl[1]). This can be overridden
1132 on a per-remote basis; see remote.<name>.proxy
1134 http.sslVerify::
1135 Whether to verify the SSL certificate when fetching or pushing
1136 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1137 variable.
1139 http.sslCert::
1140 File containing the SSL certificate when fetching or pushing
1141 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1142 variable.
1144 http.sslKey::
1145 File containing the SSL private key when fetching or pushing
1146 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1147 variable.
1149 http.sslCertPasswordProtected::
1150 Enable git's password prompt for the SSL certificate. Otherwise
1151 OpenSSL will prompt the user, possibly many times, if the
1152 certificate or private key is encrypted. Can be overridden by the
1153 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1155 http.sslCAInfo::
1156 File containing the certificates to verify the peer with when
1157 fetching or pushing over HTTPS. Can be overridden by the
1158 'GIT_SSL_CAINFO' environment variable.
1160 http.sslCAPath::
1161 Path containing files with the CA certificates to verify the peer
1162 with when fetching or pushing over HTTPS. Can be overridden
1163 by the 'GIT_SSL_CAPATH' environment variable.
1165 http.maxRequests::
1166 How many HTTP requests to launch in parallel. Can be overridden
1167 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1169 http.minSessions::
1170 The number of curl sessions (counted across slots) to be kept across
1171 requests. They will not be ended with curl_easy_cleanup() until
1172 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1173 value will be capped at 1. Defaults to 1.
1175 http.postBuffer::
1176 Maximum size in bytes of the buffer used by smart HTTP
1177 transports when POSTing data to the remote system.
1178 For requests larger than this buffer size, HTTP/1.1 and
1179 Transfer-Encoding: chunked is used to avoid creating a
1180 massive pack file locally. Default is 1 MiB, which is
1181 sufficient for most requests.
1183 http.lowSpeedLimit, http.lowSpeedTime::
1184 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1185 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1186 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1187 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1189 http.noEPSV::
1190 A boolean which disables using of EPSV ftp command by curl.
1191 This can helpful with some "poor" ftp servers which don't
1192 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1193 environment variable. Default is false (curl will use EPSV).
1195 i18n.commitEncoding::
1196 Character encoding the commit messages are stored in; git itself
1197 does not care per se, but this information is necessary e.g. when
1198 importing commits from emails or in the gitk graphical history
1199 browser (and possibly at other places in the future or in other
1200 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1202 i18n.logOutputEncoding::
1203 Character encoding the commit messages are converted to when
1204 running 'git log' and friends.
1206 imap::
1207 The configuration variables in the 'imap' section are described
1208 in linkgit:git-imap-send[1].
1210 instaweb.browser::
1211 Specify the program that will be used to browse your working
1212 repository in gitweb. See linkgit:git-instaweb[1].
1214 instaweb.httpd::
1215 The HTTP daemon command-line to start gitweb on your working
1216 repository. See linkgit:git-instaweb[1].
1218 instaweb.local::
1219 If true the web server started by linkgit:git-instaweb[1] will
1220 be bound to the local IP (127.0.0.1).
1222 instaweb.modulepath::
1223 The module path for an apache httpd used by linkgit:git-instaweb[1].
1225 instaweb.port::
1226 The port number to bind the gitweb httpd to. See
1227 linkgit:git-instaweb[1].
1229 interactive.singlekey::
1230 In interactive commands, allow the user to provide one-letter
1231 input with a single key (i.e., without hitting enter).
1232 Currently this is used only by the `\--patch` mode of
1233 linkgit:git-add[1]. Note that this setting is silently
1234 ignored if portable keystroke input is not available.
1236 log.date::
1237 Set default date-time mode for the log command. Setting log.date
1238 value is similar to using 'git log'\'s --date option. The value is one of the
1239 following alternatives: {relative,local,default,iso,rfc,short}.
1240 See linkgit:git-log[1].
1242 log.showroot::
1243 If true, the initial commit will be shown as a big creation event.
1244 This is equivalent to a diff against an empty tree.
1245 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1246 normally hide the root commit will now show it. True by default.
1248 mailmap.file::
1249 The location of an augmenting mailmap file. The default
1250 mailmap, located in the root of the repository, is loaded
1251 first, then the mailmap file pointed to by this variable.
1252 The location of the mailmap file may be in a repository
1253 subdirectory, or somewhere outside of the repository itself.
1254 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1256 man.viewer::
1257 Specify the programs that may be used to display help in the
1258 'man' format. See linkgit:git-help[1].
1260 man.<tool>.cmd::
1261 Specify the command to invoke the specified man viewer. The
1262 specified command is evaluated in shell with the man page
1263 passed as argument. (See linkgit:git-help[1].)
1265 man.<tool>.path::
1266 Override the path for the given tool that may be used to
1267 display help in the 'man' format. See linkgit:git-help[1].
1269 include::merge-config.txt[]
1271 mergetool.<tool>.path::
1272 Override the path for the given tool. This is useful in case
1273 your tool is not in the PATH.
1275 mergetool.<tool>.cmd::
1276 Specify the command to invoke the specified merge tool. The
1277 specified command is evaluated in shell with the following
1278 variables available: 'BASE' is the name of a temporary file
1279 containing the common base of the files to be merged, if available;
1280 'LOCAL' is the name of a temporary file containing the contents of
1281 the file on the current branch; 'REMOTE' is the name of a temporary
1282 file containing the contents of the file from the branch being
1283 merged; 'MERGED' contains the name of the file to which the merge
1284 tool should write the results of a successful merge.
1286 mergetool.<tool>.trustExitCode::
1287 For a custom merge command, specify whether the exit code of
1288 the merge command can be used to determine whether the merge was
1289 successful. If this is not set to true then the merge target file
1290 timestamp is checked and the merge assumed to have been successful
1291 if the file has been updated, otherwise the user is prompted to
1292 indicate the success of the merge.
1294 mergetool.keepBackup::
1295 After performing a merge, the original file with conflict markers
1296 can be saved as a file with a `.orig` extension. If this variable
1297 is set to `false` then this file is not preserved. Defaults to
1298 `true` (i.e. keep the backup files).
1300 mergetool.keepTemporaries::
1301 When invoking a custom merge tool, git uses a set of temporary
1302 files to pass to the tool. If the tool returns an error and this
1303 variable is set to `true`, then these temporary files will be
1304 preserved, otherwise they will be removed after the tool has
1305 exited. Defaults to `false`.
1307 mergetool.prompt::
1308 Prompt before each invocation of the merge resolution program.
1310 pack.window::
1311 The size of the window used by linkgit:git-pack-objects[1] when no
1312 window size is given on the command line. Defaults to 10.
1314 pack.depth::
1315 The maximum delta depth used by linkgit:git-pack-objects[1] when no
1316 maximum depth is given on the command line. Defaults to 50.
1318 pack.windowMemory::
1319 The window memory size limit used by linkgit:git-pack-objects[1]
1320 when no limit is given on the command line. The value can be
1321 suffixed with "k", "m", or "g". Defaults to 0, meaning no
1322 limit.
1324 pack.compression::
1325 An integer -1..9, indicating the compression level for objects
1326 in a pack file. -1 is the zlib default. 0 means no
1327 compression, and 1..9 are various speed/size tradeoffs, 9 being
1328 slowest. If not set, defaults to core.compression. If that is
1329 not set, defaults to -1, the zlib default, which is "a default
1330 compromise between speed and compression (currently equivalent
1331 to level 6)."
1333 pack.deltaCacheSize::
1334 The maximum memory in bytes used for caching deltas in
1335 linkgit:git-pack-objects[1] before writing them out to a pack.
1336 This cache is used to speed up the writing object phase by not
1337 having to recompute the final delta result once the best match
1338 for all objects is found. Repacking large repositories on machines
1339 which are tight with memory might be badly impacted by this though,
1340 especially if this cache pushes the system into swapping.
1341 A value of 0 means no limit. The smallest size of 1 byte may be
1342 used to virtually disable this cache. Defaults to 256 MiB.
1344 pack.deltaCacheLimit::
1345 The maximum size of a delta, that is cached in
1346 linkgit:git-pack-objects[1]. This cache is used to speed up the
1347 writing object phase by not having to recompute the final delta
1348 result once the best match for all objects is found. Defaults to 1000.
1350 pack.threads::
1351 Specifies the number of threads to spawn when searching for best
1352 delta matches. This requires that linkgit:git-pack-objects[1]
1353 be compiled with pthreads otherwise this option is ignored with a
1354 warning. This is meant to reduce packing time on multiprocessor
1355 machines. The required amount of memory for the delta search window
1356 is however multiplied by the number of threads.
1357 Specifying 0 will cause git to auto-detect the number of CPU's
1358 and set the number of threads accordingly.
1360 pack.indexVersion::
1361 Specify the default pack index version. Valid values are 1 for
1362 legacy pack index used by Git versions prior to 1.5.2, and 2 for
1363 the new pack index with capabilities for packs larger than 4 GB
1364 as well as proper protection against the repacking of corrupted
1365 packs. Version 2 is the default. Note that version 2 is enforced
1366 and this config option ignored whenever the corresponding pack is
1367 larger than 2 GB.
1368 +
1369 If you have an old git that does not understand the version 2 `{asterisk}.idx` file,
1370 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1371 that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the
1372 other side may give you a repository that cannot be accessed with your
1373 older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,
1374 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1375 the `{asterisk}.idx` file.
1377 pack.packSizeLimit::
1378 The maximum size of a pack. This setting only affects
1379 packing to a file when repacking, i.e. the git:// protocol
1380 is unaffected. It can be overridden by the `\--max-pack-size`
1381 option of linkgit:git-repack[1]. The minimum size allowed is
1382 limited to 1 MiB. The default is unlimited.
1383 Common unit suffixes of 'k', 'm', or 'g' are
1384 supported.
1386 pager.<cmd>::
1387 Allows turning on or off pagination of the output of a
1388 particular git subcommand when writing to a tty. If
1389 `\--paginate` or `\--no-pager` is specified on the command line,
1390 it takes precedence over this option. To disable pagination for
1391 all commands, set `core.pager` or `GIT_PAGER` to `cat`.
1393 pull.octopus::
1394 The default merge strategy to use when pulling multiple branches
1395 at once.
1397 pull.twohead::
1398 The default merge strategy to use when pulling a single branch.
1400 push.default::
1401 Defines the action git push should take if no refspec is given
1402 on the command line, no refspec is configured in the remote, and
1403 no refspec is implied by any of the options given on the command
1404 line. Possible values are:
1405 +
1406 * `nothing` do not push anything.
1407 * `matching` push all matching branches.
1408 All branches having the same name in both ends are considered to be
1409 matching. This is the default.
1410 * `tracking` push the current branch to its upstream branch.
1411 * `current` push the current branch to a branch of the same name.
1413 rebase.stat::
1414 Whether to show a diffstat of what changed upstream since the last
1415 rebase. False by default.
1417 receive.autogc::
1418 By default, git-receive-pack will run "git-gc --auto" after
1419 receiving data from git-push and updating refs. You can stop
1420 it by setting this variable to false.
1422 receive.fsckObjects::
1423 If it is set to true, git-receive-pack will check all received
1424 objects. It will abort in the case of a malformed object or a
1425 broken link. The result of an abort are only dangling objects.
1426 Defaults to false.
1428 receive.unpackLimit::
1429 If the number of objects received in a push is below this
1430 limit then the objects will be unpacked into loose object
1431 files. However if the number of received objects equals or
1432 exceeds this limit then the received pack will be stored as
1433 a pack, after adding any missing delta bases. Storing the
1434 pack from a push can make the push operation complete faster,
1435 especially on slow filesystems. If not set, the value of
1436 `transfer.unpackLimit` is used instead.
1438 receive.denyDeletes::
1439 If set to true, git-receive-pack will deny a ref update that deletes
1440 the ref. Use this to prevent such a ref deletion via a push.
1442 receive.denyCurrentBranch::
1443 If set to true or "refuse", receive-pack will deny a ref update
1444 to the currently checked out branch of a non-bare repository.
1445 Such a push is potentially dangerous because it brings the HEAD
1446 out of sync with the index and working tree. If set to "warn",
1447 print a warning of such a push to stderr, but allow the push to
1448 proceed. If set to false or "ignore", allow such pushes with no
1449 message. Defaults to "refuse".
1451 receive.denyNonFastForwards::
1452 If set to true, git-receive-pack will deny a ref update which is
1453 not a fast-forward. Use this to prevent such an update via a push,
1454 even if that push is forced. This configuration variable is
1455 set when initializing a shared repository.
1457 receive.updateserverinfo::
1458 If set to true, git-receive-pack will run git-update-server-info
1459 after receiving data from git-push and updating refs.
1461 remote.<name>.url::
1462 The URL of a remote repository. See linkgit:git-fetch[1] or
1463 linkgit:git-push[1].
1465 remote.<name>.pushurl::
1466 The push URL of a remote repository. See linkgit:git-push[1].
1468 remote.<name>.proxy::
1469 For remotes that require curl (http, https and ftp), the URL to
1470 the proxy to use for that remote. Set to the empty string to
1471 disable proxying for that remote.
1473 remote.<name>.fetch::
1474 The default set of "refspec" for linkgit:git-fetch[1]. See
1475 linkgit:git-fetch[1].
1477 remote.<name>.push::
1478 The default set of "refspec" for linkgit:git-push[1]. See
1479 linkgit:git-push[1].
1481 remote.<name>.mirror::
1482 If true, pushing to this remote will automatically behave
1483 as if the `\--mirror` option was given on the command line.
1485 remote.<name>.skipDefaultUpdate::
1486 If true, this remote will be skipped by default when updating
1487 using linkgit:git-fetch[1] or the `update` subcommand of
1488 linkgit:git-remote[1].
1490 remote.<name>.skipFetchAll::
1491 If true, this remote will be skipped by default when updating
1492 using linkgit:git-fetch[1] or the `update` subcommand of
1493 linkgit:git-remote[1].
1495 remote.<name>.receivepack::
1496 The default program to execute on the remote side when pushing. See
1497 option \--receive-pack of linkgit:git-push[1].
1499 remote.<name>.uploadpack::
1500 The default program to execute on the remote side when fetching. See
1501 option \--upload-pack of linkgit:git-fetch-pack[1].
1503 remote.<name>.tagopt::
1504 Setting this value to \--no-tags disables automatic tag following when
1505 fetching from remote <name>
1507 remote.<name>.vcs::
1508 Setting this to a value <vcs> will cause git to interact with
1509 the remote with the git-remote-<vcs> helper.
1511 remotes.<group>::
1512 The list of remotes which are fetched by "git remote update
1513 <group>". See linkgit:git-remote[1].
1515 repack.usedeltabaseoffset::
1516 By default, linkgit:git-repack[1] creates packs that use
1517 delta-base offset. If you need to share your repository with
1518 git older than version 1.4.4, either directly or via a dumb
1519 protocol such as http, then you need to set this option to
1520 "false" and repack. Access from old git versions over the
1521 native protocol are unaffected by this option.
1523 rerere.autoupdate::
1524 When set to true, `git-rerere` updates the index with the
1525 resulting contents after it cleanly resolves conflicts using
1526 previously recorded resolution. Defaults to false.
1528 rerere.enabled::
1529 Activate recording of resolved conflicts, so that identical
1530 conflict hunks can be resolved automatically, should they
1531 be encountered again. linkgit:git-rerere[1] command is by
1532 default enabled if you create `rr-cache` directory under
1533 `$GIT_DIR`, but can be disabled by setting this option to false.
1535 sendemail.identity::
1536 A configuration identity. When given, causes values in the
1537 'sendemail.<identity>' subsection to take precedence over
1538 values in the 'sendemail' section. The default identity is
1539 the value of 'sendemail.identity'.
1541 sendemail.smtpencryption::
1542 See linkgit:git-send-email[1] for description. Note that this
1543 setting is not subject to the 'identity' mechanism.
1545 sendemail.smtpssl::
1546 Deprecated alias for 'sendemail.smtpencryption = ssl'.
1548 sendemail.<identity>.*::
1549 Identity-specific versions of the 'sendemail.*' parameters
1550 found below, taking precedence over those when the this
1551 identity is selected, through command-line or
1552 'sendemail.identity'.
1554 sendemail.aliasesfile::
1555 sendemail.aliasfiletype::
1556 sendemail.bcc::
1557 sendemail.cc::
1558 sendemail.cccmd::
1559 sendemail.chainreplyto::
1560 sendemail.confirm::
1561 sendemail.envelopesender::
1562 sendemail.from::
1563 sendemail.multiedit::
1564 sendemail.signedoffbycc::
1565 sendemail.smtppass::
1566 sendemail.suppresscc::
1567 sendemail.suppressfrom::
1568 sendemail.to::
1569 sendemail.smtpserver::
1570 sendemail.smtpserverport::
1571 sendemail.smtpuser::
1572 sendemail.thread::
1573 sendemail.validate::
1574 See linkgit:git-send-email[1] for description.
1576 sendemail.signedoffcc::
1577 Deprecated alias for 'sendemail.signedoffbycc'.
1579 showbranch.default::
1580 The default set of branches for linkgit:git-show-branch[1].
1581 See linkgit:git-show-branch[1].
1583 status.relativePaths::
1584 By default, linkgit:git-status[1] shows paths relative to the
1585 current directory. Setting this variable to `false` shows paths
1586 relative to the repository root (this was the default for git
1587 prior to v1.5.4).
1589 status.showUntrackedFiles::
1590 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1591 files which are not currently tracked by Git. Directories which
1592 contain only untracked files, are shown with the directory name
1593 only. Showing untracked files means that Git needs to lstat() all
1594 all the files in the whole repository, which might be slow on some
1595 systems. So, this variable controls how the commands displays
1596 the untracked files. Possible values are:
1597 +
1598 --
1599 - 'no' - Show no untracked files
1600 - 'normal' - Shows untracked files and directories
1601 - 'all' - Shows also individual files in untracked directories.
1602 --
1603 +
1604 If this variable is not specified, it defaults to 'normal'.
1605 This variable can be overridden with the -u|--untracked-files option
1606 of linkgit:git-status[1] and linkgit:git-commit[1].
1608 status.submodulesummary::
1609 Defaults to false.
1610 If this is set to a non zero number or true (identical to -1 or an
1611 unlimited number), the submodule summary will be enabled and a
1612 summary of commits for modified submodules will be shown (see
1613 --summary-limit option of linkgit:git-submodule[1]).
1615 tar.umask::
1616 This variable can be used to restrict the permission bits of
1617 tar archive entries. The default is 0002, which turns off the
1618 world write bit. The special value "user" indicates that the
1619 archiving user's umask will be used instead. See umask(2) and
1620 linkgit:git-archive[1].
1622 transfer.unpackLimit::
1623 When `fetch.unpackLimit` or `receive.unpackLimit` are
1624 not set, the value of this variable is used instead.
1625 The default value is 100.
1627 url.<base>.insteadOf::
1628 Any URL that starts with this value will be rewritten to
1629 start, instead, with <base>. In cases where some site serves a
1630 large number of repositories, and serves them with multiple
1631 access methods, and some users need to use different access
1632 methods, this feature allows people to specify any of the
1633 equivalent URLs and have git automatically rewrite the URL to
1634 the best alternative for the particular user, even for a
1635 never-before-seen repository on the site. When more than one
1636 insteadOf strings match a given URL, the longest match is used.
1638 url.<base>.pushInsteadOf::
1639 Any URL that starts with this value will not be pushed to;
1640 instead, it will be rewritten to start with <base>, and the
1641 resulting URL will be pushed to. In cases where some site serves
1642 a large number of repositories, and serves them with multiple
1643 access methods, some of which do not allow push, this feature
1644 allows people to specify a pull-only URL and have git
1645 automatically use an appropriate URL to push, even for a
1646 never-before-seen repository on the site. When more than one
1647 pushInsteadOf strings match a given URL, the longest match is
1648 used. If a remote has an explicit pushurl, git will ignore this
1649 setting for that remote.
1651 user.email::
1652 Your email address to be recorded in any newly created commits.
1653 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
1654 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
1656 user.name::
1657 Your full name to be recorded in any newly created commits.
1658 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
1659 environment variables. See linkgit:git-commit-tree[1].
1661 user.signingkey::
1662 If linkgit:git-tag[1] is not selecting the key you want it to
1663 automatically when creating a signed tag, you can override the
1664 default selection with this variable. This option is passed
1665 unchanged to gpg's --local-user parameter, so you may specify a key
1666 using any method that gpg supports.
1668 web.browser::
1669 Specify a web browser that may be used by some commands.
1670 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
1671 may use it.