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