Merge branch 'sb/submodule-clone-retry'
[git/git.git] / Documentation / config.txt
2 ------------------
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; we say then that the variable is
18 multivalued.
20 Syntax
21 ~~~~~~
23 The syntax is fairly flexible and permissive; whitespaces are mostly
24 ignored. The '#' and ';' characters begin comments to the end of line,
25 blank lines are ignored.
27 The file consists of sections and variables. A section begins with
28 the name of the section in square brackets and continues until the next
29 section begins. Section names are case-insensitive. Only alphanumeric
30 characters, `-` and `.` are allowed in section names. Each variable
31 must belong to some section, which means that there must be a section
32 header before the first setting of a variable.
34 Sections can be further divided into subsections. To begin a subsection
35 put its name in double quotes, separated by space from the section name,
36 in the section header, like in the example below:
38 --------
39 [section "subsection"]
41 --------
43 Subsection names are case sensitive and can contain any characters except
44 newline (doublequote `"` and backslash can be included by escaping them
45 as `\"` and `\\`, respectively). Section headers cannot span multiple
46 lines. Variables may belong directly to a section or to a given subsection.
47 You can have `[section]` if you have `[section "subsection"]`, but you
48 don't need to.
50 There is also a deprecated `[section.subsection]` syntax. With this
51 syntax, the subsection name is converted to lower-case and is also
52 compared case sensitively. These subsection names follow the same
53 restrictions as section names.
55 All the other lines (and the remainder of the line after the section
56 header) are recognized as setting variables, in the form
57 'name = value' (or just 'name', which is a short-hand to say that
58 the variable is the boolean "true").
59 The variable names are case-insensitive, allow only alphanumeric characters
60 and `-`, and must start with an alphabetic character.
62 A line that defines a value can be continued to the next line by
63 ending it with a `\`; the backquote and the end-of-line are
64 stripped. Leading whitespaces after 'name =', the remainder of the
65 line after the first comment character '#' or ';', and trailing
66 whitespaces of the line are discarded unless they are enclosed in
67 double quotes. Internal whitespaces within the value are retained
68 verbatim.
70 Inside double quotes, double quote `"` and backslash `\` characters
71 must be escaped: use `\"` for `"` and `\\` for `\`.
73 The following escape sequences (beside `\"` and `\\`) are recognized:
74 `\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
75 and `\b` for backspace (BS). Other char escape sequences (including octal
76 escape sequences) are invalid.
79 Includes
80 ~~~~~~~~
82 You can include one config file from another by setting the special
83 `include.path` variable to the name of the file to be included. The
84 variable takes a pathname as its value, and is subject to tilde
85 expansion.
87 The
88 included file is expanded immediately, as if its contents had been
89 found at the location of the include directive. If the value of the
90 `include.path` variable is a relative path, the path is considered to be
91 relative to the configuration file in which the include directive was
92 found. See below for examples.
95 Example
96 ~~~~~~~
98 # Core variables
99 [core]
100 ; Don't trust file modes
101 filemode = false
103 # Our diff algorithm
104 [diff]
105 external = /usr/local/bin/diff-wrapper
106 renames = true
108 [branch "devel"]
109 remote = origin
110 merge = refs/heads/devel
112 # Proxy settings
113 [core]
114 gitProxy="ssh" for ""
115 gitProxy=default-proxy ; for the rest
117 [include]
118 path = /path/to/ ; include by absolute path
119 path = foo ; expand "foo" relative to the current file
120 path = ~/foo ; expand "foo" in your `$HOME` directory
123 Values
124 ~~~~~~
126 Values of many variables are treated as a simple string, but there
127 are variables that take values of specific types and there are rules
128 as to how to spell them.
130 boolean::
132 When a variable is said to take a boolean value, many
133 synonyms are accepted for 'true' and 'false'; these are all
134 case-insensitive.
136 true;; Boolean true can be spelled as `yes`, `on`, `true`,
137 or `1`. Also, a variable defined without `= <value>`
138 is taken as true.
140 false;; Boolean false can be spelled as `no`, `off`,
141 `false`, or `0`.
142 +
143 When converting value to the canonical form using '--bool' type
144 specifier; 'git config' will ensure that the output is "true" or
145 "false" (spelled in lowercase).
147 integer::
148 The value for many variables that specify various sizes can
149 be suffixed with `k`, `M`,... to mean "scale the number by
150 1024", "by 1024x1024", etc.
152 color::
153 The value for a variables that takes a color is a list of
154 colors (at most two) and attributes (at most one), separated
155 by spaces. The colors accepted are `normal`, `black`,
156 `red`, `green`, `yellow`, `blue`, `magenta`, `cyan` and
157 `white`; the attributes are `bold`, `dim`, `ul`, `blink` and
158 `reverse`. The first color given is the foreground; the
159 second is the background. The position of the attribute, if
160 any, doesn't matter. Attributes may be turned off specifically
161 by prefixing them with `no` (e.g., `noreverse`, `noul`, etc).
162 +
163 Colors (foreground and background) may also be given as numbers between
164 0 and 255; these use ANSI 256-color mode (but note that not all
165 terminals may support this). If your terminal supports it, you may also
166 specify 24-bit RGB values as hex, like `#ff0ab3`.
167 +
168 The attributes are meant to be reset at the beginning of each item
169 in the colored output, so setting color.decorate.branch to `black`
170 will paint that branch name in a plain `black`, even if the previous
171 thing on the same output line (e.g. opening parenthesis before the
172 list of branch names in `log --decorate` output) is set to be
173 painted with `bold` or some other attribute.
175 pathname::
176 A variable that takes a pathname value can be given a
177 string that begins with "`~/`" or "`~user/`", and the usual
178 tilde expansion happens to such a string: `~/`
179 is expanded to the value of `$HOME`, and `~user/` to the
180 specified user's home directory.
183 Variables
184 ~~~~~~~~~
186 Note that this list is non-comprehensive and not necessarily complete.
187 For command-specific variables, you will find a more detailed description
188 in the appropriate manual page.
190 Other git-related tools may and do use their own variables. When
191 inventing new variables for use in your own tool, make sure their
192 names do not conflict with those that are used by Git itself and
193 other popular tools, and describe them in your documentation.
196 advice.*::
197 These variables control various optional help messages designed to
198 aid new users. All 'advice.*' variables default to 'true', and you
199 can tell Git that you do not need help by setting these to 'false':
200 +
201 --
202 pushUpdateRejected::
203 Set this variable to 'false' if you want to disable
204 'pushNonFFCurrent',
205 'pushNonFFMatching', 'pushAlreadyExists',
206 'pushFetchFirst', and 'pushNeedsForce'
207 simultaneously.
208 pushNonFFCurrent::
209 Advice shown when linkgit:git-push[1] fails due to a
210 non-fast-forward update to the current branch.
211 pushNonFFMatching::
212 Advice shown when you ran linkgit:git-push[1] and pushed
213 'matching refs' explicitly (i.e. you used ':', or
214 specified a refspec that isn't your current branch) and
215 it resulted in a non-fast-forward error.
216 pushAlreadyExists::
217 Shown when linkgit:git-push[1] rejects an update that
218 does not qualify for fast-forwarding (e.g., a tag.)
219 pushFetchFirst::
220 Shown when linkgit:git-push[1] rejects an update that
221 tries to overwrite a remote ref that points at an
222 object we do not have.
223 pushNeedsForce::
224 Shown when linkgit:git-push[1] rejects an update that
225 tries to overwrite a remote ref that points at an
226 object that is not a commit-ish, or make the remote
227 ref point at an object that is not a commit-ish.
228 statusHints::
229 Show directions on how to proceed from the current
230 state in the output of linkgit:git-status[1], in
231 the template shown when writing commit messages in
232 linkgit:git-commit[1], and in the help message shown
233 by linkgit:git-checkout[1] when switching branch.
234 statusUoption::
235 Advise to consider using the `-u` option to linkgit:git-status[1]
236 when the command takes more than 2 seconds to enumerate untracked
237 files.
238 commitBeforeMerge::
239 Advice shown when linkgit:git-merge[1] refuses to
240 merge to avoid overwriting local changes.
241 resolveConflict::
242 Advice shown by various commands when conflicts
243 prevent the operation from being performed.
244 implicitIdentity::
245 Advice on how to set your identity configuration when
246 your information is guessed from the system username and
247 domain name.
248 detachedHead::
249 Advice shown when you used linkgit:git-checkout[1] to
250 move to the detach HEAD state, to instruct how to create
251 a local branch after the fact.
252 amWorkDir::
253 Advice that shows the location of the patch file when
254 linkgit:git-am[1] fails to apply it.
255 rmHints::
256 In case of failure in the output of linkgit:git-rm[1],
257 show directions on how to proceed from the current state.
258 --
260 core.fileMode::
261 Tells Git if the executable bit of files in the working tree
262 is to be honored.
263 +
264 Some filesystems lose the executable bit when a file that is
265 marked as executable is checked out, or checks out an
266 non-executable file with executable bit on.
267 linkgit:git-clone[1] or linkgit:git-init[1] probe the filesystem
268 to see if it handles the executable bit correctly
269 and this variable is automatically set as necessary.
270 +
271 A repository, however, may be on a filesystem that handles
272 the filemode correctly, and this variable is set to 'true'
273 when created, but later may be made accessible from another
274 environment that loses the filemode (e.g. exporting ext4 via
275 CIFS mount, visiting a Cygwin created repository with
276 Git for Windows or Eclipse).
277 In such a case it may be necessary to set this variable to 'false'.
278 See linkgit:git-update-index[1].
279 +
280 The default is true (when core.filemode is not specified in the config file).
282 core.hideDotFiles::
283 (Windows-only) If true, mark newly-created directories and files whose
284 name starts with a dot as hidden. If 'dotGitOnly', only the `.git/`
285 directory is hidden, but no other files starting with a dot. The
286 default mode is 'dotGitOnly'.
288 core.ignoreCase::
289 If true, this option enables various workarounds to enable
290 Git to work better on filesystems that are not case sensitive,
291 like FAT. For example, if a directory listing finds
292 "makefile" when Git expects "Makefile", Git will assume
293 it is really the same file, and continue to remember it as
294 "Makefile".
295 +
296 The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
297 will probe and set core.ignoreCase true if appropriate when the repository
298 is created.
300 core.precomposeUnicode::
301 This option is only used by Mac OS implementation of Git.
302 When core.precomposeUnicode=true, Git reverts the unicode decomposition
303 of filenames done by Mac OS. This is useful when sharing a repository
304 between Mac OS and Linux or Windows.
305 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
306 When false, file names are handled fully transparent by Git,
307 which is backward compatible with older versions of Git.
309 core.protectHFS::
310 If set to true, do not allow checkout of paths that would
311 be considered equivalent to `.git` on an HFS+ filesystem.
312 Defaults to `true` on Mac OS, and `false` elsewhere.
314 core.protectNTFS::
315 If set to true, do not allow checkout of paths that would
316 cause problems with the NTFS filesystem, e.g. conflict with
317 8.3 "short" names.
318 Defaults to `true` on Windows, and `false` elsewhere.
320 core.trustctime::
321 If false, the ctime differences between the index and the
322 working tree are ignored; useful when the inode change time
323 is regularly modified by something outside Git (file system
324 crawlers and some backup systems).
325 See linkgit:git-update-index[1]. True by default.
327 core.untrackedCache::
328 Determines what to do about the untracked cache feature of the
329 index. It will be kept, if this variable is unset or set to
330 `keep`. It will automatically be added if set to `true`. And
331 it will automatically be removed, if set to `false`. Before
332 setting it to `true`, you should check that mtime is working
333 properly on your system.
334 See linkgit:git-update-index[1]. `keep` by default.
336 core.checkStat::
337 Determines which stat fields to match between the index
338 and work tree. The user can set this to 'default' or
339 'minimal'. Default (or explicitly 'default'), is to check
340 all fields, including the sub-second part of mtime and ctime.
342 core.quotePath::
343 The commands that output paths (e.g. 'ls-files',
344 'diff'), when not given the `-z` option, will quote
345 "unusual" characters in the pathname by enclosing the
346 pathname in a double-quote pair and with backslashes the
347 same way strings in C source code are quoted. If this
348 variable is set to false, the bytes higher than 0x80 are
349 not quoted but output as verbatim. Note that double
350 quote, backslash and control characters are always
351 quoted without `-z` regardless of the setting of this
352 variable.
354 core.eol::
355 Sets the line ending type to use in the working directory for
356 files that have the `text` property set when core.autocrlf is false.
357 Alternatives are 'lf', 'crlf' and 'native', which uses the platform's
358 native line ending. The default value is `native`. See
359 linkgit:gitattributes[5] for more information on end-of-line
360 conversion.
362 core.safecrlf::
363 If true, makes Git check if converting `CRLF` is reversible when
364 end-of-line conversion is active. Git will verify if a command
365 modifies a file in the work tree either directly or indirectly.
366 For example, committing a file followed by checking out the
367 same file should yield the original file in the work tree. If
368 this is not the case for the current setting of
369 `core.autocrlf`, Git will reject the file. The variable can
370 be set to "warn", in which case Git will only warn about an
371 irreversible conversion but continue the operation.
372 +
373 CRLF conversion bears a slight chance of corrupting data.
374 When it is enabled, Git will convert CRLF to LF during commit and LF to
375 CRLF during checkout. A file that contains a mixture of LF and
376 CRLF before the commit cannot be recreated by Git. For text
377 files this is the right thing to do: it corrects line endings
378 such that we have only LF line endings in the repository.
379 But for binary files that are accidentally classified as text the
380 conversion can corrupt data.
381 +
382 If you recognize such corruption early you can easily fix it by
383 setting the conversion type explicitly in .gitattributes. Right
384 after committing you still have the original file in your work
385 tree and this file is not yet corrupted. You can explicitly tell
386 Git that this file is binary and Git will handle the file
387 appropriately.
388 +
389 Unfortunately, the desired effect of cleaning up text files with
390 mixed line endings and the undesired effect of corrupting binary
391 files cannot be distinguished. In both cases CRLFs are removed
392 in an irreversible way. For text files this is the right thing
393 to do because CRLFs are line endings, while for binary files
394 converting CRLFs corrupts data.
395 +
396 Note, this safety check does not mean that a checkout will generate a
397 file identical to the original file for a different setting of
398 `core.eol` and `core.autocrlf`, but only for the current one. For
399 example, a text file with `LF` would be accepted with `core.eol=lf`
400 and could later be checked out with `core.eol=crlf`, in which case the
401 resulting file would contain `CRLF`, although the original file
402 contained `LF`. However, in both work trees the line endings would be
403 consistent, that is either all `LF` or all `CRLF`, but never mixed. A
404 file with mixed line endings would be reported by the `core.safecrlf`
405 mechanism.
407 core.autocrlf::
408 Setting this variable to "true" is almost the same as setting
409 the `text` attribute to "auto" on all files except that text
410 files are not guaranteed to be normalized: files that contain
411 `CRLF` in the repository will not be touched. Use this
412 setting if you want to have `CRLF` line endings in your
413 working directory even though the repository does not have
414 normalized line endings. This variable can be set to 'input',
415 in which case no output conversion is performed.
417 core.symlinks::
418 If false, symbolic links are checked out as small plain files that
419 contain the link text. linkgit:git-update-index[1] and
420 linkgit:git-add[1] will not change the recorded type to regular
421 file. Useful on filesystems like FAT that do not support
422 symbolic links.
423 +
424 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
425 will probe and set core.symlinks false if appropriate when the repository
426 is created.
428 core.gitProxy::
429 A "proxy command" to execute (as 'command host port') instead
430 of establishing direct connection to the remote server when
431 using the Git protocol for fetching. If the variable value is
432 in the "COMMAND for DOMAIN" format, the command is applied only
433 on hostnames ending with the specified domain string. This variable
434 may be set multiple times and is matched in the given order;
435 the first match wins.
436 +
437 Can be overridden by the `GIT_PROXY_COMMAND` environment variable
438 (which always applies universally, without the special "for"
439 handling).
440 +
441 The special string `none` can be used as the proxy command to
442 specify that no proxy be used for a given domain pattern.
443 This is useful for excluding servers inside a firewall from
444 proxy use, while defaulting to a common proxy for external domains.
446 core.ignoreStat::
447 If true, Git will avoid using lstat() calls to detect if files have
448 changed by setting the "assume-unchanged" bit for those tracked files
449 which it has updated identically in both the index and working tree.
450 +
451 When files are modified outside of Git, the user will need to stage
452 the modified files explicitly (e.g. see 'Examples' section in
453 linkgit:git-update-index[1]).
454 Git will not normally detect changes to those files.
455 +
456 This is useful on systems where lstat() calls are very slow, such as
457 CIFS/Microsoft Windows.
458 +
459 False by default.
461 core.preferSymlinkRefs::
462 Instead of the default "symref" format for HEAD
463 and other symbolic reference files, use symbolic links.
464 This is sometimes needed to work with old scripts that
465 expect HEAD to be a symbolic link.
467 core.bare::
468 If true this repository is assumed to be 'bare' and has no
469 working directory associated with it. If this is the case a
470 number of commands that require a working directory will be
471 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
472 +
473 This setting is automatically guessed by linkgit:git-clone[1] or
474 linkgit:git-init[1] when the repository was created. By default a
475 repository that ends in "/.git" is assumed to be not bare (bare =
476 false), while all other repositories are assumed to be bare (bare
477 = true).
479 core.worktree::
480 Set the path to the root of the working tree.
481 If `GIT_COMMON_DIR` environment variable is set, core.worktree
482 is ignored and not used for determining the root of working tree.
483 This can be overridden by the `GIT_WORK_TREE` environment
484 variable and the '--work-tree' command-line option.
485 The value can be an absolute path or relative to the path to
486 the .git directory, which is either specified by --git-dir
487 or GIT_DIR, or automatically discovered.
488 If --git-dir or GIT_DIR is specified but none of
489 --work-tree, GIT_WORK_TREE and core.worktree is specified,
490 the current working directory is regarded as the top level
491 of your working tree.
492 +
493 Note that this variable is honored even when set in a configuration
494 file in a ".git" subdirectory of a directory and its value differs
495 from the latter directory (e.g. "/path/to/.git/config" has
496 core.worktree set to "/different/path"), which is most likely a
497 misconfiguration. Running Git commands in the "/path/to" directory will
498 still use "/different/path" as the root of the work tree and can cause
499 confusion unless you know what you are doing (e.g. you are creating a
500 read-only snapshot of the same index to a location different from the
501 repository's usual working tree).
503 core.logAllRefUpdates::
504 Enable the reflog. Updates to a ref <ref> is logged to the file
505 "`$GIT_DIR/logs/<ref>`", by appending the new and old
506 SHA-1, the date/time and the reason of the update, but
507 only when the file exists. If this configuration
508 variable is set to true, missing "`$GIT_DIR/logs/<ref>`"
509 file is automatically created for branch heads (i.e. under
510 refs/heads/), remote refs (i.e. under refs/remotes/),
511 note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
512 +
513 This information can be used to determine what commit
514 was the tip of a branch "2 days ago".
515 +
516 This value is true by default in a repository that has
517 a working directory associated with it, and false by
518 default in a bare repository.
520 core.repositoryFormatVersion::
521 Internal variable identifying the repository format and layout
522 version.
524 core.sharedRepository::
525 When 'group' (or 'true'), the repository is made shareable between
526 several users in a group (making sure all the files and objects are
527 group-writable). When 'all' (or 'world' or 'everybody'), the
528 repository will be readable by all users, additionally to being
529 group-shareable. When 'umask' (or 'false'), Git will use permissions
530 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
531 files in the repository will have this mode value. '0xxx' will override
532 user's umask value (whereas the other options will only override
533 requested parts of the user's umask value). Examples: '0660' will make
534 the repo read/write-able for the owner and group, but inaccessible to
535 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
536 repository that is group-readable but not group-writable.
537 See linkgit:git-init[1]. False by default.
539 core.warnAmbiguousRefs::
540 If true, Git will warn you if the ref name you passed it is ambiguous
541 and might match multiple refs in the repository. True by default.
543 core.compression::
544 An integer -1..9, indicating a default compression level.
545 -1 is the zlib default. 0 means no compression,
546 and 1..9 are various speed/size tradeoffs, 9 being slowest.
547 If set, this provides a default to other compression variables,
548 such as `core.looseCompression` and `pack.compression`.
550 core.looseCompression::
551 An integer -1..9, indicating the compression level for objects that
552 are not in a pack file. -1 is the zlib default. 0 means no
553 compression, and 1..9 are various speed/size tradeoffs, 9 being
554 slowest. If not set, defaults to core.compression. If that is
555 not set, defaults to 1 (best speed).
557 core.packedGitWindowSize::
558 Number of bytes of a pack file to map into memory in a
559 single mapping operation. Larger window sizes may allow
560 your system to process a smaller number of large pack files
561 more quickly. Smaller window sizes will negatively affect
562 performance due to increased calls to the operating system's
563 memory manager, but may improve performance when accessing
564 a large number of large pack files.
565 +
566 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
567 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
568 be reasonable for all users/operating systems. You probably do
569 not need to adjust this value.
570 +
571 Common unit suffixes of 'k', 'm', or 'g' are supported.
573 core.packedGitLimit::
574 Maximum number of bytes to map simultaneously into memory
575 from pack files. If Git needs to access more than this many
576 bytes at once to complete an operation it will unmap existing
577 regions to reclaim virtual address space within the process.
578 +
579 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
580 This should be reasonable for all users/operating systems, except on
581 the largest projects. You probably do not need to adjust this value.
582 +
583 Common unit suffixes of 'k', 'm', or 'g' are supported.
585 core.deltaBaseCacheLimit::
586 Maximum number of bytes to reserve for caching base objects
587 that may be referenced by multiple deltified objects. By storing the
588 entire decompressed base objects in a cache Git is able
589 to avoid unpacking and decompressing frequently used base
590 objects multiple times.
591 +
592 Default is 96 MiB on all platforms. This should be reasonable
593 for all users/operating systems, except on the largest projects.
594 You probably do not need to adjust this value.
595 +
596 Common unit suffixes of 'k', 'm', or 'g' are supported.
598 core.bigFileThreshold::
599 Files larger than this size are stored deflated, without
600 attempting delta compression. Storing large files without
601 delta compression avoids excessive memory usage, at the
602 slight expense of increased disk usage. Additionally files
603 larger than this size are always treated as binary.
604 +
605 Default is 512 MiB on all platforms. This should be reasonable
606 for most projects as source code and other text files can still
607 be delta compressed, but larger binary media files won't be.
608 +
609 Common unit suffixes of 'k', 'm', or 'g' are supported.
611 core.excludesFile::
612 Specifies the pathname to the file that contains patterns to
613 describe paths that are not meant to be tracked, in addition
614 to '.gitignore' (per-directory) and '.git/info/exclude'.
615 Defaults to `$XDG_CONFIG_HOME/git/ignore`.
616 If `$XDG_CONFIG_HOME` is either not set or empty, `$HOME/.config/git/ignore`
617 is used instead. See linkgit:gitignore[5].
619 core.askPass::
620 Some commands (e.g. svn and http interfaces) that interactively
621 ask for a password can be told to use an external program given
622 via the value of this variable. Can be overridden by the `GIT_ASKPASS`
623 environment variable. If not set, fall back to the value of the
624 `SSH_ASKPASS` environment variable or, failing that, a simple password
625 prompt. The external program shall be given a suitable prompt as
626 command-line argument and write the password on its STDOUT.
628 core.attributesFile::
629 In addition to '.gitattributes' (per-directory) and
630 '.git/info/attributes', Git looks into this file for attributes
631 (see linkgit:gitattributes[5]). Path expansions are made the same
632 way as for `core.excludesFile`. Its default value is
633 `$XDG_CONFIG_HOME/git/attributes`. If `$XDG_CONFIG_HOME` is either not
634 set or empty, `$HOME/.config/git/attributes` is used instead.
636 core.hooksPath::
637 By default Git will look for your hooks in the
638 '$GIT_DIR/hooks' directory. Set this to different path,
639 e.g. '/etc/git/hooks', and Git will try to find your hooks in
640 that directory, e.g. '/etc/git/hooks/pre-receive' instead of
641 in '$GIT_DIR/hooks/pre-receive'.
642 +
643 The path can be either absolute or relative. A relative path is
644 taken as relative to the directory where the hooks are run (see
645 the "DESCRIPTION" section of linkgit:githooks[5]).
646 +
647 This configuration variable is useful in cases where you'd like to
648 centrally configure your Git hooks instead of configuring them on a
649 per-repository basis, or as a more flexible and centralized
650 alternative to having an `init.templateDir` where you've changed
651 default hooks.
653 core.editor::
654 Commands such as `commit` and `tag` that lets you edit
655 messages by launching an editor uses the value of this
656 variable when it is set, and the environment variable
657 `GIT_EDITOR` is not set. See linkgit:git-var[1].
659 core.commentChar::
660 Commands such as `commit` and `tag` that lets you edit
661 messages consider a line that begins with this character
662 commented, and removes them after the editor returns
663 (default '#').
664 +
665 If set to "auto", `git-commit` would select a character that is not
666 the beginning character of any line in existing commit messages.
668 core.packedRefsTimeout::
669 The length of time, in milliseconds, to retry when trying to
670 lock the `packed-refs` file. Value 0 means not to retry at
671 all; -1 means to try indefinitely. Default is 1000 (i.e.,
672 retry for 1 second).
674 sequence.editor::
675 Text editor used by `git rebase -i` for editing the rebase instruction file.
676 The value is meant to be interpreted by the shell when it is used.
677 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
678 When not configured the default commit message editor is used instead.
680 core.pager::
681 Text viewer for use by Git commands (e.g., 'less'). The value
682 is meant to be interpreted by the shell. The order of preference
683 is the `$GIT_PAGER` environment variable, then `core.pager`
684 configuration, then `$PAGER`, and then the default chosen at
685 compile time (usually 'less').
686 +
687 When the `LESS` environment variable is unset, Git sets it to `FRX`
688 (if `LESS` environment variable is set, Git does not change it at
689 all). If you want to selectively override Git's default setting
690 for `LESS`, you can set `core.pager` to e.g. `less -S`. This will
691 be passed to the shell by Git, which will translate the final
692 command to `LESS=FRX less -S`. The environment does not set the
693 `S` option but the command line does, instructing less to truncate
694 long lines. Similarly, setting `core.pager` to `less -+F` will
695 deactivate the `F` option specified by the environment from the
696 command-line, deactivating the "quit if one screen" behavior of
697 `less`. One can specifically activate some flags for particular
698 commands: for example, setting `pager.blame` to `less -S` enables
699 line truncation only for `git blame`.
700 +
701 Likewise, when the `LV` environment variable is unset, Git sets it
702 to `-c`. You can override this setting by exporting `LV` with
703 another value or setting `core.pager` to `lv +c`.
705 core.whitespace::
706 A comma separated list of common whitespace problems to
707 notice. 'git diff' will use `color.diff.whitespace` to
708 highlight them, and 'git apply --whitespace=error' will
709 consider them as errors. You can prefix `-` to disable
710 any of them (e.g. `-trailing-space`):
711 +
712 * `blank-at-eol` treats trailing whitespaces at the end of the line
713 as an error (enabled by default).
714 * `space-before-tab` treats a space character that appears immediately
715 before a tab character in the initial indent part of the line as an
716 error (enabled by default).
717 * `indent-with-non-tab` treats a line that is indented with space
718 characters instead of the equivalent tabs as an error (not enabled by
719 default).
720 * `tab-in-indent` treats a tab character in the initial indent part of
721 the line as an error (not enabled by default).
722 * `blank-at-eof` treats blank lines added at the end of file as an error
723 (enabled by default).
724 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
725 `blank-at-eof`.
726 * `cr-at-eol` treats a carriage-return at the end of line as
727 part of the line terminator, i.e. with it, `trailing-space`
728 does not trigger if the character before such a carriage-return
729 is not a whitespace (not enabled by default).
730 * `tabwidth=<n>` tells how many character positions a tab occupies; this
731 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
732 errors. The default tab width is 8. Allowed values are 1 to 63.
734 core.fsyncObjectFiles::
735 This boolean will enable 'fsync()' when writing object files.
736 +
737 This is a total waste of time and effort on a filesystem that orders
738 data writes properly, but can be useful for filesystems that do not use
739 journalling (traditional UNIX filesystems) or that only journal metadata
740 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
742 core.preloadIndex::
743 Enable parallel index preload for operations like 'git diff'
744 +
745 This can speed up operations like 'git diff' and 'git status' especially
746 on filesystems like NFS that have weak caching semantics and thus
747 relatively high IO latencies. When enabled, Git will do the
748 index comparison to the filesystem data in parallel, allowing
749 overlapping IO's. Defaults to true.
751 core.createObject::
752 You can set this to 'link', in which case a hardlink followed by
753 a delete of the source are used to make sure that object creation
754 will not overwrite existing objects.
755 +
756 On some file system/operating system combinations, this is unreliable.
757 Set this config setting to 'rename' there; However, This will remove the
758 check that makes sure that existing object files will not get overwritten.
760 core.notesRef::
761 When showing commit messages, also show notes which are stored in
762 the given ref. The ref must be fully qualified. If the given
763 ref does not exist, it is not an error but means that no
764 notes should be printed.
765 +
766 This setting defaults to "refs/notes/commits", and it can be overridden by
767 the `GIT_NOTES_REF` environment variable. See linkgit:git-notes[1].
769 core.sparseCheckout::
770 Enable "sparse checkout" feature. See section "Sparse checkout" in
771 linkgit:git-read-tree[1] for more information.
773 core.abbrev::
774 Set the length object names are abbreviated to. If unspecified,
775 many commands abbreviate to 7 hexdigits, which may not be enough
776 for abbreviated object names to stay unique for sufficiently long
777 time.
779 add.ignoreErrors::
780 add.ignore-errors (deprecated)::
781 Tells 'git add' to continue adding files when some files cannot be
782 added due to indexing errors. Equivalent to the '--ignore-errors'
783 option of linkgit:git-add[1]. `add.ignore-errors` is deprecated,
784 as it does not follow the usual naming convention for configuration
785 variables.
787 alias.*::
788 Command aliases for the linkgit:git[1] command wrapper - e.g.
789 after defining "alias.last = cat-file commit HEAD", the invocation
790 "git last" is equivalent to "git cat-file commit HEAD". To avoid
791 confusion and troubles with script usage, aliases that
792 hide existing Git commands are ignored. Arguments are split by
793 spaces, the usual shell quoting and escaping is supported.
794 A quote pair or a backslash can be used to quote them.
795 +
796 If the alias expansion is prefixed with an exclamation point,
797 it will be treated as a shell command. For example, defining
798 " = !gitk --all --not ORIG_HEAD", the invocation
799 "git new" is equivalent to running the shell command
800 "gitk --all --not ORIG_HEAD". Note that shell commands will be
801 executed from the top-level directory of a repository, which may
802 not necessarily be the current directory.
803 `GIT_PREFIX` is set as returned by running 'git rev-parse --show-prefix'
804 from the original current directory. See linkgit:git-rev-parse[1].
806 am.keepcr::
807 If true, git-am will call git-mailsplit for patches in mbox format
808 with parameter '--keep-cr'. In this case git-mailsplit will
809 not remove `\r` from lines ending with `\r\n`. Can be overridden
810 by giving '--no-keep-cr' from the command line.
811 See linkgit:git-am[1], linkgit:git-mailsplit[1].
813 am.threeWay::
814 By default, `git am` will fail if the patch does not apply cleanly. When
815 set to true, this setting tells `git am` to fall back on 3-way merge if
816 the patch records the identity of blobs it is supposed to apply to and
817 we have those blobs available locally (equivalent to giving the `--3way`
818 option from the command line). Defaults to `false`.
819 See linkgit:git-am[1].
821 apply.ignoreWhitespace::
822 When set to 'change', tells 'git apply' to ignore changes in
823 whitespace, in the same way as the '--ignore-space-change'
824 option.
825 When set to one of: no, none, never, false tells 'git apply' to
826 respect all whitespace differences.
827 See linkgit:git-apply[1].
829 apply.whitespace::
830 Tells 'git apply' how to handle whitespaces, in the same way
831 as the '--whitespace' option. See linkgit:git-apply[1].
833 branch.autoSetupMerge::
834 Tells 'git branch' and 'git checkout' to set up new branches
835 so that linkgit:git-pull[1] will appropriately merge from the
836 starting point branch. Note that even if this option is not set,
837 this behavior can be chosen per-branch using the `--track`
838 and `--no-track` options. The valid settings are: `false` -- no
839 automatic setup is done; `true` -- automatic setup is done when the
840 starting point is a remote-tracking branch; `always` --
841 automatic setup is done when the starting point is either a
842 local branch or remote-tracking
843 branch. This option defaults to true.
845 branch.autoSetupRebase::
846 When a new branch is created with 'git branch' or 'git checkout'
847 that tracks another branch, this variable tells Git to set
848 up pull to rebase instead of merge (see "branch.<name>.rebase").
849 When `never`, rebase is never automatically set to true.
850 When `local`, rebase is set to true for tracked branches of
851 other local branches.
852 When `remote`, rebase is set to true for tracked branches of
853 remote-tracking branches.
854 When `always`, rebase will be set to true for all tracking
855 branches.
856 See "branch.autoSetupMerge" for details on how to set up a
857 branch to track another branch.
858 This option defaults to never.
860 branch.<name>.remote::
861 When on branch <name>, it tells 'git fetch' and 'git push'
862 which remote to fetch from/push to. The remote to push to
863 may be overridden with `remote.pushDefault` (for all branches).
864 The remote to push to, for the current branch, may be further
865 overridden by `branch.<name>.pushRemote`. If no remote is
866 configured, or if you are not on any branch, it defaults to
867 `origin` for fetching and `remote.pushDefault` for pushing.
868 Additionally, `.` (a period) is the current local repository
869 (a dot-repository), see `branch.<name>.merge`'s final note below.
871 branch.<name>.pushRemote::
872 When on branch <name>, it overrides `branch.<name>.remote` for
873 pushing. It also overrides `remote.pushDefault` for pushing
874 from branch <name>. When you pull from one place (e.g. your
875 upstream) and push to another place (e.g. your own publishing
876 repository), you would want to set `remote.pushDefault` to
877 specify the remote to push to for all branches, and use this
878 option to override it for a specific branch.
880 branch.<name>.merge::
881 Defines, together with branch.<name>.remote, the upstream branch
882 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
883 branch to merge and can also affect 'git push' (see push.default).
884 When in branch <name>, it tells 'git fetch' the default
885 refspec to be marked for merging in FETCH_HEAD. The value is
886 handled like the remote part of a refspec, and must match a
887 ref which is fetched from the remote given by
888 "branch.<name>.remote".
889 The merge information is used by 'git pull' (which at first calls
890 'git fetch') to lookup the default branch for merging. Without
891 this option, 'git pull' defaults to merge the first refspec fetched.
892 Specify multiple values to get an octopus merge.
893 If you wish to setup 'git pull' so that it merges into <name> from
894 another branch in the local repository, you can point
895 branch.<name>.merge to the desired branch, and use the relative path
896 setting `.` (a period) for branch.<name>.remote.
898 branch.<name>.mergeOptions::
899 Sets default options for merging into branch <name>. The syntax and
900 supported options are the same as those of linkgit:git-merge[1], but
901 option values containing whitespace characters are currently not
902 supported.
904 branch.<name>.rebase::
905 When true, rebase the branch <name> on top of the fetched branch,
906 instead of merging the default branch from the default remote when
907 "git pull" is run. See "pull.rebase" for doing this in a non
908 branch-specific manner.
909 +
910 When preserve, also pass `--preserve-merges` along to 'git rebase'
911 so that locally committed merge commits will not be flattened
912 by running 'git pull'.
913 +
914 When the value is `interactive`, the rebase is run in interactive mode.
915 +
916 *NOTE*: this is a possibly dangerous operation; do *not* use
917 it unless you understand the implications (see linkgit:git-rebase[1]
918 for details).
920 branch.<name>.description::
921 Branch description, can be edited with
922 `git branch --edit-description`. Branch description is
923 automatically added in the format-patch cover letter or
924 request-pull summary.
926 browser.<tool>.cmd::
927 Specify the command to invoke the specified browser. The
928 specified command is evaluated in shell with the URLs passed
929 as arguments. (See linkgit:git-web{litdd}browse[1].)
931 browser.<tool>.path::
932 Override the path for the given tool that may be used to
933 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
934 working repository in gitweb (see linkgit:git-instaweb[1]).
936 clean.requireForce::
937 A boolean to make git-clean do nothing unless given -f,
938 -i or -n. Defaults to true.
940 color.branch::
941 A boolean to enable/disable color in the output of
942 linkgit:git-branch[1]. May be set to `always`,
943 `false` (or `never`) or `auto` (or `true`), in which case colors are used
944 only when the output is to a terminal. Defaults to false.
946 color.branch.<slot>::
947 Use customized color for branch coloration. `<slot>` is one of
948 `current` (the current branch), `local` (a local branch),
949 `remote` (a remote-tracking branch in refs/remotes/),
950 `upstream` (upstream tracking branch), `plain` (other
951 refs).
953 color.diff::
954 Whether to use ANSI escape sequences to add color to patches.
955 If this is set to `always`, linkgit:git-diff[1],
956 linkgit:git-log[1], and linkgit:git-show[1] will use color
957 for all patches. If it is set to `true` or `auto`, those
958 commands will only use color when output is to the terminal.
959 Defaults to false.
960 +
961 This does not affect linkgit:git-format-patch[1] or the
962 'git-diff-{asterisk}' plumbing commands. Can be overridden on the
963 command line with the `--color[=<when>]` option.
965 color.diff.<slot>::
966 Use customized color for diff colorization. `<slot>` specifies
967 which part of the patch to use the specified color, and is one
968 of `context` (context text - `plain` is a historical synonym),
969 `meta` (metainformation), `frag`
970 (hunk header), 'func' (function in hunk header), `old` (removed lines),
971 `new` (added lines), `commit` (commit headers), or `whitespace`
972 (highlighting whitespace errors).
974 color.decorate.<slot>::
975 Use customized color for 'git log --decorate' output. `<slot>` is one
976 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
977 branches, remote-tracking branches, tags, stash and HEAD, respectively.
979 color.grep::
980 When set to `always`, always highlight matches. When `false` (or
981 `never`), never. When set to `true` or `auto`, use color only
982 when the output is written to the terminal. Defaults to `false`.
984 color.grep.<slot>::
985 Use customized color for grep colorization. `<slot>` specifies which
986 part of the line to use the specified color, and is one of
987 +
988 --
989 `context`;;
990 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
991 `filename`;;
992 filename prefix (when not using `-h`)
993 `function`;;
994 function name lines (when using `-p`)
995 `linenumber`;;
996 line number prefix (when using `-n`)
997 `match`;;
998 matching text (same as setting `matchContext` and `matchSelected`)
999 `matchContext`;;
1000 matching text in context lines
1001 `matchSelected`;;
1002 matching text in selected lines
1003 `selected`;;
1004 non-matching text in selected lines
1005 `separator`;;
1006 separators between fields on a line (`:`, `-`, and `=`)
1007 and between hunks (`--`)
1008 --
1010 color.interactive::
1011 When set to `always`, always use colors for interactive prompts
1012 and displays (such as those used by "git-add --interactive" and
1013 "git-clean --interactive"). When false (or `never`), never.
1014 When set to `true` or `auto`, use colors only when the output is
1015 to the terminal. Defaults to false.
1017 color.interactive.<slot>::
1018 Use customized color for 'git add --interactive' and 'git clean
1019 --interactive' output. `<slot>` may be `prompt`, `header`, `help`
1020 or `error`, for four distinct types of normal output from
1021 interactive commands.
1023 color.pager::
1024 A boolean to enable/disable colored output when the pager is in
1025 use (default is true).
1027 color.showBranch::
1028 A boolean to enable/disable color in the output of
1029 linkgit:git-show-branch[1]. May be set to `always`,
1030 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1031 only when the output is to a terminal. Defaults to false.
1033 color.status::
1034 A boolean to enable/disable color in the output of
1035 linkgit:git-status[1]. May be set to `always`,
1036 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1037 only when the output is to a terminal. Defaults to false.
1039 color.status.<slot>::
1040 Use customized color for status colorization. `<slot>` is
1041 one of `header` (the header text of the status message),
1042 `added` or `updated` (files which are added but not committed),
1043 `changed` (files which are changed but not added in the index),
1044 `untracked` (files which are not tracked by Git),
1045 `branch` (the current branch),
1046 `nobranch` (the color the 'no branch' warning is shown in, defaulting
1047 to red), or
1048 `unmerged` (files which have unmerged changes).
1050 color.ui::
1051 This variable determines the default value for variables such
1052 as `color.diff` and `color.grep` that control the use of color
1053 per command family. Its scope will expand as more commands learn
1054 configuration to set a default for the `--color` option. Set it
1055 to `false` or `never` if you prefer Git commands not to use
1056 color unless enabled explicitly with some other configuration
1057 or the `--color` option. Set it to `always` if you want all
1058 output not intended for machine consumption to use color, to
1059 `true` or `auto` (this is the default since Git 1.8.4) if you
1060 want such output to use color when written to the terminal.
1062 column.ui::
1063 Specify whether supported commands should output in columns.
1064 This variable consists of a list of tokens separated by spaces
1065 or commas:
1066 +
1067 These options control when the feature should be enabled
1068 (defaults to 'never'):
1069 +
1070 --
1071 `always`;;
1072 always show in columns
1073 `never`;;
1074 never show in columns
1075 `auto`;;
1076 show in columns if the output is to the terminal
1077 --
1078 +
1079 These options control layout (defaults to 'column'). Setting any
1080 of these implies 'always' if none of 'always', 'never', or 'auto' are
1081 specified.
1082 +
1083 --
1084 `column`;;
1085 fill columns before rows
1086 `row`;;
1087 fill rows before columns
1088 `plain`;;
1089 show in one column
1090 --
1091 +
1092 Finally, these options can be combined with a layout option (defaults
1093 to 'nodense'):
1094 +
1095 --
1096 `dense`;;
1097 make unequal size columns to utilize more space
1098 `nodense`;;
1099 make equal size columns
1100 --
1102 column.branch::
1103 Specify whether to output branch listing in `git branch` in columns.
1104 See `column.ui` for details.
1106 column.clean::
1107 Specify the layout when list items in `git clean -i`, which always
1108 shows files and directories in columns. See `column.ui` for details.
1110 column.status::
1111 Specify whether to output untracked files in `git status` in columns.
1112 See `column.ui` for details.
1114 column.tag::
1115 Specify whether to output tag listing in `git tag` in columns.
1116 See `column.ui` for details.
1118 commit.cleanup::
1119 This setting overrides the default of the `--cleanup` option in
1120 `git commit`. See linkgit:git-commit[1] for details. Changing the
1121 default can be useful when you always want to keep lines that begin
1122 with comment character `#` in your log message, in which case you
1123 would do `git config commit.cleanup whitespace` (note that you will
1124 have to remove the help lines that begin with `#` in the commit log
1125 template yourself, if you do this).
1127 commit.gpgSign::
1129 A boolean to specify whether all commits should be GPG signed.
1130 Use of this option when doing operations such as rebase can
1131 result in a large number of commits being signed. It may be
1132 convenient to use an agent to avoid typing your GPG passphrase
1133 several times.
1135 commit.status::
1136 A boolean to enable/disable inclusion of status information in the
1137 commit message template when using an editor to prepare the commit
1138 message. Defaults to true.
1140 commit.template::
1141 Specify the pathname of a file to use as the template for
1142 new commit messages.
1144 commit.verbose::
1145 A boolean or int to specify the level of verbose with `git commit`.
1146 See linkgit:git-commit[1].
1148 credential.helper::
1149 Specify an external helper to be called when a username or
1150 password credential is needed; the helper may consult external
1151 storage to avoid prompting the user for the credentials. Note
1152 that multiple helpers may be defined. See linkgit:gitcredentials[7]
1153 for details.
1155 credential.useHttpPath::
1156 When acquiring credentials, consider the "path" component of an http
1157 or https URL to be important. Defaults to false. See
1158 linkgit:gitcredentials[7] for more information.
1160 credential.username::
1161 If no username is set for a network authentication, use this username
1162 by default. See credential.<context>.* below, and
1163 linkgit:gitcredentials[7].
1165 credential.<url>.*::
1166 Any of the credential.* options above can be applied selectively to
1167 some credentials. For example "credential."
1168 would set the default username only for https connections to
1169 See linkgit:gitcredentials[7] for details on how URLs are
1170 matched.
1172 credentialCache.ignoreSIGHUP::
1173 Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.
1175 include::diff-config.txt[]
1177 difftool.<tool>.path::
1178 Override the path for the given tool. This is useful in case
1179 your tool is not in the PATH.
1181 difftool.<tool>.cmd::
1182 Specify the command to invoke the specified diff tool.
1183 The specified command is evaluated in shell with the following
1184 variables available: 'LOCAL' is set to the name of the temporary
1185 file containing the contents of the diff pre-image and 'REMOTE'
1186 is set to the name of the temporary file containing the contents
1187 of the diff post-image.
1189 difftool.prompt::
1190 Prompt before each invocation of the diff tool.
1192 fastimport.unpackLimit::
1193 If the number of objects imported by linkgit:git-fast-import[1]
1194 is below this limit, then the objects will be unpacked into
1195 loose object files. However if the number of imported objects
1196 equals or exceeds this limit then the pack will be stored as a
1197 pack. Storing the pack from a fast-import can make the import
1198 operation complete faster, especially on slow filesystems. If
1199 not set, the value of `transfer.unpackLimit` is used instead.
1201 fetch.recurseSubmodules::
1202 This option can be either set to a boolean value or to 'on-demand'.
1203 Setting it to a boolean changes the behavior of fetch and pull to
1204 unconditionally recurse into submodules when set to true or to not
1205 recurse at all when set to false. When set to 'on-demand' (the default
1206 value), fetch and pull will only recurse into a populated submodule
1207 when its superproject retrieves a commit that updates the submodule's
1208 reference.
1210 fetch.fsckObjects::
1211 If it is set to true, git-fetch-pack will check all fetched
1212 objects. It will abort in the case of a malformed object or a
1213 broken link. The result of an abort are only dangling objects.
1214 Defaults to false. If not set, the value of `transfer.fsckObjects`
1215 is used instead.
1217 fetch.unpackLimit::
1218 If the number of objects fetched over the Git native
1219 transfer is below this
1220 limit, then the objects will be unpacked into loose object
1221 files. However if the number of received objects equals or
1222 exceeds this limit then the received pack will be stored as
1223 a pack, after adding any missing delta bases. Storing the
1224 pack from a push can make the push operation complete faster,
1225 especially on slow filesystems. If not set, the value of
1226 `transfer.unpackLimit` is used instead.
1228 fetch.prune::
1229 If true, fetch will automatically behave as if the `--prune`
1230 option was given on the command line. See also `remote.<name>.prune`.
1232 format.attach::
1233 Enable multipart/mixed attachments as the default for
1234 'format-patch'. The value can also be a double quoted string
1235 which will enable attachments as the default and set the
1236 value as the boundary. See the --attach option in
1237 linkgit:git-format-patch[1].
1239 format.numbered::
1240 A boolean which can enable or disable sequence numbers in patch
1241 subjects. It defaults to "auto" which enables it only if there
1242 is more than one patch. It can be enabled or disabled for all
1243 messages by setting it to "true" or "false". See --numbered
1244 option in linkgit:git-format-patch[1].
1246 format.headers::
1247 Additional email headers to include in a patch to be submitted
1248 by mail. See linkgit:git-format-patch[1].
1252 Additional recipients to include in a patch to be submitted
1253 by mail. See the --to and --cc options in
1254 linkgit:git-format-patch[1].
1256 format.subjectPrefix::
1257 The default for format-patch is to output files with the '[PATCH]'
1258 subject prefix. Use this variable to change that prefix.
1260 format.signature::
1261 The default for format-patch is to output a signature containing
1262 the Git version number. Use this variable to change that default.
1263 Set this variable to the empty string ("") to suppress
1264 signature generation.
1266 format.signatureFile::
1267 Works just like format.signature except the contents of the
1268 file specified by this variable will be used as the signature.
1270 format.suffix::
1271 The default for format-patch is to output files with the suffix
1272 `.patch`. Use this variable to change that suffix (make sure to
1273 include the dot if you want it).
1275 format.pretty::
1276 The default pretty format for log/show/whatchanged command,
1277 See linkgit:git-log[1], linkgit:git-show[1],
1278 linkgit:git-whatchanged[1].
1280 format.thread::
1281 The default threading style for 'git format-patch'. Can be
1282 a boolean value, or `shallow` or `deep`. `shallow` threading
1283 makes every mail a reply to the head of the series,
1284 where the head is chosen from the cover letter, the
1285 `--in-reply-to`, and the first patch mail, in this order.
1286 `deep` threading makes every mail a reply to the previous one.
1287 A true boolean value is the same as `shallow`, and a false
1288 value disables threading.
1290 format.signOff::
1291 A boolean value which lets you enable the `-s/--signoff` option of
1292 format-patch by default. *Note:* Adding the Signed-off-by: line to a
1293 patch should be a conscious act and means that you certify you have
1294 the rights to submit this work under the same open source license.
1295 Please see the 'SubmittingPatches' document for further discussion.
1297 format.coverLetter::
1298 A boolean that controls whether to generate a cover-letter when
1299 format-patch is invoked, but in addition can be set to "auto", to
1300 generate a cover-letter only when there's more than one patch.
1302 format.outputDirectory::
1303 Set a custom directory to store the resulting files instead of the
1304 current working directory.
1306 format.useAutoBase::
1307 A boolean value which lets you enable the `--base=auto` option of
1308 format-patch by default.
1310 filter.<driver>.clean::
1311 The command which is used to convert the content of a worktree
1312 file to a blob upon checkin. See linkgit:gitattributes[5] for
1313 details.
1315 filter.<driver>.smudge::
1316 The command which is used to convert the content of a blob
1317 object to a worktree file upon checkout. See
1318 linkgit:gitattributes[5] for details.
1320 fsck.<msg-id>::
1321 Allows overriding the message type (error, warn or ignore) of a
1322 specific message ID such as `missingEmail`.
1323 +
1324 For convenience, fsck prefixes the error/warning with the message ID,
1325 e.g. "missingEmail: invalid author/committer line - missing email" means
1326 that setting `fsck.missingEmail = ignore` will hide that issue.
1327 +
1328 This feature is intended to support working with legacy repositories
1329 which cannot be repaired without disruptive changes.
1331 fsck.skipList::
1332 The path to a sorted list of object names (i.e. one SHA-1 per
1333 line) that are known to be broken in a non-fatal way and should
1334 be ignored. This feature is useful when an established project
1335 should be accepted despite early commits containing errors that
1336 can be safely ignored such as invalid committer email addresses.
1337 Note: corrupt objects cannot be skipped with this setting.
1339 gc.aggressiveDepth::
1340 The depth parameter used in the delta compression
1341 algorithm used by 'git gc --aggressive'. This defaults
1342 to 250.
1344 gc.aggressiveWindow::
1345 The window size parameter used in the delta compression
1346 algorithm used by 'git gc --aggressive'. This defaults
1347 to 250.
1350 When there are approximately more than this many loose
1351 objects in the repository, `git gc --auto` will pack them.
1352 Some Porcelain commands use this command to perform a
1353 light-weight garbage collection from time to time. The
1354 default value is 6700. Setting this to 0 disables it.
1356 gc.autoPackLimit::
1357 When there are more than this many packs that are not
1358 marked with `*.keep` file in the repository, `git gc
1359 --auto` consolidates them into one larger pack. The
1360 default value is 50. Setting this to 0 disables it.
1362 gc.autoDetach::
1363 Make `git gc --auto` return immediately and run in background
1364 if the system supports it. Default is true.
1366 gc.packRefs::
1367 Running `git pack-refs` in a repository renders it
1368 unclonable by Git versions prior to over dumb
1369 transports such as HTTP. This variable determines whether
1370 'git gc' runs `git pack-refs`. This can be set to `notbare`
1371 to enable it within all non-bare repos or it can be set to a
1372 boolean value. The default is `true`.
1374 gc.pruneExpire::
1375 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1376 Override the grace period with this config variable. The value
1377 "now" may be used to disable this grace period and always prune
1378 unreachable objects immediately, or "never" may be used to
1379 suppress pruning.
1381 gc.worktreePruneExpire::
1382 When 'git gc' is run, it calls
1383 'git worktree prune --expire 3.months.ago'.
1384 This config variable can be used to set a different grace
1385 period. The value "now" may be used to disable the grace
1386 period and prune `$GIT_DIR/worktrees` immediately, or "never"
1387 may be used to suppress pruning.
1389 gc.reflogExpire::
1390 gc.<pattern>.reflogExpire::
1391 'git reflog expire' removes reflog entries older than
1392 this time; defaults to 90 days. The value "now" expires all
1393 entries immediately, and "never" suppresses expiration
1394 altogether. With "<pattern>" (e.g.
1395 "refs/stash") in the middle the setting applies only to
1396 the refs that match the <pattern>.
1398 gc.reflogExpireUnreachable::
1399 gc.<pattern>.reflogExpireUnreachable::
1400 'git reflog expire' removes reflog entries older than
1401 this time and are not reachable from the current tip;
1402 defaults to 30 days. The value "now" expires all entries
1403 immediately, and "never" suppresses expiration altogether.
1404 With "<pattern>" (e.g. "refs/stash")
1405 in the middle, the setting applies only to the refs that
1406 match the <pattern>.
1408 gc.rerereResolved::
1409 Records of conflicted merge you resolved earlier are
1410 kept for this many days when 'git rerere gc' is run.
1411 The default is 60 days. See linkgit:git-rerere[1].
1413 gc.rerereUnresolved::
1414 Records of conflicted merge you have not resolved are
1415 kept for this many days when 'git rerere gc' is run.
1416 The default is 15 days. See linkgit:git-rerere[1].
1418 gitcvs.commitMsgAnnotation::
1419 Append this string to each commit message. Set to empty string
1420 to disable this feature. Defaults to "via git-CVS emulator".
1422 gitcvs.enabled::
1423 Whether the CVS server interface is enabled for this repository.
1424 See linkgit:git-cvsserver[1].
1426 gitcvs.logFile::
1427 Path to a log file where the CVS server interface well... logs
1428 various stuff. See linkgit:git-cvsserver[1].
1430 gitcvs.usecrlfattr::
1431 If true, the server will look up the end-of-line conversion
1432 attributes for files to determine the '-k' modes to use. If
1433 the attributes force Git to treat a file as text,
1434 the '-k' mode will be left blank so CVS clients will
1435 treat it as text. If they suppress text conversion, the file
1436 will be set with '-kb' mode, which suppresses any newline munging
1437 the client might otherwise do. If the attributes do not allow
1438 the file type to be determined, then `gitcvs.allBinary` is
1439 used. See linkgit:gitattributes[5].
1441 gitcvs.allBinary::
1442 This is used if `gitcvs.usecrlfattr` does not resolve
1443 the correct '-kb' mode to use. If true, all
1444 unresolved files are sent to the client in
1445 mode '-kb'. This causes the client to treat them
1446 as binary files, which suppresses any newline munging it
1447 otherwise might do. Alternatively, if it is set to "guess",
1448 then the contents of the file are examined to decide if
1449 it is binary, similar to `core.autocrlf`.
1451 gitcvs.dbName::
1452 Database used by git-cvsserver to cache revision information
1453 derived from the Git repository. The exact meaning depends on the
1454 used database driver, for SQLite (which is the default driver) this
1455 is a filename. Supports variable substitution (see
1456 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1457 Default: '%Ggitcvs.%m.sqlite'
1459 gitcvs.dbDriver::
1460 Used Perl DBI driver. You can specify any available driver
1461 for this here, but it might not work. git-cvsserver is tested
1462 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1463 reported *not* to work with 'DBD::mysql'. Experimental feature.
1464 May not contain double colons (`:`). Default: 'SQLite'.
1465 See linkgit:git-cvsserver[1].
1467 gitcvs.dbUser, gitcvs.dbPass::
1468 Database user and password. Only useful if setting `gitcvs.dbDriver`,
1469 since SQLite has no concept of database users and/or passwords.
1470 'gitcvs.dbUser' supports variable substitution (see
1471 linkgit:git-cvsserver[1] for details).
1473 gitcvs.dbTableNamePrefix::
1474 Database table name prefix. Prepended to the names of any
1475 database tables used, allowing a single database to be used
1476 for several repositories. Supports variable substitution (see
1477 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1478 characters will be replaced with underscores.
1480 All gitcvs variables except for `gitcvs.usecrlfattr` and
1481 `gitcvs.allBinary` can also be specified as
1482 'gitcvs.<access_method>.<varname>' (where 'access_method'
1483 is one of "ext" and "pserver") to make them apply only for the given
1484 access method.
1486 gitweb.category::
1487 gitweb.description::
1488 gitweb.owner::
1489 gitweb.url::
1490 See linkgit:gitweb[1] for description.
1492 gitweb.avatar::
1493 gitweb.blame::
1494 gitweb.grep::
1495 gitweb.highlight::
1496 gitweb.patches::
1497 gitweb.pickaxe::
1498 gitweb.remote_heads::
1499 gitweb.showSizes::
1500 gitweb.snapshot::
1501 See linkgit:gitweb.conf[5] for description.
1503 grep.lineNumber::
1504 If set to true, enable '-n' option by default.
1506 grep.patternType::
1507 Set the default matching behavior. Using a value of 'basic', 'extended',
1508 'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',
1509 '--fixed-strings', or '--perl-regexp' option accordingly, while the
1510 value 'default' will return to the default matching behavior.
1512 grep.extendedRegexp::
1513 If set to true, enable '--extended-regexp' option by default. This
1514 option is ignored when the `grep.patternType` option is set to a value
1515 other than 'default'.
1517 grep.threads::
1518 Number of grep worker threads to use.
1519 See `grep.threads` in linkgit:git-grep[1] for more information.
1521 grep.fallbackToNoIndex::
1522 If set to true, fall back to git grep --no-index if git grep
1523 is executed outside of a git repository. Defaults to false.
1525 gpg.program::
1526 Use this custom program instead of "`gpg`" found on `$PATH` when
1527 making or verifying a PGP signature. The program must support the
1528 same command-line interface as GPG, namely, to verify a detached
1529 signature, "`gpg --verify $file - <$signature`" is run, and the
1530 program is expected to signal a good signature by exiting with
1531 code 0, and to generate an ASCII-armored detached signature, the
1532 standard input of "`gpg -bsau $key`" is fed with the contents to be
1533 signed, and the program is expected to send the result to its
1534 standard output.
1536 gui.commitMsgWidth::
1537 Defines how wide the commit message window is in the
1538 linkgit:git-gui[1]. "75" is the default.
1540 gui.diffContext::
1541 Specifies how many context lines should be used in calls to diff
1542 made by the linkgit:git-gui[1]. The default is "5".
1544 gui.displayUntracked::
1545 Determines if linkgit:git-gui[1] shows untracked files
1546 in the file list. The default is "true".
1548 gui.encoding::
1549 Specifies the default encoding to use for displaying of
1550 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1551 It can be overridden by setting the 'encoding' attribute
1552 for relevant files (see linkgit:gitattributes[5]).
1553 If this option is not set, the tools default to the
1554 locale encoding.
1556 gui.matchTrackingBranch::
1557 Determines if new branches created with linkgit:git-gui[1] should
1558 default to tracking remote branches with matching names or
1559 not. Default: "false".
1561 gui.newBranchTemplate::
1562 Is used as suggested name when creating new branches using the
1563 linkgit:git-gui[1].
1565 gui.pruneDuringFetch::
1566 "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1567 performing a fetch. The default value is "false".
1569 gui.trustmtime::
1570 Determines if linkgit:git-gui[1] should trust the file modification
1571 timestamp or not. By default the timestamps are not trusted.
1573 gui.spellingDictionary::
1574 Specifies the dictionary used for spell checking commit messages in
1575 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1576 off.
1578 gui.fastCopyBlame::
1579 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1580 location detection. It makes blame significantly faster on huge
1581 repositories at the expense of less thorough copy detection.
1583 gui.copyBlameThreshold::
1584 Specifies the threshold to use in 'git gui blame' original location
1585 detection, measured in alphanumeric characters. See the
1586 linkgit:git-blame[1] manual for more information on copy detection.
1588 gui.blamehistoryctx::
1589 Specifies the radius of history context in days to show in
1590 linkgit:gitk[1] for the selected commit, when the `Show History
1591 Context` menu item is invoked from 'git gui blame'. If this
1592 variable is set to zero, the whole history is shown.
1594 guitool.<name>.cmd::
1595 Specifies the shell command line to execute when the corresponding item
1596 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1597 mandatory for every tool. The command is executed from the root of
1598 the working directory, and in the environment it receives the name of
1599 the tool as `GIT_GUITOOL`, the name of the currently selected file as
1600 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1601 the head is detached, 'CUR_BRANCH' is empty).
1603 guitool.<name>.needsFile::
1604 Run the tool only if a diff is selected in the GUI. It guarantees
1605 that 'FILENAME' is not empty.
1607 guitool.<name>.noConsole::
1608 Run the command silently, without creating a window to display its
1609 output.
1611 guitool.<name>.noRescan::
1612 Don't rescan the working directory for changes after the tool
1613 finishes execution.
1615 guitool.<name>.confirm::
1616 Show a confirmation dialog before actually running the tool.
1618 guitool.<name>.argPrompt::
1619 Request a string argument from the user, and pass it to the tool
1620 through the `ARGS` environment variable. Since requesting an
1621 argument implies confirmation, the 'confirm' option has no effect
1622 if this is enabled. If the option is set to 'true', 'yes', or '1',
1623 the dialog uses a built-in generic prompt; otherwise the exact
1624 value of the variable is used.
1626 guitool.<name>.revPrompt::
1627 Request a single valid revision from the user, and set the
1628 `REVISION` environment variable. In other aspects this option
1629 is similar to 'argPrompt', and can be used together with it.
1631 guitool.<name>.revUnmerged::
1632 Show only unmerged branches in the 'revPrompt' subdialog.
1633 This is useful for tools similar to merge or rebase, but not
1634 for things like checkout or reset.
1636 guitool.<name>.title::
1637 Specifies the title to use for the prompt dialog. The default
1638 is the tool name.
1640 guitool.<name>.prompt::
1641 Specifies the general prompt string to display at the top of
1642 the dialog, before subsections for 'argPrompt' and 'revPrompt'.
1643 The default value includes the actual command.
1645 help.browser::
1646 Specify the browser that will be used to display help in the
1647 'web' format. See linkgit:git-help[1].
1649 help.format::
1650 Override the default help format used by linkgit:git-help[1].
1651 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1652 the default. 'web' and 'html' are the same.
1654 help.autoCorrect::
1655 Automatically correct and execute mistyped commands after
1656 waiting for the given number of deciseconds (0.1 sec). If more
1657 than one command can be deduced from the entered text, nothing
1658 will be executed. If the value of this option is negative,
1659 the corrected command will be executed immediately. If the
1660 value is 0 - the command will be just shown but not executed.
1661 This is the default.
1663 help.htmlPath::
1664 Specify the path where the HTML documentation resides. File system paths
1665 and URLs are supported. HTML pages will be prefixed with this path when
1666 help is displayed in the 'web' format. This defaults to the documentation
1667 path of your Git installation.
1669 http.proxy::
1670 Override the HTTP proxy, normally configured using the 'http_proxy',
1671 'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In
1672 addition to the syntax understood by curl, it is possible to specify a
1673 proxy string with a user name but no password, in which case git will
1674 attempt to acquire one in the same way it does for other credentials. See
1675 linkgit:gitcredentials[7] for more information. The syntax thus is
1676 '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden
1677 on a per-remote basis; see remote.<name>.proxy
1679 http.proxyAuthMethod::
1680 Set the method with which to authenticate against the HTTP proxy. This
1681 only takes effect if the configured proxy string contains a user name part
1682 (i.e. is of the form 'user@host' or 'user@host:port'). This can be
1683 overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.
1684 Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment
1685 variable. Possible values are:
1686 +
1687 --
1688 * `anyauth` - Automatically pick a suitable authentication method. It is
1689 assumed that the proxy answers an unauthenticated request with a 407
1690 status code and one or more Proxy-authenticate headers with supported
1691 authentication methods. This is the default.
1692 * `basic` - HTTP Basic authentication
1693 * `digest` - HTTP Digest authentication; this prevents the password from being
1694 transmitted to the proxy in clear text
1695 * `negotiate` - GSS-Negotiate authentication (compare the --negotiate option
1696 of `curl(1)`)
1697 * `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)
1698 --
1700 http.emptyAuth::
1701 Attempt authentication without seeking a username or password. This
1702 can be used to attempt GSS-Negotiate authentication without specifying
1703 a username in the URL, as libcurl normally requires a username for
1704 authentication.
1706 http.extraHeader::
1707 Pass an additional HTTP header when communicating with a server. If
1708 more than one such entry exists, all of them are added as extra
1709 headers. To allow overriding the settings inherited from the system
1710 config, an empty value will reset the extra headers to the empty list.
1712 http.cookieFile::
1713 The pathname of a file containing previously stored cookie lines,
1714 which should be used
1715 in the Git http session, if they match the server. The file format
1716 of the file to read cookies from should be plain HTTP headers or
1717 the Netscape/Mozilla cookie file format (see `curl(1)`).
1718 NOTE that the file specified with http.cookieFile is used only as
1719 input unless http.saveCookies is set.
1721 http.saveCookies::
1722 If set, store cookies received during requests to the file specified by
1723 http.cookieFile. Has no effect if http.cookieFile is unset.
1725 http.sslVersion::
1726 The SSL version to use when negotiating an SSL connection, if you
1727 want to force the default. The available and default version
1728 depend on whether libcurl was built against NSS or OpenSSL and the
1729 particular configuration of the crypto library in use. Internally
1730 this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl
1731 documentation for more details on the format of this option and
1732 for the ssl version supported. Actually the possible values of
1733 this option are:
1735 - sslv2
1736 - sslv3
1737 - tlsv1
1738 - tlsv1.0
1739 - tlsv1.1
1740 - tlsv1.2
1742 +
1743 Can be overridden by the `GIT_SSL_VERSION` environment variable.
1744 To force git to use libcurl's default ssl version and ignore any
1745 explicit http.sslversion option, set `GIT_SSL_VERSION` to the
1746 empty string.
1748 http.sslCipherList::
1749 A list of SSL ciphers to use when negotiating an SSL connection.
1750 The available ciphers depend on whether libcurl was built against
1751 NSS or OpenSSL and the particular configuration of the crypto
1752 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'
1753 option; see the libcurl documentation for more details on the format
1754 of this list.
1755 +
1756 Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.
1757 To force git to use libcurl's default cipher list and ignore any
1758 explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the
1759 empty string.
1761 http.sslVerify::
1762 Whether to verify the SSL certificate when fetching or pushing
1763 over HTTPS. Can be overridden by the `GIT_SSL_NO_VERIFY` environment
1764 variable.
1766 http.sslCert::
1767 File containing the SSL certificate when fetching or pushing
1768 over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment
1769 variable.
1771 http.sslKey::
1772 File containing the SSL private key when fetching or pushing
1773 over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment
1774 variable.
1776 http.sslCertPasswordProtected::
1777 Enable Git's password prompt for the SSL certificate. Otherwise
1778 OpenSSL will prompt the user, possibly many times, if the
1779 certificate or private key is encrypted. Can be overridden by the
1780 `GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.
1782 http.sslCAInfo::
1783 File containing the certificates to verify the peer with when
1784 fetching or pushing over HTTPS. Can be overridden by the
1785 `GIT_SSL_CAINFO` environment variable.
1787 http.sslCAPath::
1788 Path containing files with the CA certificates to verify the peer
1789 with when fetching or pushing over HTTPS. Can be overridden
1790 by the `GIT_SSL_CAPATH` environment variable.
1792 http.pinnedpubkey::
1793 Public key of the https service. It may either be the filename of
1794 a PEM or DER encoded public key file or a string starting with
1795 'sha256//' followed by the base64 encoded sha256 hash of the
1796 public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will
1797 exit with an error if this option is set but not supported by
1798 cURL.
1800 http.sslTry::
1801 Attempt to use AUTH SSL/TLS and encrypted data transfers
1802 when connecting via regular FTP protocol. This might be needed
1803 if the FTP server requires it for security reasons or you wish
1804 to connect securely whenever remote FTP server supports it.
1805 Default is false since it might trigger certificate verification
1806 errors on misconfigured servers.
1808 http.maxRequests::
1809 How many HTTP requests to launch in parallel. Can be overridden
1810 by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.
1812 http.minSessions::
1813 The number of curl sessions (counted across slots) to be kept across
1814 requests. They will not be ended with curl_easy_cleanup() until
1815 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1816 value will be capped at 1. Defaults to 1.
1818 http.postBuffer::
1819 Maximum size in bytes of the buffer used by smart HTTP
1820 transports when POSTing data to the remote system.
1821 For requests larger than this buffer size, HTTP/1.1 and
1822 Transfer-Encoding: chunked is used to avoid creating a
1823 massive pack file locally. Default is 1 MiB, which is
1824 sufficient for most requests.
1826 http.lowSpeedLimit, http.lowSpeedTime::
1827 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1828 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1829 Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and
1830 `GIT_HTTP_LOW_SPEED_TIME` environment variables.
1832 http.noEPSV::
1833 A boolean which disables using of EPSV ftp command by curl.
1834 This can helpful with some "poor" ftp servers which don't
1835 support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`
1836 environment variable. Default is false (curl will use EPSV).
1838 http.userAgent::
1839 The HTTP USER_AGENT string presented to an HTTP server. The default
1840 value represents the version of the client Git such as git/1.7.1.
1841 This option allows you to override this value to a more common value
1842 such as Mozilla/4.0. This may be necessary, for instance, if
1843 connecting through a firewall that restricts HTTP connections to a set
1844 of common USER_AGENT strings (but not including those like git/1.7.1).
1845 Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.
1847 http.<url>.*::
1848 Any of the http.* options above can be applied selectively to some URLs.
1849 For a config key to match a URL, each element of the config key is
1850 compared to that of the URL, in the following order:
1851 +
1852 --
1853 . Scheme (e.g., `https` in ``). This field
1854 must match exactly between the config key and the URL.
1856 . Host/domain name (e.g., `` in ``).
1857 This field must match exactly between the config key and the URL.
1859 . Port number (e.g., `8080` in ``).
1860 This field must match exactly between the config key and the URL.
1861 Omitted port numbers are automatically converted to the correct
1862 default for the scheme before matching.
1864 . Path (e.g., `repo.git` in ``). The
1865 path field of the config key must match the path field of the URL
1866 either exactly or as a prefix of slash-delimited path elements. This means
1867 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only
1868 match on a slash (`/`) boundary. Longer matches take precedence (so a config
1869 key with path `foo/bar` is a better match to URL path `foo/bar` than a config
1870 key with just path `foo/`).
1872 . User name (e.g., `user` in ``). If
1873 the config key has a user name it must match the user name in the
1874 URL exactly. If the config key does not have a user name, that
1875 config key will match a URL with any user name (including none),
1876 but at a lower precedence than a config key with a user name.
1877 --
1878 +
1879 The list above is ordered by decreasing precedence; a URL that matches
1880 a config key's path is preferred to one that matches its user name. For example,
1881 if the URL is `` a config key match of
1882 `` will be preferred over a config key match of
1883 ``.
1884 +
1885 All URLs are normalized before attempting any matching (the password part,
1886 if embedded in the URL, is always ignored for matching purposes) so that
1887 equivalent URLs that are simply spelled differently will match properly.
1888 Environment variable settings always override any matches. The URLs that are
1889 matched against are those given directly to Git commands. This means any URLs
1890 visited as a result of a redirection do not participate in matching.
1892 i18n.commitEncoding::
1893 Character encoding the commit messages are stored in; Git itself
1894 does not care per se, but this information is necessary e.g. when
1895 importing commits from emails or in the gitk graphical history
1896 browser (and possibly at other places in the future or in other
1897 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1899 i18n.logOutputEncoding::
1900 Character encoding the commit messages are converted to when
1901 running 'git log' and friends.
1903 imap::
1904 The configuration variables in the 'imap' section are described
1905 in linkgit:git-imap-send[1].
1907 index.version::
1908 Specify the version with which new index files should be
1909 initialized. This does not affect existing repositories.
1911 init.templateDir::
1912 Specify the directory from which templates will be copied.
1913 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1915 instaweb.browser::
1916 Specify the program that will be used to browse your working
1917 repository in gitweb. See linkgit:git-instaweb[1].
1919 instaweb.httpd::
1920 The HTTP daemon command-line to start gitweb on your working
1921 repository. See linkgit:git-instaweb[1].
1923 instaweb.local::
1924 If true the web server started by linkgit:git-instaweb[1] will
1925 be bound to the local IP (
1927 instaweb.modulePath::
1928 The default module path for linkgit:git-instaweb[1] to use
1929 instead of /usr/lib/apache2/modules. Only used if httpd
1930 is Apache.
1932 instaweb.port::
1933 The port number to bind the gitweb httpd to. See
1934 linkgit:git-instaweb[1].
1936 interactive.singleKey::
1937 In interactive commands, allow the user to provide one-letter
1938 input with a single key (i.e., without hitting enter).
1939 Currently this is used by the `--patch` mode of
1940 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1941 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1942 setting is silently ignored if portable keystroke input
1943 is not available; requires the Perl module Term::ReadKey.
1945 interactive.diffFilter::
1946 When an interactive command (such as `git add --patch`) shows
1947 a colorized diff, git will pipe the diff through the shell
1948 command defined by this configuration variable. The command may
1949 mark up the diff further for human consumption, provided that it
1950 retains a one-to-one correspondence with the lines in the
1951 original diff. Defaults to disabled (no filtering).
1953 log.abbrevCommit::
1954 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1955 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
1956 override this option with `--no-abbrev-commit`.
1959 Set the default date-time mode for the 'log' command.
1960 Setting a value for is similar to using 'git log''s
1961 `--date` option. See linkgit:git-log[1] for details.
1963 log.decorate::
1964 Print out the ref names of any commits that are shown by the log
1965 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1966 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1967 specified, the full ref name (including prefix) will be printed.
1968 If 'auto' is specified, then if the output is going to a terminal,
1969 the ref names are shown as if 'short' were given, otherwise no ref
1970 names are shown. This is the same as the '--decorate' option
1971 of the `git log`.
1973 log.follow::
1974 If `true`, `git log` will act as if the `--follow` option was used when
1975 a single <path> is given. This has the same limitations as `--follow`,
1976 i.e. it cannot be used to follow multiple files and does not work well
1977 on non-linear history.
1979 log.showRoot::
1980 If true, the initial commit will be shown as a big creation event.
1981 This is equivalent to a diff against an empty tree.
1982 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1983 normally hide the root commit will now show it. True by default.
1985 log.mailmap::
1986 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1987 linkgit:git-whatchanged[1] assume `--use-mailmap`.
1989 mailinfo.scissors::
1990 If true, makes linkgit:git-mailinfo[1] (and therefore
1991 linkgit:git-am[1]) act by default as if the --scissors option
1992 was provided on the command-line. When active, this features
1993 removes everything from the message body before a scissors
1994 line (i.e. consisting mainly of ">8", "8<" and "-").
1996 mailmap.file::
1997 The location of an augmenting mailmap file. The default
1998 mailmap, located in the root of the repository, is loaded
1999 first, then the mailmap file pointed to by this variable.
2000 The location of the mailmap file may be in a repository
2001 subdirectory, or somewhere outside of the repository itself.
2002 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
2004 mailmap.blob::
2005 Like `mailmap.file`, but consider the value as a reference to a
2006 blob in the repository. If both `mailmap.file` and
2007 `mailmap.blob` are given, both are parsed, with entries from
2008 `mailmap.file` taking precedence. In a bare repository, this
2009 defaults to `HEAD:.mailmap`. In a non-bare repository, it
2010 defaults to empty.
2012 man.viewer::
2013 Specify the programs that may be used to display help in the
2014 'man' format. See linkgit:git-help[1].
2016 man.<tool>.cmd::
2017 Specify the command to invoke the specified man viewer. The
2018 specified command is evaluated in shell with the man page
2019 passed as argument. (See linkgit:git-help[1].)
2021 man.<tool>.path::
2022 Override the path for the given tool that may be used to
2023 display help in the 'man' format. See linkgit:git-help[1].
2025 include::merge-config.txt[]
2027 mergetool.<tool>.path::
2028 Override the path for the given tool. This is useful in case
2029 your tool is not in the PATH.
2031 mergetool.<tool>.cmd::
2032 Specify the command to invoke the specified merge tool. The
2033 specified command is evaluated in shell with the following
2034 variables available: 'BASE' is the name of a temporary file
2035 containing the common base of the files to be merged, if available;
2036 'LOCAL' is the name of a temporary file containing the contents of
2037 the file on the current branch; 'REMOTE' is the name of a temporary
2038 file containing the contents of the file from the branch being
2039 merged; 'MERGED' contains the name of the file to which the merge
2040 tool should write the results of a successful merge.
2042 mergetool.<tool>.trustExitCode::
2043 For a custom merge command, specify whether the exit code of
2044 the merge command can be used to determine whether the merge was
2045 successful. If this is not set to true then the merge target file
2046 timestamp is checked and the merge assumed to have been successful
2047 if the file has been updated, otherwise the user is prompted to
2048 indicate the success of the merge.
2050 mergetool.meld.hasOutput::
2051 Older versions of `meld` do not support the `--output` option.
2052 Git will attempt to detect whether `meld` supports `--output`
2053 by inspecting the output of `meld --help`. Configuring
2054 `mergetool.meld.hasOutput` will make Git skip these checks and
2055 use the configured value instead. Setting `mergetool.meld.hasOutput`
2056 to `true` tells Git to unconditionally use the `--output` option,
2057 and `false` avoids using `--output`.
2059 mergetool.keepBackup::
2060 After performing a merge, the original file with conflict markers
2061 can be saved as a file with a `.orig` extension. If this variable
2062 is set to `false` then this file is not preserved. Defaults to
2063 `true` (i.e. keep the backup files).
2065 mergetool.keepTemporaries::
2066 When invoking a custom merge tool, Git uses a set of temporary
2067 files to pass to the tool. If the tool returns an error and this
2068 variable is set to `true`, then these temporary files will be
2069 preserved, otherwise they will be removed after the tool has
2070 exited. Defaults to `false`.
2072 mergetool.writeToTemp::
2073 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of
2074 conflicting files in the worktree by default. Git will attempt
2075 to use a temporary directory for these files when set `true`.
2076 Defaults to `false`.
2078 mergetool.prompt::
2079 Prompt before each invocation of the merge resolution program.
2081 notes.mergeStrategy::
2082 Which merge strategy to choose by default when resolving notes
2083 conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or
2084 `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"
2085 section of linkgit:git-notes[1] for more information on each strategy.
2087 notes.<name>.mergeStrategy::
2088 Which merge strategy to choose when doing a notes merge into
2089 refs/notes/<name>. This overrides the more general
2090 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in
2091 linkgit:git-notes[1] for more information on the available strategies.
2093 notes.displayRef::
2094 The (fully qualified) refname from which to show notes when
2095 showing commit messages. The value of this variable can be set
2096 to a glob, in which case notes from all matching refs will be
2097 shown. You may also specify this configuration variable
2098 several times. A warning will be issued for refs that do not
2099 exist, but a glob that does not match any refs is silently
2100 ignored.
2101 +
2102 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
2103 environment variable, which must be a colon separated list of refs or
2104 globs.
2105 +
2106 The effective value of "core.notesRef" (possibly overridden by
2107 GIT_NOTES_REF) is also implicitly added to the list of refs to be
2108 displayed.
2110 notes.rewrite.<command>::
2111 When rewriting commits with <command> (currently `amend` or
2112 `rebase`) and this variable is set to `true`, Git
2113 automatically copies your notes from the original to the
2114 rewritten commit. Defaults to `true`, but see
2115 "notes.rewriteRef" below.
2117 notes.rewriteMode::
2118 When copying notes during a rewrite (see the
2119 "notes.rewrite.<command>" option), determines what to do if
2120 the target commit already has a note. Must be one of
2121 `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.
2122 Defaults to `concatenate`.
2123 +
2124 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
2125 environment variable.
2127 notes.rewriteRef::
2128 When copying notes during a rewrite, specifies the (fully
2129 qualified) ref whose notes should be copied. The ref may be a
2130 glob, in which case notes in all matching refs will be copied.
2131 You may also specify this configuration several times.
2132 +
2133 Does not have a default value; you must configure this variable to
2134 enable note rewriting. Set it to `refs/notes/commits` to enable
2135 rewriting for the default commit notes.
2136 +
2137 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
2138 environment variable, which must be a colon separated list of refs or
2139 globs.
2141 pack.window::
2142 The size of the window used by linkgit:git-pack-objects[1] when no
2143 window size is given on the command line. Defaults to 10.
2145 pack.depth::
2146 The maximum delta depth used by linkgit:git-pack-objects[1] when no
2147 maximum depth is given on the command line. Defaults to 50.
2149 pack.windowMemory::
2150 The maximum size of memory that is consumed by each thread
2151 in linkgit:git-pack-objects[1] for pack window memory when
2152 no limit is given on the command line. The value can be
2153 suffixed with "k", "m", or "g". When left unconfigured (or
2154 set explicitly to 0), there will be no limit.
2156 pack.compression::
2157 An integer -1..9, indicating the compression level for objects
2158 in a pack file. -1 is the zlib default. 0 means no
2159 compression, and 1..9 are various speed/size tradeoffs, 9 being
2160 slowest. If not set, defaults to core.compression. If that is
2161 not set, defaults to -1, the zlib default, which is "a default
2162 compromise between speed and compression (currently equivalent
2163 to level 6)."
2164 +
2165 Note that changing the compression level will not automatically recompress
2166 all existing objects. You can force recompression by passing the -F option
2167 to linkgit:git-repack[1].
2169 pack.deltaCacheSize::
2170 The maximum memory in bytes used for caching deltas in
2171 linkgit:git-pack-objects[1] before writing them out to a pack.
2172 This cache is used to speed up the writing object phase by not
2173 having to recompute the final delta result once the best match
2174 for all objects is found. Repacking large repositories on machines
2175 which are tight with memory might be badly impacted by this though,
2176 especially if this cache pushes the system into swapping.
2177 A value of 0 means no limit. The smallest size of 1 byte may be
2178 used to virtually disable this cache. Defaults to 256 MiB.
2180 pack.deltaCacheLimit::
2181 The maximum size of a delta, that is cached in
2182 linkgit:git-pack-objects[1]. This cache is used to speed up the
2183 writing object phase by not having to recompute the final delta
2184 result once the best match for all objects is found. Defaults to 1000.
2186 pack.threads::
2187 Specifies the number of threads to spawn when searching for best
2188 delta matches. This requires that linkgit:git-pack-objects[1]
2189 be compiled with pthreads otherwise this option is ignored with a
2190 warning. This is meant to reduce packing time on multiprocessor
2191 machines. The required amount of memory for the delta search window
2192 is however multiplied by the number of threads.
2193 Specifying 0 will cause Git to auto-detect the number of CPU's
2194 and set the number of threads accordingly.
2196 pack.indexVersion::
2197 Specify the default pack index version. Valid values are 1 for
2198 legacy pack index used by Git versions prior to 1.5.2, and 2 for
2199 the new pack index with capabilities for packs larger than 4 GB
2200 as well as proper protection against the repacking of corrupted
2201 packs. Version 2 is the default. Note that version 2 is enforced
2202 and this config option ignored whenever the corresponding pack is
2203 larger than 2 GB.
2204 +
2205 If you have an old Git that does not understand the version 2 `*.idx` file,
2206 cloning or fetching over a non native protocol (e.g. "http")
2207 that will copy both `*.pack` file and corresponding `*.idx` file from the
2208 other side may give you a repository that cannot be accessed with your
2209 older version of Git. If the `*.pack` file is smaller than 2 GB, however,
2210 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
2211 the `*.idx` file.
2213 pack.packSizeLimit::
2214 The maximum size of a pack. This setting only affects
2215 packing to a file when repacking, i.e. the git:// protocol
2216 is unaffected. It can be overridden by the `--max-pack-size`
2217 option of linkgit:git-repack[1]. Reaching this limit results
2218 in the creation of multiple packfiles; which in turn prevents
2219 bitmaps from being created.
2220 The minimum size allowed is limited to 1 MiB.
2221 The default is unlimited.
2222 Common unit suffixes of 'k', 'm', or 'g' are
2223 supported.
2225 pack.useBitmaps::
2226 When true, git will use pack bitmaps (if available) when packing
2227 to stdout (e.g., during the server side of a fetch). Defaults to
2228 true. You should not generally need to turn this off unless
2229 you are debugging pack bitmaps.
2231 pack.writeBitmaps (deprecated)::
2232 This is a deprecated synonym for `repack.writeBitmaps`.
2234 pack.writeBitmapHashCache::
2235 When true, git will include a "hash cache" section in the bitmap
2236 index (if one is written). This cache can be used to feed git's
2237 delta heuristics, potentially leading to better deltas between
2238 bitmapped and non-bitmapped objects (e.g., when serving a fetch
2239 between an older, bitmapped pack and objects that have been
2240 pushed since the last gc). The downside is that it consumes 4
2241 bytes per object of disk space, and that JGit's bitmap
2242 implementation does not understand it, causing it to complain if
2243 Git and JGit are used on the same repository. Defaults to false.
2245 pager.<cmd>::
2246 If the value is boolean, turns on or off pagination of the
2247 output of a particular Git subcommand when writing to a tty.
2248 Otherwise, turns on pagination for the subcommand using the
2249 pager specified by the value of `pager.<cmd>`. If `--paginate`
2250 or `--no-pager` is specified on the command line, it takes
2251 precedence over this option. To disable pagination for all
2252 commands, set `core.pager` or `GIT_PAGER` to `cat`.
2254 pretty.<name>::
2255 Alias for a --pretty= format string, as specified in
2256 linkgit:git-log[1]. Any aliases defined here can be used just
2257 as the built-in pretty formats could. For example,
2258 running `git config pretty.changelog "format:* %H %s"`
2259 would cause the invocation `git log --pretty=changelog`
2260 to be equivalent to running `git log "--pretty=format:* %H %s"`.
2261 Note that an alias with the same name as a built-in format
2262 will be silently ignored.
2264 pull.ff::
2265 By default, Git does not create an extra merge commit when merging
2266 a commit that is a descendant of the current commit. Instead, the
2267 tip of the current branch is fast-forwarded. When set to `false`,
2268 this variable tells Git to create an extra merge commit in such
2269 a case (equivalent to giving the `--no-ff` option from the command
2270 line). When set to `only`, only such fast-forward merges are
2271 allowed (equivalent to giving the `--ff-only` option from the
2272 command line). This setting overrides `merge.ff` when pulling.
2274 pull.rebase::
2275 When true, rebase branches on top of the fetched branch, instead
2276 of merging the default branch from the default remote when "git
2277 pull" is run. See "branch.<name>.rebase" for setting this on a
2278 per-branch basis.
2279 +
2280 When preserve, also pass `--preserve-merges` along to 'git rebase'
2281 so that locally committed merge commits will not be flattened
2282 by running 'git pull'.
2283 +
2284 When the value is `interactive`, the rebase is run in interactive mode.
2285 +
2286 *NOTE*: this is a possibly dangerous operation; do *not* use
2287 it unless you understand the implications (see linkgit:git-rebase[1]
2288 for details).
2290 pull.octopus::
2291 The default merge strategy to use when pulling multiple branches
2292 at once.
2294 pull.twohead::
2295 The default merge strategy to use when pulling a single branch.
2297 push.default::
2298 Defines the action `git push` should take if no refspec is
2299 explicitly given. Different values are well-suited for
2300 specific workflows; for instance, in a purely central workflow
2301 (i.e. the fetch source is equal to the push destination),
2302 `upstream` is probably what you want. Possible values are:
2303 +
2304 --
2306 * `nothing` - do not push anything (error out) unless a refspec is
2307 explicitly given. This is primarily meant for people who want to
2308 avoid mistakes by always being explicit.
2310 * `current` - push the current branch to update a branch with the same
2311 name on the receiving end. Works in both central and non-central
2312 workflows.
2314 * `upstream` - push the current branch back to the branch whose
2315 changes are usually integrated into the current branch (which is
2316 called `@{upstream}`). This mode only makes sense if you are
2317 pushing to the same repository you would normally pull from
2318 (i.e. central workflow).
2320 * `simple` - in centralized workflow, work like `upstream` with an
2321 added safety to refuse to push if the upstream branch's name is
2322 different from the local one.
2323 +
2324 When pushing to a remote that is different from the remote you normally
2325 pull from, work as `current`. This is the safest option and is suited
2326 for beginners.
2327 +
2328 This mode has become the default in Git 2.0.
2330 * `matching` - push all branches having the same name on both ends.
2331 This makes the repository you are pushing to remember the set of
2332 branches that will be pushed out (e.g. if you always push 'maint'
2333 and 'master' there and no other branches, the repository you push
2334 to will have these two branches, and your local 'maint' and
2335 'master' will be pushed there).
2336 +
2337 To use this mode effectively, you have to make sure _all_ the
2338 branches you would push out are ready to be pushed out before
2339 running 'git push', as the whole point of this mode is to allow you
2340 to push all of the branches in one go. If you usually finish work
2341 on only one branch and push out the result, while other branches are
2342 unfinished, this mode is not for you. Also this mode is not
2343 suitable for pushing into a shared central repository, as other
2344 people may add new branches there, or update the tip of existing
2345 branches outside your control.
2346 +
2347 This used to be the default, but not since Git 2.0 (`simple` is the
2348 new default).
2350 --
2352 push.followTags::
2353 If set to true enable '--follow-tags' option by default. You
2354 may override this configuration at time of push by specifying
2355 '--no-follow-tags'.
2357 push.gpgSign::
2358 May be set to a boolean value, or the string 'if-asked'. A true
2359 value causes all pushes to be GPG signed, as if '--signed' is
2360 passed to linkgit:git-push[1]. The string 'if-asked' causes
2361 pushes to be signed if the server supports it, as if
2362 '--signed=if-asked' is passed to 'git push'. A false value may
2363 override a value from a lower-priority config file. An explicit
2364 command-line flag always overrides this config option.
2366 push.recurseSubmodules::
2367 Make sure all submodule commits used by the revisions to be pushed
2368 are available on a remote-tracking branch. If the value is 'check'
2369 then Git will verify that all submodule commits that changed in the
2370 revisions to be pushed are available on at least one remote of the
2371 submodule. If any commits are missing, the push will be aborted and
2372 exit with non-zero status. If the value is 'on-demand' then all
2373 submodules that changed in the revisions to be pushed will be
2374 pushed. If on-demand was not able to push all necessary revisions
2375 it will also be aborted and exit with non-zero status. If the value
2376 is 'no' then default behavior of ignoring submodules when pushing
2377 is retained. You may override this configuration at time of push by
2378 specifying '--recurse-submodules=check|on-demand|no'.
2380 rebase.stat::
2381 Whether to show a diffstat of what changed upstream since the last
2382 rebase. False by default.
2384 rebase.autoSquash::
2385 If set to true enable '--autosquash' option by default.
2387 rebase.autoStash::
2388 When set to true, automatically create a temporary stash
2389 before the operation begins, and apply it after the operation
2390 ends. This means that you can run rebase on a dirty worktree.
2391 However, use with care: the final stash application after a
2392 successful rebase might result in non-trivial conflicts.
2393 Defaults to false.
2395 rebase.missingCommitsCheck::
2396 If set to "warn", git rebase -i will print a warning if some
2397 commits are removed (e.g. a line was deleted), however the
2398 rebase will still proceed. If set to "error", it will print
2399 the previous warning and stop the rebase, 'git rebase
2400 --edit-todo' can then be used to correct the error. If set to
2401 "ignore", no checking is done.
2402 To drop a commit without warning or error, use the `drop`
2403 command in the todo-list.
2404 Defaults to "ignore".
2406 rebase.instructionFormat
2407 A format string, as specified in linkgit:git-log[1], to be used for
2408 the instruction list during an interactive rebase. The format will automatically
2409 have the long commit hash prepended to the format.
2411 receive.advertiseAtomic::
2412 By default, git-receive-pack will advertise the atomic push
2413 capability to its clients. If you don't want to this capability
2414 to be advertised, set this variable to false.
2416 receive.autogc::
2417 By default, git-receive-pack will run "git-gc --auto" after
2418 receiving data from git-push and updating refs. You can stop
2419 it by setting this variable to false.
2421 receive.certNonceSeed::
2422 By setting this variable to a string, `git receive-pack`
2423 will accept a `git push --signed` and verifies it by using
2424 a "nonce" protected by HMAC using this string as a secret
2425 key.
2427 receive.certNonceSlop::
2428 When a `git push --signed` sent a push certificate with a
2429 "nonce" that was issued by a receive-pack serving the same
2430 repository within this many seconds, export the "nonce"
2431 found in the certificate to `GIT_PUSH_CERT_NONCE` to the
2432 hooks (instead of what the receive-pack asked the sending
2433 side to include). This may allow writing checks in
2434 `pre-receive` and `post-receive` a bit easier. Instead of
2435 checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable
2436 that records by how many seconds the nonce is stale to
2437 decide if they want to accept the certificate, they only
2438 can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.
2440 receive.fsckObjects::
2441 If it is set to true, git-receive-pack will check all received
2442 objects. It will abort in the case of a malformed object or a
2443 broken link. The result of an abort are only dangling objects.
2444 Defaults to false. If not set, the value of `transfer.fsckObjects`
2445 is used instead.
2447 receive.fsck.<msg-id>::
2448 When `receive.fsckObjects` is set to true, errors can be switched
2449 to warnings and vice versa by configuring the `receive.fsck.<msg-id>`
2450 setting where the `<msg-id>` is the fsck message ID and the value
2451 is one of `error`, `warn` or `ignore`. For convenience, fsck prefixes
2452 the error/warning with the message ID, e.g. "missingEmail: invalid
2453 author/committer line - missing email" means that setting
2454 `receive.fsck.missingEmail = ignore` will hide that issue.
2455 +
2456 This feature is intended to support working with legacy repositories
2457 which would not pass pushing when `receive.fsckObjects = true`, allowing
2458 the host to accept repositories with certain known issues but still catch
2459 other issues.
2461 receive.fsck.skipList::
2462 The path to a sorted list of object names (i.e. one SHA-1 per
2463 line) that are known to be broken in a non-fatal way and should
2464 be ignored. This feature is useful when an established project
2465 should be accepted despite early commits containing errors that
2466 can be safely ignored such as invalid committer email addresses.
2467 Note: corrupt objects cannot be skipped with this setting.
2469 receive.unpackLimit::
2470 If the number of objects received in a push is below this
2471 limit then the objects will be unpacked into loose object
2472 files. However if the number of received objects equals or
2473 exceeds this limit then the received pack will be stored as
2474 a pack, after adding any missing delta bases. Storing the
2475 pack from a push can make the push operation complete faster,
2476 especially on slow filesystems. If not set, the value of
2477 `transfer.unpackLimit` is used instead.
2479 receive.denyDeletes::
2480 If set to true, git-receive-pack will deny a ref update that deletes
2481 the ref. Use this to prevent such a ref deletion via a push.
2483 receive.denyDeleteCurrent::
2484 If set to true, git-receive-pack will deny a ref update that
2485 deletes the currently checked out branch of a non-bare repository.
2487 receive.denyCurrentBranch::
2488 If set to true or "refuse", git-receive-pack will deny a ref update
2489 to the currently checked out branch of a non-bare repository.
2490 Such a push is potentially dangerous because it brings the HEAD
2491 out of sync with the index and working tree. If set to "warn",
2492 print a warning of such a push to stderr, but allow the push to
2493 proceed. If set to false or "ignore", allow such pushes with no
2494 message. Defaults to "refuse".
2495 +
2496 Another option is "updateInstead" which will update the working
2497 tree if pushing into the current branch. This option is
2498 intended for synchronizing working directories when one side is not easily
2499 accessible via interactive ssh (e.g. a live web site, hence the requirement
2500 that the working directory be clean). This mode also comes in handy when
2501 developing inside a VM to test and fix code on different Operating Systems.
2502 +
2503 By default, "updateInstead" will refuse the push if the working tree or
2504 the index have any difference from the HEAD, but the `push-to-checkout`
2505 hook can be used to customize this. See linkgit:githooks[5].
2507 receive.denyNonFastForwards::
2508 If set to true, git-receive-pack will deny a ref update which is
2509 not a fast-forward. Use this to prevent such an update via a push,
2510 even if that push is forced. This configuration variable is
2511 set when initializing a shared repository.
2513 receive.hideRefs::
2514 This variable is the same as `transfer.hideRefs`, but applies
2515 only to `receive-pack` (and so affects pushes, but not fetches).
2516 An attempt to update or delete a hidden ref by `git push` is
2517 rejected.
2519 receive.updateServerInfo::
2520 If set to true, git-receive-pack will run git-update-server-info
2521 after receiving data from git-push and updating refs.
2523 receive.shallowUpdate::
2524 If set to true, .git/shallow can be updated when new refs
2525 require new shallow roots. Otherwise those refs are rejected.
2527 remote.pushDefault::
2528 The remote to push to by default. Overrides
2529 `branch.<name>.remote` for all branches, and is overridden by
2530 `branch.<name>.pushRemote` for specific branches.
2532 remote.<name>.url::
2533 The URL of a remote repository. See linkgit:git-fetch[1] or
2534 linkgit:git-push[1].
2536 remote.<name>.pushurl::
2537 The push URL of a remote repository. See linkgit:git-push[1].
2539 remote.<name>.proxy::
2540 For remotes that require curl (http, https and ftp), the URL to
2541 the proxy to use for that remote. Set to the empty string to
2542 disable proxying for that remote.
2544 remote.<name>.proxyAuthMethod::
2545 For remotes that require curl (http, https and ftp), the method to use for
2546 authenticating against the proxy in use (probably set in
2547 `remote.<name>.proxy`). See `http.proxyAuthMethod`.
2549 remote.<name>.fetch::
2550 The default set of "refspec" for linkgit:git-fetch[1]. See
2551 linkgit:git-fetch[1].
2553 remote.<name>.push::
2554 The default set of "refspec" for linkgit:git-push[1]. See
2555 linkgit:git-push[1].
2557 remote.<name>.mirror::
2558 If true, pushing to this remote will automatically behave
2559 as if the `--mirror` option was given on the command line.
2561 remote.<name>.skipDefaultUpdate::
2562 If true, this remote will be skipped by default when updating
2563 using linkgit:git-fetch[1] or the `update` subcommand of
2564 linkgit:git-remote[1].
2566 remote.<name>.skipFetchAll::
2567 If true, this remote will be skipped by default when updating
2568 using linkgit:git-fetch[1] or the `update` subcommand of
2569 linkgit:git-remote[1].
2571 remote.<name>.receivepack::
2572 The default program to execute on the remote side when pushing. See
2573 option --receive-pack of linkgit:git-push[1].
2575 remote.<name>.uploadpack::
2576 The default program to execute on the remote side when fetching. See
2577 option --upload-pack of linkgit:git-fetch-pack[1].
2579 remote.<name>.tagOpt::
2580 Setting this value to --no-tags disables automatic tag following when
2581 fetching from remote <name>. Setting it to --tags will fetch every
2582 tag from remote <name>, even if they are not reachable from remote
2583 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
2584 override this setting. See options --tags and --no-tags of
2585 linkgit:git-fetch[1].
2587 remote.<name>.vcs::
2588 Setting this to a value <vcs> will cause Git to interact with
2589 the remote with the git-remote-<vcs> helper.
2591 remote.<name>.prune::
2592 When set to true, fetching from this remote by default will also
2593 remove any remote-tracking references that no longer exist on the
2594 remote (as if the `--prune` option was given on the command line).
2595 Overrides `fetch.prune` settings, if any.
2597 remotes.<group>::
2598 The list of remotes which are fetched by "git remote update
2599 <group>". See linkgit:git-remote[1].
2601 repack.useDeltaBaseOffset::
2602 By default, linkgit:git-repack[1] creates packs that use
2603 delta-base offset. If you need to share your repository with
2604 Git older than version 1.4.4, either directly or via a dumb
2605 protocol such as http, then you need to set this option to
2606 "false" and repack. Access from old Git versions over the
2607 native protocol are unaffected by this option.
2609 repack.packKeptObjects::
2610 If set to true, makes `git repack` act as if
2611 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for
2612 details. Defaults to `false` normally, but `true` if a bitmap
2613 index is being written (either via `--write-bitmap-index` or
2614 `repack.writeBitmaps`).
2616 repack.writeBitmaps::
2617 When true, git will write a bitmap index when packing all
2618 objects to disk (e.g., when `git repack -a` is run). This
2619 index can speed up the "counting objects" phase of subsequent
2620 packs created for clones and fetches, at the cost of some disk
2621 space and extra time spent on the initial repack. This has
2622 no effect if multiple packfiles are created.
2623 Defaults to false.
2625 rerere.autoUpdate::
2626 When set to true, `git-rerere` updates the index with the
2627 resulting contents after it cleanly resolves conflicts using
2628 previously recorded resolution. Defaults to false.
2630 rerere.enabled::
2631 Activate recording of resolved conflicts, so that identical
2632 conflict hunks can be resolved automatically, should they be
2633 encountered again. By default, linkgit:git-rerere[1] is
2634 enabled if there is an `rr-cache` directory under the
2635 `$GIT_DIR`, e.g. if "rerere" was previously used in the
2636 repository.
2638 sendemail.identity::
2639 A configuration identity. When given, causes values in the
2640 'sendemail.<identity>' subsection to take precedence over
2641 values in the 'sendemail' section. The default identity is
2642 the value of `sendemail.identity`.
2644 sendemail.smtpEncryption::
2645 See linkgit:git-send-email[1] for description. Note that this
2646 setting is not subject to the 'identity' mechanism.
2648 sendemail.smtpssl (deprecated)::
2649 Deprecated alias for 'sendemail.smtpEncryption = ssl'.
2651 sendemail.smtpsslcertpath::
2652 Path to ca-certificates (either a directory or a single file).
2653 Set it to an empty string to disable certificate verification.
2655 sendemail.<identity>.*::
2656 Identity-specific versions of the 'sendemail.*' parameters
2657 found below, taking precedence over those when the this
2658 identity is selected, through command-line or
2659 `sendemail.identity`.
2661 sendemail.aliasesFile::
2662 sendemail.aliasFileType::
2663 sendemail.annotate::
2664 sendemail.bcc::
2666 sendemail.ccCmd::
2667 sendemail.chainReplyTo::
2668 sendemail.confirm::
2669 sendemail.envelopeSender::
2670 sendemail.from::
2671 sendemail.multiEdit::
2672 sendemail.signedoffbycc::
2673 sendemail.smtpPass::
2674 sendemail.suppresscc::
2675 sendemail.suppressFrom::
2677 sendemail.smtpDomain::
2678 sendemail.smtpServer::
2679 sendemail.smtpServerPort::
2680 sendemail.smtpServerOption::
2681 sendemail.smtpUser::
2682 sendemail.thread::
2683 sendemail.transferEncoding::
2684 sendemail.validate::
2685 sendemail.xmailer::
2686 See linkgit:git-send-email[1] for description.
2688 sendemail.signedoffcc (deprecated)::
2689 Deprecated alias for `sendemail.signedoffbycc`.
2691 showbranch.default::
2692 The default set of branches for linkgit:git-show-branch[1].
2693 See linkgit:git-show-branch[1].
2695 status.relativePaths::
2696 By default, linkgit:git-status[1] shows paths relative to the
2697 current directory. Setting this variable to `false` shows paths
2698 relative to the repository root (this was the default for Git
2699 prior to v1.5.4).
2701 status.short::
2702 Set to true to enable --short by default in linkgit:git-status[1].
2703 The option --no-short takes precedence over this variable.
2705 status.branch::
2706 Set to true to enable --branch by default in linkgit:git-status[1].
2707 The option --no-branch takes precedence over this variable.
2709 status.displayCommentPrefix::
2710 If set to true, linkgit:git-status[1] will insert a comment
2711 prefix before each output line (starting with
2712 `core.commentChar`, i.e. `#` by default). This was the
2713 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
2714 Defaults to false.
2716 status.showUntrackedFiles::
2717 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
2718 files which are not currently tracked by Git. Directories which
2719 contain only untracked files, are shown with the directory name
2720 only. Showing untracked files means that Git needs to lstat() all
2721 the files in the whole repository, which might be slow on some
2722 systems. So, this variable controls how the commands displays
2723 the untracked files. Possible values are:
2724 +
2725 --
2726 * `no` - Show no untracked files.
2727 * `normal` - Show untracked files and directories.
2728 * `all` - Show also individual files in untracked directories.
2729 --
2730 +
2731 If this variable is not specified, it defaults to 'normal'.
2732 This variable can be overridden with the -u|--untracked-files option
2733 of linkgit:git-status[1] and linkgit:git-commit[1].
2735 status.submoduleSummary::
2736 Defaults to false.
2737 If this is set to a non zero number or true (identical to -1 or an
2738 unlimited number), the submodule summary will be enabled and a
2739 summary of commits for modified submodules will be shown (see
2740 --summary-limit option of linkgit:git-submodule[1]). Please note
2741 that the summary output command will be suppressed for all
2742 submodules when `diff.ignoreSubmodules` is set to 'all' or only
2743 for those submodules where `submodule.<name>.ignore=all`. The only
2744 exception to that rule is that status and commit will show staged
2745 submodule changes. To
2746 also view the summary for ignored submodules you can either use
2747 the --ignore-submodules=dirty command-line option or the 'git
2748 submodule summary' command, which shows a similar output but does
2749 not honor these settings.
2751 stash.showPatch::
2752 If this is set to true, the `git stash show` command without an
2753 option will show the stash in patch form. Defaults to false.
2754 See description of 'show' command in linkgit:git-stash[1].
2756 stash.showStat::
2757 If this is set to true, the `git stash show` command without an
2758 option will show diffstat of the stash. Defaults to true.
2759 See description of 'show' command in linkgit:git-stash[1].
2761 submodule.<name>.path::
2762 submodule.<name>.url::
2763 The path within this project and URL for a submodule. These
2764 variables are initially populated by 'git submodule init'. See
2765 linkgit:git-submodule[1] and linkgit:gitmodules[5] for
2766 details.
2768 submodule.<name>.update::
2769 The default update procedure for a submodule. This variable
2770 is populated by `git submodule init` from the
2771 linkgit:gitmodules[5] file. See description of 'update'
2772 command in linkgit:git-submodule[1].
2774 submodule.<name>.branch::
2775 The remote branch name for a submodule, used by `git submodule
2776 update --remote`. Set this option to override the value found in
2777 the `.gitmodules` file. See linkgit:git-submodule[1] and
2778 linkgit:gitmodules[5] for details.
2780 submodule.<name>.fetchRecurseSubmodules::
2781 This option can be used to control recursive fetching of this
2782 submodule. It can be overridden by using the --[no-]recurse-submodules
2783 command-line option to "git fetch" and "git pull".
2784 This setting will override that from in the linkgit:gitmodules[5]
2785 file.
2787 submodule.<name>.ignore::
2788 Defines under what circumstances "git status" and the diff family show
2789 a submodule as modified. When set to "all", it will never be considered
2790 modified (but it will nonetheless show up in the output of status and
2791 commit when it has been staged), "dirty" will ignore all changes
2792 to the submodules work tree and
2793 takes only differences between the HEAD of the submodule and the commit
2794 recorded in the superproject into account. "untracked" will additionally
2795 let submodules with modified tracked files in their work tree show up.
2796 Using "none" (the default when this option is not set) also shows
2797 submodules that have untracked files in their work tree as changed.
2798 This setting overrides any setting made in .gitmodules for this submodule,
2799 both settings can be overridden on the command line by using the
2800 "--ignore-submodules" option. The 'git submodule' commands are not
2801 affected by this setting.
2803 submodule.fetchJobs::
2804 Specifies how many submodules are fetched/cloned at the same time.
2805 A positive integer allows up to that number of submodules fetched
2806 in parallel. A value of 0 will give some reasonable default.
2807 If unset, it defaults to 1.
2809 tag.forceSignAnnotated::
2810 A boolean to specify whether annotated tags created should be GPG signed.
2811 If `--annotate` is specified on the command line, it takes
2812 precedence over this option.
2814 tag.sort::
2815 This variable controls the sort ordering of tags when displayed by
2816 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the
2817 value of this variable will be used as the default.
2819 tar.umask::
2820 This variable can be used to restrict the permission bits of
2821 tar archive entries. The default is 0002, which turns off the
2822 world write bit. The special value "user" indicates that the
2823 archiving user's umask will be used instead. See umask(2) and
2824 linkgit:git-archive[1].
2826 transfer.fsckObjects::
2827 When `fetch.fsckObjects` or `receive.fsckObjects` are
2828 not set, the value of this variable is used instead.
2829 Defaults to false.
2831 transfer.hideRefs::
2832 String(s) `receive-pack` and `upload-pack` use to decide which
2833 refs to omit from their initial advertisements. Use more than
2834 one definition to specify multiple prefix strings. A ref that is
2835 under the hierarchies listed in the value of this variable is
2836 excluded, and is hidden when responding to `git push` or `git
2837 fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for
2838 program-specific versions of this config.
2839 +
2840 You may also include a `!` in front of the ref name to negate the entry,
2841 explicitly exposing it, even if an earlier entry marked it as hidden.
2842 If you have multiple hideRefs values, later entries override earlier ones
2843 (and entries in more-specific config files override less-specific ones).
2844 +
2845 If a namespace is in use, the namespace prefix is stripped from each
2846 reference before it is matched against `transfer.hiderefs` patterns.
2847 For example, if `refs/heads/master` is specified in `transfer.hideRefs` and
2848 the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`
2849 is omitted from the advertisements but `refs/heads/master` and
2850 `refs/namespaces/bar/refs/heads/master` are still advertised as so-called
2851 "have" lines. In order to match refs before stripping, add a `^` in front of
2852 the ref name. If you combine `!` and `^`, `!` must be specified first.
2854 transfer.unpackLimit::
2855 When `fetch.unpackLimit` or `receive.unpackLimit` are
2856 not set, the value of this variable is used instead.
2857 The default value is 100.
2859 uploadarchive.allowUnreachable::
2860 If true, allow clients to use `git archive --remote` to request
2861 any tree, whether reachable from the ref tips or not. See the
2862 discussion in the `SECURITY` section of
2863 linkgit:git-upload-archive[1] for more details. Defaults to
2864 `false`.
2866 uploadpack.hideRefs::
2867 This variable is the same as `transfer.hideRefs`, but applies
2868 only to `upload-pack` (and so affects only fetches, not pushes).
2869 An attempt to fetch a hidden ref by `git fetch` will fail. See
2870 also `uploadpack.allowTipSHA1InWant`.
2872 uploadpack.allowTipSHA1InWant::
2873 When `uploadpack.hideRefs` is in effect, allow `upload-pack`
2874 to accept a fetch request that asks for an object at the tip
2875 of a hidden ref (by default, such a request is rejected).
2876 see also `uploadpack.hideRefs`.
2878 uploadpack.allowReachableSHA1InWant::
2879 Allow `upload-pack` to accept a fetch request that asks for an
2880 object that is reachable from any ref tip. However, note that
2881 calculating object reachability is computationally expensive.
2882 Defaults to `false`.
2884 uploadpack.keepAlive::
2885 When `upload-pack` has started `pack-objects`, there may be a
2886 quiet period while `pack-objects` prepares the pack. Normally
2887 it would output progress information, but if `--quiet` was used
2888 for the fetch, `pack-objects` will output nothing at all until
2889 the pack data begins. Some clients and networks may consider
2890 the server to be hung and give up. Setting this option instructs
2891 `upload-pack` to send an empty keepalive packet every
2892 `uploadpack.keepAlive` seconds. Setting this option to 0
2893 disables keepalive packets entirely. The default is 5 seconds.
2895 uploadpack.packObjectsHook::
2896 If this option is set, when `upload-pack` would run
2897 `git pack-objects` to create a packfile for a client, it will
2898 run this shell command instead. The `pack-objects` command and
2899 arguments it _would_ have run (including the `git pack-objects`
2900 at the beginning) are appended to the shell command. The stdin
2901 and stdout of the hook are treated as if `pack-objects` itself
2902 was run. I.e., `upload-pack` will feed input intended for
2903 `pack-objects` to the hook, and expects a completed packfile on
2904 stdout.
2905 +
2906 Note that this configuration variable is ignored if it is seen in the
2907 repository-level config (this is a safety measure against fetching from
2908 untrusted repositories).
2910 url.<base>.insteadOf::
2911 Any URL that starts with this value will be rewritten to
2912 start, instead, with <base>. In cases where some site serves a
2913 large number of repositories, and serves them with multiple
2914 access methods, and some users need to use different access
2915 methods, this feature allows people to specify any of the
2916 equivalent URLs and have Git automatically rewrite the URL to
2917 the best alternative for the particular user, even for a
2918 never-before-seen repository on the site. When more than one
2919 insteadOf strings match a given URL, the longest match is used.
2921 url.<base>.pushInsteadOf::
2922 Any URL that starts with this value will not be pushed to;
2923 instead, it will be rewritten to start with <base>, and the
2924 resulting URL will be pushed to. In cases where some site serves
2925 a large number of repositories, and serves them with multiple
2926 access methods, some of which do not allow push, this feature
2927 allows people to specify a pull-only URL and have Git
2928 automatically use an appropriate URL to push, even for a
2929 never-before-seen repository on the site. When more than one
2930 pushInsteadOf strings match a given URL, the longest match is
2931 used. If a remote has an explicit pushurl, Git will ignore this
2932 setting for that remote.
2935 Your email address to be recorded in any newly created commits.
2936 Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and
2937 `EMAIL` environment variables. See linkgit:git-commit-tree[1].
2940 Your full name to be recorded in any newly created commits.
2941 Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`
2942 environment variables. See linkgit:git-commit-tree[1].
2944 user.useConfigOnly::
2945 Instruct Git to avoid trying to guess defaults for ``
2946 and ``, and instead retrieve the values only from the
2947 configuration. For example, if you have multiple email addresses
2948 and would like to use a different one for each repository, then
2949 with this configuration option set to `true` in the global config
2950 along with a name, Git will prompt you to set up an email before
2951 making new commits in a newly cloned repository.
2952 Defaults to `false`.
2954 user.signingKey::
2955 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
2956 key you want it to automatically when creating a signed tag or
2957 commit, you can override the default selection with this variable.
2958 This option is passed unchanged to gpg's --local-user parameter,
2959 so you may specify a key using any method that gpg supports.
2961 versionsort.prereleaseSuffix::
2962 When version sort is used in linkgit:git-tag[1], prerelease
2963 tags (e.g. "1.0-rc1") may appear after the main release
2964 "1.0". By specifying the suffix "-rc" in this variable,
2965 "1.0-rc1" will appear before "1.0".
2966 +
2967 This variable can be specified multiple times, once per suffix. The
2968 order of suffixes in the config file determines the sorting order
2969 (e.g. if "-pre" appears before "-rc" in the config file then 1.0-preXX
2970 is sorted before 1.0-rcXX). The sorting order between different
2971 suffixes is undefined if they are in multiple config files.
2973 web.browser::
2974 Specify a web browser that may be used by some commands.
2975 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
2976 may use it.