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