tutorial: gentler illustration of Alice/Bob workflow using gitk
[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 360core.pager::
ab54cd6c
JN
361 The command that git will use to paginate output. Can
362 be overridden with the `GIT_PAGER` environment
363 variable. Note that git sets the `LESS` environment
364 variable to `FRSX` if it is unset when it runs the
365 pager. One can change these settings by setting the
366 `LESS` variable to some other value or by giving the
367 `core.pager` option a value such as "`less -+FRSX`".
54adf370 368
91af7ae5
JH
369core.whitespace::
370 A comma separated list of common whitespace problems to
ba020ef5
JN
371 notice. 'git-diff' will use `color.diff.whitespace` to
372 highlight them, and 'git-apply --whitespace=error' will
c921cc92
JH
373 consider them as errors. You can prefix `-` to disable
374 any of them (e.g. `-trailing-space`):
91af7ae5
JH
375+
376* `trailing-space` treats trailing whitespaces at the end of the line
377 as an error (enabled by default).
378* `space-before-tab` treats a space character that appears immediately
379 before a tab character in the initial indent part of the line as an
380 error (enabled by default).
381* `indent-with-non-tab` treats a line that is indented with 8 or more
127f72e6 382 space characters as an error (not enabled by default).
b2979ff5
JH
383* `cr-at-eol` treats a carriage-return at the end of line as
384 part of the line terminator, i.e. with it, `trailing-space`
385 does not trigger if the character before such a carriage-return
386 is not a whitespace (not enabled by default).
91af7ae5 387
aafe9fba
LT
388core.fsyncobjectfiles::
389 This boolean will enable 'fsync()' when writing object files.
390+
391This is a total waste of time and effort on a filesystem that orders
392data writes properly, but can be useful for filesystems that do not use
393journalling (traditional UNIX filesystems) or that only journal metadata
394and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
395
4514ad4f 396alias.*::
5162e697 397 Command aliases for the linkgit:git[1] command wrapper - e.g.
4514ad4f
PB
398 after defining "alias.last = cat-file commit HEAD", the invocation
399 "git last" is equivalent to "git cat-file commit HEAD". To avoid
99b41c84
PB
400 confusion and troubles with script usage, aliases that
401 hide existing git commands are ignored. Arguments are split by
402 spaces, the usual shell quoting and escaping is supported.
403 quote pair and a backslash can be used to quote them.
f368f5a6
JH
404+
405If the alias expansion is prefixed with an exclamation point,
406it will be treated as a shell command. For example, defining
407"alias.new = !gitk --all --not ORIG_HEAD", the invocation
408"git new" is equivalent to running the shell command
409"gitk --all --not ORIG_HEAD".
dfd42a3c 410
1ab661dd 411apply.whitespace::
ba020ef5 412 Tells 'git-apply' how to handle whitespaces, in the same way
5162e697 413 as the '--whitespace' option. See linkgit:git-apply[1].
1ab661dd 414
9902387d 415branch.autosetupmerge::
ba020ef5 416 Tells 'git-branch' and 'git-checkout' to setup new branches
572fc81d
JS
417 so that linkgit:git-pull[1] will appropriately merge from the
418 starting point branch. Note that even if this option is not set,
9902387d 419 this behavior can be chosen per-branch using the `--track`
572fc81d
JS
420 and `--no-track` options. The valid settings are: `false` -- no
421 automatic setup is done; `true` -- automatic setup is done when the
422 starting point is a remote branch; `always` -- automatic setup is
423 done when the starting point is either a local branch or remote
424 branch. This option defaults to true.
9902387d 425
c998ae9b 426branch.autosetuprebase::
ba020ef5 427 When a new branch is created with 'git-branch' or 'git-checkout'
c998ae9b
DS
428 that tracks another branch, this variable tells git to set
429 up pull to rebase instead of merge (see "branch.<name>.rebase").
430 When `never`, rebase is never automatically set to true.
431 When `local`, rebase is set to true for tracked branches of
432 other local branches.
433 When `remote`, rebase is set to true for tracked branches of
434 remote branches.
435 When `always`, rebase will be set to true for all tracking
436 branches.
437 See "branch.autosetupmerge" for details on how to set up a
438 branch to track another branch.
439 This option defaults to never.
440
648ad18f 441branch.<name>.remote::
ba020ef5
JN
442 When in branch <name>, it tells 'git-fetch' which remote to fetch.
443 If this option is not given, 'git-fetch' defaults to remote "origin".
648ad18f 444
5372806a 445branch.<name>.merge::
ba020ef5 446 When in branch <name>, it tells 'git-fetch' the default
b888d61c
DB
447 refspec to be marked for merging in FETCH_HEAD. The value is
448 handled like the remote part of a refspec, and must match a
449 ref which is fetched from the remote given by
450 "branch.<name>.remote".
ba020ef5
JN
451 The merge information is used by 'git-pull' (which at first calls
452 'git-fetch') to lookup the default branch for merging. Without
453 this option, 'git-pull' defaults to merge the first refspec fetched.
62b339a5 454 Specify multiple values to get an octopus merge.
ba020ef5 455 If you wish to setup 'git-pull' so that it merges into <name> from
9debc324
PB
456 another branch in the local repository, you can point
457 branch.<name>.merge to the desired branch, and use the special setting
458 `.` (a period) for branch.<name>.remote.
5372806a 459
aec7b362
LH
460branch.<name>.mergeoptions::
461 Sets default options for merging into branch <name>. The syntax and
5162e697 462 supported options are equal to that of linkgit:git-merge[1], but
aec7b362
LH
463 option values containing whitespace characters are currently not
464 supported.
465
cd67e4d4
JS
466branch.<name>.rebase::
467 When true, rebase the branch <name> on top of the fetched branch,
15ddb6fa
DS
468 instead of merging the default branch from the default remote when
469 "git pull" is run.
cd67e4d4 470 *NOTE*: this is a possibly dangerous operation; do *not* use
5162e697 471 it unless you understand the implications (see linkgit:git-rebase[1]
cd67e4d4
JS
472 for details).
473
1658c614
CC
474browser.<tool>.cmd::
475 Specify the command to invoke the specified browser. The
476 specified command is evaluated in shell with the URLs passed
477 as arguments. (See linkgit:git-web--browse[1].)
478
584627b4
CC
479browser.<tool>.path::
480 Override the path for the given tool that may be used to
ab989adf
CC
481 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
482 working repository in gitweb (see linkgit:git-instaweb[1]).
584627b4 483
2122591b 484clean.requireForce::
562ca192
JH
485 A boolean to make git-clean do nothing unless given -f
486 or -n. Defaults to true.
2122591b 487
f3673988
BG
488color.branch::
489 A boolean to enable/disable color in the output of
5162e697 490 linkgit:git-branch[1]. May be set to `always`,
cec99d8c 491 `false` (or `never`) or `auto` (or `true`), in which case colors are used
f3673988
BG
492 only when the output is to a terminal. Defaults to false.
493
494color.branch.<slot>::
495 Use customized color for branch coloration. `<slot>` is one of
496 `current` (the current branch), `local` (a local branch),
497 `remote` (a tracking branch in refs/remotes/), `plain` (other
4f193f20
MW
498 refs).
499+
500The value for these configuration variables is a list of colors (at most
501two) and attributes (at most one), separated by spaces. The colors
502accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
503`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
504`blink` and `reverse`. The first color given is the foreground; the
505second is the background. The position of the attribute, if any,
506doesn't matter.
f3673988 507
a159ca0c 508color.diff::
cec99d8c
JH
509 When set to `always`, always use colors in patch.
510 When false (or `never`), never. When set to `true` or `auto`, use
511 colors only when the output is to the terminal. Defaults to false.
b5376648 512
a159ca0c 513color.diff.<slot>::
4f193f20
MW
514 Use customized color for diff colorization. `<slot>` specifies
515 which part of the patch to use the specified color, and is one
516 of `plain` (context text), `meta` (metainformation), `frag`
517 (hunk header), `old` (removed lines), `new` (added lines),
91af7ae5
JH
518 `commit` (commit headers), or `whitespace` (highlighting
519 whitespace errors). The values of these variables may be specified as
4f193f20 520 in color.branch.<slot>.
b5376648 521
b4c61ed6 522color.interactive::
47ee06f1 523 When set to `always`, always use colors for interactive prompts
467c0197 524 and displays (such as those used by "git-add --interactive").
b4c61ed6
JH
525 When false (or `never`), never. When set to `true` or `auto`, use
526 colors only when the output is to the terminal. Defaults to false.
527
528color.interactive.<slot>::
ba020ef5 529 Use customized color for 'git-add --interactive'
b4c61ed6
JH
530 output. `<slot>` may be `prompt`, `header`, or `help`, for
531 three distinct types of normal output from interactive
532 programs. The values of these variables may be specified as
533 in color.branch.<slot>.
534
1d77043b
JH
535color.pager::
536 A boolean to enable/disable colored output when the pager is in
537 use (default is true).
538
539color.status::
540 A boolean to enable/disable color in the output of
5162e697 541 linkgit:git-status[1]. May be set to `always`,
cec99d8c 542 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1d77043b
JH
543 only when the output is to a terminal. Defaults to false.
544
545color.status.<slot>::
546 Use customized color for status colorization. `<slot>` is
547 one of `header` (the header text of the status message),
82dca848
SP
548 `added` or `updated` (files which are added but not committed),
549 `changed` (files which are changed but not added in the index),
950ce2e2
CP
550 `untracked` (files which are not tracked by git), or
551 `nobranch` (the color the 'no branch' warning is shown in, defaulting
552 to red). The values of these variables may be specified as in
553 color.branch.<slot>.
1d77043b 554
383e45ce
BG
555commit.template::
556 Specify a file to use as the template for new commit messages.
557
6b2f2d98
MK
558color.ui::
559 When set to `always`, always use colors in all git commands which
560 are capable of colored output. When false (or `never`), never. When
561 set to `true` or `auto`, use colors only when the output is to the
562 terminal. When more specific variables of color.* are set, they always
563 take precedence over this setting. Defaults to false.
564
aecbf914 565diff.autorefreshindex::
ba020ef5 566 When using 'git-diff' to compare with work tree
aecbf914
JH
567 files, do not consider stat-only change as changed.
568 Instead, silently run `git update-index --refresh` to
569 update the cached stat information for paths whose
570 contents in the work tree match the contents in the
571 index. This option defaults to true. Note that this
ba020ef5 572 affects only 'git-diff' Porcelain, and not lower level
5833d730 573 'diff' commands, such as 'git-diff-files'.
aecbf914 574
77680caa
JS
575diff.external::
576 If this config variable is set, diff generation is not
577 performed using the internal diff machinery, but using the
6bb9e51b
AM
578 given command. Can be overridden with the `GIT_EXTERNAL_DIFF'
579 environment variable. The command is called with parameters
580 as described under "git Diffs" in linkgit:git[1]. Note: if
581 you want to use an external diff program only on a subset of
582 your files, you might want to use linkgit:gitattributes[5] instead.
77680caa 583
1ab661dd
PB
584diff.renameLimit::
585 The number of files to consider when performing the copy/rename
0979c106 586 detection; equivalent to the 'git-diff' option '-l'.
1ab661dd 587
b68ea12e
EW
588diff.renames::
589 Tells git to detect renames. If set to any boolean value, it
590 will enable basic rename detection. If set to "copies" or
591 "copy", it will detect copies, as well.
592
af7cf268
JH
593fetch.unpackLimit::
594 If the number of objects fetched over the git native
595 transfer is below this
596 limit, then the objects will be unpacked into loose object
597 files. However if the number of received objects equals or
598 exceeds this limit then the received pack will be stored as
599 a pack, after adding any missing delta bases. Storing the
600 pack from a push can make the push operation complete faster,
80cd9cf9
MB
601 especially on slow filesystems. If not set, the value of
602 `transfer.unpackLimit` is used instead.
af7cf268 603
49604a4d
BG
604format.numbered::
605 A boolean which can enable sequence numbers in patch subjects.
02ff6250 606 Setting this option to "auto" will enable it only if there is
49604a4d 607 more than one patch. See --numbered option in
5162e697 608 linkgit:git-format-patch[1].
49604a4d 609
1ab661dd
PB
610format.headers::
611 Additional email headers to include in a patch to be submitted
5162e697 612 by mail. See linkgit:git-format-patch[1].
1ab661dd 613
78cb59c8
JS
614format.suffix::
615 The default for format-patch is to output files with the suffix
616 `.patch`. Use this variable to change that suffix (make sure to
617 include the dot if you want it).
1ab661dd 618
94c22a5e
CR
619format.pretty::
620 The default pretty format for log/show/whatchanged command,
621 See linkgit:git-log[1], linkgit:git-show[1],
622 linkgit:git-whatchanged[1].
623
0d7566a5
TT
624gc.aggressiveWindow::
625 The window size parameter used in the delta compression
467c0197 626 algorithm used by 'git-gc --aggressive'. This defaults
0d7566a5
TT
627 to 10.
628
e9831e83
JH
629gc.auto::
630 When there are approximately more than this many loose
631 objects in the repository, `git gc --auto` will pack them.
632 Some Porcelain commands use this command to perform a
80cd9cf9
MB
633 light-weight garbage collection from time to time. The
634 default value is 6700. Setting this to 0 disables it.
e9831e83 635
17815501
JH
636gc.autopacklimit::
637 When there are more than this many packs that are not
638 marked with `*.keep` file in the repository, `git gc
80cd9cf9 639 --auto` consolidates them into one larger pack. The
97063974 640 default value is 50. Setting this to 0 disables it.
17815501 641
c2120e5e 642gc.packrefs::
ba020ef5 643 'git-gc' does not run `git pack-refs` in a bare repository by
c2120e5e 644 default so that older dumb-transport clients can still fetch
ba020ef5 645 from the repository. Setting this to `true` lets 'git-gc'
7a7d4ef6 646 to run `git pack-refs`. Setting this to `false` tells
ba020ef5 647 'git-gc' never to run `git pack-refs`. The default setting is
c2120e5e
JS
648 `notbare`. Enable it only when you know you do not have to
649 support such clients. The default setting will change to `true`
650 at some stage, and setting this to `false` will continue to
ba020ef5 651 prevent `git pack-refs` from being run from 'git-gc'.
c2120e5e 652
25ee9731 653gc.pruneexpire::
5833d730 654 When 'git-gc' is run, it will call 'prune --expire 2.weeks.ago'.
25ee9731
JS
655 Override the grace period with this config variable.
656
4aec56d1 657gc.reflogexpire::
ba020ef5 658 'git-reflog expire' removes reflog entries older than
4aec56d1
JH
659 this time; defaults to 90 days.
660
661gc.reflogexpireunreachable::
ba020ef5 662 'git-reflog expire' removes reflog entries older than
4aec56d1
JH
663 this time and are not reachable from the current tip;
664 defaults to 30 days.
665
48c32424
JH
666gc.rerereresolved::
667 Records of conflicted merge you resolved earlier are
ba020ef5 668 kept for this many days when 'git-rerere gc' is run.
5162e697 669 The default is 60 days. See linkgit:git-rerere[1].
48c32424
JH
670
671gc.rerereunresolved::
672 Records of conflicted merge you have not resolved are
ba020ef5 673 kept for this many days when 'git-rerere gc' is run.
5162e697 674 The default is 15 days. See linkgit:git-rerere[1].
48c32424 675
121c813f
JH
676rerere.autoupdate::
677 When set to true, `git-rerere` updates the index with the
678 resulting contents after it cleanly resolves conflicts using
679 previously recorded resolution. Defaults to false.
680
b4372ef1
JS
681rerere.enabled::
682 Activate recording of resolved conflicts, so that identical
683 conflict hunks can be resolved automatically, should they
5162e697 684 be encountered again. linkgit:git-rerere[1] command is by
11c57e6a
JH
685 default enabled if you create `rr-cache` directory under
686 `$GIT_DIR`, but can be disabled by setting this option to false.
b4372ef1 687
1ab661dd 688gitcvs.enabled::
db218723 689 Whether the CVS server interface is enabled for this repository.
5162e697 690 See linkgit:git-cvsserver[1].
1ab661dd
PB
691
692gitcvs.logfile::
db218723 693 Path to a log file where the CVS server interface well... logs
5162e697 694 various stuff. See linkgit:git-cvsserver[1].
1ab661dd 695
8a06a632
MO
696gitcvs.usecrlfattr
697 If true, the server will look up the `crlf` attribute for
698 files to determine the '-k' modes to use. If `crlf` is set,
699 the '-k' mode will be left blank, so cvs clients will
700 treat it as text. If `crlf` is explicitly unset, the file
1168d402 701 will be set with '-kb' mode, which suppresses any newline munging
8a06a632 702 the client might otherwise do. If `crlf` is not specified,
ea449615 703 then 'gitcvs.allbinary' is used. See linkgit:gitattributes[5].
8a06a632 704
eabb0bfd 705gitcvs.allbinary::
90948a42
MO
706 This is used if 'gitcvs.usecrlfattr' does not resolve
707 the correct '-kb' mode to use. If true, all
708 unresolved files are sent to the client in
709 mode '-kb'. This causes the client to treat them
710 as binary files, which suppresses any newline munging it
711 otherwise might do. Alternatively, if it is set to "guess",
712 then the contents of the file are examined to decide if
713 it is binary, similar to 'core.autocrlf'.
abbf5947 714
04752868
FL
715gitcvs.dbname::
716 Database used by git-cvsserver to cache revision information
717 derived from the git repository. The exact meaning depends on the
718 used database driver, for SQLite (which is the default driver) this
719 is a filename. Supports variable substitution (see
5162e697 720 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
04752868
FL
721 Default: '%Ggitcvs.%m.sqlite'
722
723gitcvs.dbdriver::
724 Used Perl DBI driver. You can specify any available driver
725 for this here, but it might not work. git-cvsserver is tested
726 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
727 reported *not* to work with 'DBD::mysql'. Experimental feature.
728 May not contain double colons (`:`). Default: 'SQLite'.
5162e697 729 See linkgit:git-cvsserver[1].
eabb0bfd 730
04752868
FL
731gitcvs.dbuser, gitcvs.dbpass::
732 Database user and password. Only useful if setting 'gitcvs.dbdriver',
733 since SQLite has no concept of database users and/or passwords.
734 'gitcvs.dbuser' supports variable substitution (see
5162e697 735 linkgit:git-cvsserver[1] for details).
04752868 736
6aeeffd1
JE
737gitcvs.dbTableNamePrefix::
738 Database table name prefix. Prepended to the names of any
739 database tables used, allowing a single database to be used
740 for several repositories. Supports variable substitution (see
741 linkgit:git-cvsserver[1] for details). Any non-alphabetic
742 characters will be replaced with underscores.
743
8a06a632
MO
744All gitcvs variables except for 'gitcvs.usecrlfattr' and
745'gitcvs.allbinary' can also be specified as
746'gitcvs.<access_method>.<varname>' (where 'access_method'
02783075
BH
747is one of "ext" and "pserver") to make them apply only for the given
748access method.
04752868 749
d84ae0db
GH
750gui.commitmsgwidth::
751 Defines how wide the commit message window is in the
752 linkgit:git-gui[1]. "75" is the default.
753
754gui.diffcontext::
755 Specifies how many context lines should be used in calls to diff
756 made by the linkgit:git-gui[1]. The default is "5".
757
758gui.matchtrackingbranch::
759 Determines if new branches created with linkgit:git-gui[1] should
760 default to tracking remote branches with matching names or
761 not. Default: "false".
762
763gui.newbranchtemplate::
764 Is used as suggested name when creating new branches using the
765 linkgit:git-gui[1].
766
767gui.pruneduringfetch::
768 "true" if linkgit:git-gui[1] should prune tracking branches when
769 performing a fetch. The default value is "false".
770
771gui.trustmtime::
772 Determines if linkgit:git-gui[1] should trust the file modification
773 timestamp or not. By default the timestamps are not trusted.
774
775gui.spellingdictionary::
776 Specifies the dictionary used for spell checking commit messages in
777 the linkgit:git-gui[1]. When set to "none" spell checking is turned
778 off.
779
983a9eeb
CC
780help.browser::
781 Specify the browser that will be used to display help in the
782 'web' format. See linkgit:git-help[1].
783
784help.format::
785 Override the default help format used by linkgit:git-help[1].
786 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
787 the default. 'web' and 'html' are the same.
788
9c5665aa
SV
789http.proxy::
790 Override the HTTP proxy, normally configured using the 'http_proxy'
5162e697 791 environment variable (see linkgit:curl[1]). This can be overridden
14c98218 792 on a per-remote basis; see remote.<name>.proxy
9c5665aa 793
1ab661dd
PB
794http.sslVerify::
795 Whether to verify the SSL certificate when fetching or pushing
37425065 796 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1ab661dd
PB
797 variable.
798
799http.sslCert::
800 File containing the SSL certificate when fetching or pushing
37425065 801 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1ab661dd
PB
802 variable.
803
804http.sslKey::
805 File containing the SSL private key when fetching or pushing
abda1ef5 806 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1ab661dd
PB
807 variable.
808
809http.sslCAInfo::
810 File containing the certificates to verify the peer with when
abda1ef5 811 fetching or pushing over HTTPS. Can be overridden by the
1ab661dd
PB
812 'GIT_SSL_CAINFO' environment variable.
813
814http.sslCAPath::
815 Path containing files with the CA certificates to verify the peer
37425065 816 with when fetching or pushing over HTTPS. Can be overridden
1ab661dd
PB
817 by the 'GIT_SSL_CAPATH' environment variable.
818
819http.maxRequests::
abda1ef5 820 How many HTTP requests to launch in parallel. Can be overridden
1ab661dd
PB
821 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
822
823http.lowSpeedLimit, http.lowSpeedTime::
824 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
825 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
abda1ef5 826 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1ab661dd
PB
827 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
828
3ea099d4
SK
829http.noEPSV::
830 A boolean which disables using of EPSV ftp command by curl.
befc9c42 831 This can helpful with some "poor" ftp servers which don't
3ea099d4
SK
832 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
833 environment variable. Default is false (curl will use EPSV).
834
1ab661dd
PB
835i18n.commitEncoding::
836 Character encoding the commit messages are stored in; git itself
837 does not care per se, but this information is necessary e.g. when
838 importing commits from emails or in the gitk graphical history
839 browser (and possibly at other places in the future or in other
5162e697 840 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1ab661dd 841
d2c11a38
JH
842i18n.logOutputEncoding::
843 Character encoding the commit messages are converted to when
ba020ef5 844 running 'git-log' and friends.
d2c11a38 845
983a9eeb
CC
846instaweb.browser::
847 Specify the program that will be used to browse your working
848 repository in gitweb. See linkgit:git-instaweb[1].
849
850instaweb.httpd::
851 The HTTP daemon command-line to start gitweb on your working
852 repository. See linkgit:git-instaweb[1].
853
854instaweb.local::
855 If true the web server started by linkgit:git-instaweb[1] will
856 be bound to the local IP (127.0.0.1).
857
858instaweb.modulepath::
859 The module path for an apache httpd used by linkgit:git-instaweb[1].
860
861instaweb.port::
862 The port number to bind the gitweb httpd to. See
863 linkgit:git-instaweb[1].
864
dd0ffd5b
HO
865log.date::
866 Set default date-time mode for the log command. Setting log.date
0979c106 867 value is similar to using 'git-log'\'s --date option. The value is one of the
dd0ffd5b
HO
868 following alternatives: {relative,local,default,iso,rfc,short}.
869 See linkgit:git-log[1].
870
0f03ca94
PB
871log.showroot::
872 If true, the initial commit will be shown as a big creation event.
873 This is equivalent to a diff against an empty tree.
5162e697 874 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
0f03ca94
PB
875 normally hide the root commit will now show it. True by default.
876
b5578f33 877man.viewer::
b8322ea8 878 Specify the programs that may be used to display help in the
b5578f33
CC
879 'man' format. See linkgit:git-help[1].
880
f5a84c37 881include::merge-config.txt[]
88e7fdf2 882
0bb64009
CC
883man.<tool>.cmd::
884 Specify the command to invoke the specified man viewer. The
885 specified command is evaluated in shell with the man page
886 passed as argument. (See linkgit:git-help[1].)
887
7e8114c0
CC
888man.<tool>.path::
889 Override the path for the given tool that may be used to
890 display help in the 'man' format. See linkgit:git-help[1].
891
77680caa
JS
892mergetool.<tool>.path::
893 Override the path for the given tool. This is useful in case
894 your tool is not in the PATH.
895
964473a0
CB
896mergetool.<tool>.cmd::
897 Specify the command to invoke the specified merge tool. The
898 specified command is evaluated in shell with the following
899 variables available: 'BASE' is the name of a temporary file
900 containing the common base of the files to be merged, if available;
901 'LOCAL' is the name of a temporary file containing the contents of
902 the file on the current branch; 'REMOTE' is the name of a temporary
903 file containing the contents of the file from the branch being
904 merged; 'MERGED' contains the name of the file to which the merge
905 tool should write the results of a successful merge.
906
907mergetool.<tool>.trustExitCode::
908 For a custom merge command, specify whether the exit code of
909 the merge command can be used to determine whether the merge was
910 successful. If this is not set to true then the merge target file
911 timestamp is checked and the merge assumed to have been successful
912 if the file has been updated, otherwise the user is prompted to
913 indicate the success of the merge.
914
44c36d1c
CB
915mergetool.keepBackup::
916 After performing a merge, the original file with conflict markers
917 can be saved as a file with a `.orig` extension. If this variable
918 is set to `false` then this file is not preserved. Defaults to
919 `true` (i.e. keep the backup files).
920
4812a93a 921pack.window::
5162e697 922 The size of the window used by linkgit:git-pack-objects[1] when no
4812a93a
JK
923 window size is given on the command line. Defaults to 10.
924
842aaf93 925pack.depth::
5162e697 926 The maximum delta depth used by linkgit:git-pack-objects[1] when no
618e613a 927 maximum depth is given on the command line. Defaults to 50.
842aaf93 928
e93b15cd 929pack.windowMemory::
5162e697 930 The window memory size limit used by linkgit:git-pack-objects[1]
e93b15cd
BD
931 when no limit is given on the command line. The value can be
932 suffixed with "k", "m", or "g". Defaults to 0, meaning no
933 limit.
934
960ccca6
DH
935pack.compression::
936 An integer -1..9, indicating the compression level for objects
937 in a pack file. -1 is the zlib default. 0 means no
938 compression, and 1..9 are various speed/size tradeoffs, 9 being
939 slowest. If not set, defaults to core.compression. If that is
dec92309
BD
940 not set, defaults to -1, the zlib default, which is "a default
941 compromise between speed and compression (currently equivalent
942 to level 6)."
960ccca6 943
074b2eea 944pack.deltaCacheSize::
02783075 945 The maximum memory in bytes used for caching deltas in
5162e697 946 linkgit:git-pack-objects[1].
074b2eea
MK
947 A value of 0 means no limit. Defaults to 0.
948
e3dfddb3 949pack.deltaCacheLimit::
693b86ff 950 The maximum size of a delta, that is cached in
5162e697 951 linkgit:git-pack-objects[1]. Defaults to 1000.
e3dfddb3 952
693b86ff
NP
953pack.threads::
954 Specifies the number of threads to spawn when searching for best
5162e697 955 delta matches. This requires that linkgit:git-pack-objects[1]
693b86ff
NP
956 be compiled with pthreads otherwise this option is ignored with a
957 warning. This is meant to reduce packing time on multiprocessor
958 machines. The required amount of memory for the delta search window
959 is however multiplied by the number of threads.
833e3df1
AE
960 Specifying 0 will cause git to auto-detect the number of CPU's
961 and set the number of threads accordingly.
693b86ff 962
4d00bda2
NP
963pack.indexVersion::
964 Specify the default pack index version. Valid values are 1 for
965 legacy pack index used by Git versions prior to 1.5.2, and 2 for
966 the new pack index with capabilities for packs larger than 4 GB
967 as well as proper protection against the repacking of corrupted
c0a5e2d4
NP
968 packs. Version 2 is the default. Note that version 2 is enforced
969 and this config option ignored whenever the corresponding pack is
970 larger than 2 GB.
971+
972If you have an old git that does not understand the version 2 `{asterisk}.idx` file,
973cloning or fetching over a non native protocol (e.g. "http" and "rsync")
974that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the
975other side may give you a repository that cannot be accessed with your
976older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,
977you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
978the `{asterisk}.idx` file.
4d00bda2 979
dbdbfec4 980pack.packSizeLimit::
2b84b5a8
JS
981 The default maximum size of a pack. This setting only affects
982 packing to a file, i.e. the git:// protocol is unaffected. It
983 can be overridden by the `\--max-pack-size` option of
984 linkgit:git-repack[1].
985
4370c2d6 986pager.<cmd>::
32818085
JN
987 Allows turning on or off pagination of the output of a
988 particular git subcommand when writing to a tty. If
989 `\--paginate` or `\--no-pager` is specified on the command line,
990 it takes precedence over this option. To disable pagination for
991 all commands, set `core.pager` or 'GIT_PAGER' to "`cat`".
4370c2d6 992
1ab661dd
PB
993pull.octopus::
994 The default merge strategy to use when pulling multiple branches
995 at once.
996
997pull.twohead::
998 The default merge strategy to use when pulling a single branch.
999
0cc6d346 1000remote.<name>.url::
5162e697
DM
1001 The URL of a remote repository. See linkgit:git-fetch[1] or
1002 linkgit:git-push[1].
0cc6d346 1003
14c98218
SV
1004remote.<name>.proxy::
1005 For remotes that require curl (http, https and ftp), the URL to
1006 the proxy to use for that remote. Set to the empty string to
1007 disable proxying for that remote.
1008
0cc6d346 1009remote.<name>.fetch::
5162e697
DM
1010 The default set of "refspec" for linkgit:git-fetch[1]. See
1011 linkgit:git-fetch[1].
0cc6d346
SB
1012
1013remote.<name>.push::
5162e697
DM
1014 The default set of "refspec" for linkgit:git-push[1]. See
1015 linkgit:git-push[1].
0cc6d346 1016
84bb2dfd
PB
1017remote.<name>.mirror::
1018 If true, pushing to this remote will automatically behave
1019 as if the `\--mirror` option was given on the command line.
1020
1918278e
TT
1021remote.<name>.skipDefaultUpdate::
1022 If true, this remote will be skipped by default when updating
5162e697 1023 using the update subcommand of linkgit:git-remote[1].
1918278e 1024
060aafc1 1025remote.<name>.receivepack::
5dee29ac 1026 The default program to execute on the remote side when pushing. See
79f43f3d 1027 option \--receive-pack of linkgit:git-push[1].
060aafc1 1028
5dee29ac
UKK
1029remote.<name>.uploadpack::
1030 The default program to execute on the remote side when fetching. See
79f43f3d 1031 option \--upload-pack of linkgit:git-fetch-pack[1].
5dee29ac 1032
047f636d 1033remote.<name>.tagopt::
79f43f3d
UKK
1034 Setting this value to \--no-tags disables automatic tag following when
1035 fetching from remote <name>
047f636d 1036
1918278e
TT
1037remotes.<group>::
1038 The list of remotes which are fetched by "git remote update
5162e697 1039 <group>". See linkgit:git-remote[1].
1918278e 1040
b6945f57 1041repack.usedeltabaseoffset::
22c79eab
NP
1042 By default, linkgit:git-repack[1] creates packs that use
1043 delta-base offset. If you need to share your repository with
1044 git older than version 1.4.4, either directly or via a dumb
1045 protocol such as http, then you need to set this option to
1046 "false" and repack. Access from old git versions over the
1047 native protocol are unaffected by this option.
b6945f57 1048
1ab661dd 1049showbranch.default::
5162e697
DM
1050 The default set of branches for linkgit:git-show-branch[1].
1051 See linkgit:git-show-branch[1].
1ab661dd 1052
46f721c8 1053status.relativePaths::
5162e697 1054 By default, linkgit:git-status[1] shows paths relative to the
46f721c8
JK
1055 current directory. Setting this variable to `false` shows paths
1056 relative to the repository root (this was the default for git
1057 prior to v1.5.4).
1058
d6293d1f
MSO
1059status.showUntrackedFiles::
1060 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1061 files which are not currently tracked by Git. Directories which
1062 contain only untracked files, are shown with the directory name
1063 only. Showing untracked files means that Git needs to lstat() all
1064 all the files in the whole repository, which might be slow on some
1065 systems. So, this variable controls how the commands displays
1066 the untracked files. Possible values are:
1067+
1068--
1069 - 'no' - Show no untracked files
1070 - 'normal' - Shows untracked files and directories
1071 - 'all' - Shows also individual files in untracked directories.
1072--
1073+
1074If this variable is not specified, it defaults to 'normal'.
1075This variable can be overridden with the -u|--untracked-files option
1076of linkgit:git-status[1] and linkgit:git-commit[1].
1077
ce1a79b6 1078tar.umask::
687157c7
RS
1079 This variable can be used to restrict the permission bits of
1080 tar archive entries. The default is 0002, which turns off the
1081 world write bit. The special value "user" indicates that the
1082 archiving user's umask will be used instead. See umask(2) and
5162e697 1083 linkgit:git-archive[1].
ce1a79b6 1084
55029ae4
DB
1085url.<base>.insteadOf::
1086 Any URL that starts with this value will be rewritten to
1087 start, instead, with <base>. In cases where some site serves a
1088 large number of repositories, and serves them with multiple
1089 access methods, and some users need to use different access
1090 methods, this feature allows people to specify any of the
1091 equivalent URLs and have git automatically rewrite the URL to
1092 the best alternative for the particular user, even for a
844112ca
JH
1093 never-before-seen repository on the site. When more than one
1094 insteadOf strings match a given URL, the longest match is used.
55029ae4 1095
1ab661dd
PB
1096user.email::
1097 Your email address to be recorded in any newly created commits.
28a94f88 1098 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
5162e697 1099 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
1ab661dd
PB
1100
1101user.name::
1102 Your full name to be recorded in any newly created commits.
abda1ef5 1103 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
5162e697 1104 environment variables. See linkgit:git-commit-tree[1].
1ab661dd 1105
d67778ec 1106user.signingkey::
5162e697 1107 If linkgit:git-tag[1] is not selecting the key you want it to
d67778ec
AP
1108 automatically when creating a signed tag, you can override the
1109 default selection with this variable. This option is passed
1110 unchanged to gpg's --local-user parameter, so you may specify a key
1111 using any method that gpg supports.
1112
1ab661dd
PB
1113imap::
1114 The configuration variables in the 'imap' section are described
5162e697 1115 in linkgit:git-imap-send[1].
199a9218 1116
20dc0016
MK
1117receive.fsckObjects::
1118 If it is set to true, git-receive-pack will check all received
1119 objects. It will abort in the case of a malformed object or a
1120 broken link. The result of an abort are only dangling objects.
1121 Defaults to false.
1122
fc04c412
SP
1123receive.unpackLimit::
1124 If the number of objects received in a push is below this
1125 limit then the objects will be unpacked into loose object
1126 files. However if the number of received objects equals or
1127 exceeds this limit then the received pack will be stored as
1128 a pack, after adding any missing delta bases. Storing the
1129 pack from a push can make the push operation complete faster,
80cd9cf9
MB
1130 especially on slow filesystems. If not set, the value of
1131 `transfer.unpackLimit` is used instead.
fc04c412
SP
1132
1133receive.denyNonFastForwards::
199a9218
JS
1134 If set to true, git-receive-pack will deny a ref update which is
1135 not a fast forward. Use this to prevent such an update via a push,
1136 even if that push is forced. This configuration variable is
1137 set when initializing a shared repository.
1138
e28714c5
JH
1139transfer.unpackLimit::
1140 When `fetch.unpackLimit` or `receive.unpackLimit` are
1141 not set, the value of this variable is used instead.
80cd9cf9 1142 The default value is 100.
983a9eeb
CC
1143
1144web.browser::
1145 Specify a web browser that may be used by some commands.
1146 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
1147 may use it.