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