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