[git/git.git] / Documentation / config.txt
2 ------------------
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.
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.
18 Syntax
19 ~~~~~~
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.
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.
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:
36 --------
37 [section "subsection"]
39 --------
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.
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.
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.
59 Leading and trailing whitespace in a variable value is discarded.
60 Internal whitespace within a variable value is retained verbatim.
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, true/false or on/off. 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".
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 `\`.
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.
80 Variable value ending in a `\` is continued on the next line in the
81 customary UNIX fashion.
83 Some variables may require special value format.
85 Example
86 ~~~~~~~
88 # Core variables
89 [core]
90 ; Don't trust file modes
91 filemode = false
93 # Our diff algorithm
94 [diff]
95 external = /usr/local/bin/diff-wrapper
96 renames = true
98 [branch "devel"]
99 remote = origin
100 merge = refs/heads/devel
102 # Proxy settings
103 [core]
104 gitProxy="ssh" for "kernel.org"
105 gitProxy=default-proxy ; for the rest
107 Variables
108 ~~~~~~~~~
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.
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.
120 core.ignoreCygwinFSTricks::
121 This option is only used by Cygwin implementation of Git. If false,
122 the Cygwin stat() and lstat() functions are used. This may be useful
123 if your repository consists of a few separate directories joined in
124 one hierarchy using Cygwin mount. If true, Git uses native Win32 API
125 whenever it is possible and falls back to Cygwin functions only to
126 handle symbol links. The native mode is more than twice faster than
127 normal Cygwin l/stat() functions. True by default, unless core.filemode
128 is true, in which case ignoreCygwinFSTricks is ignored as Cygwin's
129 POSIX emulation is required to support core.filemode.
131 core.trustctime::
132 If false, the ctime differences between the index and the
133 working copy are ignored; useful when the inode change time
134 is regularly modified by something outside Git (file system
135 crawlers and some backup systems).
136 See linkgit:git-update-index[1]. True by default.
138 core.quotepath::
139 The commands that output paths (e.g. 'ls-files',
140 'diff'), when not given the `-z` option, will quote
141 "unusual" characters in the pathname by enclosing the
142 pathname in a double-quote pair and with backslashes the
143 same way strings in C source code are quoted. If this
144 variable is set to false, the bytes higher than 0x80 are
145 not quoted but output as verbatim. Note that double
146 quote, backslash and control characters are always
147 quoted without `-z` regardless of the setting of this
148 variable.
150 core.autocrlf::
151 If true, makes git convert `CRLF` at the end of lines in text files to
152 `LF` when reading from the filesystem, and convert in reverse when
153 writing to the filesystem. The variable can be set to
154 'input', in which case the conversion happens only while
155 reading from the filesystem but files are written out with
156 `LF` at the end of lines. Currently, which paths to consider
157 "text" (i.e. be subjected to the autocrlf mechanism) is
158 decided purely based on the contents.
160 core.safecrlf::
161 If true, makes git check if converting `CRLF` as controlled by
162 `core.autocrlf` is reversible. Git will verify if a command
163 modifies a file in the work tree either directly or indirectly.
164 For example, committing a file followed by checking out the
165 same file should yield the original file in the work tree. If
166 this is not the case for the current setting of
167 `core.autocrlf`, git will reject the file. The variable can
168 be set to "warn", in which case git will only warn about an
169 irreversible conversion but continue the operation.
170 +
171 CRLF conversion bears a slight chance of corrupting data.
172 autocrlf=true will convert CRLF to LF during commit and LF to
173 CRLF during checkout. A file that contains a mixture of LF and
174 CRLF before the commit cannot be recreated by git. For text
175 files this is the right thing to do: it corrects line endings
176 such that we have only LF line endings in the repository.
177 But for binary files that are accidentally classified as text the
178 conversion can corrupt data.
179 +
180 If you recognize such corruption early you can easily fix it by
181 setting the conversion type explicitly in .gitattributes. Right
182 after committing you still have the original file in your work
183 tree and this file is not yet corrupted. You can explicitly tell
184 git that this file is binary and git will handle the file
185 appropriately.
186 +
187 Unfortunately, the desired effect of cleaning up text files with
188 mixed line endings and the undesired effect of corrupting binary
189 files cannot be distinguished. In both cases CRLFs are removed
190 in an irreversible way. For text files this is the right thing
191 to do because CRLFs are line endings, while for binary files
192 converting CRLFs corrupts data.
193 +
194 Note, this safety check does not mean that a checkout will generate a
195 file identical to the original file for a different setting of
196 `core.autocrlf`, but only for the current one. For example, a text
197 file with `LF` would be accepted with `core.autocrlf=input` and could
198 later be checked out with `core.autocrlf=true`, in which case the
199 resulting file would contain `CRLF`, although the original file
200 contained `LF`. However, in both work trees the line endings would be
201 consistent, that is either all `LF` or all `CRLF`, but never mixed. A
202 file with mixed line endings would be reported by the `core.safecrlf`
203 mechanism.
205 core.symlinks::
206 If false, symbolic links are checked out as small plain files that
207 contain the link text. linkgit:git-update-index[1] and
208 linkgit:git-add[1] will not change the recorded type to regular
209 file. Useful on filesystems like FAT that do not support
210 symbolic links. True by default.
212 core.gitProxy::
213 A "proxy command" to execute (as 'command host port') instead
214 of establishing direct connection to the remote server when
215 using the git protocol for fetching. If the variable value is
216 in the "COMMAND for DOMAIN" format, the command is applied only
217 on hostnames ending with the specified domain string. This variable
218 may be set multiple times and is matched in the given order;
219 the first match wins.
220 +
221 Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
222 (which always applies universally, without the special "for"
223 handling).
224 +
225 The special string `none` can be used as the proxy command to
226 specify that no proxy be used for a given domain pattern.
227 This is useful for excluding servers inside a firewall from
228 proxy use, while defaulting to a common proxy for external domains.
230 core.ignoreStat::
231 If true, commands which modify both the working tree and the index
232 will mark the updated paths with the "assume unchanged" bit in the
233 index. These marked files are then assumed to stay unchanged in the
234 working copy, until you mark them otherwise manually - Git will not
235 detect the file changes by lstat() calls. This is useful on systems
236 where those are very slow, such as Microsoft Windows.
237 See linkgit:git-update-index[1].
238 False by default.
240 core.preferSymlinkRefs::
241 Instead of the default "symref" format for HEAD
242 and other symbolic reference files, use symbolic links.
243 This is sometimes needed to work with old scripts that
244 expect HEAD to be a symbolic link.
246 core.bare::
247 If true this repository is assumed to be 'bare' and has no
248 working directory associated with it. If this is the case a
249 number of commands that require a working directory will be
250 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
251 +
252 This setting is automatically guessed by linkgit:git-clone[1] or
253 linkgit:git-init[1] when the repository was created. By default a
254 repository that ends in "/.git" is assumed to be not bare (bare =
255 false), while all other repositories are assumed to be bare (bare
256 = true).
258 core.worktree::
259 Set the path to the working tree. The value will not be
260 used in combination with repositories found automatically in
261 a .git directory (i.e. $GIT_DIR is not set).
262 This can be overridden by the GIT_WORK_TREE environment
263 variable and the '--work-tree' command line option. It can be
264 a absolute path or relative path to the directory specified by
265 --git-dir or GIT_DIR.
266 Note: If --git-dir or GIT_DIR are specified but none of
267 --work-tree, GIT_WORK_TREE and core.worktree is specified,
268 the current working directory is regarded as the top directory
269 of your working tree.
271 core.logAllRefUpdates::
272 Enable the reflog. Updates to a ref <ref> is logged to the file
273 "$GIT_DIR/logs/<ref>", by appending the new and old
274 SHA1, the date/time and the reason of the update, but
275 only when the file exists. If this configuration
276 variable is set to true, missing "$GIT_DIR/logs/<ref>"
277 file is automatically created for branch heads.
278 +
279 This information can be used to determine what commit
280 was the tip of a branch "2 days ago".
281 +
282 This value is true by default in a repository that has
283 a working directory associated with it, and false by
284 default in a bare repository.
286 core.repositoryFormatVersion::
287 Internal variable identifying the repository format and layout
288 version.
290 core.sharedRepository::
291 When 'group' (or 'true'), the repository is made shareable between
292 several users in a group (making sure all the files and objects are
293 group-writable). When 'all' (or 'world' or 'everybody'), the
294 repository will be readable by all users, additionally to being
295 group-shareable. When 'umask' (or 'false'), git will use permissions
296 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
297 files in the repository will have this mode value. '0xxx' will override
298 user's umask value (whereas the other options will only override
299 requested parts of the user's umask value). Examples: '0660' will make
300 the repo read/write-able for the owner and group, but inaccessible to
301 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
302 repository that is group-readable but not group-writable.
303 See linkgit:git-init[1]. False by default.
305 core.warnAmbiguousRefs::
306 If true, git will warn you if the ref name you passed it is ambiguous
307 and might match multiple refs in the .git/refs/ tree. True by default.
309 core.compression::
310 An integer -1..9, indicating a default compression level.
311 -1 is the zlib default. 0 means no compression,
312 and 1..9 are various speed/size tradeoffs, 9 being slowest.
313 If set, this provides a default to other compression variables,
314 such as 'core.loosecompression' and 'pack.compression'.
316 core.loosecompression::
317 An integer -1..9, indicating the compression level for objects that
318 are not in a pack file. -1 is the zlib default. 0 means no
319 compression, and 1..9 are various speed/size tradeoffs, 9 being
320 slowest. If not set, defaults to core.compression. If that is
321 not set, defaults to 1 (best speed).
323 core.packedGitWindowSize::
324 Number of bytes of a pack file to map into memory in a
325 single mapping operation. Larger window sizes may allow
326 your system to process a smaller number of large pack files
327 more quickly. Smaller window sizes will negatively affect
328 performance due to increased calls to the operating system's
329 memory manager, but may improve performance when accessing
330 a large number of large pack files.
331 +
332 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
333 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
334 be reasonable for all users/operating systems. You probably do
335 not need to adjust this value.
336 +
337 Common unit suffixes of 'k', 'm', or 'g' are supported.
339 core.packedGitLimit::
340 Maximum number of bytes to map simultaneously into memory
341 from pack files. If Git needs to access more than this many
342 bytes at once to complete an operation it will unmap existing
343 regions to reclaim virtual address space within the process.
344 +
345 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
346 This should be reasonable for all users/operating systems, except on
347 the largest projects. You probably do not need to adjust this value.
348 +
349 Common unit suffixes of 'k', 'm', or 'g' are supported.
351 core.deltaBaseCacheLimit::
352 Maximum number of bytes to reserve for caching base objects
353 that multiple deltafied objects reference. By storing the
354 entire decompressed base objects in a cache Git is able
355 to avoid unpacking and decompressing frequently used base
356 objects multiple times.
357 +
358 Default is 16 MiB on all platforms. This should be reasonable
359 for all users/operating systems, except on the largest projects.
360 You probably do not need to adjust this value.
361 +
362 Common unit suffixes of 'k', 'm', or 'g' are supported.
364 core.excludesfile::
365 In addition to '.gitignore' (per-directory) and
366 '.git/info/exclude', git looks into this file for patterns
367 of files which are not meant to be tracked. See
368 linkgit:gitignore[5].
370 core.editor::
371 Commands such as `commit` and `tag` that lets you edit
372 messages by launching an editor uses the value of this
373 variable when it is set, and the environment variable
374 `GIT_EDITOR` is not set. The order of preference is
375 `GIT_EDITOR` environment, `core.editor`, `VISUAL` and
376 `EDITOR` environment variables and then finally `vi`.
378 core.pager::
379 The command that git will use to paginate output. Can
380 be overridden with the `GIT_PAGER` environment
381 variable. Note that git sets the `LESS` environment
382 variable to `FRSX` if it is unset when it runs the
383 pager. One can change these settings by setting the
384 `LESS` variable to some other value. Alternately,
385 these settings can be overridden on a project or
386 global basis by setting the `core.pager` option.
387 Setting `core.pager` has no affect on the `LESS`
388 environment variable behaviour above, so if you want
389 to override git's default settings this way, you need
390 to be explicit. For example, to disable the S option
391 in a backward compatible manner, set `core.pager`
392 to `less -+$LESS -FRX`. This will be passed to the
393 shell by git, which will translate the final command to
394 `LESS=FRSX less -+FRSX -FRX`.
396 core.whitespace::
397 A comma separated list of common whitespace problems to
398 notice. 'git-diff' will use `color.diff.whitespace` to
399 highlight them, and 'git-apply --whitespace=error' will
400 consider them as errors. You can prefix `-` to disable
401 any of them (e.g. `-trailing-space`):
402 +
403 * `trailing-space` treats trailing whitespaces at the end of the line
404 as an error (enabled by default).
405 * `space-before-tab` treats a space character that appears immediately
406 before a tab character in the initial indent part of the line as an
407 error (enabled by default).
408 * `indent-with-non-tab` treats a line that is indented with 8 or more
409 space characters as an error (not enabled by default).
410 * `cr-at-eol` treats a carriage-return at the end of line as
411 part of the line terminator, i.e. with it, `trailing-space`
412 does not trigger if the character before such a carriage-return
413 is not a whitespace (not enabled by default).
415 core.fsyncobjectfiles::
416 This boolean will enable 'fsync()' when writing object files.
417 +
418 This is a total waste of time and effort on a filesystem that orders
419 data writes properly, but can be useful for filesystems that do not use
420 journalling (traditional UNIX filesystems) or that only journal metadata
421 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
423 core.preloadindex::
424 Enable parallel index preload for operations like 'git diff'
425 +
426 This can speed up operations like 'git diff' and 'git status' especially
427 on filesystems like NFS that have weak caching semantics and thus
428 relatively high IO latencies. With this set to 'true', git will do the
429 index comparison to the filesystem data in parallel, allowing
430 overlapping IO's.
432 alias.*::
433 Command aliases for the linkgit:git[1] command wrapper - e.g.
434 after defining "alias.last = cat-file commit HEAD", the invocation
435 "git last" is equivalent to "git cat-file commit HEAD". To avoid
436 confusion and troubles with script usage, aliases that
437 hide existing git commands are ignored. Arguments are split by
438 spaces, the usual shell quoting and escaping is supported.
439 quote pair and a backslash can be used to quote them.
440 +
441 If the alias expansion is prefixed with an exclamation point,
442 it will be treated as a shell command. For example, defining
443 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
444 "git new" is equivalent to running the shell command
445 "gitk --all --not ORIG_HEAD".
447 apply.whitespace::
448 Tells 'git-apply' how to handle whitespaces, in the same way
449 as the '--whitespace' option. See linkgit:git-apply[1].
451 branch.autosetupmerge::
452 Tells 'git-branch' and 'git-checkout' to setup new branches
453 so that linkgit:git-pull[1] will appropriately merge from the
454 starting point branch. Note that even if this option is not set,
455 this behavior can be chosen per-branch using the `--track`
456 and `--no-track` options. The valid settings are: `false` -- no
457 automatic setup is done; `true` -- automatic setup is done when the
458 starting point is a remote branch; `always` -- automatic setup is
459 done when the starting point is either a local branch or remote
460 branch. This option defaults to true.
462 branch.autosetuprebase::
463 When a new branch is created with 'git-branch' or 'git-checkout'
464 that tracks another branch, this variable tells git to set
465 up pull to rebase instead of merge (see "branch.<name>.rebase").
466 When `never`, rebase is never automatically set to true.
467 When `local`, rebase is set to true for tracked branches of
468 other local branches.
469 When `remote`, rebase is set to true for tracked branches of
470 remote branches.
471 When `always`, rebase will be set to true for all tracking
472 branches.
473 See "branch.autosetupmerge" for details on how to set up a
474 branch to track another branch.
475 This option defaults to never.
477 branch.<name>.remote::
478 When in branch <name>, it tells 'git-fetch' and 'git-push' which
479 remote to fetch from/push to. It defaults to `origin` if no remote is
480 configured. `origin` is also used if you are not on any branch.
482 branch.<name>.merge::
483 Defines, together with branch.<name>.remote, the upstream branch
484 for the given branch. It tells 'git-fetch'/'git-pull' which
485 branch to merge and can also affect 'git-push' (see push.default).
486 When in branch <name>, it tells 'git-fetch' the default
487 refspec to be marked for merging in FETCH_HEAD. The value is
488 handled like the remote part of a refspec, and must match a
489 ref which is fetched from the remote given by
490 "branch.<name>.remote".
491 The merge information is used by 'git-pull' (which at first calls
492 'git-fetch') to lookup the default branch for merging. Without
493 this option, 'git-pull' defaults to merge the first refspec fetched.
494 Specify multiple values to get an octopus merge.
495 If you wish to setup 'git-pull' so that it merges into <name> from
496 another branch in the local repository, you can point
497 branch.<name>.merge to the desired branch, and use the special setting
498 `.` (a period) for branch.<name>.remote.
500 branch.<name>.mergeoptions::
501 Sets default options for merging into branch <name>. The syntax and
502 supported options are equal to that of linkgit:git-merge[1], but
503 option values containing whitespace characters are currently not
504 supported.
506 branch.<name>.rebase::
507 When true, rebase the branch <name> on top of the fetched branch,
508 instead of merging the default branch from the default remote when
509 "git pull" is run.
510 *NOTE*: this is a possibly dangerous operation; do *not* use
511 it unless you understand the implications (see linkgit:git-rebase[1]
512 for details).
514 browser.<tool>.cmd::
515 Specify the command to invoke the specified browser. The
516 specified command is evaluated in shell with the URLs passed
517 as arguments. (See linkgit:git-web--browse[1].)
519 browser.<tool>.path::
520 Override the path for the given tool that may be used to
521 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
522 working repository in gitweb (see linkgit:git-instaweb[1]).
524 clean.requireForce::
525 A boolean to make git-clean do nothing unless given -f
526 or -n. Defaults to true.
528 color.branch::
529 A boolean to enable/disable color in the output of
530 linkgit:git-branch[1]. May be set to `always`,
531 `false` (or `never`) or `auto` (or `true`), in which case colors are used
532 only when the output is to a terminal. Defaults to false.
534 color.branch.<slot>::
535 Use customized color for branch coloration. `<slot>` is one of
536 `current` (the current branch), `local` (a local branch),
537 `remote` (a tracking branch in refs/remotes/), `plain` (other
538 refs).
539 +
540 The value for these configuration variables is a list of colors (at most
541 two) and attributes (at most one), separated by spaces. The colors
542 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
543 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
544 `blink` and `reverse`. The first color given is the foreground; the
545 second is the background. The position of the attribute, if any,
546 doesn't matter.
548 color.diff::
549 When set to `always`, always use colors in patch.
550 When false (or `never`), never. When set to `true` or `auto`, use
551 colors only when the output is to the terminal. Defaults to false.
553 color.diff.<slot>::
554 Use customized color for diff colorization. `<slot>` specifies
555 which part of the patch to use the specified color, and is one
556 of `plain` (context text), `meta` (metainformation), `frag`
557 (hunk header), `old` (removed lines), `new` (added lines),
558 `commit` (commit headers), or `whitespace` (highlighting
559 whitespace errors). The values of these variables may be specified as
560 in color.branch.<slot>.
562 color.grep::
563 When set to `always`, always highlight matches. When `false` (or
564 `never`), never. When set to `true` or `auto`, use color only
565 when the output is written to the terminal. Defaults to `false`.
567 color.grep.external::
568 The string value of this variable is passed to an external 'grep'
569 command as a command line option if match highlighting is turned
570 on. If set to an empty string, no option is passed at all,
571 turning off coloring for external 'grep' calls; this is the default.
572 For GNU grep, set it to `--color=always` to highlight matches even
573 when a pager is used.
575 color.grep.match::
576 Use customized color for matches. The value of this variable
577 may be specified as in color.branch.<slot>. It is passed using
578 the environment variables 'GREP_COLOR' and 'GREP_COLORS' when
579 calling an external 'grep'.
581 color.interactive::
582 When set to `always`, always use colors for interactive prompts
583 and displays (such as those used by "git-add --interactive").
584 When false (or `never`), never. When set to `true` or `auto`, use
585 colors only when the output is to the terminal. Defaults to false.
587 color.interactive.<slot>::
588 Use customized color for 'git-add --interactive'
589 output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
590 four distinct types of normal output from interactive
591 programs. The values of these variables may be specified as
592 in color.branch.<slot>.
594 color.pager::
595 A boolean to enable/disable colored output when the pager is in
596 use (default is true).
598 color.status::
599 A boolean to enable/disable color in the output of
600 linkgit:git-status[1]. May be set to `always`,
601 `false` (or `never`) or `auto` (or `true`), in which case colors are used
602 only when the output is to a terminal. Defaults to false.
604 color.status.<slot>::
605 Use customized color for status colorization. `<slot>` is
606 one of `header` (the header text of the status message),
607 `added` or `updated` (files which are added but not committed),
608 `changed` (files which are changed but not added in the index),
609 `untracked` (files which are not tracked by git), or
610 `nobranch` (the color the 'no branch' warning is shown in, defaulting
611 to red). The values of these variables may be specified as in
612 color.branch.<slot>.
614 color.ui::
615 When set to `always`, always use colors in all git commands which
616 are capable of colored output. When false (or `never`), never. When
617 set to `true` or `auto`, use colors only when the output is to the
618 terminal. When more specific variables of color.* are set, they always
619 take precedence over this setting. Defaults to false.
621 commit.template::
622 Specify a file to use as the template for new commit messages.
624 diff.autorefreshindex::
625 When using 'git-diff' to compare with work tree
626 files, do not consider stat-only change as changed.
627 Instead, silently run `git update-index --refresh` to
628 update the cached stat information for paths whose
629 contents in the work tree match the contents in the
630 index. This option defaults to true. Note that this
631 affects only 'git-diff' Porcelain, and not lower level
632 'diff' commands, such as 'git-diff-files'.
634 diff.external::
635 If this config variable is set, diff generation is not
636 performed using the internal diff machinery, but using the
637 given command. Can be overridden with the `GIT_EXTERNAL_DIFF'
638 environment variable. The command is called with parameters
639 as described under "git Diffs" in linkgit:git[1]. Note: if
640 you want to use an external diff program only on a subset of
641 your files, you might want to use linkgit:gitattributes[5] instead.
643 diff.mnemonicprefix::
644 If set, 'git-diff' uses a prefix pair that is different from the
645 standard "a/" and "b/" depending on what is being compared. When
646 this configuration is in effect, reverse diff output also swaps
647 the order of the prefixes:
648 'git-diff';;
649 compares the (i)ndex and the (w)ork tree;
650 'git-diff HEAD';;
651 compares a (c)ommit and the (w)ork tree;
652 'git diff --cached';;
653 compares a (c)ommit and the (i)ndex;
654 'git-diff HEAD:file1 file2';;
655 compares an (o)bject and a (w)ork tree entity;
656 'git diff --no-index a b';;
657 compares two non-git things (1) and (2).
659 diff.renameLimit::
660 The number of files to consider when performing the copy/rename
661 detection; equivalent to the 'git-diff' option '-l'.
663 diff.renames::
664 Tells git to detect renames. If set to any boolean value, it
665 will enable basic rename detection. If set to "copies" or
666 "copy", it will detect copies, as well.
668 diff.suppressBlankEmpty::
669 A boolean to inhibit the standard behavior of printing a space
670 before each empty output line. Defaults to false.
672 diff.tool::
673 Controls which diff tool is used. `diff.tool` overrides
674 `merge.tool` when used by linkgit:git-difftool[1] and has
675 the same valid values as `merge.tool` minus "tortoisemerge"
676 and plus "kompare".
678 difftool.<tool>.path::
679 Override the path for the given tool. This is useful in case
680 your tool is not in the PATH.
682 difftool.<tool>.cmd::
683 Specify the command to invoke the specified diff tool.
684 The specified command is evaluated in shell with the following
685 variables available: 'LOCAL' is set to the name of the temporary
686 file containing the contents of the diff pre-image and 'REMOTE'
687 is set to the name of the temporary file containing the contents
688 of the diff post-image.
690 difftool.prompt::
691 Prompt before each invocation of the diff tool.
693 diff.wordRegex::
694 A POSIX Extended Regular Expression used to determine what is a "word"
695 when performing word-by-word difference calculations. Character
696 sequences that match the regular expression are "words", all other
697 characters are *ignorable* whitespace.
699 fetch.unpackLimit::
700 If the number of objects fetched over the git native
701 transfer is below this
702 limit, then the objects will be unpacked into loose object
703 files. However if the number of received objects equals or
704 exceeds this limit then the received pack will be stored as
705 a pack, after adding any missing delta bases. Storing the
706 pack from a push can make the push operation complete faster,
707 especially on slow filesystems. If not set, the value of
708 `transfer.unpackLimit` is used instead.
710 format.numbered::
711 A boolean which can enable or disable sequence numbers in patch
712 subjects. It defaults to "auto" which enables it only if there
713 is more than one patch. It can be enabled or disabled for all
714 messages by setting it to "true" or "false". See --numbered
715 option in linkgit:git-format-patch[1].
717 format.headers::
718 Additional email headers to include in a patch to be submitted
719 by mail. See linkgit:git-format-patch[1].
721 format.suffix::
722 The default for format-patch is to output files with the suffix
723 `.patch`. Use this variable to change that suffix (make sure to
724 include the dot if you want it).
726 format.pretty::
727 The default pretty format for log/show/whatchanged command,
728 See linkgit:git-log[1], linkgit:git-show[1],
729 linkgit:git-whatchanged[1].
731 format.thread::
732 The default threading style for 'git-format-patch'. Can be
733 either a boolean value, `shallow` or `deep`. 'Shallow'
734 threading makes every mail a reply to the head of the series,
735 where the head is chosen from the cover letter, the
736 `\--in-reply-to`, and the first patch mail, in this order.
737 'Deep' threading makes every mail a reply to the previous one.
738 A true boolean value is the same as `shallow`, and a false
739 value disables threading.
741 format.signoff::
742 A boolean value which lets you enable the `-s/--signoff` option of
743 format-patch by default. *Note:* Adding the Signed-off-by: line to a
744 patch should be a conscious act and means that you certify you have
745 the rights to submit this work under the same open source license.
746 Please see the 'SubmittingPatches' document for further discussion.
748 gc.aggressiveWindow::
749 The window size parameter used in the delta compression
750 algorithm used by 'git-gc --aggressive'. This defaults
751 to 10.
753 gc.auto::
754 When there are approximately more than this many loose
755 objects in the repository, `git gc --auto` will pack them.
756 Some Porcelain commands use this command to perform a
757 light-weight garbage collection from time to time. The
758 default value is 6700. Setting this to 0 disables it.
760 gc.autopacklimit::
761 When there are more than this many packs that are not
762 marked with `*.keep` file in the repository, `git gc
763 --auto` consolidates them into one larger pack. The
764 default value is 50. Setting this to 0 disables it.
766 gc.packrefs::
767 'git-gc' does not run `git pack-refs` in a bare repository by
768 default so that older dumb-transport clients can still fetch
769 from the repository. Setting this to `true` lets 'git-gc'
770 to run `git pack-refs`. Setting this to `false` tells
771 'git-gc' never to run `git pack-refs`. The default setting is
772 `notbare`. Enable it only when you know you do not have to
773 support such clients. The default setting will change to `true`
774 at some stage, and setting this to `false` will continue to
775 prevent `git pack-refs` from being run from 'git-gc'.
777 gc.pruneexpire::
778 When 'git-gc' is run, it will call 'prune --expire 2.weeks.ago'.
779 Override the grace period with this config variable. The value
780 "now" may be used to disable this grace period and always prune
781 unreachable objects immediately.
783 gc.reflogexpire::
784 'git-reflog expire' removes reflog entries older than
785 this time; defaults to 90 days.
787 gc.reflogexpireunreachable::
788 'git-reflog expire' removes reflog entries older than
789 this time and are not reachable from the current tip;
790 defaults to 30 days.
792 gc.rerereresolved::
793 Records of conflicted merge you resolved earlier are
794 kept for this many days when 'git-rerere gc' is run.
795 The default is 60 days. See linkgit:git-rerere[1].
797 gc.rerereunresolved::
798 Records of conflicted merge you have not resolved are
799 kept for this many days when 'git-rerere gc' is run.
800 The default is 15 days. See linkgit:git-rerere[1].
802 gitcvs.commitmsgannotation::
803 Append this string to each commit message. Set to empty string
804 to disable this feature. Defaults to "via git-CVS emulator".
806 gitcvs.enabled::
807 Whether the CVS server interface is enabled for this repository.
808 See linkgit:git-cvsserver[1].
810 gitcvs.logfile::
811 Path to a log file where the CVS server interface well... logs
812 various stuff. See linkgit:git-cvsserver[1].
814 gitcvs.usecrlfattr::
815 If true, the server will look up the `crlf` attribute for
816 files to determine the '-k' modes to use. If `crlf` is set,
817 the '-k' mode will be left blank, so cvs clients will
818 treat it as text. If `crlf` is explicitly unset, the file
819 will be set with '-kb' mode, which suppresses any newline munging
820 the client might otherwise do. If `crlf` is not specified,
821 then 'gitcvs.allbinary' is used. See linkgit:gitattributes[5].
823 gitcvs.allbinary::
824 This is used if 'gitcvs.usecrlfattr' does not resolve
825 the correct '-kb' mode to use. If true, all
826 unresolved files are sent to the client in
827 mode '-kb'. This causes the client to treat them
828 as binary files, which suppresses any newline munging it
829 otherwise might do. Alternatively, if it is set to "guess",
830 then the contents of the file are examined to decide if
831 it is binary, similar to 'core.autocrlf'.
833 gitcvs.dbname::
834 Database used by git-cvsserver to cache revision information
835 derived from the git repository. The exact meaning depends on the
836 used database driver, for SQLite (which is the default driver) this
837 is a filename. Supports variable substitution (see
838 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
839 Default: '%Ggitcvs.%m.sqlite'
841 gitcvs.dbdriver::
842 Used Perl DBI driver. You can specify any available driver
843 for this here, but it might not work. git-cvsserver is tested
844 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
845 reported *not* to work with 'DBD::mysql'. Experimental feature.
846 May not contain double colons (`:`). Default: 'SQLite'.
847 See linkgit:git-cvsserver[1].
849 gitcvs.dbuser, gitcvs.dbpass::
850 Database user and password. Only useful if setting 'gitcvs.dbdriver',
851 since SQLite has no concept of database users and/or passwords.
852 'gitcvs.dbuser' supports variable substitution (see
853 linkgit:git-cvsserver[1] for details).
855 gitcvs.dbTableNamePrefix::
856 Database table name prefix. Prepended to the names of any
857 database tables used, allowing a single database to be used
858 for several repositories. Supports variable substitution (see
859 linkgit:git-cvsserver[1] for details). Any non-alphabetic
860 characters will be replaced with underscores.
862 All gitcvs variables except for 'gitcvs.usecrlfattr' and
863 'gitcvs.allbinary' can also be specified as
864 'gitcvs.<access_method>.<varname>' (where 'access_method'
865 is one of "ext" and "pserver") to make them apply only for the given
866 access method.
868 gui.commitmsgwidth::
869 Defines how wide the commit message window is in the
870 linkgit:git-gui[1]. "75" is the default.
872 gui.diffcontext::
873 Specifies how many context lines should be used in calls to diff
874 made by the linkgit:git-gui[1]. The default is "5".
876 gui.encoding::
877 Specifies the default encoding to use for displaying of
878 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
879 It can be overridden by setting the 'encoding' attribute
880 for relevant files (see linkgit:gitattributes[5]).
881 If this option is not set, the tools default to the
882 locale encoding.
884 gui.matchtrackingbranch::
885 Determines if new branches created with linkgit:git-gui[1] should
886 default to tracking remote branches with matching names or
887 not. Default: "false".
889 gui.newbranchtemplate::
890 Is used as suggested name when creating new branches using the
891 linkgit:git-gui[1].
893 gui.pruneduringfetch::
894 "true" if linkgit:git-gui[1] should prune tracking branches when
895 performing a fetch. The default value is "false".
897 gui.trustmtime::
898 Determines if linkgit:git-gui[1] should trust the file modification
899 timestamp or not. By default the timestamps are not trusted.
901 gui.spellingdictionary::
902 Specifies the dictionary used for spell checking commit messages in
903 the linkgit:git-gui[1]. When set to "none" spell checking is turned
904 off.
906 gui.fastcopyblame::
907 If true, 'git gui blame' uses '-C' instead of '-C -C' for original
908 location detection. It makes blame significantly faster on huge
909 repositories at the expense of less thorough copy detection.
911 gui.copyblamethreshold::
912 Specifies the threshold to use in 'git gui blame' original location
913 detection, measured in alphanumeric characters. See the
914 linkgit:git-blame[1] manual for more information on copy detection.
916 gui.blamehistoryctx::
917 Specifies the radius of history context in days to show in
918 linkgit:gitk[1] for the selected commit, when the `Show History
919 Context` menu item is invoked from 'git gui blame'. If this
920 variable is set to zero, the whole history is shown.
922 guitool.<name>.cmd::
923 Specifies the shell command line to execute when the corresponding item
924 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
925 mandatory for every tool. The command is executed from the root of
926 the working directory, and in the environment it receives the name of
927 the tool as 'GIT_GUITOOL', the name of the currently selected file as
928 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
929 the head is detached, 'CUR_BRANCH' is empty).
931 guitool.<name>.needsfile::
932 Run the tool only if a diff is selected in the GUI. It guarantees
933 that 'FILENAME' is not empty.
935 guitool.<name>.noconsole::
936 Run the command silently, without creating a window to display its
937 output.
939 guitool.<name>.norescan::
940 Don't rescan the working directory for changes after the tool
941 finishes execution.
943 guitool.<name>.confirm::
944 Show a confirmation dialog before actually running the tool.
946 guitool.<name>.argprompt::
947 Request a string argument from the user, and pass it to the tool
948 through the 'ARGS' environment variable. Since requesting an
949 argument implies confirmation, the 'confirm' option has no effect
950 if this is enabled. If the option is set to 'true', 'yes', or '1',
951 the dialog uses a built-in generic prompt; otherwise the exact
952 value of the variable is used.
954 guitool.<name>.revprompt::
955 Request a single valid revision from the user, and set the
956 'REVISION' environment variable. In other aspects this option
957 is similar to 'argprompt', and can be used together with it.
959 guitool.<name>.revunmerged::
960 Show only unmerged branches in the 'revprompt' subdialog.
961 This is useful for tools similar to merge or rebase, but not
962 for things like checkout or reset.
964 guitool.<name>.title::
965 Specifies the title to use for the prompt dialog. The default
966 is the tool name.
968 guitool.<name>.prompt::
969 Specifies the general prompt string to display at the top of
970 the dialog, before subsections for 'argprompt' and 'revprompt'.
971 The default value includes the actual command.
973 help.browser::
974 Specify the browser that will be used to display help in the
975 'web' format. See linkgit:git-help[1].
977 help.format::
978 Override the default help format used by linkgit:git-help[1].
979 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
980 the default. 'web' and 'html' are the same.
982 help.autocorrect::
983 Automatically correct and execute mistyped commands after
984 waiting for the given number of deciseconds (0.1 sec). If more
985 than one command can be deduced from the entered text, nothing
986 will be executed. If the value of this option is negative,
987 the corrected command will be executed immediately. If the
988 value is 0 - the command will be just shown but not executed.
989 This is the default.
991 http.proxy::
992 Override the HTTP proxy, normally configured using the 'http_proxy'
993 environment variable (see linkgit:curl[1]). This can be overridden
994 on a per-remote basis; see remote.<name>.proxy
996 http.sslVerify::
997 Whether to verify the SSL certificate when fetching or pushing
998 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
999 variable.
1001 http.sslCert::
1002 File containing the SSL certificate when fetching or pushing
1003 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1004 variable.
1006 http.sslKey::
1007 File containing the SSL private key when fetching or pushing
1008 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1009 variable.
1011 http.sslCAInfo::
1012 File containing the certificates to verify the peer with when
1013 fetching or pushing over HTTPS. Can be overridden by the
1014 'GIT_SSL_CAINFO' environment variable.
1016 http.sslCAPath::
1017 Path containing files with the CA certificates to verify the peer
1018 with when fetching or pushing over HTTPS. Can be overridden
1019 by the 'GIT_SSL_CAPATH' environment variable.
1021 http.maxRequests::
1022 How many HTTP requests to launch in parallel. Can be overridden
1023 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1025 http.lowSpeedLimit, http.lowSpeedTime::
1026 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1027 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1028 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1029 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1031 http.noEPSV::
1032 A boolean which disables using of EPSV ftp command by curl.
1033 This can helpful with some "poor" ftp servers which don't
1034 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1035 environment variable. Default is false (curl will use EPSV).
1037 i18n.commitEncoding::
1038 Character encoding the commit messages are stored in; git itself
1039 does not care per se, but this information is necessary e.g. when
1040 importing commits from emails or in the gitk graphical history
1041 browser (and possibly at other places in the future or in other
1042 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1044 i18n.logOutputEncoding::
1045 Character encoding the commit messages are converted to when
1046 running 'git-log' and friends.
1048 imap::
1049 The configuration variables in the 'imap' section are described
1050 in linkgit:git-imap-send[1].
1052 instaweb.browser::
1053 Specify the program that will be used to browse your working
1054 repository in gitweb. See linkgit:git-instaweb[1].
1056 instaweb.httpd::
1057 The HTTP daemon command-line to start gitweb on your working
1058 repository. See linkgit:git-instaweb[1].
1060 instaweb.local::
1061 If true the web server started by linkgit:git-instaweb[1] will
1062 be bound to the local IP (
1064 instaweb.modulepath::
1065 The module path for an apache httpd used by linkgit:git-instaweb[1].
1067 instaweb.port::
1068 The port number to bind the gitweb httpd to. See
1069 linkgit:git-instaweb[1].
1071 interactive.singlekey::
1072 In interactive programs, allow the user to provide one-letter
1073 input with a single key (i.e., without hitting enter).
1074 Currently this is used only by the `\--patch` mode of
1075 linkgit:git-add[1]. Note that this setting is silently
1076 ignored if portable keystroke input is not available.
1078 log.date::
1079 Set default date-time mode for the log command. Setting log.date
1080 value is similar to using 'git-log'\'s --date option. The value is one of the
1081 following alternatives: {relative,local,default,iso,rfc,short}.
1082 See linkgit:git-log[1].
1084 log.showroot::
1085 If true, the initial commit will be shown as a big creation event.
1086 This is equivalent to a diff against an empty tree.
1087 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1088 normally hide the root commit will now show it. True by default.
1090 mailmap.file::
1091 The location of an augmenting mailmap file. The default
1092 mailmap, located in the root of the repository, is loaded
1093 first, then the mailmap file pointed to by this variable.
1094 The location of the mailmap file may be in a repository
1095 subdirectory, or somewhere outside of the repository itself.
1096 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1098 man.viewer::
1099 Specify the programs that may be used to display help in the
1100 'man' format. See linkgit:git-help[1].
1102 man.<tool>.cmd::
1103 Specify the command to invoke the specified man viewer. The
1104 specified command is evaluated in shell with the man page
1105 passed as argument. (See linkgit:git-help[1].)
1107 man.<tool>.path::
1108 Override the path for the given tool that may be used to
1109 display help in the 'man' format. See linkgit:git-help[1].
1111 include::merge-config.txt[]
1113 mergetool.<tool>.path::
1114 Override the path for the given tool. This is useful in case
1115 your tool is not in the PATH.
1117 mergetool.<tool>.cmd::
1118 Specify the command to invoke the specified merge tool. The
1119 specified command is evaluated in shell with the following
1120 variables available: 'BASE' is the name of a temporary file
1121 containing the common base of the files to be merged, if available;
1122 'LOCAL' is the name of a temporary file containing the contents of
1123 the file on the current branch; 'REMOTE' is the name of a temporary
1124 file containing the contents of the file from the branch being
1125 merged; 'MERGED' contains the name of the file to which the merge
1126 tool should write the results of a successful merge.
1128 mergetool.<tool>.trustExitCode::
1129 For a custom merge command, specify whether the exit code of
1130 the merge command can be used to determine whether the merge was
1131 successful. If this is not set to true then the merge target file
1132 timestamp is checked and the merge assumed to have been successful
1133 if the file has been updated, otherwise the user is prompted to
1134 indicate the success of the merge.
1136 mergetool.keepBackup::
1137 After performing a merge, the original file with conflict markers
1138 can be saved as a file with a `.orig` extension. If this variable
1139 is set to `false` then this file is not preserved. Defaults to
1140 `true` (i.e. keep the backup files).
1142 mergetool.keepTemporaries::
1143 When invoking a custom merge tool, git uses a set of temporary
1144 files to pass to the tool. If the tool returns an error and this
1145 variable is set to `true`, then these temporary files will be
1146 preserved, otherwise they will be removed after the tool has
1147 exited. Defaults to `false`.
1149 mergetool.prompt::
1150 Prompt before each invocation of the merge resolution program.
1152 pack.window::
1153 The size of the window used by linkgit:git-pack-objects[1] when no
1154 window size is given on the command line. Defaults to 10.
1156 pack.depth::
1157 The maximum delta depth used by linkgit:git-pack-objects[1] when no
1158 maximum depth is given on the command line. Defaults to 50.
1160 pack.windowMemory::
1161 The window memory size limit used by linkgit:git-pack-objects[1]
1162 when no limit is given on the command line. The value can be
1163 suffixed with "k", "m", or "g". Defaults to 0, meaning no
1164 limit.
1166 pack.compression::
1167 An integer -1..9, indicating the compression level for objects
1168 in a pack file. -1 is the zlib default. 0 means no
1169 compression, and 1..9 are various speed/size tradeoffs, 9 being
1170 slowest. If not set, defaults to core.compression. If that is
1171 not set, defaults to -1, the zlib default, which is "a default
1172 compromise between speed and compression (currently equivalent
1173 to level 6)."
1175 pack.deltaCacheSize::
1176 The maximum memory in bytes used for caching deltas in
1177 linkgit:git-pack-objects[1].
1178 A value of 0 means no limit. Defaults to 0.
1180 pack.deltaCacheLimit::
1181 The maximum size of a delta, that is cached in
1182 linkgit:git-pack-objects[1]. Defaults to 1000.
1184 pack.threads::
1185 Specifies the number of threads to spawn when searching for best
1186 delta matches. This requires that linkgit:git-pack-objects[1]
1187 be compiled with pthreads otherwise this option is ignored with a
1188 warning. This is meant to reduce packing time on multiprocessor
1189 machines. The required amount of memory for the delta search window
1190 is however multiplied by the number of threads.
1191 Specifying 0 will cause git to auto-detect the number of CPU's
1192 and set the number of threads accordingly.
1194 pack.indexVersion::
1195 Specify the default pack index version. Valid values are 1 for
1196 legacy pack index used by Git versions prior to 1.5.2, and 2 for
1197 the new pack index with capabilities for packs larger than 4 GB
1198 as well as proper protection against the repacking of corrupted
1199 packs. Version 2 is the default. Note that version 2 is enforced
1200 and this config option ignored whenever the corresponding pack is
1201 larger than 2 GB.
1202 +
1203 If you have an old git that does not understand the version 2 `{asterisk}.idx` file,
1204 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1205 that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the
1206 other side may give you a repository that cannot be accessed with your
1207 older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,
1208 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1209 the `{asterisk}.idx` file.
1211 pack.packSizeLimit::
1212 The default maximum size of a pack. This setting only affects
1213 packing to a file, i.e. the git:// protocol is unaffected. It
1214 can be overridden by the `\--max-pack-size` option of
1215 linkgit:git-repack[1].
1217 pager.<cmd>::
1218 Allows turning on or off pagination of the output of a
1219 particular git subcommand when writing to a tty. If
1220 `\--paginate` or `\--no-pager` is specified on the command line,
1221 it takes precedence over this option. To disable pagination for
1222 all commands, set `core.pager` or `GIT_PAGER` to `cat`.
1224 pull.octopus::
1225 The default merge strategy to use when pulling multiple branches
1226 at once.
1228 pull.twohead::
1229 The default merge strategy to use when pulling a single branch.
1231 push.default::
1232 Defines the action git push should take if no refspec is given
1233 on the command line, no refspec is configured in the remote, and
1234 no refspec is implied by any of the options given on the command
1235 line. Possible values are:
1236 +
1237 * `nothing` do not push anything.
1238 * `matching` push all matching branches.
1239 All branches having the same name in both ends are considered to be
1240 matching. This is the default.
1241 * `tracking` push the current branch to its upstream branch.
1242 * `current` push the current branch to a branch of the same name.
1244 rebase.stat::
1245 Whether to show a diffstat of what changed upstream since the last
1246 rebase. False by default.
1248 receive.fsckObjects::
1249 If it is set to true, git-receive-pack will check all received
1250 objects. It will abort in the case of a malformed object or a
1251 broken link. The result of an abort are only dangling objects.
1252 Defaults to false.
1254 receive.unpackLimit::
1255 If the number of objects received in a push is below this
1256 limit then the objects will be unpacked into loose object
1257 files. However if the number of received objects equals or
1258 exceeds this limit then the received pack will be stored as
1259 a pack, after adding any missing delta bases. Storing the
1260 pack from a push can make the push operation complete faster,
1261 especially on slow filesystems. If not set, the value of
1262 `transfer.unpackLimit` is used instead.
1264 receive.denyDeletes::
1265 If set to true, git-receive-pack will deny a ref update that deletes
1266 the ref. Use this to prevent such a ref deletion via a push.
1268 receive.denyCurrentBranch::
1269 If set to true or "refuse", receive-pack will deny a ref update
1270 to the currently checked out branch of a non-bare repository.
1271 Such a push is potentially dangerous because it brings the HEAD
1272 out of sync with the index and working tree. If set to "warn",
1273 print a warning of such a push to stderr, but allow the push to
1274 proceed. If set to false or "ignore", allow such pushes with no
1275 message. Defaults to "warn".
1277 receive.denyNonFastForwards::
1278 If set to true, git-receive-pack will deny a ref update which is
1279 not a fast forward. Use this to prevent such an update via a push,
1280 even if that push is forced. This configuration variable is
1281 set when initializing a shared repository.
1283 remote.<name>.url::
1284 The URL of a remote repository. See linkgit:git-fetch[1] or
1285 linkgit:git-push[1].
1287 remote.<name>.proxy::
1288 For remotes that require curl (http, https and ftp), the URL to
1289 the proxy to use for that remote. Set to the empty string to
1290 disable proxying for that remote.
1292 remote.<name>.fetch::
1293 The default set of "refspec" for linkgit:git-fetch[1]. See
1294 linkgit:git-fetch[1].
1296 remote.<name>.push::
1297 The default set of "refspec" for linkgit:git-push[1]. See
1298 linkgit:git-push[1].
1300 remote.<name>.mirror::
1301 If true, pushing to this remote will automatically behave
1302 as if the `\--mirror` option was given on the command line.
1304 remote.<name>.skipDefaultUpdate::
1305 If true, this remote will be skipped by default when updating
1306 using the update subcommand of linkgit:git-remote[1].
1308 remote.<name>.receivepack::
1309 The default program to execute on the remote side when pushing. See
1310 option \--receive-pack of linkgit:git-push[1].
1312 remote.<name>.uploadpack::
1313 The default program to execute on the remote side when fetching. See
1314 option \--upload-pack of linkgit:git-fetch-pack[1].
1316 remote.<name>.tagopt::
1317 Setting this value to \--no-tags disables automatic tag following when
1318 fetching from remote <name>
1320 remotes.<group>::
1321 The list of remotes which are fetched by "git remote update
1322 <group>". See linkgit:git-remote[1].
1324 repack.usedeltabaseoffset::
1325 By default, linkgit:git-repack[1] creates packs that use
1326 delta-base offset. If you need to share your repository with
1327 git older than version 1.4.4, either directly or via a dumb
1328 protocol such as http, then you need to set this option to
1329 "false" and repack. Access from old git versions over the
1330 native protocol are unaffected by this option.
1332 rerere.autoupdate::
1333 When set to true, `git-rerere` updates the index with the
1334 resulting contents after it cleanly resolves conflicts using
1335 previously recorded resolution. Defaults to false.
1337 rerere.enabled::
1338 Activate recording of resolved conflicts, so that identical
1339 conflict hunks can be resolved automatically, should they
1340 be encountered again. linkgit:git-rerere[1] command is by
1341 default enabled if you create `rr-cache` directory under
1342 `$GIT_DIR`, but can be disabled by setting this option to false.
1344 showbranch.default::
1345 The default set of branches for linkgit:git-show-branch[1].
1346 See linkgit:git-show-branch[1].
1348 status.relativePaths::
1349 By default, linkgit:git-status[1] shows paths relative to the
1350 current directory. Setting this variable to `false` shows paths
1351 relative to the repository root (this was the default for git
1352 prior to v1.5.4).
1354 status.showUntrackedFiles::
1355 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1356 files which are not currently tracked by Git. Directories which
1357 contain only untracked files, are shown with the directory name
1358 only. Showing untracked files means that Git needs to lstat() all
1359 all the files in the whole repository, which might be slow on some
1360 systems. So, this variable controls how the commands displays
1361 the untracked files. Possible values are:
1362 +
1363 --
1364 - 'no' - Show no untracked files
1365 - 'normal' - Shows untracked files and directories
1366 - 'all' - Shows also individual files in untracked directories.
1367 --
1368 +
1369 If this variable is not specified, it defaults to 'normal'.
1370 This variable can be overridden with the -u|--untracked-files option
1371 of linkgit:git-status[1] and linkgit:git-commit[1].
1373 tar.umask::
1374 This variable can be used to restrict the permission bits of
1375 tar archive entries. The default is 0002, which turns off the
1376 world write bit. The special value "user" indicates that the
1377 archiving user's umask will be used instead. See umask(2) and
1378 linkgit:git-archive[1].
1380 transfer.unpackLimit::
1381 When `fetch.unpackLimit` or `receive.unpackLimit` are
1382 not set, the value of this variable is used instead.
1383 The default value is 100.
1385 url.<base>.insteadOf::
1386 Any URL that starts with this value will be rewritten to
1387 start, instead, with <base>. In cases where some site serves a
1388 large number of repositories, and serves them with multiple
1389 access methods, and some users need to use different access
1390 methods, this feature allows people to specify any of the
1391 equivalent URLs and have git automatically rewrite the URL to
1392 the best alternative for the particular user, even for a
1393 never-before-seen repository on the site. When more than one
1394 insteadOf strings match a given URL, the longest match is used.
1396 user.email::
1397 Your email address to be recorded in any newly created commits.
1398 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
1399 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
1401 user.name::
1402 Your full name to be recorded in any newly created commits.
1403 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
1404 environment variables. See linkgit:git-commit-tree[1].
1406 user.signingkey::
1407 If linkgit:git-tag[1] is not selecting the key you want it to
1408 automatically when creating a signed tag, you can override the
1409 default selection with this variable. This option is passed
1410 unchanged to gpg's --local-user parameter, so you may specify a key
1411 using any method that gpg supports.
1413 web.browser::
1414 Specify a web browser that may be used by some commands.
1415 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
1416 may use it.