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