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