4 The Git configuration file contains a number of variables that affect
5 the Git commands' 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', 'pushAlreadyExists',
147 'pushFetchFirst', and 'pushNeedsForce'
150 Advice shown when linkgit:git-push[1] fails due to a
151 non-fast-forward update to the current branch.
153 Advice to set 'push.default' to 'upstream' or 'current'
154 when you ran linkgit:git-push[1] and pushed 'matching
155 refs' by default (i.e. you did not provide an explicit
156 refspec, and no 'push.default' configuration was set)
157 and it resulted in a non-fast-forward error.
159 Advice shown when you ran linkgit:git-push[1] and pushed
160 'matching refs' explicitly (i.e. you used ':', or
161 specified a refspec that isn't your current branch) and
162 it resulted in a non-fast-forward error.
164 Shown when linkgit:git-push[1] rejects an update that
165 does not qualify for fast-forwarding (e.g., a tag.)
167 Shown when linkgit:git-push[1] rejects an update that
168 tries to overwrite a remote ref that points at an
169 object we do not have.
171 Shown when linkgit:git-push[1] rejects an update that
172 tries to overwrite a remote ref that points at an
173 object that is not a committish, or make the remote
174 ref point at an object that is not a committish.
176 Show directions on how to proceed from the current
177 state in the output of linkgit:git-status[1], in
178 the template shown when writing commit messages in
179 linkgit:git-commit[1], and in the help message shown
180 by linkgit:git-checkout[1] when switching branch.
182 Advise to consider using the `-u` option to linkgit:git-status[1]
183 when the command takes more than 2 seconds to enumerate untracked
186 Advice shown when linkgit:git-merge[1] refuses to
187 merge to avoid overwriting local changes.
189 Advice shown by various commands when conflicts
190 prevent the operation from being performed.
192 Advice on how to set your identity configuration when
193 your information is guessed from the system username and
196 Advice shown when you used linkgit:git-checkout[1] to
197 move to the detach HEAD state, to instruct how to create
198 a local branch after the fact.
200 Advice that shows the location of the patch file when
201 linkgit:git-am[1] fails to apply it.
203 In case of failure in the output of linkgit:git-rm[1],
204 show directions on how to proceed from the current state.
208 If false, the executable bit differences between the index and
209 the working tree are ignored; useful on broken filesystems like FAT.
210 See linkgit:git-update-index[1].
212 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
213 will probe and set core.fileMode false if appropriate when the
214 repository is created.
217 (Windows-only) If true (which is the default), mark newly-created
218 directories and files whose name starts with a dot as hidden.
219 If 'dotGitOnly', only the .git/ directory is hidden, but no other
220 files starting with a dot.
223 If true, this option enables various workarounds to enable
224 Git to work better on filesystems that are not case sensitive,
225 like FAT. For example, if a directory listing finds
226 "makefile" when Git expects "Makefile", Git will assume
227 it is really the same file, and continue to remember it as
230 The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
231 will probe and set core.ignorecase true if appropriate when the repository
234 core.precomposeunicode::
235 This option is only used by Mac OS implementation of Git.
236 When core.precomposeunicode=true, Git reverts the unicode decomposition
237 of filenames done by Mac OS. This is useful when sharing a repository
238 between Mac OS and Linux or Windows.
239 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
240 When false, file names are handled fully transparent by Git,
241 which is backward compatible with older versions of Git.
244 If false, the ctime differences between the index and the
245 working tree are ignored; useful when the inode change time
246 is regularly modified by something outside Git (file system
247 crawlers and some backup systems).
248 See linkgit:git-update-index[1]. True by default.
251 Determines which stat fields to match between the index
252 and work tree. The user can set this to 'default' or
253 'minimal'. Default (or explicitly 'default'), is to check
254 all fields, including the sub-second part of mtime and ctime.
257 The commands that output paths (e.g. 'ls-files',
258 'diff'), when not given the `-z` option, will quote
259 "unusual" characters in the pathname by enclosing the
260 pathname in a double-quote pair and with backslashes the
261 same way strings in C source code are quoted. If this
262 variable is set to false, the bytes higher than 0x80 are
263 not quoted but output as verbatim. Note that double
264 quote, backslash and control characters are always
265 quoted without `-z` regardless of the setting of this
269 Sets the line ending type to use in the working directory for
270 files that have the `text` property set. Alternatives are
271 'lf', 'crlf' and 'native', which uses the platform's native
272 line ending. The default value is `native`. See
273 linkgit:gitattributes[5] for more information on end-of-line
277 If true, makes Git check if converting `CRLF` is reversible when
278 end-of-line conversion is active. Git will verify if a command
279 modifies a file in the work tree either directly or indirectly.
280 For example, committing a file followed by checking out the
281 same file should yield the original file in the work tree. If
282 this is not the case for the current setting of
283 `core.autocrlf`, Git will reject the file. The variable can
284 be set to "warn", in which case Git will only warn about an
285 irreversible conversion but continue the operation.
287 CRLF conversion bears a slight chance of corrupting data.
288 When it is enabled, Git will convert CRLF to LF during commit and LF to
289 CRLF during checkout. A file that contains a mixture of LF and
290 CRLF before the commit cannot be recreated by Git. For text
291 files this is the right thing to do: it corrects line endings
292 such that we have only LF line endings in the repository.
293 But for binary files that are accidentally classified as text the
294 conversion can corrupt data.
296 If you recognize such corruption early you can easily fix it by
297 setting the conversion type explicitly in .gitattributes. Right
298 after committing you still have the original file in your work
299 tree and this file is not yet corrupted. You can explicitly tell
300 Git that this file is binary and Git will handle the file
303 Unfortunately, the desired effect of cleaning up text files with
304 mixed line endings and the undesired effect of corrupting binary
305 files cannot be distinguished. In both cases CRLFs are removed
306 in an irreversible way. For text files this is the right thing
307 to do because CRLFs are line endings, while for binary files
308 converting CRLFs corrupts data.
310 Note, this safety check does not mean that a checkout will generate a
311 file identical to the original file for a different setting of
312 `core.eol` and `core.autocrlf`, but only for the current one. For
313 example, a text file with `LF` would be accepted with `core.eol=lf`
314 and could later be checked out with `core.eol=crlf`, in which case the
315 resulting file would contain `CRLF`, although the original file
316 contained `LF`. However, in both work trees the line endings would be
317 consistent, that is either all `LF` or all `CRLF`, but never mixed. A
318 file with mixed line endings would be reported by the `core.safecrlf`
322 Setting this variable to "true" is almost the same as setting
323 the `text` attribute to "auto" on all files except that text
324 files are not guaranteed to be normalized: files that contain
325 `CRLF` in the repository will not be touched. Use this
326 setting if you want to have `CRLF` line endings in your
327 working directory even though the repository does not have
328 normalized line endings. This variable can be set to 'input',
329 in which case no output conversion is performed.
332 If false, symbolic links are checked out as small plain files that
333 contain the link text. linkgit:git-update-index[1] and
334 linkgit:git-add[1] will not change the recorded type to regular
335 file. Useful on filesystems like FAT that do not support
338 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
339 will probe and set core.symlinks false if appropriate when the repository
343 A "proxy command" to execute (as 'command host port') instead
344 of establishing direct connection to the remote server when
345 using the Git protocol for fetching. If the variable value is
346 in the "COMMAND for DOMAIN" format, the command is applied only
347 on hostnames ending with the specified domain string. This variable
348 may be set multiple times and is matched in the given order;
349 the first match wins.
351 Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
352 (which always applies universally, without the special "for"
355 The special string `none` can be used as the proxy command to
356 specify that no proxy be used for a given domain pattern.
357 This is useful for excluding servers inside a firewall from
358 proxy use, while defaulting to a common proxy for external domains.
361 If true, commands which modify both the working tree and the index
362 will mark the updated paths with the "assume unchanged" bit in the
363 index. These marked files are then assumed to stay unchanged in the
364 working tree, until you mark them otherwise manually - Git will not
365 detect the file changes by lstat() calls. This is useful on systems
366 where those are very slow, such as Microsoft Windows.
367 See linkgit:git-update-index[1].
370 core.preferSymlinkRefs::
371 Instead of the default "symref" format for HEAD
372 and other symbolic reference files, use symbolic links.
373 This is sometimes needed to work with old scripts that
374 expect HEAD to be a symbolic link.
377 If true this repository is assumed to be 'bare' and has no
378 working directory associated with it. If this is the case a
379 number of commands that require a working directory will be
380 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
382 This setting is automatically guessed by linkgit:git-clone[1] or
383 linkgit:git-init[1] when the repository was created. By default a
384 repository that ends in "/.git" is assumed to be not bare (bare =
385 false), while all other repositories are assumed to be bare (bare
389 Set the path to the root of the working tree.
390 This can be overridden by the GIT_WORK_TREE environment
391 variable and the '--work-tree' command line option.
392 The value can be an absolute path or relative to the path to
393 the .git directory, which is either specified by --git-dir
394 or GIT_DIR, or automatically discovered.
395 If --git-dir or GIT_DIR is specified but none of
396 --work-tree, GIT_WORK_TREE and core.worktree is specified,
397 the current working directory is regarded as the top level
398 of your working tree.
400 Note that this variable is honored even when set in a configuration
401 file in a ".git" subdirectory of a directory and its value differs
402 from the latter directory (e.g. "/path/to/.git/config" has
403 core.worktree set to "/different/path"), which is most likely a
404 misconfiguration. Running Git commands in the "/path/to" directory will
405 still use "/different/path" as the root of the work tree and can cause
406 confusion unless you know what you are doing (e.g. you are creating a
407 read-only snapshot of the same index to a location different from the
408 repository's usual working tree).
410 core.logAllRefUpdates::
411 Enable the reflog. Updates to a ref <ref> is logged to the file
412 "$GIT_DIR/logs/<ref>", by appending the new and old
413 SHA-1, the date/time and the reason of the update, but
414 only when the file exists. If this configuration
415 variable is set to true, missing "$GIT_DIR/logs/<ref>"
416 file is automatically created for branch heads (i.e. under
417 refs/heads/), remote refs (i.e. under refs/remotes/),
418 note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
420 This information can be used to determine what commit
421 was the tip of a branch "2 days ago".
423 This value is true by default in a repository that has
424 a working directory associated with it, and false by
425 default in a bare repository.
427 core.repositoryFormatVersion::
428 Internal variable identifying the repository format and layout
431 core.sharedRepository::
432 When 'group' (or 'true'), the repository is made shareable between
433 several users in a group (making sure all the files and objects are
434 group-writable). When 'all' (or 'world' or 'everybody'), the
435 repository will be readable by all users, additionally to being
436 group-shareable. When 'umask' (or 'false'), Git will use permissions
437 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
438 files in the repository will have this mode value. '0xxx' will override
439 user's umask value (whereas the other options will only override
440 requested parts of the user's umask value). Examples: '0660' will make
441 the repo read/write-able for the owner and group, but inaccessible to
442 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
443 repository that is group-readable but not group-writable.
444 See linkgit:git-init[1]. False by default.
446 core.warnAmbiguousRefs::
447 If true, Git will warn you if the ref name you passed it is ambiguous
448 and might match multiple refs in the repository. True by default.
451 An integer -1..9, indicating a default compression level.
452 -1 is the zlib default. 0 means no compression,
453 and 1..9 are various speed/size tradeoffs, 9 being slowest.
454 If set, this provides a default to other compression variables,
455 such as 'core.loosecompression' and 'pack.compression'.
457 core.loosecompression::
458 An integer -1..9, indicating the compression level for objects that
459 are not in a pack file. -1 is the zlib default. 0 means no
460 compression, and 1..9 are various speed/size tradeoffs, 9 being
461 slowest. If not set, defaults to core.compression. If that is
462 not set, defaults to 1 (best speed).
464 core.packedGitWindowSize::
465 Number of bytes of a pack file to map into memory in a
466 single mapping operation. Larger window sizes may allow
467 your system to process a smaller number of large pack files
468 more quickly. Smaller window sizes will negatively affect
469 performance due to increased calls to the operating system's
470 memory manager, but may improve performance when accessing
471 a large number of large pack files.
473 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
474 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
475 be reasonable for all users/operating systems. You probably do
476 not need to adjust this value.
478 Common unit suffixes of 'k', 'm', or 'g' are supported.
480 core.packedGitLimit::
481 Maximum number of bytes to map simultaneously into memory
482 from pack files. If Git needs to access more than this many
483 bytes at once to complete an operation it will unmap existing
484 regions to reclaim virtual address space within the process.
486 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
487 This should be reasonable for all users/operating systems, except on
488 the largest projects. You probably do not need to adjust this value.
490 Common unit suffixes of 'k', 'm', or 'g' are supported.
492 core.deltaBaseCacheLimit::
493 Maximum number of bytes to reserve for caching base objects
494 that may be referenced by multiple deltified objects. By storing the
495 entire decompressed base objects in a cache Git is able
496 to avoid unpacking and decompressing frequently used base
497 objects multiple times.
499 Default is 16 MiB on all platforms. This should be reasonable
500 for all users/operating systems, except on the largest projects.
501 You probably do not need to adjust this value.
503 Common unit suffixes of 'k', 'm', or 'g' are supported.
505 core.bigFileThreshold::
506 Files larger than this size are stored deflated, without
507 attempting delta compression. Storing large files without
508 delta compression avoids excessive memory usage, at the
509 slight expense of increased disk usage.
511 Default is 512 MiB on all platforms. This should be reasonable
512 for most projects as source code and other text files can still
513 be delta compressed, but larger binary media files won't be.
515 Common unit suffixes of 'k', 'm', or 'g' are supported.
518 In addition to '.gitignore' (per-directory) and
519 '.git/info/exclude', Git looks into this file for patterns
520 of files which are not meant to be tracked. "`~/`" is expanded
521 to the value of `$HOME` and "`~user/`" to the specified user's
522 home directory. Its default value is $XDG_CONFIG_HOME/git/ignore.
523 If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore
524 is used instead. See linkgit:gitignore[5].
527 Some commands (e.g. svn and http interfaces) that interactively
528 ask for a password can be told to use an external program given
529 via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
530 environment variable. If not set, fall back to the value of the
531 'SSH_ASKPASS' environment variable or, failing that, a simple password
532 prompt. The external program shall be given a suitable prompt as
533 command line argument and write the password on its STDOUT.
535 core.attributesfile::
536 In addition to '.gitattributes' (per-directory) and
537 '.git/info/attributes', Git looks into this file for attributes
538 (see linkgit:gitattributes[5]). Path expansions are made the same
539 way as for `core.excludesfile`. Its default value is
540 $XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not
541 set or empty, $HOME/.config/git/attributes is used instead.
544 Commands such as `commit` and `tag` that lets you edit
545 messages by launching an editor uses the value of this
546 variable when it is set, and the environment variable
547 `GIT_EDITOR` is not set. See linkgit:git-var[1].
550 Commands such as `commit` and `tag` that lets you edit
551 messages consider a line that begins with this character
552 commented, and removes them after the editor returns
556 Text editor used by `git rebase -i` for editing the rebase instruction file.
557 The value is meant to be interpreted by the shell when it is used.
558 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
559 When not configured the default commit message editor is used instead.
562 The command that Git will use to paginate output. Can
563 be overridden with the `GIT_PAGER` environment
564 variable. Note that Git sets the `LESS` environment
565 variable to `FRSX` if it is unset when it runs the
566 pager. One can change these settings by setting the
567 `LESS` variable to some other value. Alternately,
568 these settings can be overridden on a project or
569 global basis by setting the `core.pager` option.
570 Setting `core.pager` has no effect on the `LESS`
571 environment variable behaviour above, so if you want
572 to override Git's default settings this way, you need
573 to be explicit. For example, to disable the S option
574 in a backward compatible manner, set `core.pager`
575 to `less -+S`. This will be passed to the shell by
576 Git, which will translate the final command to
577 `LESS=FRSX less -+S`.
580 A comma separated list of common whitespace problems to
581 notice. 'git diff' will use `color.diff.whitespace` to
582 highlight them, and 'git apply --whitespace=error' will
583 consider them as errors. You can prefix `-` to disable
584 any of them (e.g. `-trailing-space`):
586 * `blank-at-eol` treats trailing whitespaces at the end of the line
587 as an error (enabled by default).
588 * `space-before-tab` treats a space character that appears immediately
589 before a tab character in the initial indent part of the line as an
590 error (enabled by default).
591 * `indent-with-non-tab` treats a line that is indented with space
592 characters instead of the equivalent tabs as an error (not enabled by
594 * `tab-in-indent` treats a tab character in the initial indent part of
595 the line as an error (not enabled by default).
596 * `blank-at-eof` treats blank lines added at the end of file as an error
597 (enabled by default).
598 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
600 * `cr-at-eol` treats a carriage-return at the end of line as
601 part of the line terminator, i.e. with it, `trailing-space`
602 does not trigger if the character before such a carriage-return
603 is not a whitespace (not enabled by default).
604 * `tabwidth=<n>` tells how many character positions a tab occupies; this
605 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
606 errors. The default tab width is 8. Allowed values are 1 to 63.
608 core.fsyncobjectfiles::
609 This boolean will enable 'fsync()' when writing object files.
611 This is a total waste of time and effort on a filesystem that orders
612 data writes properly, but can be useful for filesystems that do not use
613 journalling (traditional UNIX filesystems) or that only journal metadata
614 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
617 Enable parallel index preload for operations like 'git diff'
619 This can speed up operations like 'git diff' and 'git status' especially
620 on filesystems like NFS that have weak caching semantics and thus
621 relatively high IO latencies. With this set to 'true', Git will do the
622 index comparison to the filesystem data in parallel, allowing
626 You can set this to 'link', in which case a hardlink followed by
627 a delete of the source are used to make sure that object creation
628 will not overwrite existing objects.
630 On some file system/operating system combinations, this is unreliable.
631 Set this config setting to 'rename' there; However, This will remove the
632 check that makes sure that existing object files will not get overwritten.
635 When showing commit messages, also show notes which are stored in
636 the given ref. The ref must be fully qualified. If the given
637 ref does not exist, it is not an error but means that no
638 notes should be printed.
640 This setting defaults to "refs/notes/commits", and it can be overridden by
641 the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1].
643 core.sparseCheckout::
644 Enable "sparse checkout" feature. See section "Sparse checkout" in
645 linkgit:git-read-tree[1] for more information.
648 Set the length object names are abbreviated to. If unspecified,
649 many commands abbreviate to 7 hexdigits, which may not be enough
650 for abbreviated object names to stay unique for sufficiently long
655 Tells 'git add' to continue adding files when some files cannot be
656 added due to indexing errors. Equivalent to the '--ignore-errors'
657 option of linkgit:git-add[1]. Older versions of Git accept only
658 `add.ignore-errors`, which does not follow the usual naming
659 convention for configuration variables. Newer versions of Git
660 honor `add.ignoreErrors` as well.
663 Command aliases for the linkgit:git[1] command wrapper - e.g.
664 after defining "alias.last = cat-file commit HEAD", the invocation
665 "git last" is equivalent to "git cat-file commit HEAD". To avoid
666 confusion and troubles with script usage, aliases that
667 hide existing Git commands are ignored. Arguments are split by
668 spaces, the usual shell quoting and escaping is supported.
669 quote pair and a backslash can be used to quote them.
671 If the alias expansion is prefixed with an exclamation point,
672 it will be treated as a shell command. For example, defining
673 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
674 "git new" is equivalent to running the shell command
675 "gitk --all --not ORIG_HEAD". Note that shell commands will be
676 executed from the top-level directory of a repository, which may
677 not necessarily be the current directory.
678 'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
679 from the original current directory. See linkgit:git-rev-parse[1].
682 If true, git-am will call git-mailsplit for patches in mbox format
683 with parameter '--keep-cr'. In this case git-mailsplit will
684 not remove `\r` from lines ending with `\r\n`. Can be overridden
685 by giving '--no-keep-cr' from the command line.
686 See linkgit:git-am[1], linkgit:git-mailsplit[1].
688 apply.ignorewhitespace::
689 When set to 'change', tells 'git apply' to ignore changes in
690 whitespace, in the same way as the '--ignore-space-change'
692 When set to one of: no, none, never, false tells 'git apply' to
693 respect all whitespace differences.
694 See linkgit:git-apply[1].
697 Tells 'git apply' how to handle whitespaces, in the same way
698 as the '--whitespace' option. See linkgit:git-apply[1].
700 branch.autosetupmerge::
701 Tells 'git branch' and 'git checkout' to set up new branches
702 so that linkgit:git-pull[1] will appropriately merge from the
703 starting point branch. Note that even if this option is not set,
704 this behavior can be chosen per-branch using the `--track`
705 and `--no-track` options. The valid settings are: `false` -- no
706 automatic setup is done; `true` -- automatic setup is done when the
707 starting point is a remote-tracking branch; `always` --
708 automatic setup is done when the starting point is either a
709 local branch or remote-tracking
710 branch. This option defaults to true.
712 branch.autosetuprebase::
713 When a new branch is created with 'git branch' or 'git checkout'
714 that tracks another branch, this variable tells Git to set
715 up pull to rebase instead of merge (see "branch.<name>.rebase").
716 When `never`, rebase is never automatically set to true.
717 When `local`, rebase is set to true for tracked branches of
718 other local branches.
719 When `remote`, rebase is set to true for tracked branches of
720 remote-tracking branches.
721 When `always`, rebase will be set to true for all tracking
723 See "branch.autosetupmerge" for details on how to set up a
724 branch to track another branch.
725 This option defaults to never.
727 branch.<name>.remote::
728 When on branch <name>, it tells 'git fetch' and 'git push'
729 which remote to fetch from/push to. The remote to push to
730 may be overridden with `remote.pushdefault` (for all branches).
731 The remote to push to, for the current branch, may be further
732 overridden by `branch.<name>.pushremote`. If no remote is
733 configured, or if you are not on any branch, it defaults to
734 `origin` for fetching and `remote.pushdefault` for pushing.
736 branch.<name>.pushremote::
737 When on branch <name>, it overrides `branch.<name>.remote` for
738 pushing. It also overrides `remote.pushdefault` for pushing
739 from branch <name>. When you pull from one place (e.g. your
740 upstream) and push to another place (e.g. your own publishing
741 repository), you would want to set `remote.pushdefault` to
742 specify the remote to push to for all branches, and use this
743 option to override it for a specific branch.
745 branch.<name>.merge::
746 Defines, together with branch.<name>.remote, the upstream branch
747 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
748 branch to merge and can also affect 'git push' (see push.default).
749 When in branch <name>, it tells 'git fetch' the default
750 refspec to be marked for merging in FETCH_HEAD. The value is
751 handled like the remote part of a refspec, and must match a
752 ref which is fetched from the remote given by
753 "branch.<name>.remote".
754 The merge information is used by 'git pull' (which at first calls
755 'git fetch') to lookup the default branch for merging. Without
756 this option, 'git pull' defaults to merge the first refspec fetched.
757 Specify multiple values to get an octopus merge.
758 If you wish to setup 'git pull' so that it merges into <name> from
759 another branch in the local repository, you can point
760 branch.<name>.merge to the desired branch, and use the special setting
761 `.` (a period) for branch.<name>.remote.
763 branch.<name>.mergeoptions::
764 Sets default options for merging into branch <name>. The syntax and
765 supported options are the same as those of linkgit:git-merge[1], but
766 option values containing whitespace characters are currently not
769 branch.<name>.rebase::
770 When true, rebase the branch <name> on top of the fetched branch,
771 instead of merging the default branch from the default remote when
772 "git pull" is run. See "pull.rebase" for doing this in a non
773 branch-specific manner.
774 When the value is `interactive`, the rebase is run in interactive mode.
776 *NOTE*: this is a possibly dangerous operation; do *not* use
777 it unless you understand the implications (see linkgit:git-rebase[1]
780 branch.<name>.description::
781 Branch description, can be edited with
782 `git branch --edit-description`. Branch description is
783 automatically added in the format-patch cover letter or
784 request-pull summary.
787 Specify the command to invoke the specified browser. The
788 specified command is evaluated in shell with the URLs passed
789 as arguments. (See linkgit:git-web{litdd}browse[1].)
791 browser.<tool>.path::
792 Override the path for the given tool that may be used to
793 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
794 working repository in gitweb (see linkgit:git-instaweb[1]).
797 A boolean to make git-clean do nothing unless given -f
798 or -n. Defaults to true.
801 A boolean to enable/disable color in the output of
802 linkgit:git-branch[1]. May be set to `always`,
803 `false` (or `never`) or `auto` (or `true`), in which case colors are used
804 only when the output is to a terminal. Defaults to false.
806 color.branch.<slot>::
807 Use customized color for branch coloration. `<slot>` is one of
808 `current` (the current branch), `local` (a local branch),
809 `remote` (a remote-tracking branch in refs/remotes/),
810 `upstream` (upstream tracking branch), `plain` (other
813 The value for these configuration variables is a list of colors (at most
814 two) and attributes (at most one), separated by spaces. The colors
815 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
816 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
817 `blink` and `reverse`. The first color given is the foreground; the
818 second is the background. The position of the attribute, if any,
822 Whether to use ANSI escape sequences to add color to patches.
823 If this is set to `always`, linkgit:git-diff[1],
824 linkgit:git-log[1], and linkgit:git-show[1] will use color
825 for all patches. If it is set to `true` or `auto`, those
826 commands will only use color when output is to the terminal.
829 This does not affect linkgit:git-format-patch[1] nor the
830 'git-diff-{asterisk}' plumbing commands. Can be overridden on the
831 command line with the `--color[=<when>]` option.
834 Use customized color for diff colorization. `<slot>` specifies
835 which part of the patch to use the specified color, and is one
836 of `plain` (context text), `meta` (metainformation), `frag`
837 (hunk header), 'func' (function in hunk header), `old` (removed lines),
838 `new` (added lines), `commit` (commit headers), or `whitespace`
839 (highlighting whitespace errors). The values of these variables may be
840 specified as in color.branch.<slot>.
842 color.decorate.<slot>::
843 Use customized color for 'git log --decorate' output. `<slot>` is one
844 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
845 branches, remote-tracking branches, tags, stash and HEAD, respectively.
848 When set to `always`, always highlight matches. When `false` (or
849 `never`), never. When set to `true` or `auto`, use color only
850 when the output is written to the terminal. Defaults to `false`.
853 Use customized color for grep colorization. `<slot>` specifies which
854 part of the line to use the specified color, and is one of
858 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
860 filename prefix (when not using `-h`)
862 function name lines (when using `-p`)
864 line number prefix (when using `-n`)
868 non-matching text in selected lines
870 separators between fields on a line (`:`, `-`, and `=`)
871 and between hunks (`--`)
874 The values of these variables may be specified as in color.branch.<slot>.
877 When set to `always`, always use colors for interactive prompts
878 and displays (such as those used by "git-add --interactive" and
879 "git-clean --interactive"). When false (or `never`), never.
880 When set to `true` or `auto`, use colors only when the output is
881 to the terminal. Defaults to false.
883 color.interactive.<slot>::
884 Use customized color for 'git add --interactive' and 'git clean
885 --interactive' output. `<slot>` may be `prompt`, `header`, `help`
886 or `error`, for four distinct types of normal output from
887 interactive commands. The values of these variables may be
888 specified as in color.branch.<slot>.
891 A boolean to enable/disable colored output when the pager is in
892 use (default is true).
895 A boolean to enable/disable color in the output of
896 linkgit:git-show-branch[1]. May be set to `always`,
897 `false` (or `never`) or `auto` (or `true`), in which case colors are used
898 only when the output is to a terminal. Defaults to false.
901 A boolean to enable/disable color in the output of
902 linkgit:git-status[1]. May be set to `always`,
903 `false` (or `never`) or `auto` (or `true`), in which case colors are used
904 only when the output is to a terminal. Defaults to false.
906 color.status.<slot>::
907 Use customized color for status colorization. `<slot>` is
908 one of `header` (the header text of the status message),
909 `added` or `updated` (files which are added but not committed),
910 `changed` (files which are changed but not added in the index),
911 `untracked` (files which are not tracked by Git),
912 `branch` (the current branch), or
913 `nobranch` (the color the 'no branch' warning is shown in, defaulting
914 to red). The values of these variables may be specified as in
918 This variable determines the default value for variables such
919 as `color.diff` and `color.grep` that control the use of color
920 per command family. Its scope will expand as more commands learn
921 configuration to set a default for the `--color` option. Set it
922 to `false` or `never` if you prefer Git commands not to use
923 color unless enabled explicitly with some other configuration
924 or the `--color` option. Set it to `always` if you want all
925 output not intended for machine consumption to use color, to
926 `true` or `auto` (this is the default since Git 1.8.4) if you
927 want such output to use color when written to the terminal.
930 Specify whether supported commands should output in columns.
931 This variable consists of a list of tokens separated by spaces
934 These options control when the feature should be enabled
935 (defaults to 'never'):
939 always show in columns
941 never show in columns
943 show in columns if the output is to the terminal
946 These options control layout (defaults to 'column'). Setting any
947 of these implies 'always' if none of 'always', 'never', or 'auto' are
952 fill columns before rows
954 fill rows before columns
959 Finally, these options can be combined with a layout option (defaults
964 make unequal size columns to utilize more space
966 make equal size columns
970 Specify whether to output branch listing in `git branch` in columns.
971 See `column.ui` for details.
974 Specify the layout when list items in `git clean -i`, which always
975 shows files and directories in columns. See `column.ui` for details.
978 Specify whether to output untracked files in `git status` in columns.
979 See `column.ui` for details.
982 Specify whether to output tag listing in `git tag` in columns.
983 See `column.ui` for details.
986 This setting overrides the default of the `--cleanup` option in
987 `git commit`. See linkgit:git-commit[1] for details. Changing the
988 default can be useful when you always want to keep lines that begin
989 with comment character `#` in your log message, in which case you
990 would do `git config commit.cleanup whitespace` (note that you will
991 have to remove the help lines that begin with `#` in the commit log
992 template yourself, if you do this).
995 A boolean to enable/disable inclusion of status information in the
996 commit message template when using an editor to prepare the commit
997 message. Defaults to true.
1000 Specify a file to use as the template for new commit messages.
1001 "`~/`" is expanded to the value of `$HOME` and "`~user/`" to the
1002 specified user's home directory.
1005 Specify an external helper to be called when a username or
1006 password credential is needed; the helper may consult external
1007 storage to avoid prompting the user for the credentials. See
1008 linkgit:gitcredentials[7] for details.
1010 credential.useHttpPath::
1011 When acquiring credentials, consider the "path" component of an http
1012 or https URL to be important. Defaults to false. See
1013 linkgit:gitcredentials[7] for more information.
1015 credential.username::
1016 If no username is set for a network authentication, use this username
1017 by default. See credential.<context>.* below, and
1018 linkgit:gitcredentials[7].
1020 credential.<url>.*::
1021 Any of the credential.* options above can be applied selectively to
1022 some credentials. For example "credential.https://example.com.username"
1023 would set the default username only for https connections to
1024 example.com. See linkgit:gitcredentials[7] for details on how URLs are
1027 include::diff-config.txt[]
1029 difftool.<tool>.path::
1030 Override the path for the given tool. This is useful in case
1031 your tool is not in the PATH.
1033 difftool.<tool>.cmd::
1034 Specify the command to invoke the specified diff tool.
1035 The specified command is evaluated in shell with the following
1036 variables available: 'LOCAL' is set to the name of the temporary
1037 file containing the contents of the diff pre-image and 'REMOTE'
1038 is set to the name of the temporary file containing the contents
1039 of the diff post-image.
1042 Prompt before each invocation of the diff tool.
1044 fetch.recurseSubmodules::
1045 This option can be either set to a boolean value or to 'on-demand'.
1046 Setting it to a boolean changes the behavior of fetch and pull to
1047 unconditionally recurse into submodules when set to true or to not
1048 recurse at all when set to false. When set to 'on-demand' (the default
1049 value), fetch and pull will only recurse into a populated submodule
1050 when its superproject retrieves a commit that updates the submodule's
1054 If it is set to true, git-fetch-pack will check all fetched
1055 objects. It will abort in the case of a malformed object or a
1056 broken link. The result of an abort are only dangling objects.
1057 Defaults to false. If not set, the value of `transfer.fsckObjects`
1061 If the number of objects fetched over the Git native
1062 transfer is below this
1063 limit, then the objects will be unpacked into loose object
1064 files. However if the number of received objects equals or
1065 exceeds this limit then the received pack will be stored as
1066 a pack, after adding any missing delta bases. Storing the
1067 pack from a push can make the push operation complete faster,
1068 especially on slow filesystems. If not set, the value of
1069 `transfer.unpackLimit` is used instead.
1072 Enable multipart/mixed attachments as the default for
1073 'format-patch'. The value can also be a double quoted string
1074 which will enable attachments as the default and set the
1075 value as the boundary. See the --attach option in
1076 linkgit:git-format-patch[1].
1079 A boolean which can enable or disable sequence numbers in patch
1080 subjects. It defaults to "auto" which enables it only if there
1081 is more than one patch. It can be enabled or disabled for all
1082 messages by setting it to "true" or "false". See --numbered
1083 option in linkgit:git-format-patch[1].
1086 Additional email headers to include in a patch to be submitted
1087 by mail. See linkgit:git-format-patch[1].
1091 Additional recipients to include in a patch to be submitted
1092 by mail. See the --to and --cc options in
1093 linkgit:git-format-patch[1].
1095 format.subjectprefix::
1096 The default for format-patch is to output files with the '[PATCH]'
1097 subject prefix. Use this variable to change that prefix.
1100 The default for format-patch is to output a signature containing
1101 the Git version number. Use this variable to change that default.
1102 Set this variable to the empty string ("") to suppress
1103 signature generation.
1106 The default for format-patch is to output files with the suffix
1107 `.patch`. Use this variable to change that suffix (make sure to
1108 include the dot if you want it).
1111 The default pretty format for log/show/whatchanged command,
1112 See linkgit:git-log[1], linkgit:git-show[1],
1113 linkgit:git-whatchanged[1].
1116 The default threading style for 'git format-patch'. Can be
1117 a boolean value, or `shallow` or `deep`. `shallow` threading
1118 makes every mail a reply to the head of the series,
1119 where the head is chosen from the cover letter, the
1120 `--in-reply-to`, and the first patch mail, in this order.
1121 `deep` threading makes every mail a reply to the previous one.
1122 A true boolean value is the same as `shallow`, and a false
1123 value disables threading.
1126 A boolean value which lets you enable the `-s/--signoff` option of
1127 format-patch by default. *Note:* Adding the Signed-off-by: line to a
1128 patch should be a conscious act and means that you certify you have
1129 the rights to submit this work under the same open source license.
1130 Please see the 'SubmittingPatches' document for further discussion.
1132 format.coverLetter::
1133 A boolean that controls whether to generate a cover-letter when
1134 format-patch is invoked, but in addition can be set to "auto", to
1135 generate a cover-letter only when there's more than one patch.
1137 filter.<driver>.clean::
1138 The command which is used to convert the content of a worktree
1139 file to a blob upon checkin. See linkgit:gitattributes[5] for
1142 filter.<driver>.smudge::
1143 The command which is used to convert the content of a blob
1144 object to a worktree file upon checkout. See
1145 linkgit:gitattributes[5] for details.
1147 gc.aggressiveWindow::
1148 The window size parameter used in the delta compression
1149 algorithm used by 'git gc --aggressive'. This defaults
1153 When there are approximately more than this many loose
1154 objects in the repository, `git gc --auto` will pack them.
1155 Some Porcelain commands use this command to perform a
1156 light-weight garbage collection from time to time. The
1157 default value is 6700. Setting this to 0 disables it.
1160 When there are more than this many packs that are not
1161 marked with `*.keep` file in the repository, `git gc
1162 --auto` consolidates them into one larger pack. The
1163 default value is 50. Setting this to 0 disables it.
1166 Running `git pack-refs` in a repository renders it
1167 unclonable by Git versions prior to 1.5.1.2 over dumb
1168 transports such as HTTP. This variable determines whether
1169 'git gc' runs `git pack-refs`. This can be set to `notbare`
1170 to enable it within all non-bare repos or it can be set to a
1171 boolean value. The default is `true`.
1174 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1175 Override the grace period with this config variable. The value
1176 "now" may be used to disable this grace period and always prune
1177 unreachable objects immediately.
1180 gc.<pattern>.reflogexpire::
1181 'git reflog expire' removes reflog entries older than
1182 this time; defaults to 90 days. With "<pattern>" (e.g.
1183 "refs/stash") in the middle the setting applies only to
1184 the refs that match the <pattern>.
1186 gc.reflogexpireunreachable::
1187 gc.<ref>.reflogexpireunreachable::
1188 'git reflog expire' removes reflog entries older than
1189 this time and are not reachable from the current tip;
1190 defaults to 30 days. With "<pattern>" (e.g. "refs/stash")
1191 in the middle, the setting applies only to the refs that
1192 match the <pattern>.
1195 Records of conflicted merge you resolved earlier are
1196 kept for this many days when 'git rerere gc' is run.
1197 The default is 60 days. See linkgit:git-rerere[1].
1199 gc.rerereunresolved::
1200 Records of conflicted merge you have not resolved are
1201 kept for this many days when 'git rerere gc' is run.
1202 The default is 15 days. See linkgit:git-rerere[1].
1204 gitcvs.commitmsgannotation::
1205 Append this string to each commit message. Set to empty string
1206 to disable this feature. Defaults to "via git-CVS emulator".
1209 Whether the CVS server interface is enabled for this repository.
1210 See linkgit:git-cvsserver[1].
1213 Path to a log file where the CVS server interface well... logs
1214 various stuff. See linkgit:git-cvsserver[1].
1216 gitcvs.usecrlfattr::
1217 If true, the server will look up the end-of-line conversion
1218 attributes for files to determine the '-k' modes to use. If
1219 the attributes force Git to treat a file as text,
1220 the '-k' mode will be left blank so CVS clients will
1221 treat it as text. If they suppress text conversion, the file
1222 will be set with '-kb' mode, which suppresses any newline munging
1223 the client might otherwise do. If the attributes do not allow
1224 the file type to be determined, then 'gitcvs.allbinary' is
1225 used. See linkgit:gitattributes[5].
1228 This is used if 'gitcvs.usecrlfattr' does not resolve
1229 the correct '-kb' mode to use. If true, all
1230 unresolved files are sent to the client in
1231 mode '-kb'. This causes the client to treat them
1232 as binary files, which suppresses any newline munging it
1233 otherwise might do. Alternatively, if it is set to "guess",
1234 then the contents of the file are examined to decide if
1235 it is binary, similar to 'core.autocrlf'.
1238 Database used by git-cvsserver to cache revision information
1239 derived from the Git repository. The exact meaning depends on the
1240 used database driver, for SQLite (which is the default driver) this
1241 is a filename. Supports variable substitution (see
1242 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1243 Default: '%Ggitcvs.%m.sqlite'
1246 Used Perl DBI driver. You can specify any available driver
1247 for this here, but it might not work. git-cvsserver is tested
1248 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1249 reported *not* to work with 'DBD::mysql'. Experimental feature.
1250 May not contain double colons (`:`). Default: 'SQLite'.
1251 See linkgit:git-cvsserver[1].
1253 gitcvs.dbuser, gitcvs.dbpass::
1254 Database user and password. Only useful if setting 'gitcvs.dbdriver',
1255 since SQLite has no concept of database users and/or passwords.
1256 'gitcvs.dbuser' supports variable substitution (see
1257 linkgit:git-cvsserver[1] for details).
1259 gitcvs.dbTableNamePrefix::
1260 Database table name prefix. Prepended to the names of any
1261 database tables used, allowing a single database to be used
1262 for several repositories. Supports variable substitution (see
1263 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1264 characters will be replaced with underscores.
1266 All gitcvs variables except for 'gitcvs.usecrlfattr' and
1267 'gitcvs.allbinary' can also be specified as
1268 'gitcvs.<access_method>.<varname>' (where 'access_method'
1269 is one of "ext" and "pserver") to make them apply only for the given
1273 gitweb.description::
1276 See linkgit:gitweb[1] for description.
1284 gitweb.remote_heads::
1287 See linkgit:gitweb.conf[5] for description.
1290 If set to true, enable '-n' option by default.
1293 Set the default matching behavior. Using a value of 'basic', 'extended',
1294 'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',
1295 '--fixed-strings', or '--perl-regexp' option accordingly, while the
1296 value 'default' will return to the default matching behavior.
1298 grep.extendedRegexp::
1299 If set to true, enable '--extended-regexp' option by default. This
1300 option is ignored when the 'grep.patternType' option is set to a value
1301 other than 'default'.
1304 Use this custom program instead of "gpg" found on $PATH when
1305 making or verifying a PGP signature. The program must support the
1306 same command line interface as GPG, namely, to verify a detached
1307 signature, "gpg --verify $file - <$signature" is run, and the
1308 program is expected to signal a good signature by exiting with
1309 code 0, and to generate an ascii-armored detached signature, the
1310 standard input of "gpg -bsau $key" is fed with the contents to be
1311 signed, and the program is expected to send the result to its
1314 gui.commitmsgwidth::
1315 Defines how wide the commit message window is in the
1316 linkgit:git-gui[1]. "75" is the default.
1319 Specifies how many context lines should be used in calls to diff
1320 made by the linkgit:git-gui[1]. The default is "5".
1323 Specifies the default encoding to use for displaying of
1324 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1325 It can be overridden by setting the 'encoding' attribute
1326 for relevant files (see linkgit:gitattributes[5]).
1327 If this option is not set, the tools default to the
1330 gui.matchtrackingbranch::
1331 Determines if new branches created with linkgit:git-gui[1] should
1332 default to tracking remote branches with matching names or
1333 not. Default: "false".
1335 gui.newbranchtemplate::
1336 Is used as suggested name when creating new branches using the
1339 gui.pruneduringfetch::
1340 "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1341 performing a fetch. The default value is "false".
1344 Determines if linkgit:git-gui[1] should trust the file modification
1345 timestamp or not. By default the timestamps are not trusted.
1347 gui.spellingdictionary::
1348 Specifies the dictionary used for spell checking commit messages in
1349 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1353 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1354 location detection. It makes blame significantly faster on huge
1355 repositories at the expense of less thorough copy detection.
1357 gui.copyblamethreshold::
1358 Specifies the threshold to use in 'git gui blame' original location
1359 detection, measured in alphanumeric characters. See the
1360 linkgit:git-blame[1] manual for more information on copy detection.
1362 gui.blamehistoryctx::
1363 Specifies the radius of history context in days to show in
1364 linkgit:gitk[1] for the selected commit, when the `Show History
1365 Context` menu item is invoked from 'git gui blame'. If this
1366 variable is set to zero, the whole history is shown.
1368 guitool.<name>.cmd::
1369 Specifies the shell command line to execute when the corresponding item
1370 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1371 mandatory for every tool. The command is executed from the root of
1372 the working directory, and in the environment it receives the name of
1373 the tool as 'GIT_GUITOOL', the name of the currently selected file as
1374 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1375 the head is detached, 'CUR_BRANCH' is empty).
1377 guitool.<name>.needsfile::
1378 Run the tool only if a diff is selected in the GUI. It guarantees
1379 that 'FILENAME' is not empty.
1381 guitool.<name>.noconsole::
1382 Run the command silently, without creating a window to display its
1385 guitool.<name>.norescan::
1386 Don't rescan the working directory for changes after the tool
1389 guitool.<name>.confirm::
1390 Show a confirmation dialog before actually running the tool.
1392 guitool.<name>.argprompt::
1393 Request a string argument from the user, and pass it to the tool
1394 through the 'ARGS' environment variable. Since requesting an
1395 argument implies confirmation, the 'confirm' option has no effect
1396 if this is enabled. If the option is set to 'true', 'yes', or '1',
1397 the dialog uses a built-in generic prompt; otherwise the exact
1398 value of the variable is used.
1400 guitool.<name>.revprompt::
1401 Request a single valid revision from the user, and set the
1402 'REVISION' environment variable. In other aspects this option
1403 is similar to 'argprompt', and can be used together with it.
1405 guitool.<name>.revunmerged::
1406 Show only unmerged branches in the 'revprompt' subdialog.
1407 This is useful for tools similar to merge or rebase, but not
1408 for things like checkout or reset.
1410 guitool.<name>.title::
1411 Specifies the title to use for the prompt dialog. The default
1414 guitool.<name>.prompt::
1415 Specifies the general prompt string to display at the top of
1416 the dialog, before subsections for 'argprompt' and 'revprompt'.
1417 The default value includes the actual command.
1420 Specify the browser that will be used to display help in the
1421 'web' format. See linkgit:git-help[1].
1424 Override the default help format used by linkgit:git-help[1].
1425 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1426 the default. 'web' and 'html' are the same.
1429 Automatically correct and execute mistyped commands after
1430 waiting for the given number of deciseconds (0.1 sec). If more
1431 than one command can be deduced from the entered text, nothing
1432 will be executed. If the value of this option is negative,
1433 the corrected command will be executed immediately. If the
1434 value is 0 - the command will be just shown but not executed.
1435 This is the default.
1438 Specify the path where the HTML documentation resides. File system paths
1439 and URLs are supported. HTML pages will be prefixed with this path when
1440 help is displayed in the 'web' format. This defaults to the documentation
1441 path of your Git installation.
1444 Override the HTTP proxy, normally configured using the 'http_proxy',
1445 'https_proxy', and 'all_proxy' environment variables (see
1446 `curl(1)`). This can be overridden on a per-remote basis; see
1450 File containing previously stored cookie lines which should be used
1451 in the Git http session, if they match the server. The file format
1452 of the file to read cookies from should be plain HTTP headers or
1453 the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
1454 NOTE that the file specified with http.cookiefile is only used as
1455 input. No cookies will be stored in the file.
1458 Whether to verify the SSL certificate when fetching or pushing
1459 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1463 File containing the SSL certificate when fetching or pushing
1464 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1468 File containing the SSL private key when fetching or pushing
1469 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1472 http.sslCertPasswordProtected::
1473 Enable Git's password prompt for the SSL certificate. Otherwise
1474 OpenSSL will prompt the user, possibly many times, if the
1475 certificate or private key is encrypted. Can be overridden by the
1476 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1479 File containing the certificates to verify the peer with when
1480 fetching or pushing over HTTPS. Can be overridden by the
1481 'GIT_SSL_CAINFO' environment variable.
1484 Path containing files with the CA certificates to verify the peer
1485 with when fetching or pushing over HTTPS. Can be overridden
1486 by the 'GIT_SSL_CAPATH' environment variable.
1489 Attempt to use AUTH SSL/TLS and encrypted data transfers
1490 when connecting via regular FTP protocol. This might be needed
1491 if the FTP server requires it for security reasons or you wish
1492 to connect securely whenever remote FTP server supports it.
1493 Default is false since it might trigger certificate verification
1494 errors on misconfigured servers.
1497 How many HTTP requests to launch in parallel. Can be overridden
1498 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1501 The number of curl sessions (counted across slots) to be kept across
1502 requests. They will not be ended with curl_easy_cleanup() until
1503 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1504 value will be capped at 1. Defaults to 1.
1507 Maximum size in bytes of the buffer used by smart HTTP
1508 transports when POSTing data to the remote system.
1509 For requests larger than this buffer size, HTTP/1.1 and
1510 Transfer-Encoding: chunked is used to avoid creating a
1511 massive pack file locally. Default is 1 MiB, which is
1512 sufficient for most requests.
1514 http.lowSpeedLimit, http.lowSpeedTime::
1515 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1516 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1517 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1518 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1521 A boolean which disables using of EPSV ftp command by curl.
1522 This can helpful with some "poor" ftp servers which don't
1523 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1524 environment variable. Default is false (curl will use EPSV).
1527 The HTTP USER_AGENT string presented to an HTTP server. The default
1528 value represents the version of the client Git such as git/1.7.1.
1529 This option allows you to override this value to a more common value
1530 such as Mozilla/4.0. This may be necessary, for instance, if
1531 connecting through a firewall that restricts HTTP connections to a set
1532 of common USER_AGENT strings (but not including those like git/1.7.1).
1533 Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1535 i18n.commitEncoding::
1536 Character encoding the commit messages are stored in; Git itself
1537 does not care per se, but this information is necessary e.g. when
1538 importing commits from emails or in the gitk graphical history
1539 browser (and possibly at other places in the future or in other
1540 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1542 i18n.logOutputEncoding::
1543 Character encoding the commit messages are converted to when
1544 running 'git log' and friends.
1547 The configuration variables in the 'imap' section are described
1548 in linkgit:git-imap-send[1].
1551 Specify the directory from which templates will be copied.
1552 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1555 Specify the program that will be used to browse your working
1556 repository in gitweb. See linkgit:git-instaweb[1].
1559 The HTTP daemon command-line to start gitweb on your working
1560 repository. See linkgit:git-instaweb[1].
1563 If true the web server started by linkgit:git-instaweb[1] will
1564 be bound to the local IP (127.0.0.1).
1566 instaweb.modulepath::
1567 The default module path for linkgit:git-instaweb[1] to use
1568 instead of /usr/lib/apache2/modules. Only used if httpd
1572 The port number to bind the gitweb httpd to. See
1573 linkgit:git-instaweb[1].
1575 interactive.singlekey::
1576 In interactive commands, allow the user to provide one-letter
1577 input with a single key (i.e., without hitting enter).
1578 Currently this is used by the `--patch` mode of
1579 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1580 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1581 setting is silently ignored if portable keystroke input
1585 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1586 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
1587 override this option with `--no-abbrev-commit`.
1590 Set the default date-time mode for the 'log' command.
1591 Setting a value for log.date is similar to using 'git log''s
1592 `--date` option. Possible values are `relative`, `local`,
1593 `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1597 Print out the ref names of any commits that are shown by the log
1598 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1599 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1600 specified, the full ref name (including prefix) will be printed.
1601 This is the same as the log commands '--decorate' option.
1604 If true, the initial commit will be shown as a big creation event.
1605 This is equivalent to a diff against an empty tree.
1606 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1607 normally hide the root commit will now show it. True by default.
1610 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1611 linkgit:git-whatchanged[1] assume `--use-mailmap`.
1614 The location of an augmenting mailmap file. The default
1615 mailmap, located in the root of the repository, is loaded
1616 first, then the mailmap file pointed to by this variable.
1617 The location of the mailmap file may be in a repository
1618 subdirectory, or somewhere outside of the repository itself.
1619 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1622 Like `mailmap.file`, but consider the value as a reference to a
1623 blob in the repository. If both `mailmap.file` and
1624 `mailmap.blob` are given, both are parsed, with entries from
1625 `mailmap.file` taking precedence. In a bare repository, this
1626 defaults to `HEAD:.mailmap`. In a non-bare repository, it
1630 Specify the programs that may be used to display help in the
1631 'man' format. See linkgit:git-help[1].
1634 Specify the command to invoke the specified man viewer. The
1635 specified command is evaluated in shell with the man page
1636 passed as argument. (See linkgit:git-help[1].)
1639 Override the path for the given tool that may be used to
1640 display help in the 'man' format. See linkgit:git-help[1].
1642 include::merge-config.txt[]
1644 mergetool.<tool>.path::
1645 Override the path for the given tool. This is useful in case
1646 your tool is not in the PATH.
1648 mergetool.<tool>.cmd::
1649 Specify the command to invoke the specified merge tool. The
1650 specified command is evaluated in shell with the following
1651 variables available: 'BASE' is the name of a temporary file
1652 containing the common base of the files to be merged, if available;
1653 'LOCAL' is the name of a temporary file containing the contents of
1654 the file on the current branch; 'REMOTE' is the name of a temporary
1655 file containing the contents of the file from the branch being
1656 merged; 'MERGED' contains the name of the file to which the merge
1657 tool should write the results of a successful merge.
1659 mergetool.<tool>.trustExitCode::
1660 For a custom merge command, specify whether the exit code of
1661 the merge command can be used to determine whether the merge was
1662 successful. If this is not set to true then the merge target file
1663 timestamp is checked and the merge assumed to have been successful
1664 if the file has been updated, otherwise the user is prompted to
1665 indicate the success of the merge.
1667 mergetool.keepBackup::
1668 After performing a merge, the original file with conflict markers
1669 can be saved as a file with a `.orig` extension. If this variable
1670 is set to `false` then this file is not preserved. Defaults to
1671 `true` (i.e. keep the backup files).
1673 mergetool.keepTemporaries::
1674 When invoking a custom merge tool, Git uses a set of temporary
1675 files to pass to the tool. If the tool returns an error and this
1676 variable is set to `true`, then these temporary files will be
1677 preserved, otherwise they will be removed after the tool has
1678 exited. Defaults to `false`.
1681 Prompt before each invocation of the merge resolution program.
1684 The (fully qualified) refname from which to show notes when
1685 showing commit messages. The value of this variable can be set
1686 to a glob, in which case notes from all matching refs will be
1687 shown. You may also specify this configuration variable
1688 several times. A warning will be issued for refs that do not
1689 exist, but a glob that does not match any refs is silently
1692 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1693 environment variable, which must be a colon separated list of refs or
1696 The effective value of "core.notesRef" (possibly overridden by
1697 GIT_NOTES_REF) is also implicitly added to the list of refs to be
1700 notes.rewrite.<command>::
1701 When rewriting commits with <command> (currently `amend` or
1702 `rebase`) and this variable is set to `true`, Git
1703 automatically copies your notes from the original to the
1704 rewritten commit. Defaults to `true`, but see
1705 "notes.rewriteRef" below.
1708 When copying notes during a rewrite (see the
1709 "notes.rewrite.<command>" option), determines what to do if
1710 the target commit already has a note. Must be one of
1711 `overwrite`, `concatenate`, or `ignore`. Defaults to
1714 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1715 environment variable.
1718 When copying notes during a rewrite, specifies the (fully
1719 qualified) ref whose notes should be copied. The ref may be a
1720 glob, in which case notes in all matching refs will be copied.
1721 You may also specify this configuration several times.
1723 Does not have a default value; you must configure this variable to
1724 enable note rewriting. Set it to `refs/notes/commits` to enable
1725 rewriting for the default commit notes.
1727 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1728 environment variable, which must be a colon separated list of refs or
1732 The size of the window used by linkgit:git-pack-objects[1] when no
1733 window size is given on the command line. Defaults to 10.
1736 The maximum delta depth used by linkgit:git-pack-objects[1] when no
1737 maximum depth is given on the command line. Defaults to 50.
1740 The window memory size limit used by linkgit:git-pack-objects[1]
1741 when no limit is given on the command line. The value can be
1742 suffixed with "k", "m", or "g". Defaults to 0, meaning no
1746 An integer -1..9, indicating the compression level for objects
1747 in a pack file. -1 is the zlib default. 0 means no
1748 compression, and 1..9 are various speed/size tradeoffs, 9 being
1749 slowest. If not set, defaults to core.compression. If that is
1750 not set, defaults to -1, the zlib default, which is "a default
1751 compromise between speed and compression (currently equivalent
1754 Note that changing the compression level will not automatically recompress
1755 all existing objects. You can force recompression by passing the -F option
1756 to linkgit:git-repack[1].
1758 pack.deltaCacheSize::
1759 The maximum memory in bytes used for caching deltas in
1760 linkgit:git-pack-objects[1] before writing them out to a pack.
1761 This cache is used to speed up the writing object phase by not
1762 having to recompute the final delta result once the best match
1763 for all objects is found. Repacking large repositories on machines
1764 which are tight with memory might be badly impacted by this though,
1765 especially if this cache pushes the system into swapping.
1766 A value of 0 means no limit. The smallest size of 1 byte may be
1767 used to virtually disable this cache. Defaults to 256 MiB.
1769 pack.deltaCacheLimit::
1770 The maximum size of a delta, that is cached in
1771 linkgit:git-pack-objects[1]. This cache is used to speed up the
1772 writing object phase by not having to recompute the final delta
1773 result once the best match for all objects is found. Defaults to 1000.
1776 Specifies the number of threads to spawn when searching for best
1777 delta matches. This requires that linkgit:git-pack-objects[1]
1778 be compiled with pthreads otherwise this option is ignored with a
1779 warning. This is meant to reduce packing time on multiprocessor
1780 machines. The required amount of memory for the delta search window
1781 is however multiplied by the number of threads.
1782 Specifying 0 will cause Git to auto-detect the number of CPU's
1783 and set the number of threads accordingly.
1786 Specify the default pack index version. Valid values are 1 for
1787 legacy pack index used by Git versions prior to 1.5.2, and 2 for
1788 the new pack index with capabilities for packs larger than 4 GB
1789 as well as proper protection against the repacking of corrupted
1790 packs. Version 2 is the default. Note that version 2 is enforced
1791 and this config option ignored whenever the corresponding pack is
1794 If you have an old Git that does not understand the version 2 `*.idx` file,
1795 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1796 that will copy both `*.pack` file and corresponding `*.idx` file from the
1797 other side may give you a repository that cannot be accessed with your
1798 older version of Git. If the `*.pack` file is smaller than 2 GB, however,
1799 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1802 pack.packSizeLimit::
1803 The maximum size of a pack. This setting only affects
1804 packing to a file when repacking, i.e. the git:// protocol
1805 is unaffected. It can be overridden by the `--max-pack-size`
1806 option of linkgit:git-repack[1]. The minimum size allowed is
1807 limited to 1 MiB. The default is unlimited.
1808 Common unit suffixes of 'k', 'm', or 'g' are
1812 If the value is boolean, turns on or off pagination of the
1813 output of a particular Git subcommand when writing to a tty.
1814 Otherwise, turns on pagination for the subcommand using the
1815 pager specified by the value of `pager.<cmd>`. If `--paginate`
1816 or `--no-pager` is specified on the command line, it takes
1817 precedence over this option. To disable pagination for all
1818 commands, set `core.pager` or `GIT_PAGER` to `cat`.
1821 Alias for a --pretty= format string, as specified in
1822 linkgit:git-log[1]. Any aliases defined here can be used just
1823 as the built-in pretty formats could. For example,
1824 running `git config pretty.changelog "format:* %H %s"`
1825 would cause the invocation `git log --pretty=changelog`
1826 to be equivalent to running `git log "--pretty=format:* %H %s"`.
1827 Note that an alias with the same name as a built-in format
1828 will be silently ignored.
1831 When true, rebase branches on top of the fetched branch, instead
1832 of merging the default branch from the default remote when "git
1833 pull" is run. See "branch.<name>.rebase" for setting this on a
1836 *NOTE*: this is a possibly dangerous operation; do *not* use
1837 it unless you understand the implications (see linkgit:git-rebase[1]
1841 The default merge strategy to use when pulling multiple branches
1845 The default merge strategy to use when pulling a single branch.
1848 Defines the action `git push` should take if no refspec is
1849 explicitly given. Different values are well-suited for
1850 specific workflows; for instance, in a purely central workflow
1851 (i.e. the fetch source is equal to the push destination),
1852 `upstream` is probably what you want. Possible values are:
1856 * `nothing` - do not push anything (error out) unless a refspec is
1857 explicitly given. This is primarily meant for people who want to
1858 avoid mistakes by always being explicit.
1860 * `current` - push the current branch to update a branch with the same
1861 name on the receiving end. Works in both central and non-central
1864 * `upstream` - push the current branch back to the branch whose
1865 changes are usually integrated into the current branch (which is
1866 called `@{upstream}`). This mode only makes sense if you are
1867 pushing to the same repository you would normally pull from
1868 (i.e. central workflow).
1870 * `simple` - in centralized workflow, work like `upstream` with an
1871 added safety to refuse to push if the upstream branch's name is
1872 different from the local one.
1874 When pushing to a remote that is different from the remote you normally
1875 pull from, work as `current`. This is the safest option and is suited
1878 This mode will become the default in Git 2.0.
1880 * `matching` - push all branches having the same name on both ends.
1881 This makes the repository you are pushing to remember the set of
1882 branches that will be pushed out (e.g. if you always push 'maint'
1883 and 'master' there and no other branches, the repository you push
1884 to will have these two branches, and your local 'maint' and
1885 'master' will be pushed there).
1887 To use this mode effectively, you have to make sure _all_ the
1888 branches you would push out are ready to be pushed out before
1889 running 'git push', as the whole point of this mode is to allow you
1890 to push all of the branches in one go. If you usually finish work
1891 on only one branch and push out the result, while other branches are
1892 unfinished, this mode is not for you. Also this mode is not
1893 suitable for pushing into a shared central repository, as other
1894 people may add new branches there, or update the tip of existing
1895 branches outside your control.
1897 This is currently the default, but Git 2.0 will change the default
1903 Whether to show a diffstat of what changed upstream since the last
1904 rebase. False by default.
1907 If set to true enable '--autosquash' option by default.
1910 When set to true, automatically create a temporary stash
1911 before the operation begins, and apply it after the operation
1912 ends. This means that you can run rebase on a dirty worktree.
1913 However, use with care: the final stash application after a
1914 successful rebase might result in non-trivial conflicts.
1918 By default, git-receive-pack will run "git-gc --auto" after
1919 receiving data from git-push and updating refs. You can stop
1920 it by setting this variable to false.
1922 receive.fsckObjects::
1923 If it is set to true, git-receive-pack will check all received
1924 objects. It will abort in the case of a malformed object or a
1925 broken link. The result of an abort are only dangling objects.
1926 Defaults to false. If not set, the value of `transfer.fsckObjects`
1929 receive.unpackLimit::
1930 If the number of objects received in a push is below this
1931 limit then the objects will be unpacked into loose object
1932 files. However if the number of received objects equals or
1933 exceeds this limit then the received pack will be stored as
1934 a pack, after adding any missing delta bases. Storing the
1935 pack from a push can make the push operation complete faster,
1936 especially on slow filesystems. If not set, the value of
1937 `transfer.unpackLimit` is used instead.
1939 receive.denyDeletes::
1940 If set to true, git-receive-pack will deny a ref update that deletes
1941 the ref. Use this to prevent such a ref deletion via a push.
1943 receive.denyDeleteCurrent::
1944 If set to true, git-receive-pack will deny a ref update that
1945 deletes the currently checked out branch of a non-bare repository.
1947 receive.denyCurrentBranch::
1948 If set to true or "refuse", git-receive-pack will deny a ref update
1949 to the currently checked out branch of a non-bare repository.
1950 Such a push is potentially dangerous because it brings the HEAD
1951 out of sync with the index and working tree. If set to "warn",
1952 print a warning of such a push to stderr, but allow the push to
1953 proceed. If set to false or "ignore", allow such pushes with no
1954 message. Defaults to "refuse".
1956 There are two more options that are meant for Git experts: "updateInstead"
1957 which will run `read-tree -u -m HEAD` and "detachInstead" which will detach
1958 the HEAD so it does not need to change. Both options come with their own
1959 set of possible *complications*, but can be appropriate in rare workflows.
1961 receive.denyNonFastForwards::
1962 If set to true, git-receive-pack will deny a ref update which is
1963 not a fast-forward. Use this to prevent such an update via a push,
1964 even if that push is forced. This configuration variable is
1965 set when initializing a shared repository.
1968 String(s) `receive-pack` uses to decide which refs to omit
1969 from its initial advertisement. Use more than one
1970 definitions to specify multiple prefix strings. A ref that
1971 are under the hierarchies listed on the value of this
1972 variable is excluded, and is hidden when responding to `git
1973 push`, and an attempt to update or delete a hidden ref by
1974 `git push` is rejected.
1976 receive.updateserverinfo::
1977 If set to true, git-receive-pack will run git-update-server-info
1978 after receiving data from git-push and updating refs.
1980 remote.pushdefault::
1981 The remote to push to by default. Overrides
1982 `branch.<name>.remote` for all branches, and is overridden by
1983 `branch.<name>.pushremote` for specific branches.
1986 The URL of a remote repository. See linkgit:git-fetch[1] or
1987 linkgit:git-push[1].
1989 remote.<name>.pushurl::
1990 The push URL of a remote repository. See linkgit:git-push[1].
1992 remote.<name>.proxy::
1993 For remotes that require curl (http, https and ftp), the URL to
1994 the proxy to use for that remote. Set to the empty string to
1995 disable proxying for that remote.
1997 remote.<name>.fetch::
1998 The default set of "refspec" for linkgit:git-fetch[1]. See
1999 linkgit:git-fetch[1].
2001 remote.<name>.push::
2002 The default set of "refspec" for linkgit:git-push[1]. See
2003 linkgit:git-push[1].
2005 remote.<name>.mirror::
2006 If true, pushing to this remote will automatically behave
2007 as if the `--mirror` option was given on the command line.
2009 remote.<name>.skipDefaultUpdate::
2010 If true, this remote will be skipped by default when updating
2011 using linkgit:git-fetch[1] or the `update` subcommand of
2012 linkgit:git-remote[1].
2014 remote.<name>.skipFetchAll::
2015 If true, this remote will be skipped by default when updating
2016 using linkgit:git-fetch[1] or the `update` subcommand of
2017 linkgit:git-remote[1].
2019 remote.<name>.receivepack::
2020 The default program to execute on the remote side when pushing. See
2021 option \--receive-pack of linkgit:git-push[1].
2023 remote.<name>.uploadpack::
2024 The default program to execute on the remote side when fetching. See
2025 option \--upload-pack of linkgit:git-fetch-pack[1].
2027 remote.<name>.tagopt::
2028 Setting this value to \--no-tags disables automatic tag following when
2029 fetching from remote <name>. Setting it to \--tags will fetch every
2030 tag from remote <name>, even if they are not reachable from remote
2031 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
2032 override this setting. See options \--tags and \--no-tags of
2033 linkgit:git-fetch[1].
2036 Setting this to a value <vcs> will cause Git to interact with
2037 the remote with the git-remote-<vcs> helper.
2040 The list of remotes which are fetched by "git remote update
2041 <group>". See linkgit:git-remote[1].
2043 repack.usedeltabaseoffset::
2044 By default, linkgit:git-repack[1] creates packs that use
2045 delta-base offset. If you need to share your repository with
2046 Git older than version 1.4.4, either directly or via a dumb
2047 protocol such as http, then you need to set this option to
2048 "false" and repack. Access from old Git versions over the
2049 native protocol are unaffected by this option.
2052 When set to true, `git-rerere` updates the index with the
2053 resulting contents after it cleanly resolves conflicts using
2054 previously recorded resolution. Defaults to false.
2057 Activate recording of resolved conflicts, so that identical
2058 conflict hunks can be resolved automatically, should they be
2059 encountered again. By default, linkgit:git-rerere[1] is
2060 enabled if there is an `rr-cache` directory under the
2061 `$GIT_DIR`, e.g. if "rerere" was previously used in the
2064 sendemail.identity::
2065 A configuration identity. When given, causes values in the
2066 'sendemail.<identity>' subsection to take precedence over
2067 values in the 'sendemail' section. The default identity is
2068 the value of 'sendemail.identity'.
2070 sendemail.smtpencryption::
2071 See linkgit:git-send-email[1] for description. Note that this
2072 setting is not subject to the 'identity' mechanism.
2075 Deprecated alias for 'sendemail.smtpencryption = ssl'.
2077 sendemail.smtpsslcertpath::
2078 Path to ca-certificates (either a directory or a single file).
2079 Set it to an empty string to disable certificate verification.
2081 sendemail.<identity>.*::
2082 Identity-specific versions of the 'sendemail.*' parameters
2083 found below, taking precedence over those when the this
2084 identity is selected, through command-line or
2085 'sendemail.identity'.
2087 sendemail.aliasesfile::
2088 sendemail.aliasfiletype::
2089 sendemail.annotate::
2093 sendemail.chainreplyto::
2095 sendemail.envelopesender::
2097 sendemail.multiedit::
2098 sendemail.signedoffbycc::
2099 sendemail.smtppass::
2100 sendemail.suppresscc::
2101 sendemail.suppressfrom::
2103 sendemail.smtpdomain::
2104 sendemail.smtpserver::
2105 sendemail.smtpserverport::
2106 sendemail.smtpserveroption::
2107 sendemail.smtpuser::
2109 sendemail.validate::
2110 See linkgit:git-send-email[1] for description.
2112 sendemail.signedoffcc::
2113 Deprecated alias for 'sendemail.signedoffbycc'.
2115 showbranch.default::
2116 The default set of branches for linkgit:git-show-branch[1].
2117 See linkgit:git-show-branch[1].
2119 status.relativePaths::
2120 By default, linkgit:git-status[1] shows paths relative to the
2121 current directory. Setting this variable to `false` shows paths
2122 relative to the repository root (this was the default for Git
2126 Set to true to enable --short by default in linkgit:git-status[1].
2127 The option --no-short takes precedence over this variable.
2130 Set to true to enable --branch by default in linkgit:git-status[1].
2131 The option --no-branch takes precedence over this variable.
2133 status.showUntrackedFiles::
2134 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
2135 files which are not currently tracked by Git. Directories which
2136 contain only untracked files, are shown with the directory name
2137 only. Showing untracked files means that Git needs to lstat() all
2138 all the files in the whole repository, which might be slow on some
2139 systems. So, this variable controls how the commands displays
2140 the untracked files. Possible values are:
2143 * `no` - Show no untracked files.
2144 * `normal` - Show untracked files and directories.
2145 * `all` - Show also individual files in untracked directories.
2148 If this variable is not specified, it defaults to 'normal'.
2149 This variable can be overridden with the -u|--untracked-files option
2150 of linkgit:git-status[1] and linkgit:git-commit[1].
2152 status.submodulesummary::
2154 If this is set to a non zero number or true (identical to -1 or an
2155 unlimited number), the submodule summary will be enabled and a
2156 summary of commits for modified submodules will be shown (see
2157 --summary-limit option of linkgit:git-submodule[1]).
2159 submodule.<name>.path::
2160 submodule.<name>.url::
2161 submodule.<name>.update::
2162 The path within this project, URL, and the updating strategy
2163 for a submodule. These variables are initially populated
2164 by 'git submodule init'; edit them to override the
2165 URL and other values found in the `.gitmodules` file. See
2166 linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
2168 submodule.<name>.branch::
2169 The remote branch name for a submodule, used by `git submodule
2170 update --remote`. Set this option to override the value found in
2171 the `.gitmodules` file. See linkgit:git-submodule[1] and
2172 linkgit:gitmodules[5] for details.
2174 submodule.<name>.fetchRecurseSubmodules::
2175 This option can be used to control recursive fetching of this
2176 submodule. It can be overridden by using the --[no-]recurse-submodules
2177 command line option to "git fetch" and "git pull".
2178 This setting will override that from in the linkgit:gitmodules[5]
2181 submodule.<name>.ignore::
2182 Defines under what circumstances "git status" and the diff family show
2183 a submodule as modified. When set to "all", it will never be considered
2184 modified, "dirty" will ignore all changes to the submodules work tree and
2185 takes only differences between the HEAD of the submodule and the commit
2186 recorded in the superproject into account. "untracked" will additionally
2187 let submodules with modified tracked files in their work tree show up.
2188 Using "none" (the default when this option is not set) also shows
2189 submodules that have untracked files in their work tree as changed.
2190 This setting overrides any setting made in .gitmodules for this submodule,
2191 both settings can be overridden on the command line by using the
2192 "--ignore-submodules" option.
2195 This variable can be used to restrict the permission bits of
2196 tar archive entries. The default is 0002, which turns off the
2197 world write bit. The special value "user" indicates that the
2198 archiving user's umask will be used instead. See umask(2) and
2199 linkgit:git-archive[1].
2201 transfer.fsckObjects::
2202 When `fetch.fsckObjects` or `receive.fsckObjects` are
2203 not set, the value of this variable is used instead.
2207 This variable can be used to set both `receive.hiderefs`
2208 and `uploadpack.hiderefs` at the same time to the same
2209 values. See entries for these other variables.
2211 transfer.unpackLimit::
2212 When `fetch.unpackLimit` or `receive.unpackLimit` are
2213 not set, the value of this variable is used instead.
2214 The default value is 100.
2216 uploadpack.hiderefs::
2217 String(s) `upload-pack` uses to decide which refs to omit
2218 from its initial advertisement. Use more than one
2219 definitions to specify multiple prefix strings. A ref that
2220 are under the hierarchies listed on the value of this
2221 variable is excluded, and is hidden from `git ls-remote`,
2222 `git fetch`, etc. An attempt to fetch a hidden ref by `git
2223 fetch` will fail. See also `uploadpack.allowtipsha1inwant`.
2225 uploadpack.allowtipsha1inwant::
2226 When `uploadpack.hiderefs` is in effect, allow `upload-pack`
2227 to accept a fetch request that asks for an object at the tip
2228 of a hidden ref (by default, such a request is rejected).
2229 see also `uploadpack.hiderefs`.
2231 url.<base>.insteadOf::
2232 Any URL that starts with this value will be rewritten to
2233 start, instead, with <base>. In cases where some site serves a
2234 large number of repositories, and serves them with multiple
2235 access methods, and some users need to use different access
2236 methods, this feature allows people to specify any of the
2237 equivalent URLs and have Git automatically rewrite the URL to
2238 the best alternative for the particular user, even for a
2239 never-before-seen repository on the site. When more than one
2240 insteadOf strings match a given URL, the longest match is used.
2242 url.<base>.pushInsteadOf::
2243 Any URL that starts with this value will not be pushed to;
2244 instead, it will be rewritten to start with <base>, and the
2245 resulting URL will be pushed to. In cases where some site serves
2246 a large number of repositories, and serves them with multiple
2247 access methods, some of which do not allow push, this feature
2248 allows people to specify a pull-only URL and have Git
2249 automatically use an appropriate URL to push, even for a
2250 never-before-seen repository on the site. When more than one
2251 pushInsteadOf strings match a given URL, the longest match is
2252 used. If a remote has an explicit pushurl, Git will ignore this
2253 setting for that remote.
2256 Your email address to be recorded in any newly created commits.
2257 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
2258 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
2261 Your full name to be recorded in any newly created commits.
2262 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
2263 environment variables. See linkgit:git-commit-tree[1].
2266 If linkgit:git-tag[1] is not selecting the key you want it to
2267 automatically when creating a signed tag, you can override the
2268 default selection with this variable. This option is passed
2269 unchanged to gpg's --local-user parameter, so you may specify a key
2270 using any method that gpg supports.
2273 Specify a web browser that may be used by some commands.
2274 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]