Submodules: Add the new "ignore" config option for diff and status
[git/git.git] / Documentation / config.txt
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 ""
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.eol::
200 Sets the line ending type to use in the working directory for
201 files that have the `text` property set. Alternatives are
202 'lf', 'crlf' and 'native', which uses the platform's native
203 line ending. The default value is `native`. See
204 linkgit:gitattributes[5] for more information on end-of-line
205 conversion.
207 core.safecrlf::
208 If true, makes git check if converting `CRLF` is reversible when
209 end-of-line conversion is active. Git will verify if a command
210 modifies a file in the work tree either directly or indirectly.
211 For example, committing a file followed by checking out the
212 same file should yield the original file in the work tree. If
213 this is not the case for the current setting of
214 `core.autocrlf`, git will reject the file. The variable can
215 be set to "warn", in which case git will only warn about an
216 irreversible conversion but continue the operation.
217 +
218 CRLF conversion bears a slight chance of corrupting data.
219 When it is enabled, git will convert CRLF to LF during commit and LF to
220 CRLF during checkout. A file that contains a mixture of LF and
221 CRLF before the commit cannot be recreated by git. For text
222 files this is the right thing to do: it corrects line endings
223 such that we have only LF line endings in the repository.
224 But for binary files that are accidentally classified as text the
225 conversion can corrupt data.
226 +
227 If you recognize such corruption early you can easily fix it by
228 setting the conversion type explicitly in .gitattributes. Right
229 after committing you still have the original file in your work
230 tree and this file is not yet corrupted. You can explicitly tell
231 git that this file is binary and git will handle the file
232 appropriately.
233 +
234 Unfortunately, the desired effect of cleaning up text files with
235 mixed line endings and the undesired effect of corrupting binary
236 files cannot be distinguished. In both cases CRLFs are removed
237 in an irreversible way. For text files this is the right thing
238 to do because CRLFs are line endings, while for binary files
239 converting CRLFs corrupts data.
240 +
241 Note, this safety check does not mean that a checkout will generate a
242 file identical to the original file for a different setting of
243 `core.eol` and `core.autocrlf`, but only for the current one. For
244 example, a text file with `LF` would be accepted with `core.eol=lf`
245 and could later be checked out with `core.eol=crlf`, in which case the
246 resulting file would contain `CRLF`, although the original file
247 contained `LF`. However, in both work trees the line endings would be
248 consistent, that is either all `LF` or all `CRLF`, but never mixed. A
249 file with mixed line endings would be reported by the `core.safecrlf`
250 mechanism.
252 core.autocrlf::
253 Setting this variable to "true" is almost the same as setting
254 the `text` attribute to "auto" on all files except that text
255 files are not guaranteed to be normalized: files that contain
256 `CRLF` in the repository will not be touched. Use this
257 setting if you want to have `CRLF` line endings in your
258 working directory even though the repository does not have
259 normalized line endings. This variable can be set to 'input',
260 in which case no output conversion is performed.
262 core.symlinks::
263 If false, symbolic links are checked out as small plain files that
264 contain the link text. linkgit:git-update-index[1] and
265 linkgit:git-add[1] will not change the recorded type to regular
266 file. Useful on filesystems like FAT that do not support
267 symbolic links.
268 +
269 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
270 will probe and set core.symlinks false if appropriate when the repository
271 is created.
273 core.gitProxy::
274 A "proxy command" to execute (as 'command host port') instead
275 of establishing direct connection to the remote server when
276 using the git protocol for fetching. If the variable value is
277 in the "COMMAND for DOMAIN" format, the command is applied only
278 on hostnames ending with the specified domain string. This variable
279 may be set multiple times and is matched in the given order;
280 the first match wins.
281 +
282 Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
283 (which always applies universally, without the special "for"
284 handling).
285 +
286 The special string `none` can be used as the proxy command to
287 specify that no proxy be used for a given domain pattern.
288 This is useful for excluding servers inside a firewall from
289 proxy use, while defaulting to a common proxy for external domains.
291 core.ignoreStat::
292 If true, commands which modify both the working tree and the index
293 will mark the updated paths with the "assume unchanged" bit in the
294 index. These marked files are then assumed to stay unchanged in the
295 working copy, until you mark them otherwise manually - Git will not
296 detect the file changes by lstat() calls. This is useful on systems
297 where those are very slow, such as Microsoft Windows.
298 See linkgit:git-update-index[1].
299 False by default.
301 core.preferSymlinkRefs::
302 Instead of the default "symref" format for HEAD
303 and other symbolic reference files, use symbolic links.
304 This is sometimes needed to work with old scripts that
305 expect HEAD to be a symbolic link.
307 core.bare::
308 If true this repository is assumed to be 'bare' and has no
309 working directory associated with it. If this is the case a
310 number of commands that require a working directory will be
311 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
312 +
313 This setting is automatically guessed by linkgit:git-clone[1] or
314 linkgit:git-init[1] when the repository was created. By default a
315 repository that ends in "/.git" is assumed to be not bare (bare =
316 false), while all other repositories are assumed to be bare (bare
317 = true).
319 core.worktree::
320 Set the path to the root of the work tree.
321 This can be overridden by the GIT_WORK_TREE environment
322 variable and the '--work-tree' command line option. It can be
323 an absolute path or a relative path to the .git directory,
324 either specified by --git-dir or GIT_DIR, or automatically
325 discovered.
326 If --git-dir or GIT_DIR are specified but none of
327 --work-tree, GIT_WORK_TREE and core.worktree is specified,
328 the current working directory is regarded as the root of the
329 work tree.
330 +
331 Note that this variable is honored even when set in a configuration
332 file in a ".git" subdirectory of a directory, and its value differs
333 from the latter directory (e.g. "/path/to/.git/config" has
334 core.worktree set to "/different/path"), which is most likely a
335 misconfiguration. Running git commands in "/path/to" directory will
336 still use "/different/path" as the root of the work tree and can cause
337 great confusion to the users.
339 core.logAllRefUpdates::
340 Enable the reflog. Updates to a ref <ref> is logged to the file
341 "$GIT_DIR/logs/<ref>", by appending the new and old
342 SHA1, the date/time and the reason of the update, but
343 only when the file exists. If this configuration
344 variable is set to true, missing "$GIT_DIR/logs/<ref>"
345 file is automatically created for branch heads.
346 +
347 This information can be used to determine what commit
348 was the tip of a branch "2 days ago".
349 +
350 This value is true by default in a repository that has
351 a working directory associated with it, and false by
352 default in a bare repository.
354 core.repositoryFormatVersion::
355 Internal variable identifying the repository format and layout
356 version.
358 core.sharedRepository::
359 When 'group' (or 'true'), the repository is made shareable between
360 several users in a group (making sure all the files and objects are
361 group-writable). When 'all' (or 'world' or 'everybody'), the
362 repository will be readable by all users, additionally to being
363 group-shareable. When 'umask' (or 'false'), git will use permissions
364 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
365 files in the repository will have this mode value. '0xxx' will override
366 user's umask value (whereas the other options will only override
367 requested parts of the user's umask value). Examples: '0660' will make
368 the repo read/write-able for the owner and group, but inaccessible to
369 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
370 repository that is group-readable but not group-writable.
371 See linkgit:git-init[1]. False by default.
373 core.warnAmbiguousRefs::
374 If true, git will warn you if the ref name you passed it is ambiguous
375 and might match multiple refs in the .git/refs/ tree. True by default.
377 core.compression::
378 An integer -1..9, indicating a default compression level.
379 -1 is the zlib default. 0 means no compression,
380 and 1..9 are various speed/size tradeoffs, 9 being slowest.
381 If set, this provides a default to other compression variables,
382 such as 'core.loosecompression' and 'pack.compression'.
384 core.loosecompression::
385 An integer -1..9, indicating the compression level for objects that
386 are not in a pack file. -1 is the zlib default. 0 means no
387 compression, and 1..9 are various speed/size tradeoffs, 9 being
388 slowest. If not set, defaults to core.compression. If that is
389 not set, defaults to 1 (best speed).
391 core.packedGitWindowSize::
392 Number of bytes of a pack file to map into memory in a
393 single mapping operation. Larger window sizes may allow
394 your system to process a smaller number of large pack files
395 more quickly. Smaller window sizes will negatively affect
396 performance due to increased calls to the operating system's
397 memory manager, but may improve performance when accessing
398 a large number of large pack files.
399 +
400 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
401 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
402 be reasonable for all users/operating systems. You probably do
403 not need to adjust this value.
404 +
405 Common unit suffixes of 'k', 'm', or 'g' are supported.
407 core.packedGitLimit::
408 Maximum number of bytes to map simultaneously into memory
409 from pack files. If Git needs to access more than this many
410 bytes at once to complete an operation it will unmap existing
411 regions to reclaim virtual address space within the process.
412 +
413 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
414 This should be reasonable for all users/operating systems, except on
415 the largest projects. You probably do not need to adjust this value.
416 +
417 Common unit suffixes of 'k', 'm', or 'g' are supported.
419 core.deltaBaseCacheLimit::
420 Maximum number of bytes to reserve for caching base objects
421 that multiple deltafied objects reference. By storing the
422 entire decompressed base objects in a cache Git is able
423 to avoid unpacking and decompressing frequently used base
424 objects multiple times.
425 +
426 Default is 16 MiB on all platforms. This should be reasonable
427 for all users/operating systems, except on the largest projects.
428 You probably do not need to adjust this value.
429 +
430 Common unit suffixes of 'k', 'm', or 'g' are supported.
432 core.bigFileThreshold::
433 Files larger than this size are stored deflated, without
434 attempting delta compression. Storing large files without
435 delta compression avoids excessive memory usage, at the
436 slight expense of increased disk usage.
437 +
438 Default is 512 MiB on all platforms. This should be reasonable
439 for most projects as source code and other text files can still
440 be delta compressed, but larger binary media files won't be.
441 +
442 Common unit suffixes of 'k', 'm', or 'g' are supported.
443 +
444 Currently only linkgit:git-fast-import[1] honors this setting.
446 core.excludesfile::
447 In addition to '.gitignore' (per-directory) and
448 '.git/info/exclude', git looks into this file for patterns
449 of files which are not meant to be tracked. "{tilde}/" is expanded
450 to the value of `$HOME` and "{tilde}user/" to the specified user's
451 home directory. See linkgit:gitignore[5].
453 core.editor::
454 Commands such as `commit` and `tag` that lets you edit
455 messages by launching an editor uses the value of this
456 variable when it is set, and the environment variable
457 `GIT_EDITOR` is not set. See linkgit:git-var[1].
459 core.pager::
460 The command that git will use to paginate output. Can
461 be overridden with the `GIT_PAGER` environment
462 variable. Note that git sets the `LESS` environment
463 variable to `FRSX` if it is unset when it runs the
464 pager. One can change these settings by setting the
465 `LESS` variable to some other value. Alternately,
466 these settings can be overridden on a project or
467 global basis by setting the `core.pager` option.
468 Setting `core.pager` has no affect on the `LESS`
469 environment variable behaviour above, so if you want
470 to override git's default settings this way, you need
471 to be explicit. For example, to disable the S option
472 in a backward compatible manner, set `core.pager`
473 to `less -+$LESS -FRX`. This will be passed to the
474 shell by git, which will translate the final command to
475 `LESS=FRSX less -+FRSX -FRX`.
477 core.whitespace::
478 A comma separated list of common whitespace problems to
479 notice. 'git diff' will use `color.diff.whitespace` to
480 highlight them, and 'git apply --whitespace=error' will
481 consider them as errors. You can prefix `-` to disable
482 any of them (e.g. `-trailing-space`):
483 +
484 * `blank-at-eol` treats trailing whitespaces at the end of the line
485 as an error (enabled by default).
486 * `space-before-tab` treats a space character that appears immediately
487 before a tab character in the initial indent part of the line as an
488 error (enabled by default).
489 * `indent-with-non-tab` treats a line that is indented with 8 or more
490 space characters as an error (not enabled by default).
491 * `tab-in-indent` treats a tab character in the initial indent part of
492 the line as an error (not enabled by default).
493 * `blank-at-eof` treats blank lines added at the end of file as an error
494 (enabled by default).
495 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
496 `blank-at-eof`.
497 * `cr-at-eol` treats a carriage-return at the end of line as
498 part of the line terminator, i.e. with it, `trailing-space`
499 does not trigger if the character before such a carriage-return
500 is not a whitespace (not enabled by default).
502 core.fsyncobjectfiles::
503 This boolean will enable 'fsync()' when writing object files.
504 +
505 This is a total waste of time and effort on a filesystem that orders
506 data writes properly, but can be useful for filesystems that do not use
507 journalling (traditional UNIX filesystems) or that only journal metadata
508 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
510 core.preloadindex::
511 Enable parallel index preload for operations like 'git diff'
512 +
513 This can speed up operations like 'git diff' and 'git status' especially
514 on filesystems like NFS that have weak caching semantics and thus
515 relatively high IO latencies. With this set to 'true', git will do the
516 index comparison to the filesystem data in parallel, allowing
517 overlapping IO's.
519 core.createObject::
520 You can set this to 'link', in which case a hardlink followed by
521 a delete of the source are used to make sure that object creation
522 will not overwrite existing objects.
523 +
524 On some file system/operating system combinations, this is unreliable.
525 Set this config setting to 'rename' there; However, This will remove the
526 check that makes sure that existing object files will not get overwritten.
528 core.notesRef::
529 When showing commit messages, also show notes which are stored in
530 the given ref. The ref must be fully qualified. If the given
531 ref does not exist, it is not an error but means that no
532 notes should be printed.
533 +
534 This setting defaults to "refs/notes/commits", and it can be overridden by
535 the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1].
537 core.sparseCheckout::
538 Enable "sparse checkout" feature. See section "Sparse checkout" in
539 linkgit:git-read-tree[1] for more information.
541 add.ignore-errors::
542 Tells 'git add' to continue adding files when some files cannot be
543 added due to indexing errors. Equivalent to the '--ignore-errors'
544 option of linkgit:git-add[1].
546 alias.*::
547 Command aliases for the linkgit:git[1] command wrapper - e.g.
548 after defining "alias.last = cat-file commit HEAD", the invocation
549 "git last" is equivalent to "git cat-file commit HEAD". To avoid
550 confusion and troubles with script usage, aliases that
551 hide existing git commands are ignored. Arguments are split by
552 spaces, the usual shell quoting and escaping is supported.
553 quote pair and a backslash can be used to quote them.
554 +
555 If the alias expansion is prefixed with an exclamation point,
556 it will be treated as a shell command. For example, defining
557 " = !gitk --all --not ORIG_HEAD", the invocation
558 "git new" is equivalent to running the shell command
559 "gitk --all --not ORIG_HEAD". Note that shell commands will be
560 executed from the top-level directory of a repository, which may
561 not necessarily be the current directory.
563 am.keepcr::
564 If true, git-am will call git-mailsplit for patches in mbox format
565 with parameter '--keep-cr'. In this case git-mailsplit will
566 not remove `\r` from lines ending with `\r\n`. Can be overrriden
567 by giving '--no-keep-cr' from the command line.
568 See linkgit:git-am[1], linkgit:git-mailsplit[1].
570 apply.ignorewhitespace::
571 When set to 'change', tells 'git apply' to ignore changes in
572 whitespace, in the same way as the '--ignore-space-change'
573 option.
574 When set to one of: no, none, never, false tells 'git apply' to
575 respect all whitespace differences.
576 See linkgit:git-apply[1].
578 apply.whitespace::
579 Tells 'git apply' how to handle whitespaces, in the same way
580 as the '--whitespace' option. See linkgit:git-apply[1].
582 branch.autosetupmerge::
583 Tells 'git branch' and 'git checkout' to set up new branches
584 so that linkgit:git-pull[1] will appropriately merge from the
585 starting point branch. Note that even if this option is not set,
586 this behavior can be chosen per-branch using the `--track`
587 and `--no-track` options. The valid settings are: `false` -- no
588 automatic setup is done; `true` -- automatic setup is done when the
589 starting point is a remote branch; `always` -- automatic setup is
590 done when the starting point is either a local branch or remote
591 branch. This option defaults to true.
593 branch.autosetuprebase::
594 When a new branch is created with 'git branch' or 'git checkout'
595 that tracks another branch, this variable tells git to set
596 up pull to rebase instead of merge (see "branch.<name>.rebase").
597 When `never`, rebase is never automatically set to true.
598 When `local`, rebase is set to true for tracked branches of
599 other local branches.
600 When `remote`, rebase is set to true for tracked branches of
601 remote branches.
602 When `always`, rebase will be set to true for all tracking
603 branches.
604 See "branch.autosetupmerge" for details on how to set up a
605 branch to track another branch.
606 This option defaults to never.
608 branch.<name>.remote::
609 When in branch <name>, it tells 'git fetch' and 'git push' which
610 remote to fetch from/push to. It defaults to `origin` if no remote is
611 configured. `origin` is also used if you are not on any branch.
613 branch.<name>.merge::
614 Defines, together with branch.<name>.remote, the upstream branch
615 for the given branch. It tells 'git fetch'/'git pull' which
616 branch to merge and can also affect 'git push' (see push.default).
617 When in branch <name>, it tells 'git fetch' the default
618 refspec to be marked for merging in FETCH_HEAD. The value is
619 handled like the remote part of a refspec, and must match a
620 ref which is fetched from the remote given by
621 "branch.<name>.remote".
622 The merge information is used by 'git pull' (which at first calls
623 'git fetch') to lookup the default branch for merging. Without
624 this option, 'git pull' defaults to merge the first refspec fetched.
625 Specify multiple values to get an octopus merge.
626 If you wish to setup 'git pull' so that it merges into <name> from
627 another branch in the local repository, you can point
628 branch.<name>.merge to the desired branch, and use the special setting
629 `.` (a period) for branch.<name>.remote.
631 branch.<name>.mergeoptions::
632 Sets default options for merging into branch <name>. The syntax and
633 supported options are the same as those of linkgit:git-merge[1], but
634 option values containing whitespace characters are currently not
635 supported.
637 branch.<name>.rebase::
638 When true, rebase the branch <name> on top of the fetched branch,
639 instead of merging the default branch from the default remote when
640 "git pull" is run.
641 *NOTE*: this is a possibly dangerous operation; do *not* use
642 it unless you understand the implications (see linkgit:git-rebase[1]
643 for details).
645 browser.<tool>.cmd::
646 Specify the command to invoke the specified browser. The
647 specified command is evaluated in shell with the URLs passed
648 as arguments. (See linkgit:git-web--browse[1].)
650 browser.<tool>.path::
651 Override the path for the given tool that may be used to
652 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
653 working repository in gitweb (see linkgit:git-instaweb[1]).
655 clean.requireForce::
656 A boolean to make git-clean do nothing unless given -f
657 or -n. Defaults to true.
659 color.branch::
660 A boolean to enable/disable color in the output of
661 linkgit:git-branch[1]. May be set to `always`,
662 `false` (or `never`) or `auto` (or `true`), in which case colors are used
663 only when the output is to a terminal. Defaults to false.
665 color.branch.<slot>::
666 Use customized color for branch coloration. `<slot>` is one of
667 `current` (the current branch), `local` (a local branch),
668 `remote` (a tracking branch in refs/remotes/), `plain` (other
669 refs).
670 +
671 The value for these configuration variables is a list of colors (at most
672 two) and attributes (at most one), separated by spaces. The colors
673 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
674 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
675 `blink` and `reverse`. The first color given is the foreground; the
676 second is the background. The position of the attribute, if any,
677 doesn't matter.
679 color.diff::
680 When set to `always`, always use colors in patch.
681 When false (or `never`), never. When set to `true` or `auto`, use
682 colors only when the output is to the terminal. Defaults to false.
684 color.diff.<slot>::
685 Use customized color for diff colorization. `<slot>` specifies
686 which part of the patch to use the specified color, and is one
687 of `plain` (context text), `meta` (metainformation), `frag`
688 (hunk header), 'func' (function in hunk header), `old` (removed lines),
689 `new` (added lines), `commit` (commit headers), or `whitespace`
690 (highlighting whitespace errors). The values of these variables may be
691 specified as in color.branch.<slot>.
693 color.decorate.<slot>::
694 Use customized color for 'git log --decorate' output. `<slot>` is one
695 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
696 branches, remote tracking branches, tags, stash and HEAD, respectively.
698 color.grep::
699 When set to `always`, always highlight matches. When `false` (or
700 `never`), never. When set to `true` or `auto`, use color only
701 when the output is written to the terminal. Defaults to `false`.
703 color.grep.<slot>::
704 Use customized color for grep colorization. `<slot>` specifies which
705 part of the line to use the specified color, and is one of
706 +
707 --
708 `context`;;
709 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
710 `filename`;;
711 filename prefix (when not using `-h`)
712 `function`;;
713 function name lines (when using `-p`)
714 `linenumber`;;
715 line number prefix (when using `-n`)
716 `match`;;
717 matching text
718 `selected`;;
719 non-matching text in selected lines
720 `separator`;;
721 separators between fields on a line (`:`, `-`, and `=`)
722 and between hunks (`--`)
723 --
724 +
725 The values of these variables may be specified as in color.branch.<slot>.
727 color.interactive::
728 When set to `always`, always use colors for interactive prompts
729 and displays (such as those used by "git-add --interactive").
730 When false (or `never`), never. When set to `true` or `auto`, use
731 colors only when the output is to the terminal. Defaults to false.
733 color.interactive.<slot>::
734 Use customized color for 'git add --interactive'
735 output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
736 four distinct types of normal output from interactive
737 commands. The values of these variables may be specified as
738 in color.branch.<slot>.
740 color.pager::
741 A boolean to enable/disable colored output when the pager is in
742 use (default is true).
744 color.showbranch::
745 A boolean to enable/disable color in the output of
746 linkgit:git-show-branch[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::
751 A boolean to enable/disable color in the output of
752 linkgit:git-status[1]. May be set to `always`,
753 `false` (or `never`) or `auto` (or `true`), in which case colors are used
754 only when the output is to a terminal. Defaults to false.
756 color.status.<slot>::
757 Use customized color for status colorization. `<slot>` is
758 one of `header` (the header text of the status message),
759 `added` or `updated` (files which are added but not committed),
760 `changed` (files which are changed but not added in the index),
761 `untracked` (files which are not tracked by git), or
762 `nobranch` (the color the 'no branch' warning is shown in, defaulting
763 to red). The values of these variables may be specified as in
764 color.branch.<slot>.
766 color.ui::
767 When set to `always`, always use colors in all git commands which
768 are capable of colored output. When false (or `never`), never. When
769 set to `true` or `auto`, use colors only when the output is to the
770 terminal. When more specific variables of color.* are set, they always
771 take precedence over this setting. Defaults to false.
773 commit.status::
774 A boolean to enable/disable inclusion of status information in the
775 commit message template when using an editor to prepare the commit
776 message. Defaults to true.
778 commit.template::
779 Specify a file to use as the template for new commit messages.
780 "{tilde}/" is expanded to the value of `$HOME` and "{tilde}user/" to the
781 specified user's home directory.
783 diff.autorefreshindex::
784 When using 'git diff' to compare with work tree
785 files, do not consider stat-only change as changed.
786 Instead, silently run `git update-index --refresh` to
787 update the cached stat information for paths whose
788 contents in the work tree match the contents in the
789 index. This option defaults to true. Note that this
790 affects only 'git diff' Porcelain, and not lower level
791 'diff' commands such as 'git diff-files'.
793 diff.external::
794 If this config variable is set, diff generation is not
795 performed using the internal diff machinery, but using the
796 given command. Can be overridden with the `GIT_EXTERNAL_DIFF'
797 environment variable. The command is called with parameters
798 as described under "git Diffs" in linkgit:git[1]. Note: if
799 you want to use an external diff program only on a subset of
800 your files, you might want to use linkgit:gitattributes[5] instead.
802 diff.mnemonicprefix::
803 If set, 'git diff' uses a prefix pair that is different from the
804 standard "a/" and "b/" depending on what is being compared. When
805 this configuration is in effect, reverse diff output also swaps
806 the order of the prefixes:
807 diff.noprefix::
808 If set, 'git diff' does not show any source or destination prefix.
809 `git diff`;;
810 compares the (i)ndex and the (w)ork tree;
811 `git diff HEAD`;;
812 compares a (c)ommit and the (w)ork tree;
813 `git diff --cached`;;
814 compares a (c)ommit and the (i)ndex;
815 `git diff HEAD:file1 file2`;;
816 compares an (o)bject and a (w)ork tree entity;
817 `git diff --no-index a b`;;
818 compares two non-git things (1) and (2).
820 diff.renameLimit::
821 The number of files to consider when performing the copy/rename
822 detection; equivalent to the 'git diff' option '-l'.
824 diff.renames::
825 Tells git to detect renames. If set to any boolean value, it
826 will enable basic rename detection. If set to "copies" or
827 "copy", it will detect copies, as well.
829 diff.suppressBlankEmpty::
830 A boolean to inhibit the standard behavior of printing a space
831 before each empty output line. Defaults to false.
833 diff.tool::
834 Controls which diff tool is used. `diff.tool` overrides
835 `merge.tool` when used by linkgit:git-difftool[1] and has
836 the same valid values as `merge.tool` minus "tortoisemerge"
837 and plus "kompare".
839 difftool.<tool>.path::
840 Override the path for the given tool. This is useful in case
841 your tool is not in the PATH.
843 difftool.<tool>.cmd::
844 Specify the command to invoke the specified diff tool.
845 The specified command is evaluated in shell with the following
846 variables available: 'LOCAL' is set to the name of the temporary
847 file containing the contents of the diff pre-image and 'REMOTE'
848 is set to the name of the temporary file containing the contents
849 of the diff post-image.
851 difftool.prompt::
852 Prompt before each invocation of the diff tool.
854 diff.wordRegex::
855 A POSIX Extended Regular Expression used to determine what is a "word"
856 when performing word-by-word difference calculations. Character
857 sequences that match the regular expression are "words", all other
858 characters are *ignorable* whitespace.
860 fetch.unpackLimit::
861 If the number of objects fetched over the git native
862 transfer is below this
863 limit, then the objects will be unpacked into loose object
864 files. However if the number of received objects equals or
865 exceeds this limit then the received pack will be stored as
866 a pack, after adding any missing delta bases. Storing the
867 pack from a push can make the push operation complete faster,
868 especially on slow filesystems. If not set, the value of
869 `transfer.unpackLimit` is used instead.
871 format.attach::
872 Enable multipart/mixed attachments as the default for
873 'format-patch'. The value can also be a double quoted string
874 which will enable attachments as the default and set the
875 value as the boundary. See the --attach option in
876 linkgit:git-format-patch[1].
878 format.numbered::
879 A boolean which can enable or disable sequence numbers in patch
880 subjects. It defaults to "auto" which enables it only if there
881 is more than one patch. It can be enabled or disabled for all
882 messages by setting it to "true" or "false". See --numbered
883 option in linkgit:git-format-patch[1].
885 format.headers::
886 Additional email headers to include in a patch to be submitted
887 by mail. See linkgit:git-format-patch[1].
891 Additional recipients to include in a patch to be submitted
892 by mail. See the --to and --cc options in
893 linkgit:git-format-patch[1].
895 format.subjectprefix::
896 The default for format-patch is to output files with the '[PATCH]'
897 subject prefix. Use this variable to change that prefix.
899 format.signature::
900 The default for format-patch is to output a signature containing
901 the git version number. Use this variable to change that default.
902 Set this variable to the empty string ("") to suppress
903 signature generation.
905 format.suffix::
906 The default for format-patch is to output files with the suffix
907 `.patch`. Use this variable to change that suffix (make sure to
908 include the dot if you want it).
910 format.pretty::
911 The default pretty format for log/show/whatchanged command,
912 See linkgit:git-log[1], linkgit:git-show[1],
913 linkgit:git-whatchanged[1].
915 format.thread::
916 The default threading style for 'git format-patch'. Can be
917 a boolean value, or `shallow` or `deep`. `shallow` threading
918 makes every mail a reply to the head of the series,
919 where the head is chosen from the cover letter, the
920 `\--in-reply-to`, and the first patch mail, in this order.
921 `deep` threading makes every mail a reply to the previous one.
922 A true boolean value is the same as `shallow`, and a false
923 value disables threading.
925 format.signoff::
926 A boolean value which lets you enable the `-s/--signoff` option of
927 format-patch by default. *Note:* Adding the Signed-off-by: line to a
928 patch should be a conscious act and means that you certify you have
929 the rights to submit this work under the same open source license.
930 Please see the 'SubmittingPatches' document for further discussion.
932 gc.aggressiveWindow::
933 The window size parameter used in the delta compression
934 algorithm used by 'git gc --aggressive'. This defaults
935 to 250.
938 When there are approximately more than this many loose
939 objects in the repository, `git gc --auto` will pack them.
940 Some Porcelain commands use this command to perform a
941 light-weight garbage collection from time to time. The
942 default value is 6700. Setting this to 0 disables it.
944 gc.autopacklimit::
945 When there are more than this many packs that are not
946 marked with `*.keep` file in the repository, `git gc
947 --auto` consolidates them into one larger pack. The
948 default value is 50. Setting this to 0 disables it.
950 gc.packrefs::
951 Running `git pack-refs` in a repository renders it
952 unclonable by Git versions prior to over dumb
953 transports such as HTTP. This variable determines whether
954 'git gc' runs `git pack-refs`. This can be set to `nobare`
955 to enable it within all non-bare repos or it can be set to a
956 boolean value. The default is `true`.
958 gc.pruneexpire::
959 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
960 Override the grace period with this config variable. The value
961 "now" may be used to disable this grace period and always prune
962 unreachable objects immediately.
964 gc.reflogexpire::
965 gc.<pattern>.reflogexpire::
966 'git reflog expire' removes reflog entries older than
967 this time; defaults to 90 days. With "<pattern>" (e.g.
968 "refs/stash") in the middle the setting applies only to
969 the refs that match the <pattern>.
971 gc.reflogexpireunreachable::
972 gc.<ref>.reflogexpireunreachable::
973 'git reflog expire' removes reflog entries older than
974 this time and are not reachable from the current tip;
975 defaults to 30 days. With "<pattern>" (e.g. "refs/stash")
976 in the middle, the setting applies only to the refs that
977 match the <pattern>.
979 gc.rerereresolved::
980 Records of conflicted merge you resolved earlier are
981 kept for this many days when 'git rerere gc' is run.
982 The default is 60 days. See linkgit:git-rerere[1].
984 gc.rerereunresolved::
985 Records of conflicted merge you have not resolved are
986 kept for this many days when 'git rerere gc' is run.
987 The default is 15 days. See linkgit:git-rerere[1].
989 gitcvs.commitmsgannotation::
990 Append this string to each commit message. Set to empty string
991 to disable this feature. Defaults to "via git-CVS emulator".
993 gitcvs.enabled::
994 Whether the CVS server interface is enabled for this repository.
995 See linkgit:git-cvsserver[1].
997 gitcvs.logfile::
998 Path to a log file where the CVS server interface well... logs
999 various stuff. See linkgit:git-cvsserver[1].
1001 gitcvs.usecrlfattr::
1002 If true, the server will look up the end-of-line conversion
1003 attributes for files to determine the '-k' modes to use. If
1004 the attributes force git to treat a file as text,
1005 the '-k' mode will be left blank so cvs clients will
1006 treat it as text. If they suppress text conversion, the file
1007 will be set with '-kb' mode, which suppresses any newline munging
1008 the client might otherwise do. If the attributes do not allow
1009 the file type to be determined, then 'gitcvs.allbinary' is
1010 used. See linkgit:gitattributes[5].
1012 gitcvs.allbinary::
1013 This is used if 'gitcvs.usecrlfattr' does not resolve
1014 the correct '-kb' mode to use. If true, all
1015 unresolved files are sent to the client in
1016 mode '-kb'. This causes the client to treat them
1017 as binary files, which suppresses any newline munging it
1018 otherwise might do. Alternatively, if it is set to "guess",
1019 then the contents of the file are examined to decide if
1020 it is binary, similar to 'core.autocrlf'.
1022 gitcvs.dbname::
1023 Database used by git-cvsserver to cache revision information
1024 derived from the git repository. The exact meaning depends on the
1025 used database driver, for SQLite (which is the default driver) this
1026 is a filename. Supports variable substitution (see
1027 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1028 Default: '%Ggitcvs.%m.sqlite'
1030 gitcvs.dbdriver::
1031 Used Perl DBI driver. You can specify any available driver
1032 for this here, but it might not work. git-cvsserver is tested
1033 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1034 reported *not* to work with 'DBD::mysql'. Experimental feature.
1035 May not contain double colons (`:`). Default: 'SQLite'.
1036 See linkgit:git-cvsserver[1].
1038 gitcvs.dbuser, gitcvs.dbpass::
1039 Database user and password. Only useful if setting 'gitcvs.dbdriver',
1040 since SQLite has no concept of database users and/or passwords.
1041 'gitcvs.dbuser' supports variable substitution (see
1042 linkgit:git-cvsserver[1] for details).
1044 gitcvs.dbTableNamePrefix::
1045 Database table name prefix. Prepended to the names of any
1046 database tables used, allowing a single database to be used
1047 for several repositories. Supports variable substitution (see
1048 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1049 characters will be replaced with underscores.
1051 All gitcvs variables except for 'gitcvs.usecrlfattr' and
1052 'gitcvs.allbinary' can also be specified as
1053 'gitcvs.<access_method>.<varname>' (where 'access_method'
1054 is one of "ext" and "pserver") to make them apply only for the given
1055 access method.
1057 gui.commitmsgwidth::
1058 Defines how wide the commit message window is in the
1059 linkgit:git-gui[1]. "75" is the default.
1061 gui.diffcontext::
1062 Specifies how many context lines should be used in calls to diff
1063 made by the linkgit:git-gui[1]. The default is "5".
1065 gui.encoding::
1066 Specifies the default encoding to use for displaying of
1067 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1068 It can be overridden by setting the 'encoding' attribute
1069 for relevant files (see linkgit:gitattributes[5]).
1070 If this option is not set, the tools default to the
1071 locale encoding.
1073 gui.matchtrackingbranch::
1074 Determines if new branches created with linkgit:git-gui[1] should
1075 default to tracking remote branches with matching names or
1076 not. Default: "false".
1078 gui.newbranchtemplate::
1079 Is used as suggested name when creating new branches using the
1080 linkgit:git-gui[1].
1082 gui.pruneduringfetch::
1083 "true" if linkgit:git-gui[1] should prune tracking branches when
1084 performing a fetch. The default value is "false".
1086 gui.trustmtime::
1087 Determines if linkgit:git-gui[1] should trust the file modification
1088 timestamp or not. By default the timestamps are not trusted.
1090 gui.spellingdictionary::
1091 Specifies the dictionary used for spell checking commit messages in
1092 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1093 off.
1095 gui.fastcopyblame::
1096 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1097 location detection. It makes blame significantly faster on huge
1098 repositories at the expense of less thorough copy detection.
1100 gui.copyblamethreshold::
1101 Specifies the threshold to use in 'git gui blame' original location
1102 detection, measured in alphanumeric characters. See the
1103 linkgit:git-blame[1] manual for more information on copy detection.
1105 gui.blamehistoryctx::
1106 Specifies the radius of history context in days to show in
1107 linkgit:gitk[1] for the selected commit, when the `Show History
1108 Context` menu item is invoked from 'git gui blame'. If this
1109 variable is set to zero, the whole history is shown.
1111 guitool.<name>.cmd::
1112 Specifies the shell command line to execute when the corresponding item
1113 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1114 mandatory for every tool. The command is executed from the root of
1115 the working directory, and in the environment it receives the name of
1116 the tool as 'GIT_GUITOOL', the name of the currently selected file as
1117 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1118 the head is detached, 'CUR_BRANCH' is empty).
1120 guitool.<name>.needsfile::
1121 Run the tool only if a diff is selected in the GUI. It guarantees
1122 that 'FILENAME' is not empty.
1124 guitool.<name>.noconsole::
1125 Run the command silently, without creating a window to display its
1126 output.
1128 guitool.<name>.norescan::
1129 Don't rescan the working directory for changes after the tool
1130 finishes execution.
1132 guitool.<name>.confirm::
1133 Show a confirmation dialog before actually running the tool.
1135 guitool.<name>.argprompt::
1136 Request a string argument from the user, and pass it to the tool
1137 through the 'ARGS' environment variable. Since requesting an
1138 argument implies confirmation, the 'confirm' option has no effect
1139 if this is enabled. If the option is set to 'true', 'yes', or '1',
1140 the dialog uses a built-in generic prompt; otherwise the exact
1141 value of the variable is used.
1143 guitool.<name>.revprompt::
1144 Request a single valid revision from the user, and set the
1145 'REVISION' environment variable. In other aspects this option
1146 is similar to 'argprompt', and can be used together with it.
1148 guitool.<name>.revunmerged::
1149 Show only unmerged branches in the 'revprompt' subdialog.
1150 This is useful for tools similar to merge or rebase, but not
1151 for things like checkout or reset.
1153 guitool.<name>.title::
1154 Specifies the title to use for the prompt dialog. The default
1155 is the tool name.
1157 guitool.<name>.prompt::
1158 Specifies the general prompt string to display at the top of
1159 the dialog, before subsections for 'argprompt' and 'revprompt'.
1160 The default value includes the actual command.
1162 help.browser::
1163 Specify the browser that will be used to display help in the
1164 'web' format. See linkgit:git-help[1].
1166 help.format::
1167 Override the default help format used by linkgit:git-help[1].
1168 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1169 the default. 'web' and 'html' are the same.
1171 help.autocorrect::
1172 Automatically correct and execute mistyped commands after
1173 waiting for the given number of deciseconds (0.1 sec). If more
1174 than one command can be deduced from the entered text, nothing
1175 will be executed. If the value of this option is negative,
1176 the corrected command will be executed immediately. If the
1177 value is 0 - the command will be just shown but not executed.
1178 This is the default.
1180 http.proxy::
1181 Override the HTTP proxy, normally configured using the 'http_proxy'
1182 environment variable (see linkgit:curl[1]). This can be overridden
1183 on a per-remote basis; see remote.<name>.proxy
1185 http.sslVerify::
1186 Whether to verify the SSL certificate when fetching or pushing
1187 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1188 variable.
1190 http.sslCert::
1191 File containing the SSL certificate when fetching or pushing
1192 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1193 variable.
1195 http.sslKey::
1196 File containing the SSL private key when fetching or pushing
1197 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1198 variable.
1200 http.sslCertPasswordProtected::
1201 Enable git's password prompt for the SSL certificate. Otherwise
1202 OpenSSL will prompt the user, possibly many times, if the
1203 certificate or private key is encrypted. Can be overridden by the
1204 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1206 http.sslCAInfo::
1207 File containing the certificates to verify the peer with when
1208 fetching or pushing over HTTPS. Can be overridden by the
1209 'GIT_SSL_CAINFO' environment variable.
1211 http.sslCAPath::
1212 Path containing files with the CA certificates to verify the peer
1213 with when fetching or pushing over HTTPS. Can be overridden
1214 by the 'GIT_SSL_CAPATH' environment variable.
1216 http.maxRequests::
1217 How many HTTP requests to launch in parallel. Can be overridden
1218 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1220 http.minSessions::
1221 The number of curl sessions (counted across slots) to be kept across
1222 requests. They will not be ended with curl_easy_cleanup() until
1223 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1224 value will be capped at 1. Defaults to 1.
1226 http.postBuffer::
1227 Maximum size in bytes of the buffer used by smart HTTP
1228 transports when POSTing data to the remote system.
1229 For requests larger than this buffer size, HTTP/1.1 and
1230 Transfer-Encoding: chunked is used to avoid creating a
1231 massive pack file locally. Default is 1 MiB, which is
1232 sufficient for most requests.
1234 http.lowSpeedLimit, http.lowSpeedTime::
1235 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1236 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1237 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1238 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1240 http.noEPSV::
1241 A boolean which disables using of EPSV ftp command by curl.
1242 This can helpful with some "poor" ftp servers which don't
1243 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1244 environment variable. Default is false (curl will use EPSV).
1246 i18n.commitEncoding::
1247 Character encoding the commit messages are stored in; git itself
1248 does not care per se, but this information is necessary e.g. when
1249 importing commits from emails or in the gitk graphical history
1250 browser (and possibly at other places in the future or in other
1251 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1253 i18n.logOutputEncoding::
1254 Character encoding the commit messages are converted to when
1255 running 'git log' and friends.
1257 imap::
1258 The configuration variables in the 'imap' section are described
1259 in linkgit:git-imap-send[1].
1261 init.templatedir::
1262 Specify the directory from which templates will be copied.
1263 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1265 instaweb.browser::
1266 Specify the program that will be used to browse your working
1267 repository in gitweb. See linkgit:git-instaweb[1].
1269 instaweb.httpd::
1270 The HTTP daemon command-line to start gitweb on your working
1271 repository. See linkgit:git-instaweb[1].
1273 instaweb.local::
1274 If true the web server started by linkgit:git-instaweb[1] will
1275 be bound to the local IP (
1277 instaweb.modulepath::
1278 The module path for an apache httpd used by linkgit:git-instaweb[1].
1280 instaweb.port::
1281 The port number to bind the gitweb httpd to. See
1282 linkgit:git-instaweb[1].
1284 interactive.singlekey::
1285 In interactive commands, allow the user to provide one-letter
1286 input with a single key (i.e., without hitting enter).
1287 Currently this is used only by the `\--patch` mode of
1288 linkgit:git-add[1]. Note that this setting is silently
1289 ignored if portable keystroke input is not available.
1292 Set default date-time mode for the log command. Setting
1293 value is similar to using 'git log'\'s --date option. The value is one of the
1294 following alternatives: {relative,local,default,iso,rfc,short}.
1295 See linkgit:git-log[1].
1297 log.decorate::
1298 Print out the ref names of any commits that are shown by the log
1299 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1300 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1301 specified, the full ref name (including prefix) will be printed.
1302 This is the same as the log commands '--decorate' option.
1304 log.showroot::
1305 If true, the initial commit will be shown as a big creation event.
1306 This is equivalent to a diff against an empty tree.
1307 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1308 normally hide the root commit will now show it. True by default.
1310 mailmap.file::
1311 The location of an augmenting mailmap file. The default
1312 mailmap, located in the root of the repository, is loaded
1313 first, then the mailmap file pointed to by this variable.
1314 The location of the mailmap file may be in a repository
1315 subdirectory, or somewhere outside of the repository itself.
1316 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1318 man.viewer::
1319 Specify the programs that may be used to display help in the
1320 'man' format. See linkgit:git-help[1].
1322 man.<tool>.cmd::
1323 Specify the command to invoke the specified man viewer. The
1324 specified command is evaluated in shell with the man page
1325 passed as argument. (See linkgit:git-help[1].)
1327 man.<tool>.path::
1328 Override the path for the given tool that may be used to
1329 display help in the 'man' format. See linkgit:git-help[1].
1331 include::merge-config.txt[]
1333 mergetool.<tool>.path::
1334 Override the path for the given tool. This is useful in case
1335 your tool is not in the PATH.
1337 mergetool.<tool>.cmd::
1338 Specify the command to invoke the specified merge tool. The
1339 specified command is evaluated in shell with the following
1340 variables available: 'BASE' is the name of a temporary file
1341 containing the common base of the files to be merged, if available;
1342 'LOCAL' is the name of a temporary file containing the contents of
1343 the file on the current branch; 'REMOTE' is the name of a temporary
1344 file containing the contents of the file from the branch being
1345 merged; 'MERGED' contains the name of the file to which the merge
1346 tool should write the results of a successful merge.
1348 mergetool.<tool>.trustExitCode::
1349 For a custom merge command, specify whether the exit code of
1350 the merge command can be used to determine whether the merge was
1351 successful. If this is not set to true then the merge target file
1352 timestamp is checked and the merge assumed to have been successful
1353 if the file has been updated, otherwise the user is prompted to
1354 indicate the success of the merge.
1356 mergetool.keepBackup::
1357 After performing a merge, the original file with conflict markers
1358 can be saved as a file with a `.orig` extension. If this variable
1359 is set to `false` then this file is not preserved. Defaults to
1360 `true` (i.e. keep the backup files).
1362 mergetool.keepTemporaries::
1363 When invoking a custom merge tool, git uses a set of temporary
1364 files to pass to the tool. If the tool returns an error and this
1365 variable is set to `true`, then these temporary files will be
1366 preserved, otherwise they will be removed after the tool has
1367 exited. Defaults to `false`.
1369 mergetool.prompt::
1370 Prompt before each invocation of the merge resolution program.
1372 notes.displayRef::
1373 The (fully qualified) refname from which to show notes when
1374 showing commit messages. The value of this variable can be set
1375 to a glob, in which case notes from all matching refs will be
1376 shown. You may also specify this configuration variable
1377 several times. A warning will be issued for refs that do not
1378 exist, but a glob that does not match any refs is silently
1379 ignored.
1380 +
1381 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1382 environment variable, which must be a colon separated list of refs or
1383 globs.
1384 +
1385 The effective value of "core.notesRef" (possibly overridden by
1386 GIT_NOTES_REF) is also implicitly added to the list of refs to be
1387 displayed.
1389 notes.rewrite.<command>::
1390 When rewriting commits with <command> (currently `amend` or
1391 `rebase`) and this variable is set to `true`, git
1392 automatically copies your notes from the original to the
1393 rewritten commit. Defaults to `true`, but see
1394 "notes.rewriteRef" below.
1396 notes.rewriteMode::
1397 When copying notes during a rewrite (see the
1398 "notes.rewrite.<command>" option), determines what to do if
1399 the target commit already has a note. Must be one of
1400 `overwrite`, `concatenate`, or `ignore`. Defaults to
1401 `concatenate`.
1402 +
1403 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1404 environment variable.
1406 notes.rewriteRef::
1407 When copying notes during a rewrite, specifies the (fully
1408 qualified) ref whose notes should be copied. The ref may be a
1409 glob, in which case notes in all matching refs will be copied.
1410 You may also specify this configuration several times.
1411 +
1412 Does not have a default value; you must configure this variable to
1413 enable note rewriting.
1414 +
1415 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1416 environment variable, which must be a colon separated list of refs or
1417 globs.
1419 pack.window::
1420 The size of the window used by linkgit:git-pack-objects[1] when no
1421 window size is given on the command line. Defaults to 10.
1423 pack.depth::
1424 The maximum delta depth used by linkgit:git-pack-objects[1] when no
1425 maximum depth is given on the command line. Defaults to 50.
1427 pack.windowMemory::
1428 The window memory size limit used by linkgit:git-pack-objects[1]
1429 when no limit is given on the command line. The value can be
1430 suffixed with "k", "m", or "g". Defaults to 0, meaning no
1431 limit.
1433 pack.compression::
1434 An integer -1..9, indicating the compression level for objects
1435 in a pack file. -1 is the zlib default. 0 means no
1436 compression, and 1..9 are various speed/size tradeoffs, 9 being
1437 slowest. If not set, defaults to core.compression. If that is
1438 not set, defaults to -1, the zlib default, which is "a default
1439 compromise between speed and compression (currently equivalent
1440 to level 6)."
1442 pack.deltaCacheSize::
1443 The maximum memory in bytes used for caching deltas in
1444 linkgit:git-pack-objects[1] before writing them out to a pack.
1445 This cache is used to speed up the writing object phase by not
1446 having to recompute the final delta result once the best match
1447 for all objects is found. Repacking large repositories on machines
1448 which are tight with memory might be badly impacted by this though,
1449 especially if this cache pushes the system into swapping.
1450 A value of 0 means no limit. The smallest size of 1 byte may be
1451 used to virtually disable this cache. Defaults to 256 MiB.
1453 pack.deltaCacheLimit::
1454 The maximum size of a delta, that is cached in
1455 linkgit:git-pack-objects[1]. This cache is used to speed up the
1456 writing object phase by not having to recompute the final delta
1457 result once the best match for all objects is found. Defaults to 1000.
1459 pack.threads::
1460 Specifies the number of threads to spawn when searching for best
1461 delta matches. This requires that linkgit:git-pack-objects[1]
1462 be compiled with pthreads otherwise this option is ignored with a
1463 warning. This is meant to reduce packing time on multiprocessor
1464 machines. The required amount of memory for the delta search window
1465 is however multiplied by the number of threads.
1466 Specifying 0 will cause git to auto-detect the number of CPU's
1467 and set the number of threads accordingly.
1469 pack.indexVersion::
1470 Specify the default pack index version. Valid values are 1 for
1471 legacy pack index used by Git versions prior to 1.5.2, and 2 for
1472 the new pack index with capabilities for packs larger than 4 GB
1473 as well as proper protection against the repacking of corrupted
1474 packs. Version 2 is the default. Note that version 2 is enforced
1475 and this config option ignored whenever the corresponding pack is
1476 larger than 2 GB.
1477 +
1478 If you have an old git that does not understand the version 2 `{asterisk}.idx` file,
1479 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1480 that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the
1481 other side may give you a repository that cannot be accessed with your
1482 older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,
1483 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1484 the `{asterisk}.idx` file.
1486 pack.packSizeLimit::
1487 The maximum size of a pack. This setting only affects
1488 packing to a file when repacking, i.e. the git:// protocol
1489 is unaffected. It can be overridden by the `\--max-pack-size`
1490 option of linkgit:git-repack[1]. The minimum size allowed is
1491 limited to 1 MiB. The default is unlimited.
1492 Common unit suffixes of 'k', 'm', or 'g' are
1493 supported.
1495 pager.<cmd>::
1496 Allows turning on or off pagination of the output of a
1497 particular git subcommand when writing to a tty. If
1498 `\--paginate` or `\--no-pager` is specified on the command line,
1499 it takes precedence over this option. To disable pagination for
1500 all commands, set `core.pager` or `GIT_PAGER` to `cat`.
1502 pretty.<name>::
1503 Alias for a --pretty= format string, as specified in
1504 linkgit:git-log[1]. Any aliases defined here can be used just
1505 as the built-in pretty formats could. For example,
1506 running `git config pretty.changelog "format:{asterisk} %H %s"`
1507 would cause the invocation `git log --pretty=changelog`
1508 to be equivalent to running `git log "--pretty=format:{asterisk} %H %s"`.
1509 Note that an alias with the same name as a built-in format
1510 will be silently ignored.
1512 pull.octopus::
1513 The default merge strategy to use when pulling multiple branches
1514 at once.
1516 pull.twohead::
1517 The default merge strategy to use when pulling a single branch.
1519 push.default::
1520 Defines the action git push should take if no refspec is given
1521 on the command line, no refspec is configured in the remote, and
1522 no refspec is implied by any of the options given on the command
1523 line. Possible values are:
1524 +
1525 * `nothing` do not push anything.
1526 * `matching` push all matching branches.
1527 All branches having the same name in both ends are considered to be
1528 matching. This is the default.
1529 * `tracking` push the current branch to its upstream branch.
1530 * `current` push the current branch to a branch of the same name.
1532 rebase.stat::
1533 Whether to show a diffstat of what changed upstream since the last
1534 rebase. False by default.
1536 receive.autogc::
1537 By default, git-receive-pack will run "git-gc --auto" after
1538 receiving data from git-push and updating refs. You can stop
1539 it by setting this variable to false.
1541 receive.fsckObjects::
1542 If it is set to true, git-receive-pack will check all received
1543 objects. It will abort in the case of a malformed object or a
1544 broken link. The result of an abort are only dangling objects.
1545 Defaults to false.
1547 receive.unpackLimit::
1548 If the number of objects received in a push is below this
1549 limit then the objects will be unpacked into loose object
1550 files. However if the number of received objects equals or
1551 exceeds this limit then the received pack will be stored as
1552 a pack, after adding any missing delta bases. Storing the
1553 pack from a push can make the push operation complete faster,
1554 especially on slow filesystems. If not set, the value of
1555 `transfer.unpackLimit` is used instead.
1557 receive.denyDeletes::
1558 If set to true, git-receive-pack will deny a ref update that deletes
1559 the ref. Use this to prevent such a ref deletion via a push.
1561 receive.denyCurrentBranch::
1562 If set to true or "refuse", git-receive-pack will deny a ref update
1563 to the currently checked out branch of a non-bare repository.
1564 Such a push is potentially dangerous because it brings the HEAD
1565 out of sync with the index and working tree. If set to "warn",
1566 print a warning of such a push to stderr, but allow the push to
1567 proceed. If set to false or "ignore", allow such pushes with no
1568 message. Defaults to "refuse".
1570 receive.denyNonFastForwards::
1571 If set to true, git-receive-pack will deny a ref update which is
1572 not a fast-forward. Use this to prevent such an update via a push,
1573 even if that push is forced. This configuration variable is
1574 set when initializing a shared repository.
1576 receive.updateserverinfo::
1577 If set to true, git-receive-pack will run git-update-server-info
1578 after receiving data from git-push and updating refs.
1580 remote.<name>.url::
1581 The URL of a remote repository. See linkgit:git-fetch[1] or
1582 linkgit:git-push[1].
1584 remote.<name>.pushurl::
1585 The push URL of a remote repository. See linkgit:git-push[1].
1587 remote.<name>.proxy::
1588 For remotes that require curl (http, https and ftp), the URL to
1589 the proxy to use for that remote. Set to the empty string to
1590 disable proxying for that remote.
1592 remote.<name>.fetch::
1593 The default set of "refspec" for linkgit:git-fetch[1]. See
1594 linkgit:git-fetch[1].
1596 remote.<name>.push::
1597 The default set of "refspec" for linkgit:git-push[1]. See
1598 linkgit:git-push[1].
1600 remote.<name>.mirror::
1601 If true, pushing to this remote will automatically behave
1602 as if the `\--mirror` option was given on the command line.
1604 remote.<name>.skipDefaultUpdate::
1605 If true, this remote will be skipped by default when updating
1606 using linkgit:git-fetch[1] or the `update` subcommand of
1607 linkgit:git-remote[1].
1609 remote.<name>.skipFetchAll::
1610 If true, this remote will be skipped by default when updating
1611 using linkgit:git-fetch[1] or the `update` subcommand of
1612 linkgit:git-remote[1].
1614 remote.<name>.receivepack::
1615 The default program to execute on the remote side when pushing. See
1616 option \--receive-pack of linkgit:git-push[1].
1618 remote.<name>.uploadpack::
1619 The default program to execute on the remote side when fetching. See
1620 option \--upload-pack of linkgit:git-fetch-pack[1].
1622 remote.<name>.tagopt::
1623 Setting this value to \--no-tags disables automatic tag following when
1624 fetching from remote <name>. Setting it to \--tags will fetch every
1625 tag from remote <name>, even if they are not reachable from remote
1626 branch heads.
1628 remote.<name>.vcs::
1629 Setting this to a value <vcs> will cause git to interact with
1630 the remote with the git-remote-<vcs> helper.
1632 remotes.<group>::
1633 The list of remotes which are fetched by "git remote update
1634 <group>". See linkgit:git-remote[1].
1636 repack.usedeltabaseoffset::
1637 By default, linkgit:git-repack[1] creates packs that use
1638 delta-base offset. If you need to share your repository with
1639 git older than version 1.4.4, either directly or via a dumb
1640 protocol such as http, then you need to set this option to
1641 "false" and repack. Access from old git versions over the
1642 native protocol are unaffected by this option.
1644 rerere.autoupdate::
1645 When set to true, `git-rerere` updates the index with the
1646 resulting contents after it cleanly resolves conflicts using
1647 previously recorded resolution. Defaults to false.
1649 rerere.enabled::
1650 Activate recording of resolved conflicts, so that identical
1651 conflict hunks can be resolved automatically, should they
1652 be encountered again. linkgit:git-rerere[1] command is by
1653 default enabled if you create `rr-cache` directory under
1654 `$GIT_DIR`, but can be disabled by setting this option to false.
1656 sendemail.identity::
1657 A configuration identity. When given, causes values in the
1658 'sendemail.<identity>' subsection to take precedence over
1659 values in the 'sendemail' section. The default identity is
1660 the value of 'sendemail.identity'.
1662 sendemail.smtpencryption::
1663 See linkgit:git-send-email[1] for description. Note that this
1664 setting is not subject to the 'identity' mechanism.
1666 sendemail.smtpssl::
1667 Deprecated alias for 'sendemail.smtpencryption = ssl'.
1669 sendemail.<identity>.*::
1670 Identity-specific versions of the 'sendemail.*' parameters
1671 found below, taking precedence over those when the this
1672 identity is selected, through command-line or
1673 'sendemail.identity'.
1675 sendemail.aliasesfile::
1676 sendemail.aliasfiletype::
1677 sendemail.bcc::
1679 sendemail.cccmd::
1680 sendemail.chainreplyto::
1681 sendemail.confirm::
1682 sendemail.envelopesender::
1683 sendemail.from::
1684 sendemail.multiedit::
1685 sendemail.signedoffbycc::
1686 sendemail.smtppass::
1687 sendemail.suppresscc::
1688 sendemail.suppressfrom::
1690 sendemail.smtpdomain::
1691 sendemail.smtpserver::
1692 sendemail.smtpserverport::
1693 sendemail.smtpuser::
1694 sendemail.thread::
1695 sendemail.validate::
1696 See linkgit:git-send-email[1] for description.
1698 sendemail.signedoffcc::
1699 Deprecated alias for 'sendemail.signedoffbycc'.
1701 showbranch.default::
1702 The default set of branches for linkgit:git-show-branch[1].
1703 See linkgit:git-show-branch[1].
1705 status.relativePaths::
1706 By default, linkgit:git-status[1] shows paths relative to the
1707 current directory. Setting this variable to `false` shows paths
1708 relative to the repository root (this was the default for git
1709 prior to v1.5.4).
1711 status.showUntrackedFiles::
1712 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1713 files which are not currently tracked by Git. Directories which
1714 contain only untracked files, are shown with the directory name
1715 only. Showing untracked files means that Git needs to lstat() all
1716 all the files in the whole repository, which might be slow on some
1717 systems. So, this variable controls how the commands displays
1718 the untracked files. Possible values are:
1719 +
1720 --
1721 - 'no' - Show no untracked files
1722 - 'normal' - Shows untracked files and directories
1723 - 'all' - Shows also individual files in untracked directories.
1724 --
1725 +
1726 If this variable is not specified, it defaults to 'normal'.
1727 This variable can be overridden with the -u|--untracked-files option
1728 of linkgit:git-status[1] and linkgit:git-commit[1].
1730 status.submodulesummary::
1731 Defaults to false.
1732 If this is set to a non zero number or true (identical to -1 or an
1733 unlimited number), the submodule summary will be enabled and a
1734 summary of commits for modified submodules will be shown (see
1735 --summary-limit option of linkgit:git-submodule[1]).
1737 submodule.<name>.path::
1738 submodule.<name>.url::
1739 submodule.<name>.update::
1740 The path within this project, URL, and the updating strategy
1741 for a submodule. These variables are initially populated
1742 by 'git submodule init'; edit them to override the
1743 URL and other values found in the `.gitmodules` file. See
1744 linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
1746 submodule.<name>.ignore::
1747 Defines under what circumstances "git status" and the diff family show
1748 a submodule as modified. When set to "all", it will never be considered
1749 modified, "dirty" will ignore all changes to the submodules work tree and
1750 takes only differences between the HEAD of the submodule and the commit
1751 recorded in the superproject into account. "untracked" will additionally
1752 let submodules with modified tracked files in their work tree show up.
1753 Using "none" (the default when this option is not set) also shows
1754 submodules that have untracked files in their work tree as changed.
1756 tar.umask::
1757 This variable can be used to restrict the permission bits of
1758 tar archive entries. The default is 0002, which turns off the
1759 world write bit. The special value "user" indicates that the
1760 archiving user's umask will be used instead. See umask(2) and
1761 linkgit:git-archive[1].
1763 transfer.unpackLimit::
1764 When `fetch.unpackLimit` or `receive.unpackLimit` are
1765 not set, the value of this variable is used instead.
1766 The default value is 100.
1768 url.<base>.insteadOf::
1769 Any URL that starts with this value will be rewritten to
1770 start, instead, with <base>. In cases where some site serves a
1771 large number of repositories, and serves them with multiple
1772 access methods, and some users need to use different access
1773 methods, this feature allows people to specify any of the
1774 equivalent URLs and have git automatically rewrite the URL to
1775 the best alternative for the particular user, even for a
1776 never-before-seen repository on the site. When more than one
1777 insteadOf strings match a given URL, the longest match is used.
1779 url.<base>.pushInsteadOf::
1780 Any URL that starts with this value will not be pushed to;
1781 instead, it will be rewritten to start with <base>, and the
1782 resulting URL will be pushed to. In cases where some site serves
1783 a large number of repositories, and serves them with multiple
1784 access methods, some of which do not allow push, this feature
1785 allows people to specify a pull-only URL and have git
1786 automatically use an appropriate URL to push, even for a
1787 never-before-seen repository on the site. When more than one
1788 pushInsteadOf strings match a given URL, the longest match is
1789 used. If a remote has an explicit pushurl, git will ignore this
1790 setting for that remote.
1793 Your email address to be recorded in any newly created commits.
1794 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
1795 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
1798 Your full name to be recorded in any newly created commits.
1799 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
1800 environment variables. See linkgit:git-commit-tree[1].
1802 user.signingkey::
1803 If linkgit:git-tag[1] is not selecting the key you want it to
1804 automatically when creating a signed tag, you can override the
1805 default selection with this variable. This option is passed
1806 unchanged to gpg's --local-user parameter, so you may specify a key
1807 using any method that gpg supports.
1809 web.browser::
1810 Specify a web browser that may be used by some commands.
1811 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
1812 may use it.