add boolean diff.suppress-blank-empty config option
[git/git.git] / Documentation / config.txt
CommitLineData
1ab661dd
PB
1CONFIGURATION FILE
2------------------
3
4The git configuration file contains a number of variables that affect
5ea5621f
JH
5the git command's behavior. `.git/config` file for each repository
6is used to store the information for that repository, and
7`$HOME/.gitconfig` is used to store per user information to give
32043c9f
JS
8fallback values for `.git/config` file. The file `/etc/gitconfig`
9can be used to store system-wide defaults.
5ea5621f
JH
10
11They can be used by both the git plumbing
b8936cf0 12and the porcelains. The variables are divided into sections, where
1ab661dd
PB
13in the fully qualified variable name the variable itself is the last
14dot-separated segment and the section name is everything before the last
15dot. The variable names are case-insensitive and only alphanumeric
16characters are allowed. Some variables may appear multiple times.
17
e136f33b
JN
18Syntax
19~~~~~~
20
1ab661dd 21The syntax is fairly flexible and permissive; whitespaces are mostly
e136f33b
JN
22ignored. The '#' and ';' characters begin comments to the end of line,
23blank lines are ignored.
24
25The file consists of sections and variables. A section begins with
26the name of the section in square brackets and continues until the next
27section begins. Section names are not case sensitive. Only alphanumeric
28characters, '`-`' and '`.`' are allowed in section names. Each variable
29must belong to some section, which means that there must be section
30header before first setting of a variable.
31
32Sections can be further divided into subsections. To begin a subsection
33put its name in double quotes, separated by space from the section name,
34in the section header, like in example below:
35
36--------
37 [section "subsection"]
38
39--------
40
191453f6
JN
41Subsection names can contain any characters except newline (doublequote
42'`"`' and backslash have to be escaped as '`\"`' and '`\\`',
3dff5379 43respectively) and are case sensitive. Section header cannot span multiple
e136f33b
JN
44lines. Variables may belong directly to a section or to a given subsection.
45You can have `[section]` if you have `[section "subsection"]`, but you
46don't need to.
47
48There is also (case insensitive) alternative `[section.subsection]` syntax.
49In this syntax subsection names follow the same restrictions as for section
50name.
51
52All the other lines are recognized as setting variables, in the form
53'name = value'. If there is no equal sign on the line, the entire line
54is taken as 'name' and the variable is recognized as boolean "true".
55The variable names are case-insensitive and only alphanumeric
56characters and '`-`' are allowed. There can be more than one value
57for a given variable; we say then that variable is multivalued.
58
59Leading and trailing whitespace in a variable value is discarded.
60Internal whitespace within a variable value is retained verbatim.
61
62The values following the equals sign in variable assign are all either
63a string, an integer, or a boolean. Boolean values may be given as yes/no,
640/1 or true/false. Case is not significant in boolean values, when
65converting value to the canonical form using '--bool' type specifier;
ba020ef5 66'git-config' will ensure that the output is "true" or "false".
e136f33b
JN
67
68String values may be entirely or partially enclosed in double quotes.
69You need to enclose variable value in double quotes if you want to
70preserve leading or trailing whitespace, or if variable value contains
71beginning of comment characters (if it contains '#' or ';').
72Double quote '`"`' and backslash '`\`' characters in variable value must
73be escaped: use '`\"`' for '`"`' and '`\\`' for '`\`'.
74
75The following escape sequences (beside '`\"`' and '`\\`') are recognized:
76'`\n`' for newline character (NL), '`\t`' for horizontal tabulation (HT, TAB)
77and '`\b`' for backspace (BS). No other char escape sequence, nor octal
78char sequences are valid.
79
80Variable value ending in a '`\`' is continued on the next line in the
81customary UNIX fashion.
82
83Some variables may require special value format.
1ab661dd
PB
84
85Example
86~~~~~~~
87
88 # Core variables
89 [core]
90 ; Don't trust file modes
91 filemode = false
92
93 # Our diff algorithm
94 [diff]
6bb9e51b 95 external = /usr/local/bin/diff-wrapper
1ab661dd
PB
96 renames = true
97
910c00c8
AK
98 [branch "devel"]
99 remote = origin
100 merge = refs/heads/devel
101
e136f33b
JN
102 # Proxy settings
103 [core]
29093c28 104 gitProxy="ssh" for "kernel.org"
e136f33b 105 gitProxy=default-proxy ; for the rest
910c00c8 106
1ab661dd
PB
107Variables
108~~~~~~~~~
109
110Note that this list is non-comprehensive and not necessarily complete.
b8936cf0
FD
111For command-specific variables, you will find a more detailed description
112in the appropriate manual page. You will find a description of non-core
1ab661dd
PB
113porcelain configuration variables in the respective porcelain documentation.
114
115core.fileMode::
116 If false, the executable bit differences between the index and
117 the working copy are ignored; useful on broken filesystems like FAT.
5162e697 118 See linkgit:git-update-index[1]. True by default.
1ab661dd 119
1ce4790b
AR
120core.trustctime::
121 If false, the ctime differences between the index and the
122 working copy are ignored; useful when the inode change time
123 is regularly modified by something outside Git (file system
124 crawlers and some backup systems).
125 See linkgit:git-update-index[1]. True by default.
126
9378c161 127core.quotepath::
5833d730
JN
128 The commands that output paths (e.g. 'ls-files',
129 'diff'), when not given the `-z` option, will quote
9378c161
JH
130 "unusual" characters in the pathname by enclosing the
131 pathname in a double-quote pair and with backslashes the
132 same way strings in C source code are quoted. If this
133 variable is set to false, the bytes higher than 0x80 are
134 not quoted but output as verbatim. Note that double
135 quote, backslash and control characters are always
136 quoted without `-z` regardless of the setting of this
137 variable.
138
5cb71f82
FL
139core.autocrlf::
140 If true, makes git convert `CRLF` at the end of lines in text files to
141 `LF` when reading from the filesystem, and convert in reverse when
142 writing to the filesystem. The variable can be set to
143 'input', in which case the conversion happens only while
144 reading from the filesystem but files are written out with
145 `LF` at the end of lines. Currently, which paths to consider
146 "text" (i.e. be subjected to the autocrlf mechanism) is
147 decided purely based on the contents.
148
21e5ad50
SP
149core.safecrlf::
150 If true, makes git check if converting `CRLF` as controlled by
151 `core.autocrlf` is reversible. Git will verify if a command
152 modifies a file in the work tree either directly or indirectly.
153 For example, committing a file followed by checking out the
154 same file should yield the original file in the work tree. If
155 this is not the case for the current setting of
156 `core.autocrlf`, git will reject the file. The variable can
157 be set to "warn", in which case git will only warn about an
158 irreversible conversion but continue the operation.
159+
160CRLF conversion bears a slight chance of corrupting data.
161autocrlf=true will convert CRLF to LF during commit and LF to
162CRLF during checkout. A file that contains a mixture of LF and
163CRLF before the commit cannot be recreated by git. For text
164files this is the right thing to do: it corrects line endings
165such that we have only LF line endings in the repository.
166But for binary files that are accidentally classified as text the
167conversion can corrupt data.
168+
169If you recognize such corruption early you can easily fix it by
170setting the conversion type explicitly in .gitattributes. Right
171after committing you still have the original file in your work
172tree and this file is not yet corrupted. You can explicitly tell
173git that this file is binary and git will handle the file
174appropriately.
175+
176Unfortunately, the desired effect of cleaning up text files with
177mixed line endings and the undesired effect of corrupting binary
178files cannot be distinguished. In both cases CRLFs are removed
179in an irreversible way. For text files this is the right thing
180to do because CRLFs are line endings, while for binary files
181converting CRLFs corrupts data.
182+
183Note, this safety check does not mean that a checkout will generate a
184file identical to the original file for a different setting of
185`core.autocrlf`, but only for the current one. For example, a text
186file with `LF` would be accepted with `core.autocrlf=input` and could
187later be checked out with `core.autocrlf=true`, in which case the
188resulting file would contain `CRLF`, although the original file
189contained `LF`. However, in both work trees the line endings would be
190consistent, that is either all `LF` or all `CRLF`, but never mixed. A
191file with mixed line endings would be reported by the `core.safecrlf`
192mechanism.
193
78a8d641
JS
194core.symlinks::
195 If false, symbolic links are checked out as small plain files that
5162e697
DM
196 contain the link text. linkgit:git-update-index[1] and
197 linkgit:git-add[1] will not change the recorded type to regular
78a8d641
JS
198 file. Useful on filesystems like FAT that do not support
199 symbolic links. True by default.
200
1ab661dd
PB
201core.gitProxy::
202 A "proxy command" to execute (as 'command host port') instead
203 of establishing direct connection to the remote server when
204 using the git protocol for fetching. If the variable value is
205 in the "COMMAND for DOMAIN" format, the command is applied only
206 on hostnames ending with the specified domain string. This variable
207 may be set multiple times and is matched in the given order;
208 the first match wins.
b8936cf0
FD
209+
210Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
211(which always applies universally, without the special "for"
212handling).
1ab661dd
PB
213
214core.ignoreStat::
b7f685a7
MSO
215 If true, commands which modify both the working tree and the index
216 will mark the updated paths with the "assume unchanged" bit in the
217 index. These marked files are then assumed to stay unchanged in the
218 working copy, until you mark them otherwise manually - Git will not
219 detect the file changes by lstat() calls. This is useful on systems
220 where those are very slow, such as Microsoft Windows.
221 See linkgit:git-update-index[1].
1ab661dd
PB
222 False by default.
223
9f0bb90d
JH
224core.preferSymlinkRefs::
225 Instead of the default "symref" format for HEAD
226 and other symbolic reference files, use symbolic links.
227 This is sometimes needed to work with old scripts that
228 expect HEAD to be a symbolic link.
1ab661dd 229
e4a15f40
SP
230core.bare::
231 If true this repository is assumed to be 'bare' and has no
232 working directory associated with it. If this is the case a
233 number of commands that require a working directory will be
5162e697 234 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
e4a15f40 235+
5162e697
DM
236This setting is automatically guessed by linkgit:git-clone[1] or
237linkgit:git-init[1] when the repository was created. By default a
e4a15f40
SP
238repository that ends in "/.git" is assumed to be not bare (bare =
239false), while all other repositories are assumed to be bare (bare
240= true).
241
892c41b9
ML
242core.worktree::
243 Set the path to the working tree. The value will not be
244 used in combination with repositories found automatically in
245 a .git directory (i.e. $GIT_DIR is not set).
06ada152 246 This can be overridden by the GIT_WORK_TREE environment
302cc11a
LY
247 variable and the '--work-tree' command line option. It can be
248 a absolute path or relative path to the directory specified by
249 --git-dir or GIT_DIR.
250 Note: If --git-dir or GIT_DIR are specified but none of
251 --work-tree, GIT_WORK_TREE and core.worktree is specified,
252 the current working directory is regarded as the top directory
253 of your working tree.
892c41b9 254
6de08ae6 255core.logAllRefUpdates::
14cd5607 256 Enable the reflog. Updates to a ref <ref> is logged to the file
4057deb5
JH
257 "$GIT_DIR/logs/<ref>", by appending the new and old
258 SHA1, the date/time and the reason of the update, but
259 only when the file exists. If this configuration
260 variable is set to true, missing "$GIT_DIR/logs/<ref>"
261 file is automatically created for branch heads.
a862f97e
JH
262+
263This information can be used to determine what commit
264was the tip of a branch "2 days ago".
265+
266This value is true by default in a repository that has
267a working directory associated with it, and false by
268default in a bare repository.
6de08ae6 269
1ab661dd
PB
270core.repositoryFormatVersion::
271 Internal variable identifying the repository format and layout
272 version.
273
274core.sharedRepository::
d5dc6a76
JF
275 When 'group' (or 'true'), the repository is made shareable between
276 several users in a group (making sure all the files and objects are
277 group-writable). When 'all' (or 'world' or 'everybody'), the
278 repository will be readable by all users, additionally to being
279 group-shareable. When 'umask' (or 'false'), git will use permissions
06cbe855
HO
280 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
281 files in the repository will have this mode value. '0xxx' will override
282 user's umask value, and thus, users with a safe umask (0077) can use
283 this option. Examples: '0660' is equivalent to 'group'. '0640' is a
284 repository that is group-readable but not group-writable.
285 See linkgit:git-init[1]. False by default.
1ab661dd
PB
286
287core.warnAmbiguousRefs::
288 If true, git will warn you if the ref name you passed it is ambiguous
289 and might match multiple refs in the .git/refs/ tree. True by default.
290
3d3e95af 291core.compression::
960ccca6
DH
292 An integer -1..9, indicating a default compression level.
293 -1 is the zlib default. 0 means no compression,
294 and 1..9 are various speed/size tradeoffs, 9 being slowest.
dec92309
BD
295 If set, this provides a default to other compression variables,
296 such as 'core.loosecompression' and 'pack.compression'.
960ccca6
DH
297
298core.loosecompression::
12f6c308 299 An integer -1..9, indicating the compression level for objects that
960ccca6 300 are not in a pack file. -1 is the zlib default. 0 means no
12f6c308 301 compression, and 1..9 are various speed/size tradeoffs, 9 being
960ccca6 302 slowest. If not set, defaults to core.compression. If that is
de1b2460 303 not set, defaults to 1 (best speed).
12f6c308 304
60bb8b14
SP
305core.packedGitWindowSize::
306 Number of bytes of a pack file to map into memory in a
307 single mapping operation. Larger window sizes may allow
308 your system to process a smaller number of large pack files
309 more quickly. Smaller window sizes will negatively affect
eb92242f 310 performance due to increased calls to the operating system's
60bb8b14 311 memory manager, but may improve performance when accessing
22bac0ea
SP
312 a large number of large pack files.
313+
314Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
315MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
316be reasonable for all users/operating systems. You probably do
317not need to adjust this value.
eb92242f
SP
318+
319Common unit suffixes of 'k', 'm', or 'g' are supported.
60bb8b14 320
77ccc5bb
SP
321core.packedGitLimit::
322 Maximum number of bytes to map simultaneously into memory
323 from pack files. If Git needs to access more than this many
324 bytes at once to complete an operation it will unmap existing
325 regions to reclaim virtual address space within the process.
22bac0ea
SP
326+
327Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
328This should be reasonable for all users/operating systems, except on
329the largest projects. You probably do not need to adjust this value.
eb92242f
SP
330+
331Common unit suffixes of 'k', 'm', or 'g' are supported.
77ccc5bb 332
18bdec11
SP
333core.deltaBaseCacheLimit::
334 Maximum number of bytes to reserve for caching base objects
335 that multiple deltafied objects reference. By storing the
336 entire decompressed base objects in a cache Git is able
337 to avoid unpacking and decompressing frequently used base
338 objects multiple times.
339+
340Default is 16 MiB on all platforms. This should be reasonable
341for all users/operating systems, except on the largest projects.
342You probably do not need to adjust this value.
343+
344Common unit suffixes of 'k', 'm', or 'g' are supported.
345
e8964a5b 346core.excludesfile::
0ba956d3
JS
347 In addition to '.gitignore' (per-directory) and
348 '.git/info/exclude', git looks into this file for patterns
cedb8d5d 349 of files which are not meant to be tracked. See
5162e697 350 linkgit:gitignore[5].
0ba956d3 351
ef0c2abf
AR
352core.editor::
353 Commands such as `commit` and `tag` that lets you edit
02783075 354 messages by launching an editor uses the value of this
ef0c2abf
AR
355 variable when it is set, and the environment variable
356 `GIT_EDITOR` is not set. The order of preference is
a644ffde
JH
357 `GIT_EDITOR` environment, `core.editor`, `VISUAL` and
358 `EDITOR` environment variables and then finally `vi`.
ef0c2abf 359
54adf370
BG
360core.pager::
361 The command that git will use to paginate output. Can be overridden
362 with the `GIT_PAGER` environment variable.
363
91af7ae5
JH
364core.whitespace::
365 A comma separated list of common whitespace problems to
ba020ef5
JN
366 notice. 'git-diff' will use `color.diff.whitespace` to
367 highlight them, and 'git-apply --whitespace=error' will
c921cc92
JH
368 consider them as errors. You can prefix `-` to disable
369 any of them (e.g. `-trailing-space`):
91af7ae5
JH
370+
371* `trailing-space` treats trailing whitespaces at the end of the line
372 as an error (enabled by default).
373* `space-before-tab` treats a space character that appears immediately
374 before a tab character in the initial indent part of the line as an
375 error (enabled by default).
376* `indent-with-non-tab` treats a line that is indented with 8 or more
127f72e6 377 space characters as an error (not enabled by default).
b2979ff5
JH
378* `cr-at-eol` treats a carriage-return at the end of line as
379 part of the line terminator, i.e. with it, `trailing-space`
380 does not trigger if the character before such a carriage-return
381 is not a whitespace (not enabled by default).
91af7ae5 382
aafe9fba
LT
383core.fsyncobjectfiles::
384 This boolean will enable 'fsync()' when writing object files.
385+
386This is a total waste of time and effort on a filesystem that orders
387data writes properly, but can be useful for filesystems that do not use
388journalling (traditional UNIX filesystems) or that only journal metadata
389and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
390
4514ad4f 391alias.*::
5162e697 392 Command aliases for the linkgit:git[1] command wrapper - e.g.
4514ad4f
PB
393 after defining "alias.last = cat-file commit HEAD", the invocation
394 "git last" is equivalent to "git cat-file commit HEAD". To avoid
99b41c84
PB
395 confusion and troubles with script usage, aliases that
396 hide existing git commands are ignored. Arguments are split by
397 spaces, the usual shell quoting and escaping is supported.
398 quote pair and a backslash can be used to quote them.
f368f5a6
JH
399+
400If the alias expansion is prefixed with an exclamation point,
401it will be treated as a shell command. For example, defining
402"alias.new = !gitk --all --not ORIG_HEAD", the invocation
403"git new" is equivalent to running the shell command
404"gitk --all --not ORIG_HEAD".
dfd42a3c 405
1ab661dd 406apply.whitespace::
ba020ef5 407 Tells 'git-apply' how to handle whitespaces, in the same way
5162e697 408 as the '--whitespace' option. See linkgit:git-apply[1].
1ab661dd 409
9902387d 410branch.autosetupmerge::
ba020ef5 411 Tells 'git-branch' and 'git-checkout' to setup new branches
572fc81d
JS
412 so that linkgit:git-pull[1] will appropriately merge from the
413 starting point branch. Note that even if this option is not set,
9902387d 414 this behavior can be chosen per-branch using the `--track`
572fc81d
JS
415 and `--no-track` options. The valid settings are: `false` -- no
416 automatic setup is done; `true` -- automatic setup is done when the
417 starting point is a remote branch; `always` -- automatic setup is
418 done when the starting point is either a local branch or remote
419 branch. This option defaults to true.
9902387d 420
c998ae9b 421branch.autosetuprebase::
ba020ef5 422 When a new branch is created with 'git-branch' or 'git-checkout'
c998ae9b
DS
423 that tracks another branch, this variable tells git to set
424 up pull to rebase instead of merge (see "branch.<name>.rebase").
425 When `never`, rebase is never automatically set to true.
426 When `local`, rebase is set to true for tracked branches of
427 other local branches.
428 When `remote`, rebase is set to true for tracked branches of
429 remote branches.
430 When `always`, rebase will be set to true for all tracking
431 branches.
432 See "branch.autosetupmerge" for details on how to set up a
433 branch to track another branch.
434 This option defaults to never.
435
648ad18f 436branch.<name>.remote::
ba020ef5
JN
437 When in branch <name>, it tells 'git-fetch' which remote to fetch.
438 If this option is not given, 'git-fetch' defaults to remote "origin".
648ad18f 439
5372806a 440branch.<name>.merge::
ba020ef5 441 When in branch <name>, it tells 'git-fetch' the default
b888d61c
DB
442 refspec to be marked for merging in FETCH_HEAD. The value is
443 handled like the remote part of a refspec, and must match a
444 ref which is fetched from the remote given by
445 "branch.<name>.remote".
ba020ef5
JN
446 The merge information is used by 'git-pull' (which at first calls
447 'git-fetch') to lookup the default branch for merging. Without
448 this option, 'git-pull' defaults to merge the first refspec fetched.
62b339a5 449 Specify multiple values to get an octopus merge.
ba020ef5 450 If you wish to setup 'git-pull' so that it merges into <name> from
9debc324
PB
451 another branch in the local repository, you can point
452 branch.<name>.merge to the desired branch, and use the special setting
453 `.` (a period) for branch.<name>.remote.
5372806a 454
aec7b362
LH
455branch.<name>.mergeoptions::
456 Sets default options for merging into branch <name>. The syntax and
5162e697 457 supported options are equal to that of linkgit:git-merge[1], but
aec7b362
LH
458 option values containing whitespace characters are currently not
459 supported.
460
cd67e4d4
JS
461branch.<name>.rebase::
462 When true, rebase the branch <name> on top of the fetched branch,
15ddb6fa
DS
463 instead of merging the default branch from the default remote when
464 "git pull" is run.
cd67e4d4 465 *NOTE*: this is a possibly dangerous operation; do *not* use
5162e697 466 it unless you understand the implications (see linkgit:git-rebase[1]
cd67e4d4
JS
467 for details).
468
1658c614
CC
469browser.<tool>.cmd::
470 Specify the command to invoke the specified browser. The
471 specified command is evaluated in shell with the URLs passed
472 as arguments. (See linkgit:git-web--browse[1].)
473
584627b4
CC
474browser.<tool>.path::
475 Override the path for the given tool that may be used to
ab989adf
CC
476 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
477 working repository in gitweb (see linkgit:git-instaweb[1]).
584627b4 478
2122591b 479clean.requireForce::
562ca192
JH
480 A boolean to make git-clean do nothing unless given -f
481 or -n. Defaults to true.
2122591b 482
f3673988
BG
483color.branch::
484 A boolean to enable/disable color in the output of
5162e697 485 linkgit:git-branch[1]. May be set to `always`,
cec99d8c 486 `false` (or `never`) or `auto` (or `true`), in which case colors are used
f3673988
BG
487 only when the output is to a terminal. Defaults to false.
488
489color.branch.<slot>::
490 Use customized color for branch coloration. `<slot>` is one of
491 `current` (the current branch), `local` (a local branch),
492 `remote` (a tracking branch in refs/remotes/), `plain` (other
4f193f20
MW
493 refs).
494+
495The value for these configuration variables is a list of colors (at most
496two) and attributes (at most one), separated by spaces. The colors
497accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
498`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
499`blink` and `reverse`. The first color given is the foreground; the
500second is the background. The position of the attribute, if any,
501doesn't matter.
f3673988 502
a159ca0c 503color.diff::
cec99d8c
JH
504 When set to `always`, always use colors in patch.
505 When false (or `never`), never. When set to `true` or `auto`, use
506 colors only when the output is to the terminal. Defaults to false.
b5376648 507
a159ca0c 508color.diff.<slot>::
4f193f20
MW
509 Use customized color for diff colorization. `<slot>` specifies
510 which part of the patch to use the specified color, and is one
511 of `plain` (context text), `meta` (metainformation), `frag`
512 (hunk header), `old` (removed lines), `new` (added lines),
91af7ae5
JH
513 `commit` (commit headers), or `whitespace` (highlighting
514 whitespace errors). The values of these variables may be specified as
4f193f20 515 in color.branch.<slot>.
b5376648 516
b4c61ed6 517color.interactive::
47ee06f1 518 When set to `always`, always use colors for interactive prompts
467c0197 519 and displays (such as those used by "git-add --interactive").
b4c61ed6
JH
520 When false (or `never`), never. When set to `true` or `auto`, use
521 colors only when the output is to the terminal. Defaults to false.
522
523color.interactive.<slot>::
ba020ef5 524 Use customized color for 'git-add --interactive'
b4c61ed6
JH
525 output. `<slot>` may be `prompt`, `header`, or `help`, for
526 three distinct types of normal output from interactive
527 programs. The values of these variables may be specified as
528 in color.branch.<slot>.
529
1d77043b
JH
530color.pager::
531 A boolean to enable/disable colored output when the pager is in
532 use (default is true).
533
534color.status::
535 A boolean to enable/disable color in the output of
5162e697 536 linkgit:git-status[1]. May be set to `always`,
cec99d8c 537 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1d77043b
JH
538 only when the output is to a terminal. Defaults to false.
539
540color.status.<slot>::
541 Use customized color for status colorization. `<slot>` is
542 one of `header` (the header text of the status message),
82dca848
SP
543 `added` or `updated` (files which are added but not committed),
544 `changed` (files which are changed but not added in the index),
950ce2e2
CP
545 `untracked` (files which are not tracked by git), or
546 `nobranch` (the color the 'no branch' warning is shown in, defaulting
547 to red). The values of these variables may be specified as in
548 color.branch.<slot>.
1d77043b 549
383e45ce
BG
550commit.template::
551 Specify a file to use as the template for new commit messages.
552
6b2f2d98
MK
553color.ui::
554 When set to `always`, always use colors in all git commands which
555 are capable of colored output. When false (or `never`), never. When
556 set to `true` or `auto`, use colors only when the output is to the
557 terminal. When more specific variables of color.* are set, they always
558 take precedence over this setting. Defaults to false.
559
aecbf914 560diff.autorefreshindex::
ba020ef5 561 When using 'git-diff' to compare with work tree
aecbf914
JH
562 files, do not consider stat-only change as changed.
563 Instead, silently run `git update-index --refresh` to
564 update the cached stat information for paths whose
565 contents in the work tree match the contents in the
566 index. This option defaults to true. Note that this
ba020ef5 567 affects only 'git-diff' Porcelain, and not lower level
5833d730 568 'diff' commands, such as 'git-diff-files'.
aecbf914 569
a624eaa7
JM
570diff.suppress-blank-empty::
571 A boolean to inhibit the standard behavior of printing a space
572 before each empty output line. Defaults to false.
573
77680caa
JS
574diff.external::
575 If this config variable is set, diff generation is not
576 performed using the internal diff machinery, but using the
6bb9e51b
AM
577 given command. Can be overridden with the `GIT_EXTERNAL_DIFF'
578 environment variable. The command is called with parameters
579 as described under "git Diffs" in linkgit:git[1]. Note: if
580 you want to use an external diff program only on a subset of
581 your files, you might want to use linkgit:gitattributes[5] instead.
77680caa 582
1ab661dd
PB
583diff.renameLimit::
584 The number of files to consider when performing the copy/rename
0979c106 585 detection; equivalent to the 'git-diff' option '-l'.
1ab661dd 586
b68ea12e
EW
587diff.renames::
588 Tells git to detect renames. If set to any boolean value, it
589 will enable basic rename detection. If set to "copies" or
590 "copy", it will detect copies, as well.
591
af7cf268
JH
592fetch.unpackLimit::
593 If the number of objects fetched over the git native
594 transfer is below this
595 limit, then the objects will be unpacked into loose object
596 files. However if the number of received objects equals or
597 exceeds this limit then the received pack will be stored as
598 a pack, after adding any missing delta bases. Storing the
599 pack from a push can make the push operation complete faster,
80cd9cf9
MB
600 especially on slow filesystems. If not set, the value of
601 `transfer.unpackLimit` is used instead.
af7cf268 602
49604a4d
BG
603format.numbered::
604 A boolean which can enable sequence numbers in patch subjects.
02ff6250 605 Setting this option to "auto" will enable it only if there is
49604a4d 606 more than one patch. See --numbered option in
5162e697 607 linkgit:git-format-patch[1].
49604a4d 608
1ab661dd
PB
609format.headers::
610 Additional email headers to include in a patch to be submitted
5162e697 611 by mail. See linkgit:git-format-patch[1].
1ab661dd 612
78cb59c8
JS
613format.suffix::
614 The default for format-patch is to output files with the suffix
615 `.patch`. Use this variable to change that suffix (make sure to
616 include the dot if you want it).
1ab661dd 617
94c22a5e
CR
618format.pretty::
619 The default pretty format for log/show/whatchanged command,
620 See linkgit:git-log[1], linkgit:git-show[1],
621 linkgit:git-whatchanged[1].
622
0d7566a5
TT
623gc.aggressiveWindow::
624 The window size parameter used in the delta compression
467c0197 625 algorithm used by 'git-gc --aggressive'. This defaults
0d7566a5
TT
626 to 10.
627
e9831e83
JH
628gc.auto::
629 When there are approximately more than this many loose
630 objects in the repository, `git gc --auto` will pack them.
631 Some Porcelain commands use this command to perform a
80cd9cf9
MB
632 light-weight garbage collection from time to time. The
633 default value is 6700. Setting this to 0 disables it.
e9831e83 634
17815501
JH
635gc.autopacklimit::
636 When there are more than this many packs that are not
637 marked with `*.keep` file in the repository, `git gc
80cd9cf9 638 --auto` consolidates them into one larger pack. The
97063974 639 default value is 50. Setting this to 0 disables it.
17815501 640
c2120e5e 641gc.packrefs::
ba020ef5 642 'git-gc' does not run `git pack-refs` in a bare repository by
c2120e5e 643 default so that older dumb-transport clients can still fetch
ba020ef5 644 from the repository. Setting this to `true` lets 'git-gc'
7a7d4ef6 645 to run `git pack-refs`. Setting this to `false` tells
ba020ef5 646 'git-gc' never to run `git pack-refs`. The default setting is
c2120e5e
JS
647 `notbare`. Enable it only when you know you do not have to
648 support such clients. The default setting will change to `true`
649 at some stage, and setting this to `false` will continue to
ba020ef5 650 prevent `git pack-refs` from being run from 'git-gc'.
c2120e5e 651
25ee9731 652gc.pruneexpire::
5833d730 653 When 'git-gc' is run, it will call 'prune --expire 2.weeks.ago'.
25ee9731
JS
654 Override the grace period with this config variable.
655
4aec56d1 656gc.reflogexpire::
ba020ef5 657 'git-reflog expire' removes reflog entries older than
4aec56d1
JH
658 this time; defaults to 90 days.
659
660gc.reflogexpireunreachable::
ba020ef5 661 'git-reflog expire' removes reflog entries older than
4aec56d1
JH
662 this time and are not reachable from the current tip;
663 defaults to 30 days.
664
48c32424
JH
665gc.rerereresolved::
666 Records of conflicted merge you resolved earlier are
ba020ef5 667 kept for this many days when 'git-rerere gc' is run.
5162e697 668 The default is 60 days. See linkgit:git-rerere[1].
48c32424
JH
669
670gc.rerereunresolved::
671 Records of conflicted merge you have not resolved are
ba020ef5 672 kept for this many days when 'git-rerere gc' is run.
5162e697 673 The default is 15 days. See linkgit:git-rerere[1].
48c32424 674
121c813f
JH
675rerere.autoupdate::
676 When set to true, `git-rerere` updates the index with the
677 resulting contents after it cleanly resolves conflicts using
678 previously recorded resolution. Defaults to false.
679
b4372ef1
JS
680rerere.enabled::
681 Activate recording of resolved conflicts, so that identical
682 conflict hunks can be resolved automatically, should they
5162e697 683 be encountered again. linkgit:git-rerere[1] command is by
11c57e6a
JH
684 default enabled if you create `rr-cache` directory under
685 `$GIT_DIR`, but can be disabled by setting this option to false.
b4372ef1 686
1ab661dd 687gitcvs.enabled::
db218723 688 Whether the CVS server interface is enabled for this repository.
5162e697 689 See linkgit:git-cvsserver[1].
1ab661dd
PB
690
691gitcvs.logfile::
db218723 692 Path to a log file where the CVS server interface well... logs
5162e697 693 various stuff. See linkgit:git-cvsserver[1].
1ab661dd 694
8a06a632
MO
695gitcvs.usecrlfattr
696 If true, the server will look up the `crlf` attribute for
697 files to determine the '-k' modes to use. If `crlf` is set,
698 the '-k' mode will be left blank, so cvs clients will
699 treat it as text. If `crlf` is explicitly unset, the file
1168d402 700 will be set with '-kb' mode, which suppresses any newline munging
8a06a632 701 the client might otherwise do. If `crlf` is not specified,
ea449615 702 then 'gitcvs.allbinary' is used. See linkgit:gitattributes[5].
8a06a632 703
eabb0bfd 704gitcvs.allbinary::
90948a42
MO
705 This is used if 'gitcvs.usecrlfattr' does not resolve
706 the correct '-kb' mode to use. If true, all
707 unresolved files are sent to the client in
708 mode '-kb'. This causes the client to treat them
709 as binary files, which suppresses any newline munging it
710 otherwise might do. Alternatively, if it is set to "guess",
711 then the contents of the file are examined to decide if
712 it is binary, similar to 'core.autocrlf'.
abbf5947 713
04752868
FL
714gitcvs.dbname::
715 Database used by git-cvsserver to cache revision information
716 derived from the git repository. The exact meaning depends on the
717 used database driver, for SQLite (which is the default driver) this
718 is a filename. Supports variable substitution (see
5162e697 719 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
04752868
FL
720 Default: '%Ggitcvs.%m.sqlite'
721
722gitcvs.dbdriver::
723 Used Perl DBI driver. You can specify any available driver
724 for this here, but it might not work. git-cvsserver is tested
725 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
726 reported *not* to work with 'DBD::mysql'. Experimental feature.
727 May not contain double colons (`:`). Default: 'SQLite'.
5162e697 728 See linkgit:git-cvsserver[1].
eabb0bfd 729
04752868
FL
730gitcvs.dbuser, gitcvs.dbpass::
731 Database user and password. Only useful if setting 'gitcvs.dbdriver',
732 since SQLite has no concept of database users and/or passwords.
733 'gitcvs.dbuser' supports variable substitution (see
5162e697 734 linkgit:git-cvsserver[1] for details).
04752868 735
6aeeffd1
JE
736gitcvs.dbTableNamePrefix::
737 Database table name prefix. Prepended to the names of any
738 database tables used, allowing a single database to be used
739 for several repositories. Supports variable substitution (see
740 linkgit:git-cvsserver[1] for details). Any non-alphabetic
741 characters will be replaced with underscores.
742
8a06a632
MO
743All gitcvs variables except for 'gitcvs.usecrlfattr' and
744'gitcvs.allbinary' can also be specified as
745'gitcvs.<access_method>.<varname>' (where 'access_method'
02783075
BH
746is one of "ext" and "pserver") to make them apply only for the given
747access method.
04752868 748
d84ae0db
GH
749gui.commitmsgwidth::
750 Defines how wide the commit message window is in the
751 linkgit:git-gui[1]. "75" is the default.
752
753gui.diffcontext::
754 Specifies how many context lines should be used in calls to diff
755 made by the linkgit:git-gui[1]. The default is "5".
756
757gui.matchtrackingbranch::
758 Determines if new branches created with linkgit:git-gui[1] should
759 default to tracking remote branches with matching names or
760 not. Default: "false".
761
762gui.newbranchtemplate::
763 Is used as suggested name when creating new branches using the
764 linkgit:git-gui[1].
765
766gui.pruneduringfetch::
767 "true" if linkgit:git-gui[1] should prune tracking branches when
768 performing a fetch. The default value is "false".
769
770gui.trustmtime::
771 Determines if linkgit:git-gui[1] should trust the file modification
772 timestamp or not. By default the timestamps are not trusted.
773
774gui.spellingdictionary::
775 Specifies the dictionary used for spell checking commit messages in
776 the linkgit:git-gui[1]. When set to "none" spell checking is turned
777 off.
778
983a9eeb
CC
779help.browser::
780 Specify the browser that will be used to display help in the
781 'web' format. See linkgit:git-help[1].
782
783help.format::
784 Override the default help format used by linkgit:git-help[1].
785 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
786 the default. 'web' and 'html' are the same.
787
9c5665aa
SV
788http.proxy::
789 Override the HTTP proxy, normally configured using the 'http_proxy'
5162e697 790 environment variable (see linkgit:curl[1]). This can be overridden
14c98218 791 on a per-remote basis; see remote.<name>.proxy
9c5665aa 792
1ab661dd
PB
793http.sslVerify::
794 Whether to verify the SSL certificate when fetching or pushing
37425065 795 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1ab661dd
PB
796 variable.
797
798http.sslCert::
799 File containing the SSL certificate when fetching or pushing
37425065 800 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1ab661dd
PB
801 variable.
802
803http.sslKey::
804 File containing the SSL private key when fetching or pushing
abda1ef5 805 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1ab661dd
PB
806 variable.
807
808http.sslCAInfo::
809 File containing the certificates to verify the peer with when
abda1ef5 810 fetching or pushing over HTTPS. Can be overridden by the
1ab661dd
PB
811 'GIT_SSL_CAINFO' environment variable.
812
813http.sslCAPath::
814 Path containing files with the CA certificates to verify the peer
37425065 815 with when fetching or pushing over HTTPS. Can be overridden
1ab661dd
PB
816 by the 'GIT_SSL_CAPATH' environment variable.
817
818http.maxRequests::
abda1ef5 819 How many HTTP requests to launch in parallel. Can be overridden
1ab661dd
PB
820 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
821
822http.lowSpeedLimit, http.lowSpeedTime::
823 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
824 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
abda1ef5 825 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1ab661dd
PB
826 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
827
3ea099d4
SK
828http.noEPSV::
829 A boolean which disables using of EPSV ftp command by curl.
befc9c42 830 This can helpful with some "poor" ftp servers which don't
3ea099d4
SK
831 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
832 environment variable. Default is false (curl will use EPSV).
833
1ab661dd
PB
834i18n.commitEncoding::
835 Character encoding the commit messages are stored in; git itself
836 does not care per se, but this information is necessary e.g. when
837 importing commits from emails or in the gitk graphical history
838 browser (and possibly at other places in the future or in other
5162e697 839 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1ab661dd 840
d2c11a38
JH
841i18n.logOutputEncoding::
842 Character encoding the commit messages are converted to when
ba020ef5 843 running 'git-log' and friends.
d2c11a38 844
983a9eeb
CC
845instaweb.browser::
846 Specify the program that will be used to browse your working
847 repository in gitweb. See linkgit:git-instaweb[1].
848
849instaweb.httpd::
850 The HTTP daemon command-line to start gitweb on your working
851 repository. See linkgit:git-instaweb[1].
852
853instaweb.local::
854 If true the web server started by linkgit:git-instaweb[1] will
855 be bound to the local IP (127.0.0.1).
856
857instaweb.modulepath::
858 The module path for an apache httpd used by linkgit:git-instaweb[1].
859
860instaweb.port::
861 The port number to bind the gitweb httpd to. See
862 linkgit:git-instaweb[1].
863
dd0ffd5b
HO
864log.date::
865 Set default date-time mode for the log command. Setting log.date
0979c106 866 value is similar to using 'git-log'\'s --date option. The value is one of the
dd0ffd5b
HO
867 following alternatives: {relative,local,default,iso,rfc,short}.
868 See linkgit:git-log[1].
869
0f03ca94
PB
870log.showroot::
871 If true, the initial commit will be shown as a big creation event.
872 This is equivalent to a diff against an empty tree.
5162e697 873 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
0f03ca94
PB
874 normally hide the root commit will now show it. True by default.
875
b5578f33 876man.viewer::
b8322ea8 877 Specify the programs that may be used to display help in the
b5578f33
CC
878 'man' format. See linkgit:git-help[1].
879
f5a84c37 880include::merge-config.txt[]
88e7fdf2 881
0bb64009
CC
882man.<tool>.cmd::
883 Specify the command to invoke the specified man viewer. The
884 specified command is evaluated in shell with the man page
885 passed as argument. (See linkgit:git-help[1].)
886
7e8114c0
CC
887man.<tool>.path::
888 Override the path for the given tool that may be used to
889 display help in the 'man' format. See linkgit:git-help[1].
890
77680caa
JS
891mergetool.<tool>.path::
892 Override the path for the given tool. This is useful in case
893 your tool is not in the PATH.
894
964473a0
CB
895mergetool.<tool>.cmd::
896 Specify the command to invoke the specified merge tool. The
897 specified command is evaluated in shell with the following
898 variables available: 'BASE' is the name of a temporary file
899 containing the common base of the files to be merged, if available;
900 'LOCAL' is the name of a temporary file containing the contents of
901 the file on the current branch; 'REMOTE' is the name of a temporary
902 file containing the contents of the file from the branch being
903 merged; 'MERGED' contains the name of the file to which the merge
904 tool should write the results of a successful merge.
905
906mergetool.<tool>.trustExitCode::
907 For a custom merge command, specify whether the exit code of
908 the merge command can be used to determine whether the merge was
909 successful. If this is not set to true then the merge target file
910 timestamp is checked and the merge assumed to have been successful
911 if the file has been updated, otherwise the user is prompted to
912 indicate the success of the merge.
913
44c36d1c
CB
914mergetool.keepBackup::
915 After performing a merge, the original file with conflict markers
916 can be saved as a file with a `.orig` extension. If this variable
917 is set to `false` then this file is not preserved. Defaults to
918 `true` (i.e. keep the backup files).
919
4812a93a 920pack.window::
5162e697 921 The size of the window used by linkgit:git-pack-objects[1] when no
4812a93a
JK
922 window size is given on the command line. Defaults to 10.
923
842aaf93 924pack.depth::
5162e697 925 The maximum delta depth used by linkgit:git-pack-objects[1] when no
618e613a 926 maximum depth is given on the command line. Defaults to 50.
842aaf93 927
e93b15cd 928pack.windowMemory::
5162e697 929 The window memory size limit used by linkgit:git-pack-objects[1]
e93b15cd
BD
930 when no limit is given on the command line. The value can be
931 suffixed with "k", "m", or "g". Defaults to 0, meaning no
932 limit.
933
960ccca6
DH
934pack.compression::
935 An integer -1..9, indicating the compression level for objects
936 in a pack file. -1 is the zlib default. 0 means no
937 compression, and 1..9 are various speed/size tradeoffs, 9 being
938 slowest. If not set, defaults to core.compression. If that is
dec92309
BD
939 not set, defaults to -1, the zlib default, which is "a default
940 compromise between speed and compression (currently equivalent
941 to level 6)."
960ccca6 942
074b2eea 943pack.deltaCacheSize::
02783075 944 The maximum memory in bytes used for caching deltas in
5162e697 945 linkgit:git-pack-objects[1].
074b2eea
MK
946 A value of 0 means no limit. Defaults to 0.
947
e3dfddb3 948pack.deltaCacheLimit::
693b86ff 949 The maximum size of a delta, that is cached in
5162e697 950 linkgit:git-pack-objects[1]. Defaults to 1000.
e3dfddb3 951
693b86ff
NP
952pack.threads::
953 Specifies the number of threads to spawn when searching for best
5162e697 954 delta matches. This requires that linkgit:git-pack-objects[1]
693b86ff
NP
955 be compiled with pthreads otherwise this option is ignored with a
956 warning. This is meant to reduce packing time on multiprocessor
957 machines. The required amount of memory for the delta search window
958 is however multiplied by the number of threads.
833e3df1
AE
959 Specifying 0 will cause git to auto-detect the number of CPU's
960 and set the number of threads accordingly.
693b86ff 961
4d00bda2
NP
962pack.indexVersion::
963 Specify the default pack index version. Valid values are 1 for
964 legacy pack index used by Git versions prior to 1.5.2, and 2 for
965 the new pack index with capabilities for packs larger than 4 GB
966 as well as proper protection against the repacking of corrupted
c0a5e2d4
NP
967 packs. Version 2 is the default. Note that version 2 is enforced
968 and this config option ignored whenever the corresponding pack is
969 larger than 2 GB.
970+
971If you have an old git that does not understand the version 2 `{asterisk}.idx` file,
972cloning or fetching over a non native protocol (e.g. "http" and "rsync")
973that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the
974other side may give you a repository that cannot be accessed with your
975older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,
976you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
977the `{asterisk}.idx` file.
4d00bda2 978
dbdbfec4 979pack.packSizeLimit::
2b84b5a8
JS
980 The default maximum size of a pack. This setting only affects
981 packing to a file, i.e. the git:// protocol is unaffected. It
982 can be overridden by the `\--max-pack-size` option of
983 linkgit:git-repack[1].
984
4370c2d6
MV
985pager.<cmd>::
986 Allows to set your own pager preferences for each command, overriding
987 the default. If `\--pager` or `\--no-pager` is specified on the command
988 line, it takes precedence over this option.
989
1ab661dd
PB
990pull.octopus::
991 The default merge strategy to use when pulling multiple branches
992 at once.
993
994pull.twohead::
995 The default merge strategy to use when pulling a single branch.
996
0cc6d346 997remote.<name>.url::
5162e697
DM
998 The URL of a remote repository. See linkgit:git-fetch[1] or
999 linkgit:git-push[1].
0cc6d346 1000
14c98218
SV
1001remote.<name>.proxy::
1002 For remotes that require curl (http, https and ftp), the URL to
1003 the proxy to use for that remote. Set to the empty string to
1004 disable proxying for that remote.
1005
0cc6d346 1006remote.<name>.fetch::
5162e697
DM
1007 The default set of "refspec" for linkgit:git-fetch[1]. See
1008 linkgit:git-fetch[1].
0cc6d346
SB
1009
1010remote.<name>.push::
5162e697
DM
1011 The default set of "refspec" for linkgit:git-push[1]. See
1012 linkgit:git-push[1].
0cc6d346 1013
84bb2dfd
PB
1014remote.<name>.mirror::
1015 If true, pushing to this remote will automatically behave
1016 as if the `\--mirror` option was given on the command line.
1017
1918278e
TT
1018remote.<name>.skipDefaultUpdate::
1019 If true, this remote will be skipped by default when updating
5162e697 1020 using the update subcommand of linkgit:git-remote[1].
1918278e 1021
060aafc1 1022remote.<name>.receivepack::
5dee29ac 1023 The default program to execute on the remote side when pushing. See
79f43f3d 1024 option \--receive-pack of linkgit:git-push[1].
060aafc1 1025
5dee29ac
UKK
1026remote.<name>.uploadpack::
1027 The default program to execute on the remote side when fetching. See
79f43f3d 1028 option \--upload-pack of linkgit:git-fetch-pack[1].
5dee29ac 1029
047f636d 1030remote.<name>.tagopt::
79f43f3d
UKK
1031 Setting this value to \--no-tags disables automatic tag following when
1032 fetching from remote <name>
047f636d 1033
1918278e
TT
1034remotes.<group>::
1035 The list of remotes which are fetched by "git remote update
5162e697 1036 <group>". See linkgit:git-remote[1].
1918278e 1037
b6945f57 1038repack.usedeltabaseoffset::
22c79eab
NP
1039 By default, linkgit:git-repack[1] creates packs that use
1040 delta-base offset. If you need to share your repository with
1041 git older than version 1.4.4, either directly or via a dumb
1042 protocol such as http, then you need to set this option to
1043 "false" and repack. Access from old git versions over the
1044 native protocol are unaffected by this option.
b6945f57 1045
1ab661dd 1046showbranch.default::
5162e697
DM
1047 The default set of branches for linkgit:git-show-branch[1].
1048 See linkgit:git-show-branch[1].
1ab661dd 1049
46f721c8 1050status.relativePaths::
5162e697 1051 By default, linkgit:git-status[1] shows paths relative to the
46f721c8
JK
1052 current directory. Setting this variable to `false` shows paths
1053 relative to the repository root (this was the default for git
1054 prior to v1.5.4).
1055
d6293d1f
MSO
1056status.showUntrackedFiles::
1057 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1058 files which are not currently tracked by Git. Directories which
1059 contain only untracked files, are shown with the directory name
1060 only. Showing untracked files means that Git needs to lstat() all
1061 all the files in the whole repository, which might be slow on some
1062 systems. So, this variable controls how the commands displays
1063 the untracked files. Possible values are:
1064+
1065--
1066 - 'no' - Show no untracked files
1067 - 'normal' - Shows untracked files and directories
1068 - 'all' - Shows also individual files in untracked directories.
1069--
1070+
1071If this variable is not specified, it defaults to 'normal'.
1072This variable can be overridden with the -u|--untracked-files option
1073of linkgit:git-status[1] and linkgit:git-commit[1].
1074
ce1a79b6 1075tar.umask::
687157c7
RS
1076 This variable can be used to restrict the permission bits of
1077 tar archive entries. The default is 0002, which turns off the
1078 world write bit. The special value "user" indicates that the
1079 archiving user's umask will be used instead. See umask(2) and
5162e697 1080 linkgit:git-archive[1].
ce1a79b6 1081
55029ae4
DB
1082url.<base>.insteadOf::
1083 Any URL that starts with this value will be rewritten to
1084 start, instead, with <base>. In cases where some site serves a
1085 large number of repositories, and serves them with multiple
1086 access methods, and some users need to use different access
1087 methods, this feature allows people to specify any of the
1088 equivalent URLs and have git automatically rewrite the URL to
1089 the best alternative for the particular user, even for a
844112ca
JH
1090 never-before-seen repository on the site. When more than one
1091 insteadOf strings match a given URL, the longest match is used.
55029ae4 1092
1ab661dd
PB
1093user.email::
1094 Your email address to be recorded in any newly created commits.
28a94f88 1095 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
5162e697 1096 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
1ab661dd
PB
1097
1098user.name::
1099 Your full name to be recorded in any newly created commits.
abda1ef5 1100 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
5162e697 1101 environment variables. See linkgit:git-commit-tree[1].
1ab661dd 1102
d67778ec 1103user.signingkey::
5162e697 1104 If linkgit:git-tag[1] is not selecting the key you want it to
d67778ec
AP
1105 automatically when creating a signed tag, you can override the
1106 default selection with this variable. This option is passed
1107 unchanged to gpg's --local-user parameter, so you may specify a key
1108 using any method that gpg supports.
1109
1ab661dd
PB
1110imap::
1111 The configuration variables in the 'imap' section are described
5162e697 1112 in linkgit:git-imap-send[1].
199a9218 1113
20dc0016
MK
1114receive.fsckObjects::
1115 If it is set to true, git-receive-pack will check all received
1116 objects. It will abort in the case of a malformed object or a
1117 broken link. The result of an abort are only dangling objects.
1118 Defaults to false.
1119
fc04c412
SP
1120receive.unpackLimit::
1121 If the number of objects received in a push is below this
1122 limit then the objects will be unpacked into loose object
1123 files. However if the number of received objects equals or
1124 exceeds this limit then the received pack will be stored as
1125 a pack, after adding any missing delta bases. Storing the
1126 pack from a push can make the push operation complete faster,
80cd9cf9
MB
1127 especially on slow filesystems. If not set, the value of
1128 `transfer.unpackLimit` is used instead.
fc04c412
SP
1129
1130receive.denyNonFastForwards::
199a9218
JS
1131 If set to true, git-receive-pack will deny a ref update which is
1132 not a fast forward. Use this to prevent such an update via a push,
1133 even if that push is forced. This configuration variable is
1134 set when initializing a shared repository.
1135
e28714c5
JH
1136transfer.unpackLimit::
1137 When `fetch.unpackLimit` or `receive.unpackLimit` are
1138 not set, the value of this variable is used instead.
80cd9cf9 1139 The default value is 100.
983a9eeb
CC
1140
1141web.browser::
1142 Specify a web browser that may be used by some commands.
1143 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
1144 may use it.