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