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