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