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, allow only alphanumeric
16 characters and `-`, and must start with an alphabetic character. Some
17 variables may appear multiple times.
22 The syntax is fairly flexible and permissive; whitespaces are mostly
23 ignored. The '#' and ';' characters begin comments to the end of line,
24 blank lines are ignored.
26 The file consists of sections and variables. A section begins with
27 the name of the section in square brackets and continues until the next
28 section begins. Section names are not case sensitive. Only alphanumeric
29 characters, `-` and `.` are allowed in section names. Each variable
30 must belong to some section, which means that there must be a section
31 header before the first setting of a variable.
33 Sections can be further divided into subsections. To begin a subsection
34 put its name in double quotes, separated by space from the section name,
35 in the section header, like in the example below:
38 [section "subsection"]
42 Subsection names are case sensitive and can contain any characters except
43 newline (doublequote `"` and backslash have to be escaped as `\"` and `\\`,
44 respectively). Section headers cannot span multiple
45 lines. Variables may belong directly to a section or to a given subsection.
46 You can have `[section]` if you have `[section "subsection"]`, but you
49 There is also a deprecated `[section.subsection]` syntax. With this
50 syntax, the subsection name is converted to lower-case and is also
51 compared case sensitively. These subsection names follow the same
52 restrictions as section names.
54 All the other lines (and the remainder of the line after the section
55 header) are recognized as setting variables, in the form
56 'name = value'. If there is no equal sign on the line, the entire line
57 is taken as 'name' and the variable is recognized as boolean "true".
58 The variable names are case-insensitive, allow only alphanumeric characters
59 and `-`, and must start with an alphabetic character. There can be more
60 than one value for a given variable; we say then that the variable is
63 Leading and trailing whitespace in a variable value is discarded.
64 Internal whitespace within a variable value is retained verbatim.
66 The values following the equals sign in variable assign are all either
67 a string, an integer, or a boolean. Boolean values may be given as yes/no,
68 1/0, true/false or on/off. Case is not significant in boolean values, when
69 converting value to the canonical form using '--bool' type specifier;
70 'git config' will ensure that the output is "true" or "false".
72 String values may be entirely or partially enclosed in double quotes.
73 You need to enclose variable values in double quotes if you want to
74 preserve leading or trailing whitespace, or if the variable value contains
75 comment characters (i.e. it contains '#' or ';').
76 Double quote `"` and backslash `\` characters in variable values must
77 be escaped: use `\"` for `"` and `\\` for `\`.
79 The following escape sequences (beside `\"` and `\\`) are recognized:
80 `\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
81 and `\b` for backspace (BS). No other char escape sequence, nor octal
82 char sequences are valid.
84 Variable values ending in a `\` are continued on the next line in the
85 customary UNIX fashion.
87 Some variables may require a special value format.
92 You can include one config file from another by setting the special
93 `include.path` variable to the name of the file to be included. The
94 included file is expanded immediately, as if its contents had been
95 found at the location of the include directive. If the value of the
96 `include.path` variable is a relative path, the path is considered to be
97 relative to the configuration file in which the include directive was
98 found. The value of `include.path` is subject to tilde expansion: `~/`
99 is expanded to the value of `$HOME`, and `~user/` to the specified
100 user's home directory. See below for examples.
107 ; Don't trust file modes
112 external = /usr/local/bin/diff-wrapper
117 merge = refs/heads/devel
121 gitProxy="ssh" for "kernel.org"
122 gitProxy=default-proxy ; for the rest
125 path = /path/to/foo.inc ; include by absolute path
126 path = foo ; expand "foo" relative to the current file
127 path = ~/foo ; expand "foo" in your $HOME directory
132 Note that this list is non-comprehensive and not necessarily complete.
133 For command-specific variables, you will find a more detailed description
134 in the appropriate manual page. You will find a description of non-core
135 porcelain configuration variables in the respective porcelain documentation.
138 These variables control various optional help messages designed to
139 aid new users. All 'advice.*' variables default to 'true', and you
140 can tell Git that you do not need help by setting these to 'false':
144 Set this variable to 'false' if you want to disable
145 'pushNonFFCurrent', 'pushNonFFDefault',
146 'pushNonFFMatching', and 'pushAlreadyExists'
149 Advice shown when linkgit:git-push[1] fails due to a
150 non-fast-forward update to the current branch.
152 Advice to set 'push.default' to 'upstream' or 'current'
153 when you ran linkgit:git-push[1] and pushed 'matching
154 refs' by default (i.e. you did not provide an explicit
155 refspec, and no 'push.default' configuration was set)
156 and it resulted in a non-fast-forward error.
158 Advice shown when you ran linkgit:git-push[1] and pushed
159 'matching refs' explicitly (i.e. you used ':', or
160 specified a refspec that isn't your current branch) and
161 it resulted in a non-fast-forward error.
163 Shown when linkgit:git-push[1] rejects an update that
164 does not qualify for fast-forwarding (e.g., a tag.)
166 Show directions on how to proceed from the current
167 state in the output of linkgit:git-status[1], in
168 the template shown when writing commit messages in
169 linkgit:git-commit[1], and in the help message shown
170 by linkgit:git-checkout[1] when switching branch.
172 Advice shown when linkgit:git-merge[1] refuses to
173 merge to avoid overwriting local changes.
175 Advices shown by various commands when conflicts
176 prevent the operation from being performed.
178 Advice on how to set your identity configuration when
179 your information is guessed from the system username and
182 Advice shown when you used linkgit:git-checkout[1] to
183 move to the detach HEAD state, to instruct how to create
184 a local branch after the fact.
186 Advice that shows the location of the patch file when
187 linkgit:git-am[1] fails to apply it.
191 If false, the executable bit differences between the index and
192 the working tree are ignored; useful on broken filesystems like FAT.
193 See linkgit:git-update-index[1].
195 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
196 will probe and set core.fileMode false if appropriate when the
197 repository is created.
199 core.ignoreCygwinFSTricks::
200 This option is only used by Cygwin implementation of Git. If false,
201 the Cygwin stat() and lstat() functions are used. This may be useful
202 if your repository consists of a few separate directories joined in
203 one hierarchy using Cygwin mount. If true, Git uses native Win32 API
204 whenever it is possible and falls back to Cygwin functions only to
205 handle symbol links. The native mode is more than twice faster than
206 normal Cygwin l/stat() functions. True by default, unless core.filemode
207 is true, in which case ignoreCygwinFSTricks is ignored as Cygwin's
208 POSIX emulation is required to support core.filemode.
211 If true, this option enables various workarounds to enable
212 git to work better on filesystems that are not case sensitive,
213 like FAT. For example, if a directory listing finds
214 "makefile" when git expects "Makefile", git will assume
215 it is really the same file, and continue to remember it as
218 The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
219 will probe and set core.ignorecase true if appropriate when the repository
222 core.precomposeunicode::
223 This option is only used by Mac OS implementation of git.
224 When core.precomposeunicode=true, git reverts the unicode decomposition
225 of filenames done by Mac OS. This is useful when sharing a repository
226 between Mac OS and Linux or Windows.
227 (Git for Windows 1.7.10 or higher is needed, or git under cygwin 1.7).
228 When false, file names are handled fully transparent by git,
229 which is backward compatible with older versions of git.
232 If false, the ctime differences between the index and the
233 working tree are ignored; useful when the inode change time
234 is regularly modified by something outside Git (file system
235 crawlers and some backup systems).
236 See linkgit:git-update-index[1]. True by default.
239 Determines which stat fields to match between the index
240 and work tree. The user can set this to 'default' or
241 'minimal'. Default (or explicitly 'default'), is to check
242 all fields, including the sub-second part of mtime and ctime.
245 The commands that output paths (e.g. 'ls-files',
246 'diff'), when not given the `-z` option, will quote
247 "unusual" characters in the pathname by enclosing the
248 pathname in a double-quote pair and with backslashes the
249 same way strings in C source code are quoted. If this
250 variable is set to false, the bytes higher than 0x80 are
251 not quoted but output as verbatim. Note that double
252 quote, backslash and control characters are always
253 quoted without `-z` regardless of the setting of this
257 Sets the line ending type to use in the working directory for
258 files that have the `text` property set. Alternatives are
259 'lf', 'crlf' and 'native', which uses the platform's native
260 line ending. The default value is `native`. See
261 linkgit:gitattributes[5] for more information on end-of-line
265 If true, makes git check if converting `CRLF` is reversible when
266 end-of-line conversion is active. Git will verify if a command
267 modifies a file in the work tree either directly or indirectly.
268 For example, committing a file followed by checking out the
269 same file should yield the original file in the work tree. If
270 this is not the case for the current setting of
271 `core.autocrlf`, git will reject the file. The variable can
272 be set to "warn", in which case git will only warn about an
273 irreversible conversion but continue the operation.
275 CRLF conversion bears a slight chance of corrupting data.
276 When it is enabled, git will convert CRLF to LF during commit and LF to
277 CRLF during checkout. A file that contains a mixture of LF and
278 CRLF before the commit cannot be recreated by git. For text
279 files this is the right thing to do: it corrects line endings
280 such that we have only LF line endings in the repository.
281 But for binary files that are accidentally classified as text the
282 conversion can corrupt data.
284 If you recognize such corruption early you can easily fix it by
285 setting the conversion type explicitly in .gitattributes. Right
286 after committing you still have the original file in your work
287 tree and this file is not yet corrupted. You can explicitly tell
288 git that this file is binary and git will handle the file
291 Unfortunately, the desired effect of cleaning up text files with
292 mixed line endings and the undesired effect of corrupting binary
293 files cannot be distinguished. In both cases CRLFs are removed
294 in an irreversible way. For text files this is the right thing
295 to do because CRLFs are line endings, while for binary files
296 converting CRLFs corrupts data.
298 Note, this safety check does not mean that a checkout will generate a
299 file identical to the original file for a different setting of
300 `core.eol` and `core.autocrlf`, but only for the current one. For
301 example, a text file with `LF` would be accepted with `core.eol=lf`
302 and could later be checked out with `core.eol=crlf`, in which case the
303 resulting file would contain `CRLF`, although the original file
304 contained `LF`. However, in both work trees the line endings would be
305 consistent, that is either all `LF` or all `CRLF`, but never mixed. A
306 file with mixed line endings would be reported by the `core.safecrlf`
310 Setting this variable to "true" is almost the same as setting
311 the `text` attribute to "auto" on all files except that text
312 files are not guaranteed to be normalized: files that contain
313 `CRLF` in the repository will not be touched. Use this
314 setting if you want to have `CRLF` line endings in your
315 working directory even though the repository does not have
316 normalized line endings. This variable can be set to 'input',
317 in which case no output conversion is performed.
320 If false, symbolic links are checked out as small plain files that
321 contain the link text. linkgit:git-update-index[1] and
322 linkgit:git-add[1] will not change the recorded type to regular
323 file. Useful on filesystems like FAT that do not support
326 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
327 will probe and set core.symlinks false if appropriate when the repository
331 A "proxy command" to execute (as 'command host port') instead
332 of establishing direct connection to the remote server when
333 using the git protocol for fetching. If the variable value is
334 in the "COMMAND for DOMAIN" format, the command is applied only
335 on hostnames ending with the specified domain string. This variable
336 may be set multiple times and is matched in the given order;
337 the first match wins.
339 Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
340 (which always applies universally, without the special "for"
343 The special string `none` can be used as the proxy command to
344 specify that no proxy be used for a given domain pattern.
345 This is useful for excluding servers inside a firewall from
346 proxy use, while defaulting to a common proxy for external domains.
349 If true, commands which modify both the working tree and the index
350 will mark the updated paths with the "assume unchanged" bit in the
351 index. These marked files are then assumed to stay unchanged in the
352 working tree, until you mark them otherwise manually - Git will not
353 detect the file changes by lstat() calls. This is useful on systems
354 where those are very slow, such as Microsoft Windows.
355 See linkgit:git-update-index[1].
358 core.preferSymlinkRefs::
359 Instead of the default "symref" format for HEAD
360 and other symbolic reference files, use symbolic links.
361 This is sometimes needed to work with old scripts that
362 expect HEAD to be a symbolic link.
365 If true this repository is assumed to be 'bare' and has no
366 working directory associated with it. If this is the case a
367 number of commands that require a working directory will be
368 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
370 This setting is automatically guessed by linkgit:git-clone[1] or
371 linkgit:git-init[1] when the repository was created. By default a
372 repository that ends in "/.git" is assumed to be not bare (bare =
373 false), while all other repositories are assumed to be bare (bare
377 Set the path to the root of the working tree.
378 This can be overridden by the GIT_WORK_TREE environment
379 variable and the '--work-tree' command line option.
380 The value can be an absolute path or relative to the path to
381 the .git directory, which is either specified by --git-dir
382 or GIT_DIR, or automatically discovered.
383 If --git-dir or GIT_DIR is specified but none of
384 --work-tree, GIT_WORK_TREE and core.worktree is specified,
385 the current working directory is regarded as the top level
386 of your working tree.
388 Note that this variable is honored even when set in a configuration
389 file in a ".git" subdirectory of a directory and its value differs
390 from the latter directory (e.g. "/path/to/.git/config" has
391 core.worktree set to "/different/path"), which is most likely a
392 misconfiguration. Running git commands in the "/path/to" directory will
393 still use "/different/path" as the root of the work tree and can cause
394 confusion unless you know what you are doing (e.g. you are creating a
395 read-only snapshot of the same index to a location different from the
396 repository's usual working tree).
398 core.logAllRefUpdates::
399 Enable the reflog. Updates to a ref <ref> is logged to the file
400 "$GIT_DIR/logs/<ref>", by appending the new and old
401 SHA1, the date/time and the reason of the update, but
402 only when the file exists. If this configuration
403 variable is set to true, missing "$GIT_DIR/logs/<ref>"
404 file is automatically created for branch heads (i.e. under
405 refs/heads/), remote refs (i.e. under refs/remotes/),
406 note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
408 This information can be used to determine what commit
409 was the tip of a branch "2 days ago".
411 This value is true by default in a repository that has
412 a working directory associated with it, and false by
413 default in a bare repository.
415 core.repositoryFormatVersion::
416 Internal variable identifying the repository format and layout
419 core.sharedRepository::
420 When 'group' (or 'true'), the repository is made shareable between
421 several users in a group (making sure all the files and objects are
422 group-writable). When 'all' (or 'world' or 'everybody'), the
423 repository will be readable by all users, additionally to being
424 group-shareable. When 'umask' (or 'false'), git will use permissions
425 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
426 files in the repository will have this mode value. '0xxx' will override
427 user's umask value (whereas the other options will only override
428 requested parts of the user's umask value). Examples: '0660' will make
429 the repo read/write-able for the owner and group, but inaccessible to
430 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
431 repository that is group-readable but not group-writable.
432 See linkgit:git-init[1]. False by default.
434 core.warnAmbiguousRefs::
435 If true, git will warn you if the ref name you passed it is ambiguous
436 and might match multiple refs in the .git/refs/ tree. True by default.
439 An integer -1..9, indicating a default compression level.
440 -1 is the zlib default. 0 means no compression,
441 and 1..9 are various speed/size tradeoffs, 9 being slowest.
442 If set, this provides a default to other compression variables,
443 such as 'core.loosecompression' and 'pack.compression'.
445 core.loosecompression::
446 An integer -1..9, indicating the compression level for objects that
447 are not in a pack file. -1 is the zlib default. 0 means no
448 compression, and 1..9 are various speed/size tradeoffs, 9 being
449 slowest. If not set, defaults to core.compression. If that is
450 not set, defaults to 1 (best speed).
452 core.packedGitWindowSize::
453 Number of bytes of a pack file to map into memory in a
454 single mapping operation. Larger window sizes may allow
455 your system to process a smaller number of large pack files
456 more quickly. Smaller window sizes will negatively affect
457 performance due to increased calls to the operating system's
458 memory manager, but may improve performance when accessing
459 a large number of large pack files.
461 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
462 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
463 be reasonable for all users/operating systems. You probably do
464 not need to adjust this value.
466 Common unit suffixes of 'k', 'm', or 'g' are supported.
468 core.packedGitLimit::
469 Maximum number of bytes to map simultaneously into memory
470 from pack files. If Git needs to access more than this many
471 bytes at once to complete an operation it will unmap existing
472 regions to reclaim virtual address space within the process.
474 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
475 This should be reasonable for all users/operating systems, except on
476 the largest projects. You probably do not need to adjust this value.
478 Common unit suffixes of 'k', 'm', or 'g' are supported.
480 core.deltaBaseCacheLimit::
481 Maximum number of bytes to reserve for caching base objects
482 that may be referenced by multiple deltified objects. By storing the
483 entire decompressed base objects in a cache Git is able
484 to avoid unpacking and decompressing frequently used base
485 objects multiple times.
487 Default is 16 MiB on all platforms. This should be reasonable
488 for all users/operating systems, except on the largest projects.
489 You probably do not need to adjust this value.
491 Common unit suffixes of 'k', 'm', or 'g' are supported.
493 core.bigFileThreshold::
494 Files larger than this size are stored deflated, without
495 attempting delta compression. Storing large files without
496 delta compression avoids excessive memory usage, at the
497 slight expense of increased disk usage.
499 Default is 512 MiB on all platforms. This should be reasonable
500 for most projects as source code and other text files can still
501 be delta compressed, but larger binary media files won't be.
503 Common unit suffixes of 'k', 'm', or 'g' are supported.
506 In addition to '.gitignore' (per-directory) and
507 '.git/info/exclude', git looks into this file for patterns
508 of files which are not meant to be tracked. "`~/`" is expanded
509 to the value of `$HOME` and "`~user/`" to the specified user's
510 home directory. Its default value is $XDG_CONFIG_HOME/git/ignore.
511 If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore
512 is used instead. See linkgit:gitignore[5].
515 Some commands (e.g. svn and http interfaces) that interactively
516 ask for a password can be told to use an external program given
517 via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
518 environment variable. If not set, fall back to the value of the
519 'SSH_ASKPASS' environment variable or, failing that, a simple password
520 prompt. The external program shall be given a suitable prompt as
521 command line argument and write the password on its STDOUT.
523 core.attributesfile::
524 In addition to '.gitattributes' (per-directory) and
525 '.git/info/attributes', git looks into this file for attributes
526 (see linkgit:gitattributes[5]). Path expansions are made the same
527 way as for `core.excludesfile`. Its default value is
528 $XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not
529 set or empty, $HOME/.config/git/attributes is used instead.
532 Commands such as `commit` and `tag` that lets you edit
533 messages by launching an editor uses the value of this
534 variable when it is set, and the environment variable
535 `GIT_EDITOR` is not set. See linkgit:git-var[1].
538 Commands such as `commit` and `tag` that lets you edit
539 messages consider a line that begins with this character
540 commented, and removes them after the editor returns
544 Text editor used by `git rebase -i` for editing the rebase insn file.
545 The value is meant to be interpreted by the shell when it is used.
546 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
547 When not configured the default commit message editor is used instead.
550 The command that git will use to paginate output. Can
551 be overridden with the `GIT_PAGER` environment
552 variable. Note that git sets the `LESS` environment
553 variable to `FRSX` if it is unset when it runs the
554 pager. One can change these settings by setting the
555 `LESS` variable to some other value. Alternately,
556 these settings can be overridden on a project or
557 global basis by setting the `core.pager` option.
558 Setting `core.pager` has no effect on the `LESS`
559 environment variable behaviour above, so if you want
560 to override git's default settings this way, you need
561 to be explicit. For example, to disable the S option
562 in a backward compatible manner, set `core.pager`
563 to `less -+S`. This will be passed to the shell by
564 git, which will translate the final command to
565 `LESS=FRSX less -+S`.
568 A comma separated list of common whitespace problems to
569 notice. 'git diff' will use `color.diff.whitespace` to
570 highlight them, and 'git apply --whitespace=error' will
571 consider them as errors. You can prefix `-` to disable
572 any of them (e.g. `-trailing-space`):
574 * `blank-at-eol` treats trailing whitespaces at the end of the line
575 as an error (enabled by default).
576 * `space-before-tab` treats a space character that appears immediately
577 before a tab character in the initial indent part of the line as an
578 error (enabled by default).
579 * `indent-with-non-tab` treats a line that is indented with space
580 characters instead of the equivalent tabs as an error (not enabled by
582 * `tab-in-indent` treats a tab character in the initial indent part of
583 the line as an error (not enabled by default).
584 * `blank-at-eof` treats blank lines added at the end of file as an error
585 (enabled by default).
586 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
588 * `cr-at-eol` treats a carriage-return at the end of line as
589 part of the line terminator, i.e. with it, `trailing-space`
590 does not trigger if the character before such a carriage-return
591 is not a whitespace (not enabled by default).
592 * `tabwidth=<n>` tells how many character positions a tab occupies; this
593 is relevant for `indent-with-non-tab` and when git fixes `tab-in-indent`
594 errors. The default tab width is 8. Allowed values are 1 to 63.
596 core.fsyncobjectfiles::
597 This boolean will enable 'fsync()' when writing object files.
599 This is a total waste of time and effort on a filesystem that orders
600 data writes properly, but can be useful for filesystems that do not use
601 journalling (traditional UNIX filesystems) or that only journal metadata
602 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
605 Enable parallel index preload for operations like 'git diff'
607 This can speed up operations like 'git diff' and 'git status' especially
608 on filesystems like NFS that have weak caching semantics and thus
609 relatively high IO latencies. With this set to 'true', git will do the
610 index comparison to the filesystem data in parallel, allowing
614 You can set this to 'link', in which case a hardlink followed by
615 a delete of the source are used to make sure that object creation
616 will not overwrite existing objects.
618 On some file system/operating system combinations, this is unreliable.
619 Set this config setting to 'rename' there; However, This will remove the
620 check that makes sure that existing object files will not get overwritten.
623 When showing commit messages, also show notes which are stored in
624 the given ref. The ref must be fully qualified. If the given
625 ref does not exist, it is not an error but means that no
626 notes should be printed.
628 This setting defaults to "refs/notes/commits", and it can be overridden by
629 the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1].
631 core.sparseCheckout::
632 Enable "sparse checkout" feature. See section "Sparse checkout" in
633 linkgit:git-read-tree[1] for more information.
636 Set the length object names are abbreviated to. If unspecified,
637 many commands abbreviate to 7 hexdigits, which may not be enough
638 for abbreviated object names to stay unique for sufficiently long
643 Tells 'git add' to continue adding files when some files cannot be
644 added due to indexing errors. Equivalent to the '--ignore-errors'
645 option of linkgit:git-add[1]. Older versions of git accept only
646 `add.ignore-errors`, which does not follow the usual naming
647 convention for configuration variables. Newer versions of git
648 honor `add.ignoreErrors` as well.
651 Command aliases for the linkgit:git[1] command wrapper - e.g.
652 after defining "alias.last = cat-file commit HEAD", the invocation
653 "git last" is equivalent to "git cat-file commit HEAD". To avoid
654 confusion and troubles with script usage, aliases that
655 hide existing git commands are ignored. Arguments are split by
656 spaces, the usual shell quoting and escaping is supported.
657 quote pair and a backslash can be used to quote them.
659 If the alias expansion is prefixed with an exclamation point,
660 it will be treated as a shell command. For example, defining
661 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
662 "git new" is equivalent to running the shell command
663 "gitk --all --not ORIG_HEAD". Note that shell commands will be
664 executed from the top-level directory of a repository, which may
665 not necessarily be the current directory.
666 'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
667 from the original current directory. See linkgit:git-rev-parse[1].
670 If true, git-am will call git-mailsplit for patches in mbox format
671 with parameter '--keep-cr'. In this case git-mailsplit will
672 not remove `\r` from lines ending with `\r\n`. Can be overridden
673 by giving '--no-keep-cr' from the command line.
674 See linkgit:git-am[1], linkgit:git-mailsplit[1].
676 apply.ignorewhitespace::
677 When set to 'change', tells 'git apply' to ignore changes in
678 whitespace, in the same way as the '--ignore-space-change'
680 When set to one of: no, none, never, false tells 'git apply' to
681 respect all whitespace differences.
682 See linkgit:git-apply[1].
685 Tells 'git apply' how to handle whitespaces, in the same way
686 as the '--whitespace' option. See linkgit:git-apply[1].
688 branch.autosetupmerge::
689 Tells 'git branch' and 'git checkout' to set up new branches
690 so that linkgit:git-pull[1] will appropriately merge from the
691 starting point branch. Note that even if this option is not set,
692 this behavior can be chosen per-branch using the `--track`
693 and `--no-track` options. The valid settings are: `false` -- no
694 automatic setup is done; `true` -- automatic setup is done when the
695 starting point is a remote-tracking branch; `always` --
696 automatic setup is done when the starting point is either a
697 local branch or remote-tracking
698 branch. This option defaults to true.
700 branch.autosetuprebase::
701 When a new branch is created with 'git branch' or 'git checkout'
702 that tracks another branch, this variable tells git to set
703 up pull to rebase instead of merge (see "branch.<name>.rebase").
704 When `never`, rebase is never automatically set to true.
705 When `local`, rebase is set to true for tracked branches of
706 other local branches.
707 When `remote`, rebase is set to true for tracked branches of
708 remote-tracking branches.
709 When `always`, rebase will be set to true for all tracking
711 See "branch.autosetupmerge" for details on how to set up a
712 branch to track another branch.
713 This option defaults to never.
715 branch.<name>.remote::
716 When in branch <name>, it tells 'git fetch' and 'git push' which
717 remote to fetch from/push to. It defaults to `origin` if no remote is
718 configured. `origin` is also used if you are not on any branch.
720 branch.<name>.merge::
721 Defines, together with branch.<name>.remote, the upstream branch
722 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
723 branch to merge and can also affect 'git push' (see push.default).
724 When in branch <name>, it tells 'git fetch' the default
725 refspec to be marked for merging in FETCH_HEAD. The value is
726 handled like the remote part of a refspec, and must match a
727 ref which is fetched from the remote given by
728 "branch.<name>.remote".
729 The merge information is used by 'git pull' (which at first calls
730 'git fetch') to lookup the default branch for merging. Without
731 this option, 'git pull' defaults to merge the first refspec fetched.
732 Specify multiple values to get an octopus merge.
733 If you wish to setup 'git pull' so that it merges into <name> from
734 another branch in the local repository, you can point
735 branch.<name>.merge to the desired branch, and use the special setting
736 `.` (a period) for branch.<name>.remote.
738 branch.<name>.mergeoptions::
739 Sets default options for merging into branch <name>. The syntax and
740 supported options are the same as those of linkgit:git-merge[1], but
741 option values containing whitespace characters are currently not
744 branch.<name>.rebase::
745 When true, rebase the branch <name> on top of the fetched branch,
746 instead of merging the default branch from the default remote when
747 "git pull" is run. See "pull.rebase" for doing this in a non
748 branch-specific manner.
750 *NOTE*: this is a possibly dangerous operation; do *not* use
751 it unless you understand the implications (see linkgit:git-rebase[1]
754 branch.<name>.description::
755 Branch description, can be edited with
756 `git branch --edit-description`. Branch description is
757 automatically added in the format-patch cover letter or
758 request-pull summary.
761 Specify the command to invoke the specified browser. The
762 specified command is evaluated in shell with the URLs passed
763 as arguments. (See linkgit:git-web{litdd}browse[1].)
765 browser.<tool>.path::
766 Override the path for the given tool that may be used to
767 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
768 working repository in gitweb (see linkgit:git-instaweb[1]).
771 A boolean to make git-clean do nothing unless given -f
772 or -n. Defaults to true.
775 A boolean to enable/disable color in the output of
776 linkgit:git-branch[1]. May be set to `always`,
777 `false` (or `never`) or `auto` (or `true`), in which case colors are used
778 only when the output is to a terminal. Defaults to false.
780 color.branch.<slot>::
781 Use customized color for branch coloration. `<slot>` is one of
782 `current` (the current branch), `local` (a local branch),
783 `remote` (a remote-tracking branch in refs/remotes/), `plain` (other
786 The value for these configuration variables is a list of colors (at most
787 two) and attributes (at most one), separated by spaces. The colors
788 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
789 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
790 `blink` and `reverse`. The first color given is the foreground; the
791 second is the background. The position of the attribute, if any,
795 Whether to use ANSI escape sequences to add color to patches.
796 If this is set to `always`, linkgit:git-diff[1],
797 linkgit:git-log[1], and linkgit:git-show[1] will use color
798 for all patches. If it is set to `true` or `auto`, those
799 commands will only use color when output is to the terminal.
802 This does not affect linkgit:git-format-patch[1] nor the
803 'git-diff-{asterisk}' plumbing commands. Can be overridden on the
804 command line with the `--color[=<when>]` option.
807 Use customized color for diff colorization. `<slot>` specifies
808 which part of the patch to use the specified color, and is one
809 of `plain` (context text), `meta` (metainformation), `frag`
810 (hunk header), 'func' (function in hunk header), `old` (removed lines),
811 `new` (added lines), `commit` (commit headers), or `whitespace`
812 (highlighting whitespace errors). The values of these variables may be
813 specified as in color.branch.<slot>.
815 color.decorate.<slot>::
816 Use customized color for 'git log --decorate' output. `<slot>` is one
817 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
818 branches, remote-tracking branches, tags, stash and HEAD, respectively.
821 When set to `always`, always highlight matches. When `false` (or
822 `never`), never. When set to `true` or `auto`, use color only
823 when the output is written to the terminal. Defaults to `false`.
826 Use customized color for grep colorization. `<slot>` specifies which
827 part of the line to use the specified color, and is one of
831 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
833 filename prefix (when not using `-h`)
835 function name lines (when using `-p`)
837 line number prefix (when using `-n`)
841 non-matching text in selected lines
843 separators between fields on a line (`:`, `-`, and `=`)
844 and between hunks (`--`)
847 The values of these variables may be specified as in color.branch.<slot>.
850 When set to `always`, always use colors for interactive prompts
851 and displays (such as those used by "git-add --interactive").
852 When false (or `never`), never. When set to `true` or `auto`, use
853 colors only when the output is to the terminal. Defaults to false.
855 color.interactive.<slot>::
856 Use customized color for 'git add --interactive'
857 output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
858 four distinct types of normal output from interactive
859 commands. The values of these variables may be specified as
860 in color.branch.<slot>.
863 A boolean to enable/disable colored output when the pager is in
864 use (default is true).
867 A boolean to enable/disable color in the output of
868 linkgit:git-show-branch[1]. May be set to `always`,
869 `false` (or `never`) or `auto` (or `true`), in which case colors are used
870 only when the output is to a terminal. Defaults to false.
873 A boolean to enable/disable color in the output of
874 linkgit:git-status[1]. May be set to `always`,
875 `false` (or `never`) or `auto` (or `true`), in which case colors are used
876 only when the output is to a terminal. Defaults to false.
878 color.status.<slot>::
879 Use customized color for status colorization. `<slot>` is
880 one of `header` (the header text of the status message),
881 `added` or `updated` (files which are added but not committed),
882 `changed` (files which are changed but not added in the index),
883 `untracked` (files which are not tracked by git),
884 `branch` (the current branch), or
885 `nobranch` (the color the 'no branch' warning is shown in, defaulting
886 to red). The values of these variables may be specified as in
890 This variable determines the default value for variables such
891 as `color.diff` and `color.grep` that control the use of color
892 per command family. Its scope will expand as more commands learn
893 configuration to set a default for the `--color` option. Set it
894 to `always` if you want all output not intended for machine
895 consumption to use color, to `true` or `auto` if you want such
896 output to use color when written to the terminal, or to `false` or
897 `never` if you prefer git commands not to use color unless enabled
898 explicitly with some other configuration or the `--color` option.
901 Specify whether supported commands should output in columns.
902 This variable consists of a list of tokens separated by spaces
907 always show in columns
909 never show in columns
911 show in columns if the output is to the terminal
913 fill columns before rows (default)
915 fill rows before columns
919 make unequal size columns to utilize more space
921 make equal size columns
924 This option defaults to 'never'.
927 Specify whether to output branch listing in `git branch` in columns.
928 See `column.ui` for details.
931 Specify whether to output untracked files in `git status` in columns.
932 See `column.ui` for details.
935 Specify whether to output tag listing in `git tag` in columns.
936 See `column.ui` for details.
939 This setting overrides the default of the `--cleanup` option in
940 `git commit`. See linkgit:git-commit[1] for details. Changing the
941 default can be useful when you always want to keep lines that begin
942 with comment character `#` in your log message, in which case you
943 would do `git config commit.cleanup whitespace` (note that you will
944 have to remove the help lines that begin with `#` in the commit log
945 template yourself, if you do this).
948 A boolean to enable/disable inclusion of status information in the
949 commit message template when using an editor to prepare the commit
950 message. Defaults to true.
953 Specify a file to use as the template for new commit messages.
954 "`~/`" is expanded to the value of `$HOME` and "`~user/`" to the
955 specified user's home directory.
958 Specify an external helper to be called when a username or
959 password credential is needed; the helper may consult external
960 storage to avoid prompting the user for the credentials. See
961 linkgit:gitcredentials[7] for details.
963 credential.useHttpPath::
964 When acquiring credentials, consider the "path" component of an http
965 or https URL to be important. Defaults to false. See
966 linkgit:gitcredentials[7] for more information.
968 credential.username::
969 If no username is set for a network authentication, use this username
970 by default. See credential.<context>.* below, and
971 linkgit:gitcredentials[7].
974 Any of the credential.* options above can be applied selectively to
975 some credentials. For example "credential.https://example.com.username"
976 would set the default username only for https connections to
977 example.com. See linkgit:gitcredentials[7] for details on how URLs are
980 include::diff-config.txt[]
982 difftool.<tool>.path::
983 Override the path for the given tool. This is useful in case
984 your tool is not in the PATH.
986 difftool.<tool>.cmd::
987 Specify the command to invoke the specified diff tool.
988 The specified command is evaluated in shell with the following
989 variables available: 'LOCAL' is set to the name of the temporary
990 file containing the contents of the diff pre-image and 'REMOTE'
991 is set to the name of the temporary file containing the contents
992 of the diff post-image.
995 Prompt before each invocation of the diff tool.
997 fetch.recurseSubmodules::
998 This option can be either set to a boolean value or to 'on-demand'.
999 Setting it to a boolean changes the behavior of fetch and pull to
1000 unconditionally recurse into submodules when set to true or to not
1001 recurse at all when set to false. When set to 'on-demand' (the default
1002 value), fetch and pull will only recurse into a populated submodule
1003 when its superproject retrieves a commit that updates the submodule's
1007 If it is set to true, git-fetch-pack will check all fetched
1008 objects. It will abort in the case of a malformed object or a
1009 broken link. The result of an abort are only dangling objects.
1010 Defaults to false. If not set, the value of `transfer.fsckObjects`
1014 If the number of objects fetched over the git native
1015 transfer is below this
1016 limit, then the objects will be unpacked into loose object
1017 files. However if the number of received objects equals or
1018 exceeds this limit then the received pack will be stored as
1019 a pack, after adding any missing delta bases. Storing the
1020 pack from a push can make the push operation complete faster,
1021 especially on slow filesystems. If not set, the value of
1022 `transfer.unpackLimit` is used instead.
1025 Enable multipart/mixed attachments as the default for
1026 'format-patch'. The value can also be a double quoted string
1027 which will enable attachments as the default and set the
1028 value as the boundary. See the --attach option in
1029 linkgit:git-format-patch[1].
1032 A boolean which can enable or disable sequence numbers in patch
1033 subjects. It defaults to "auto" which enables it only if there
1034 is more than one patch. It can be enabled or disabled for all
1035 messages by setting it to "true" or "false". See --numbered
1036 option in linkgit:git-format-patch[1].
1039 Additional email headers to include in a patch to be submitted
1040 by mail. See linkgit:git-format-patch[1].
1044 Additional recipients to include in a patch to be submitted
1045 by mail. See the --to and --cc options in
1046 linkgit:git-format-patch[1].
1048 format.subjectprefix::
1049 The default for format-patch is to output files with the '[PATCH]'
1050 subject prefix. Use this variable to change that prefix.
1053 The default for format-patch is to output a signature containing
1054 the git version number. Use this variable to change that default.
1055 Set this variable to the empty string ("") to suppress
1056 signature generation.
1059 The default for format-patch is to output files with the suffix
1060 `.patch`. Use this variable to change that suffix (make sure to
1061 include the dot if you want it).
1064 The default pretty format for log/show/whatchanged command,
1065 See linkgit:git-log[1], linkgit:git-show[1],
1066 linkgit:git-whatchanged[1].
1069 The default threading style for 'git format-patch'. Can be
1070 a boolean value, or `shallow` or `deep`. `shallow` threading
1071 makes every mail a reply to the head of the series,
1072 where the head is chosen from the cover letter, the
1073 `--in-reply-to`, and the first patch mail, in this order.
1074 `deep` threading makes every mail a reply to the previous one.
1075 A true boolean value is the same as `shallow`, and a false
1076 value disables threading.
1079 A boolean value which lets you enable the `-s/--signoff` option of
1080 format-patch by default. *Note:* Adding the Signed-off-by: line to a
1081 patch should be a conscious act and means that you certify you have
1082 the rights to submit this work under the same open source license.
1083 Please see the 'SubmittingPatches' document for further discussion.
1085 filter.<driver>.clean::
1086 The command which is used to convert the content of a worktree
1087 file to a blob upon checkin. See linkgit:gitattributes[5] for
1090 filter.<driver>.smudge::
1091 The command which is used to convert the content of a blob
1092 object to a worktree file upon checkout. See
1093 linkgit:gitattributes[5] for details.
1095 gc.aggressiveWindow::
1096 The window size parameter used in the delta compression
1097 algorithm used by 'git gc --aggressive'. This defaults
1101 When there are approximately more than this many loose
1102 objects in the repository, `git gc --auto` will pack them.
1103 Some Porcelain commands use this command to perform a
1104 light-weight garbage collection from time to time. The
1105 default value is 6700. Setting this to 0 disables it.
1108 When there are more than this many packs that are not
1109 marked with `*.keep` file in the repository, `git gc
1110 --auto` consolidates them into one larger pack. The
1111 default value is 50. Setting this to 0 disables it.
1114 Running `git pack-refs` in a repository renders it
1115 unclonable by Git versions prior to 1.5.1.2 over dumb
1116 transports such as HTTP. This variable determines whether
1117 'git gc' runs `git pack-refs`. This can be set to `notbare`
1118 to enable it within all non-bare repos or it can be set to a
1119 boolean value. The default is `true`.
1122 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1123 Override the grace period with this config variable. The value
1124 "now" may be used to disable this grace period and always prune
1125 unreachable objects immediately.
1128 gc.<pattern>.reflogexpire::
1129 'git reflog expire' removes reflog entries older than
1130 this time; defaults to 90 days. With "<pattern>" (e.g.
1131 "refs/stash") in the middle the setting applies only to
1132 the refs that match the <pattern>.
1134 gc.reflogexpireunreachable::
1135 gc.<ref>.reflogexpireunreachable::
1136 'git reflog expire' removes reflog entries older than
1137 this time and are not reachable from the current tip;
1138 defaults to 30 days. With "<pattern>" (e.g. "refs/stash")
1139 in the middle, the setting applies only to the refs that
1140 match the <pattern>.
1143 Records of conflicted merge you resolved earlier are
1144 kept for this many days when 'git rerere gc' is run.
1145 The default is 60 days. See linkgit:git-rerere[1].
1147 gc.rerereunresolved::
1148 Records of conflicted merge you have not resolved are
1149 kept for this many days when 'git rerere gc' is run.
1150 The default is 15 days. See linkgit:git-rerere[1].
1152 gitcvs.commitmsgannotation::
1153 Append this string to each commit message. Set to empty string
1154 to disable this feature. Defaults to "via git-CVS emulator".
1157 Whether the CVS server interface is enabled for this repository.
1158 See linkgit:git-cvsserver[1].
1161 Path to a log file where the CVS server interface well... logs
1162 various stuff. See linkgit:git-cvsserver[1].
1164 gitcvs.usecrlfattr::
1165 If true, the server will look up the end-of-line conversion
1166 attributes for files to determine the '-k' modes to use. If
1167 the attributes force git to treat a file as text,
1168 the '-k' mode will be left blank so CVS clients will
1169 treat it as text. If they suppress text conversion, the file
1170 will be set with '-kb' mode, which suppresses any newline munging
1171 the client might otherwise do. If the attributes do not allow
1172 the file type to be determined, then 'gitcvs.allbinary' is
1173 used. See linkgit:gitattributes[5].
1176 This is used if 'gitcvs.usecrlfattr' does not resolve
1177 the correct '-kb' mode to use. If true, all
1178 unresolved files are sent to the client in
1179 mode '-kb'. This causes the client to treat them
1180 as binary files, which suppresses any newline munging it
1181 otherwise might do. Alternatively, if it is set to "guess",
1182 then the contents of the file are examined to decide if
1183 it is binary, similar to 'core.autocrlf'.
1186 Database used by git-cvsserver to cache revision information
1187 derived from the git repository. The exact meaning depends on the
1188 used database driver, for SQLite (which is the default driver) this
1189 is a filename. Supports variable substitution (see
1190 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1191 Default: '%Ggitcvs.%m.sqlite'
1194 Used Perl DBI driver. You can specify any available driver
1195 for this here, but it might not work. git-cvsserver is tested
1196 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1197 reported *not* to work with 'DBD::mysql'. Experimental feature.
1198 May not contain double colons (`:`). Default: 'SQLite'.
1199 See linkgit:git-cvsserver[1].
1201 gitcvs.dbuser, gitcvs.dbpass::
1202 Database user and password. Only useful if setting 'gitcvs.dbdriver',
1203 since SQLite has no concept of database users and/or passwords.
1204 'gitcvs.dbuser' supports variable substitution (see
1205 linkgit:git-cvsserver[1] for details).
1207 gitcvs.dbTableNamePrefix::
1208 Database table name prefix. Prepended to the names of any
1209 database tables used, allowing a single database to be used
1210 for several repositories. Supports variable substitution (see
1211 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1212 characters will be replaced with underscores.
1214 All gitcvs variables except for 'gitcvs.usecrlfattr' and
1215 'gitcvs.allbinary' can also be specified as
1216 'gitcvs.<access_method>.<varname>' (where 'access_method'
1217 is one of "ext" and "pserver") to make them apply only for the given
1221 gitweb.description::
1224 See linkgit:gitweb[1] for description.
1232 gitweb.remote_heads::
1235 See linkgit:gitweb.conf[5] for description.
1238 If set to true, enable '-n' option by default.
1241 Set the default matching behavior. Using a value of 'basic', 'extended',
1242 'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',
1243 '--fixed-strings', or '--perl-regexp' option accordingly, while the
1244 value 'default' will return to the default matching behavior.
1246 grep.extendedRegexp::
1247 If set to true, enable '--extended-regexp' option by default. This
1248 option is ignored when the 'grep.patternType' option is set to a value
1249 other than 'default'.
1252 Use this custom program instead of "gpg" found on $PATH when
1253 making or verifying a PGP signature. The program must support the
1254 same command line interface as GPG, namely, to verify a detached
1255 signature, "gpg --verify $file - <$signature" is run, and the
1256 program is expected to signal a good signature by exiting with
1257 code 0, and to generate an ascii-armored detached signature, the
1258 standard input of "gpg -bsau $key" is fed with the contents to be
1259 signed, and the program is expected to send the result to its
1262 gui.commitmsgwidth::
1263 Defines how wide the commit message window is in the
1264 linkgit:git-gui[1]. "75" is the default.
1267 Specifies how many context lines should be used in calls to diff
1268 made by the linkgit:git-gui[1]. The default is "5".
1271 Specifies the default encoding to use for displaying of
1272 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1273 It can be overridden by setting the 'encoding' attribute
1274 for relevant files (see linkgit:gitattributes[5]).
1275 If this option is not set, the tools default to the
1278 gui.matchtrackingbranch::
1279 Determines if new branches created with linkgit:git-gui[1] should
1280 default to tracking remote branches with matching names or
1281 not. Default: "false".
1283 gui.newbranchtemplate::
1284 Is used as suggested name when creating new branches using the
1287 gui.pruneduringfetch::
1288 "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1289 performing a fetch. The default value is "false".
1292 Determines if linkgit:git-gui[1] should trust the file modification
1293 timestamp or not. By default the timestamps are not trusted.
1295 gui.spellingdictionary::
1296 Specifies the dictionary used for spell checking commit messages in
1297 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1301 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1302 location detection. It makes blame significantly faster on huge
1303 repositories at the expense of less thorough copy detection.
1305 gui.copyblamethreshold::
1306 Specifies the threshold to use in 'git gui blame' original location
1307 detection, measured in alphanumeric characters. See the
1308 linkgit:git-blame[1] manual for more information on copy detection.
1310 gui.blamehistoryctx::
1311 Specifies the radius of history context in days to show in
1312 linkgit:gitk[1] for the selected commit, when the `Show History
1313 Context` menu item is invoked from 'git gui blame'. If this
1314 variable is set to zero, the whole history is shown.
1316 guitool.<name>.cmd::
1317 Specifies the shell command line to execute when the corresponding item
1318 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1319 mandatory for every tool. The command is executed from the root of
1320 the working directory, and in the environment it receives the name of
1321 the tool as 'GIT_GUITOOL', the name of the currently selected file as
1322 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1323 the head is detached, 'CUR_BRANCH' is empty).
1325 guitool.<name>.needsfile::
1326 Run the tool only if a diff is selected in the GUI. It guarantees
1327 that 'FILENAME' is not empty.
1329 guitool.<name>.noconsole::
1330 Run the command silently, without creating a window to display its
1333 guitool.<name>.norescan::
1334 Don't rescan the working directory for changes after the tool
1337 guitool.<name>.confirm::
1338 Show a confirmation dialog before actually running the tool.
1340 guitool.<name>.argprompt::
1341 Request a string argument from the user, and pass it to the tool
1342 through the 'ARGS' environment variable. Since requesting an
1343 argument implies confirmation, the 'confirm' option has no effect
1344 if this is enabled. If the option is set to 'true', 'yes', or '1',
1345 the dialog uses a built-in generic prompt; otherwise the exact
1346 value of the variable is used.
1348 guitool.<name>.revprompt::
1349 Request a single valid revision from the user, and set the
1350 'REVISION' environment variable. In other aspects this option
1351 is similar to 'argprompt', and can be used together with it.
1353 guitool.<name>.revunmerged::
1354 Show only unmerged branches in the 'revprompt' subdialog.
1355 This is useful for tools similar to merge or rebase, but not
1356 for things like checkout or reset.
1358 guitool.<name>.title::
1359 Specifies the title to use for the prompt dialog. The default
1362 guitool.<name>.prompt::
1363 Specifies the general prompt string to display at the top of
1364 the dialog, before subsections for 'argprompt' and 'revprompt'.
1365 The default value includes the actual command.
1368 Specify the browser that will be used to display help in the
1369 'web' format. See linkgit:git-help[1].
1372 Override the default help format used by linkgit:git-help[1].
1373 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1374 the default. 'web' and 'html' are the same.
1377 Automatically correct and execute mistyped commands after
1378 waiting for the given number of deciseconds (0.1 sec). If more
1379 than one command can be deduced from the entered text, nothing
1380 will be executed. If the value of this option is negative,
1381 the corrected command will be executed immediately. If the
1382 value is 0 - the command will be just shown but not executed.
1383 This is the default.
1386 Specify the path where the HTML documentation resides. File system paths
1387 and URLs are supported. HTML pages will be prefixed with this path when
1388 help is displayed in the 'web' format. This defaults to the documentation
1389 path of your Git installation.
1392 Override the HTTP proxy, normally configured using the 'http_proxy',
1393 'https_proxy', and 'all_proxy' environment variables (see
1394 `curl(1)`). This can be overridden on a per-remote basis; see
1398 File containing previously stored cookie lines which should be used
1399 in the git http session, if they match the server. The file format
1400 of the file to read cookies from should be plain HTTP headers or
1401 the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
1402 NOTE that the file specified with http.cookiefile is only used as
1403 input. No cookies will be stored in the file.
1406 Whether to verify the SSL certificate when fetching or pushing
1407 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1411 File containing the SSL certificate when fetching or pushing
1412 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1416 File containing the SSL private key when fetching or pushing
1417 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1420 http.sslCertPasswordProtected::
1421 Enable git's password prompt for the SSL certificate. Otherwise
1422 OpenSSL will prompt the user, possibly many times, if the
1423 certificate or private key is encrypted. Can be overridden by the
1424 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1427 File containing the certificates to verify the peer with when
1428 fetching or pushing over HTTPS. Can be overridden by the
1429 'GIT_SSL_CAINFO' environment variable.
1432 Path containing files with the CA certificates to verify the peer
1433 with when fetching or pushing over HTTPS. Can be overridden
1434 by the 'GIT_SSL_CAPATH' environment variable.
1437 How many HTTP requests to launch in parallel. Can be overridden
1438 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1441 The number of curl sessions (counted across slots) to be kept across
1442 requests. They will not be ended with curl_easy_cleanup() until
1443 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1444 value will be capped at 1. Defaults to 1.
1447 Maximum size in bytes of the buffer used by smart HTTP
1448 transports when POSTing data to the remote system.
1449 For requests larger than this buffer size, HTTP/1.1 and
1450 Transfer-Encoding: chunked is used to avoid creating a
1451 massive pack file locally. Default is 1 MiB, which is
1452 sufficient for most requests.
1454 http.lowSpeedLimit, http.lowSpeedTime::
1455 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1456 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1457 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1458 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1461 A boolean which disables using of EPSV ftp command by curl.
1462 This can helpful with some "poor" ftp servers which don't
1463 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1464 environment variable. Default is false (curl will use EPSV).
1467 The HTTP USER_AGENT string presented to an HTTP server. The default
1468 value represents the version of the client git such as git/1.7.1.
1469 This option allows you to override this value to a more common value
1470 such as Mozilla/4.0. This may be necessary, for instance, if
1471 connecting through a firewall that restricts HTTP connections to a set
1472 of common USER_AGENT strings (but not including those like git/1.7.1).
1473 Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1475 i18n.commitEncoding::
1476 Character encoding the commit messages are stored in; git itself
1477 does not care per se, but this information is necessary e.g. when
1478 importing commits from emails or in the gitk graphical history
1479 browser (and possibly at other places in the future or in other
1480 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1482 i18n.logOutputEncoding::
1483 Character encoding the commit messages are converted to when
1484 running 'git log' and friends.
1487 The configuration variables in the 'imap' section are described
1488 in linkgit:git-imap-send[1].
1491 Specify the directory from which templates will be copied.
1492 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1495 Specify the program that will be used to browse your working
1496 repository in gitweb. See linkgit:git-instaweb[1].
1499 The HTTP daemon command-line to start gitweb on your working
1500 repository. See linkgit:git-instaweb[1].
1503 If true the web server started by linkgit:git-instaweb[1] will
1504 be bound to the local IP (127.0.0.1).
1506 instaweb.modulepath::
1507 The default module path for linkgit:git-instaweb[1] to use
1508 instead of /usr/lib/apache2/modules. Only used if httpd
1512 The port number to bind the gitweb httpd to. See
1513 linkgit:git-instaweb[1].
1515 interactive.singlekey::
1516 In interactive commands, allow the user to provide one-letter
1517 input with a single key (i.e., without hitting enter).
1518 Currently this is used by the `--patch` mode of
1519 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1520 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1521 setting is silently ignored if portable keystroke input
1525 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1526 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
1527 override this option with `--no-abbrev-commit`.
1530 Set the default date-time mode for the 'log' command.
1531 Setting a value for log.date is similar to using 'git log''s
1532 `--date` option. Possible values are `relative`, `local`,
1533 `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1537 Print out the ref names of any commits that are shown by the log
1538 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1539 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1540 specified, the full ref name (including prefix) will be printed.
1541 This is the same as the log commands '--decorate' option.
1544 If true, the initial commit will be shown as a big creation event.
1545 This is equivalent to a diff against an empty tree.
1546 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1547 normally hide the root commit will now show it. True by default.
1550 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1551 linkgit:git-whatchanged[1] assume `--use-mailmap`.
1554 The location of an augmenting mailmap file. The default
1555 mailmap, located in the root of the repository, is loaded
1556 first, then the mailmap file pointed to by this variable.
1557 The location of the mailmap file may be in a repository
1558 subdirectory, or somewhere outside of the repository itself.
1559 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1562 Like `mailmap.file`, but consider the value as a reference to a
1563 blob in the repository. If both `mailmap.file` and
1564 `mailmap.blob` are given, both are parsed, with entries from
1565 `mailmap.file` taking precedence. In a bare repository, this
1566 defaults to `HEAD:.mailmap`. In a non-bare repository, it
1570 Specify the programs that may be used to display help in the
1571 'man' format. See linkgit:git-help[1].
1574 Specify the command to invoke the specified man viewer. The
1575 specified command is evaluated in shell with the man page
1576 passed as argument. (See linkgit:git-help[1].)
1579 Override the path for the given tool that may be used to
1580 display help in the 'man' format. See linkgit:git-help[1].
1582 include::merge-config.txt[]
1584 mergetool.<tool>.path::
1585 Override the path for the given tool. This is useful in case
1586 your tool is not in the PATH.
1588 mergetool.<tool>.cmd::
1589 Specify the command to invoke the specified merge tool. The
1590 specified command is evaluated in shell with the following
1591 variables available: 'BASE' is the name of a temporary file
1592 containing the common base of the files to be merged, if available;
1593 'LOCAL' is the name of a temporary file containing the contents of
1594 the file on the current branch; 'REMOTE' is the name of a temporary
1595 file containing the contents of the file from the branch being
1596 merged; 'MERGED' contains the name of the file to which the merge
1597 tool should write the results of a successful merge.
1599 mergetool.<tool>.trustExitCode::
1600 For a custom merge command, specify whether the exit code of
1601 the merge command can be used to determine whether the merge was
1602 successful. If this is not set to true then the merge target file
1603 timestamp is checked and the merge assumed to have been successful
1604 if the file has been updated, otherwise the user is prompted to
1605 indicate the success of the merge.
1607 mergetool.keepBackup::
1608 After performing a merge, the original file with conflict markers
1609 can be saved as a file with a `.orig` extension. If this variable
1610 is set to `false` then this file is not preserved. Defaults to
1611 `true` (i.e. keep the backup files).
1613 mergetool.keepTemporaries::
1614 When invoking a custom merge tool, git uses a set of temporary
1615 files to pass to the tool. If the tool returns an error and this
1616 variable is set to `true`, then these temporary files will be
1617 preserved, otherwise they will be removed after the tool has
1618 exited. Defaults to `false`.
1621 Prompt before each invocation of the merge resolution program.
1624 The (fully qualified) refname from which to show notes when
1625 showing commit messages. The value of this variable can be set
1626 to a glob, in which case notes from all matching refs will be
1627 shown. You may also specify this configuration variable
1628 several times. A warning will be issued for refs that do not
1629 exist, but a glob that does not match any refs is silently
1632 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1633 environment variable, which must be a colon separated list of refs or
1636 The effective value of "core.notesRef" (possibly overridden by
1637 GIT_NOTES_REF) is also implicitly added to the list of refs to be
1640 notes.rewrite.<command>::
1641 When rewriting commits with <command> (currently `amend` or
1642 `rebase`) and this variable is set to `true`, git
1643 automatically copies your notes from the original to the
1644 rewritten commit. Defaults to `true`, but see
1645 "notes.rewriteRef" below.
1648 When copying notes during a rewrite (see the
1649 "notes.rewrite.<command>" option), determines what to do if
1650 the target commit already has a note. Must be one of
1651 `overwrite`, `concatenate`, or `ignore`. Defaults to
1654 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1655 environment variable.
1658 When copying notes during a rewrite, specifies the (fully
1659 qualified) ref whose notes should be copied. The ref may be a
1660 glob, in which case notes in all matching refs will be copied.
1661 You may also specify this configuration several times.
1663 Does not have a default value; you must configure this variable to
1664 enable note rewriting. Set it to `refs/notes/commits` to enable
1665 rewriting for the default commit notes.
1667 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1668 environment variable, which must be a colon separated list of refs or
1672 The size of the window used by linkgit:git-pack-objects[1] when no
1673 window size is given on the command line. Defaults to 10.
1676 The maximum delta depth used by linkgit:git-pack-objects[1] when no
1677 maximum depth is given on the command line. Defaults to 50.
1680 The window memory size limit used by linkgit:git-pack-objects[1]
1681 when no limit is given on the command line. The value can be
1682 suffixed with "k", "m", or "g". Defaults to 0, meaning no
1686 An integer -1..9, indicating the compression level for objects
1687 in a pack file. -1 is the zlib default. 0 means no
1688 compression, and 1..9 are various speed/size tradeoffs, 9 being
1689 slowest. If not set, defaults to core.compression. If that is
1690 not set, defaults to -1, the zlib default, which is "a default
1691 compromise between speed and compression (currently equivalent
1694 Note that changing the compression level will not automatically recompress
1695 all existing objects. You can force recompression by passing the -F option
1696 to linkgit:git-repack[1].
1698 pack.deltaCacheSize::
1699 The maximum memory in bytes used for caching deltas in
1700 linkgit:git-pack-objects[1] before writing them out to a pack.
1701 This cache is used to speed up the writing object phase by not
1702 having to recompute the final delta result once the best match
1703 for all objects is found. Repacking large repositories on machines
1704 which are tight with memory might be badly impacted by this though,
1705 especially if this cache pushes the system into swapping.
1706 A value of 0 means no limit. The smallest size of 1 byte may be
1707 used to virtually disable this cache. Defaults to 256 MiB.
1709 pack.deltaCacheLimit::
1710 The maximum size of a delta, that is cached in
1711 linkgit:git-pack-objects[1]. This cache is used to speed up the
1712 writing object phase by not having to recompute the final delta
1713 result once the best match for all objects is found. Defaults to 1000.
1716 Specifies the number of threads to spawn when searching for best
1717 delta matches. This requires that linkgit:git-pack-objects[1]
1718 be compiled with pthreads otherwise this option is ignored with a
1719 warning. This is meant to reduce packing time on multiprocessor
1720 machines. The required amount of memory for the delta search window
1721 is however multiplied by the number of threads.
1722 Specifying 0 will cause git to auto-detect the number of CPU's
1723 and set the number of threads accordingly.
1726 Specify the default pack index version. Valid values are 1 for
1727 legacy pack index used by Git versions prior to 1.5.2, and 2 for
1728 the new pack index with capabilities for packs larger than 4 GB
1729 as well as proper protection against the repacking of corrupted
1730 packs. Version 2 is the default. Note that version 2 is enforced
1731 and this config option ignored whenever the corresponding pack is
1734 If you have an old git that does not understand the version 2 `*.idx` file,
1735 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1736 that will copy both `*.pack` file and corresponding `*.idx` file from the
1737 other side may give you a repository that cannot be accessed with your
1738 older version of git. If the `*.pack` file is smaller than 2 GB, however,
1739 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1742 pack.packSizeLimit::
1743 The maximum size of a pack. This setting only affects
1744 packing to a file when repacking, i.e. the git:// protocol
1745 is unaffected. It can be overridden by the `--max-pack-size`
1746 option of linkgit:git-repack[1]. The minimum size allowed is
1747 limited to 1 MiB. The default is unlimited.
1748 Common unit suffixes of 'k', 'm', or 'g' are
1752 If the value is boolean, turns on or off pagination of the
1753 output of a particular git subcommand when writing to a tty.
1754 Otherwise, turns on pagination for the subcommand using the
1755 pager specified by the value of `pager.<cmd>`. If `--paginate`
1756 or `--no-pager` is specified on the command line, it takes
1757 precedence over this option. To disable pagination for all
1758 commands, set `core.pager` or `GIT_PAGER` to `cat`.
1761 Alias for a --pretty= format string, as specified in
1762 linkgit:git-log[1]. Any aliases defined here can be used just
1763 as the built-in pretty formats could. For example,
1764 running `git config pretty.changelog "format:* %H %s"`
1765 would cause the invocation `git log --pretty=changelog`
1766 to be equivalent to running `git log "--pretty=format:* %H %s"`.
1767 Note that an alias with the same name as a built-in format
1768 will be silently ignored.
1771 When true, rebase branches on top of the fetched branch, instead
1772 of merging the default branch from the default remote when "git
1773 pull" is run. See "branch.<name>.rebase" for setting this on a
1776 *NOTE*: this is a possibly dangerous operation; do *not* use
1777 it unless you understand the implications (see linkgit:git-rebase[1]
1781 The default merge strategy to use when pulling multiple branches
1785 The default merge strategy to use when pulling a single branch.
1788 Defines the action git push should take if no refspec is given
1789 on the command line, no refspec is configured in the remote, and
1790 no refspec is implied by any of the options given on the command
1791 line. Possible values are:
1794 * `nothing` - do not push anything.
1795 * `matching` - push all branches having the same name in both ends.
1796 This is for those who prepare all the branches into a publishable
1797 shape and then push them out with a single command. It is not
1798 appropriate for pushing into a repository shared by multiple users,
1799 since locally stalled branches will attempt a non-fast forward push
1800 if other users updated the branch.
1802 This is currently the default, but Git 2.0 will change the default
1804 * `upstream` - push the current branch to its upstream branch.
1805 With this, `git push` will update the same remote ref as the one which
1806 is merged by `git pull`, making `push` and `pull` symmetrical.
1807 See "branch.<name>.merge" for how to configure the upstream branch.
1808 * `simple` - like `upstream`, but refuses to push if the upstream
1809 branch's name is different from the local one. This is the safest
1810 option and is well-suited for beginners. It will become the default
1812 * `current` - push the current branch to a branch of the same name.
1815 The `simple`, `current` and `upstream` modes are for those who want to
1816 push out a single branch after finishing work, even when the other
1817 branches are not yet ready to be pushed out. If you are working with
1818 other people to push into the same shared repository, you would want
1819 to use one of these.
1822 Whether to show a diffstat of what changed upstream since the last
1823 rebase. False by default.
1826 If set to true enable '--autosquash' option by default.
1829 By default, git-receive-pack will run "git-gc --auto" after
1830 receiving data from git-push and updating refs. You can stop
1831 it by setting this variable to false.
1833 receive.fsckObjects::
1834 If it is set to true, git-receive-pack will check all received
1835 objects. It will abort in the case of a malformed object or a
1836 broken link. The result of an abort are only dangling objects.
1837 Defaults to false. If not set, the value of `transfer.fsckObjects`
1840 receive.unpackLimit::
1841 If the number of objects received in a push is below this
1842 limit then the objects will be unpacked into loose object
1843 files. However if the number of received objects equals or
1844 exceeds this limit then the received pack will be stored as
1845 a pack, after adding any missing delta bases. Storing the
1846 pack from a push can make the push operation complete faster,
1847 especially on slow filesystems. If not set, the value of
1848 `transfer.unpackLimit` is used instead.
1850 receive.denyDeletes::
1851 If set to true, git-receive-pack will deny a ref update that deletes
1852 the ref. Use this to prevent such a ref deletion via a push.
1854 receive.denyDeleteCurrent::
1855 If set to true, git-receive-pack will deny a ref update that
1856 deletes the currently checked out branch of a non-bare repository.
1858 receive.denyCurrentBranch::
1859 If set to true or "refuse", git-receive-pack will deny a ref update
1860 to the currently checked out branch of a non-bare repository.
1861 Such a push is potentially dangerous because it brings the HEAD
1862 out of sync with the index and working tree. If set to "warn",
1863 print a warning of such a push to stderr, but allow the push to
1864 proceed. If set to false or "ignore", allow such pushes with no
1865 message. Defaults to "refuse".
1867 receive.denyNonFastForwards::
1868 If set to true, git-receive-pack will deny a ref update which is
1869 not a fast-forward. Use this to prevent such an update via a push,
1870 even if that push is forced. This configuration variable is
1871 set when initializing a shared repository.
1873 receive.updateserverinfo::
1874 If set to true, git-receive-pack will run git-update-server-info
1875 after receiving data from git-push and updating refs.
1878 The URL of a remote repository. See linkgit:git-fetch[1] or
1879 linkgit:git-push[1].
1881 remote.<name>.pushurl::
1882 The push URL of a remote repository. See linkgit:git-push[1].
1884 remote.<name>.proxy::
1885 For remotes that require curl (http, https and ftp), the URL to
1886 the proxy to use for that remote. Set to the empty string to
1887 disable proxying for that remote.
1889 remote.<name>.fetch::
1890 The default set of "refspec" for linkgit:git-fetch[1]. See
1891 linkgit:git-fetch[1].
1893 remote.<name>.push::
1894 The default set of "refspec" for linkgit:git-push[1]. See
1895 linkgit:git-push[1].
1897 remote.<name>.mirror::
1898 If true, pushing to this remote will automatically behave
1899 as if the `--mirror` option was given on the command line.
1901 remote.<name>.skipDefaultUpdate::
1902 If true, this remote will be skipped by default when updating
1903 using linkgit:git-fetch[1] or the `update` subcommand of
1904 linkgit:git-remote[1].
1906 remote.<name>.skipFetchAll::
1907 If true, this remote will be skipped by default when updating
1908 using linkgit:git-fetch[1] or the `update` subcommand of
1909 linkgit:git-remote[1].
1911 remote.<name>.receivepack::
1912 The default program to execute on the remote side when pushing. See
1913 option \--receive-pack of linkgit:git-push[1].
1915 remote.<name>.uploadpack::
1916 The default program to execute on the remote side when fetching. See
1917 option \--upload-pack of linkgit:git-fetch-pack[1].
1919 remote.<name>.tagopt::
1920 Setting this value to \--no-tags disables automatic tag following when
1921 fetching from remote <name>. Setting it to \--tags will fetch every
1922 tag from remote <name>, even if they are not reachable from remote
1923 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
1924 override this setting. See options \--tags and \--no-tags of
1925 linkgit:git-fetch[1].
1928 Setting this to a value <vcs> will cause git to interact with
1929 the remote with the git-remote-<vcs> helper.
1932 The list of remotes which are fetched by "git remote update
1933 <group>". See linkgit:git-remote[1].
1935 repack.usedeltabaseoffset::
1936 By default, linkgit:git-repack[1] creates packs that use
1937 delta-base offset. If you need to share your repository with
1938 git older than version 1.4.4, either directly or via a dumb
1939 protocol such as http, then you need to set this option to
1940 "false" and repack. Access from old git versions over the
1941 native protocol are unaffected by this option.
1944 When set to true, `git-rerere` updates the index with the
1945 resulting contents after it cleanly resolves conflicts using
1946 previously recorded resolution. Defaults to false.
1949 Activate recording of resolved conflicts, so that identical
1950 conflict hunks can be resolved automatically, should they be
1951 encountered again. By default, linkgit:git-rerere[1] is
1952 enabled if there is an `rr-cache` directory under the
1953 `$GIT_DIR`, e.g. if "rerere" was previously used in the
1956 sendemail.identity::
1957 A configuration identity. When given, causes values in the
1958 'sendemail.<identity>' subsection to take precedence over
1959 values in the 'sendemail' section. The default identity is
1960 the value of 'sendemail.identity'.
1962 sendemail.smtpencryption::
1963 See linkgit:git-send-email[1] for description. Note that this
1964 setting is not subject to the 'identity' mechanism.
1967 Deprecated alias for 'sendemail.smtpencryption = ssl'.
1969 sendemail.<identity>.*::
1970 Identity-specific versions of the 'sendemail.*' parameters
1971 found below, taking precedence over those when the this
1972 identity is selected, through command-line or
1973 'sendemail.identity'.
1975 sendemail.aliasesfile::
1976 sendemail.aliasfiletype::
1980 sendemail.chainreplyto::
1982 sendemail.envelopesender::
1984 sendemail.multiedit::
1985 sendemail.signedoffbycc::
1986 sendemail.smtppass::
1987 sendemail.suppresscc::
1988 sendemail.suppressfrom::
1990 sendemail.smtpdomain::
1991 sendemail.smtpserver::
1992 sendemail.smtpserverport::
1993 sendemail.smtpserveroption::
1994 sendemail.smtpuser::
1996 sendemail.validate::
1997 See linkgit:git-send-email[1] for description.
1999 sendemail.signedoffcc::
2000 Deprecated alias for 'sendemail.signedoffbycc'.
2002 showbranch.default::
2003 The default set of branches for linkgit:git-show-branch[1].
2004 See linkgit:git-show-branch[1].
2006 status.relativePaths::
2007 By default, linkgit:git-status[1] shows paths relative to the
2008 current directory. Setting this variable to `false` shows paths
2009 relative to the repository root (this was the default for git
2012 status.showUntrackedFiles::
2013 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
2014 files which are not currently tracked by Git. Directories which
2015 contain only untracked files, are shown with the directory name
2016 only. Showing untracked files means that Git needs to lstat() all
2017 all the files in the whole repository, which might be slow on some
2018 systems. So, this variable controls how the commands displays
2019 the untracked files. Possible values are:
2022 * `no` - Show no untracked files.
2023 * `normal` - Show untracked files and directories.
2024 * `all` - Show also individual files in untracked directories.
2027 If this variable is not specified, it defaults to 'normal'.
2028 This variable can be overridden with the -u|--untracked-files option
2029 of linkgit:git-status[1] and linkgit:git-commit[1].
2031 status.submodulesummary::
2033 If this is set to a non zero number or true (identical to -1 or an
2034 unlimited number), the submodule summary will be enabled and a
2035 summary of commits for modified submodules will be shown (see
2036 --summary-limit option of linkgit:git-submodule[1]).
2038 submodule.<name>.path::
2039 submodule.<name>.url::
2040 submodule.<name>.update::
2041 The path within this project, URL, and the updating strategy
2042 for a submodule. These variables are initially populated
2043 by 'git submodule init'; edit them to override the
2044 URL and other values found in the `.gitmodules` file. See
2045 linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
2047 submodule.<name>.branch::
2048 The remote branch name for a submodule, used by `git submodule
2049 update --remote`. Set this option to override the value found in
2050 the `.gitmodules` file. See linkgit:git-submodule[1] and
2051 linkgit:gitmodules[5] for details.
2053 submodule.<name>.fetchRecurseSubmodules::
2054 This option can be used to control recursive fetching of this
2055 submodule. It can be overridden by using the --[no-]recurse-submodules
2056 command line option to "git fetch" and "git pull".
2057 This setting will override that from in the linkgit:gitmodules[5]
2060 submodule.<name>.ignore::
2061 Defines under what circumstances "git status" and the diff family show
2062 a submodule as modified. When set to "all", it will never be considered
2063 modified, "dirty" will ignore all changes to the submodules work tree and
2064 takes only differences between the HEAD of the submodule and the commit
2065 recorded in the superproject into account. "untracked" will additionally
2066 let submodules with modified tracked files in their work tree show up.
2067 Using "none" (the default when this option is not set) also shows
2068 submodules that have untracked files in their work tree as changed.
2069 This setting overrides any setting made in .gitmodules for this submodule,
2070 both settings can be overridden on the command line by using the
2071 "--ignore-submodules" option.
2074 This variable can be used to restrict the permission bits of
2075 tar archive entries. The default is 0002, which turns off the
2076 world write bit. The special value "user" indicates that the
2077 archiving user's umask will be used instead. See umask(2) and
2078 linkgit:git-archive[1].
2080 transfer.fsckObjects::
2081 When `fetch.fsckObjects` or `receive.fsckObjects` are
2082 not set, the value of this variable is used instead.
2085 transfer.unpackLimit::
2086 When `fetch.unpackLimit` or `receive.unpackLimit` are
2087 not set, the value of this variable is used instead.
2088 The default value is 100.
2090 url.<base>.insteadOf::
2091 Any URL that starts with this value will be rewritten to
2092 start, instead, with <base>. In cases where some site serves a
2093 large number of repositories, and serves them with multiple
2094 access methods, and some users need to use different access
2095 methods, this feature allows people to specify any of the
2096 equivalent URLs and have git automatically rewrite the URL to
2097 the best alternative for the particular user, even for a
2098 never-before-seen repository on the site. When more than one
2099 insteadOf strings match a given URL, the longest match is used.
2101 url.<base>.pushInsteadOf::
2102 Any URL that starts with this value will not be pushed to;
2103 instead, it will be rewritten to start with <base>, and the
2104 resulting URL will be pushed to. In cases where some site serves
2105 a large number of repositories, and serves them with multiple
2106 access methods, some of which do not allow push, this feature
2107 allows people to specify a pull-only URL and have git
2108 automatically use an appropriate URL to push, even for a
2109 never-before-seen repository on the site. When more than one
2110 pushInsteadOf strings match a given URL, the longest match is
2111 used. If a remote has an explicit pushurl, git will ignore this
2112 setting for that remote.
2115 Your email address to be recorded in any newly created commits.
2116 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
2117 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
2120 Your full name to be recorded in any newly created commits.
2121 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
2122 environment variables. See linkgit:git-commit-tree[1].
2125 If linkgit:git-tag[1] is not selecting the key you want it to
2126 automatically when creating a signed tag, you can override the
2127 default selection with this variable. This option is passed
2128 unchanged to gpg's --local-user parameter, so you may specify a key
2129 using any method that gpg supports.
2132 Specify a web browser that may be used by some commands.
2133 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]