Merge branch 'dk/blame-el' into pu
[git/spearce.git] / Documentation / config.txt
blob32b0cdf7aaa1bc31a3f3cb75a6389059fe56ac86
1 CONFIGURATION FILE
2 ------------------
4 The git configuration file contains a number of variables that affect
5 the git command's behavior. The `.git/config` file in each repository
6 is used to store the configuration for that repository, and
7 `$HOME/.gitconfig` is used to store a per-user configuration as
8 fallback values for the `.git/config` file. The file `/etc/gitconfig`
9 can be used to store a system-wide default configuration.
11 The configuration variables are used by both the git plumbing
12 and the porcelains. The variables are divided into sections, wherein
13 the fully qualified variable name of 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 a section
30 header before the 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 the example below:
36 --------
37         [section "subsection"]
39 --------
41 Subsection names are case sensitive and can contain any characters except
42 newline (doublequote `"` and backslash have to be escaped as `\"` and `\\`,
43 respectively).  Section headers 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 a case insensitive alternative `[section.subsection]` syntax.
49 In this syntax, subsection names follow the same restrictions as for section
50 names.
52 All the other lines (and the remainder of the line after the section
53 header) are recognized as setting variables, in the form
54 'name = value'.  If there is no equal sign on the line, the entire line
55 is taken as 'name' and the variable is recognized as boolean "true".
56 The variable names are case-insensitive and only alphanumeric
57 characters and `-` are allowed.  There can be more than one value
58 for a given variable; we say then that variable is multivalued.
60 Leading and trailing whitespace in a variable value is discarded.
61 Internal whitespace within a variable value is retained verbatim.
63 The values following the equals sign in variable assign are all either
64 a string, an integer, or a boolean.  Boolean values may be given as yes/no,
65 0/1, true/false or on/off.  Case is not significant in boolean values, when
66 converting value to the canonical form using '--bool' type specifier;
67 'git-config' will ensure that the output is "true" or "false".
69 String values may be entirely or partially enclosed in double quotes.
70 You need to enclose variable values in double quotes if you want to
71 preserve leading or trailing whitespace, or if the variable value contains
72 comment characters (i.e. it contains '#' or ';').
73 Double quote `"` and backslash `\` characters in variable values must
74 be escaped: use `\"` for `"` and `\\` for `\`.
76 The following escape sequences (beside `\"` and `\\`) are recognized:
77 `\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
78 and `\b` for backspace (BS).  No other char escape sequence, nor octal
79 char sequences are valid.
81 Variable values ending in a `\` are continued on the next line in the
82 customary UNIX fashion.
84 Some variables may require a special value format.
86 Example
87 ~~~~~~~
89         # Core variables
90         [core]
91                 ; Don't trust file modes
92                 filemode = false
94         # Our diff algorithm
95         [diff]
96                 external = /usr/local/bin/diff-wrapper
97                 renames = true
99         [branch "devel"]
100                 remote = origin
101                 merge = refs/heads/devel
103         # Proxy settings
104         [core]
105                 gitProxy="ssh" for "kernel.org"
106                 gitProxy=default-proxy ; for the rest
108 Variables
109 ~~~~~~~~~
111 Note that this list is non-comprehensive and not necessarily complete.
112 For command-specific variables, you will find a more detailed description
113 in the appropriate manual page. You will find a description of non-core
114 porcelain configuration variables in the respective porcelain documentation.
116 advice.*::
117         When set to 'true', display the given optional help message.
118         When set to 'false', do not display. The configuration variables
119         are:
122         pushNonFastForward::
123                 Advice shown when linkgit:git-push[1] refuses
124                 non-fast-forward refs. Default: true.
125         statusHints::
126                 Directions on how to stage/unstage/add shown in the
127                 output of linkgit:git-status[1] and the template shown
128                 when writing commit messages. Default: true.
131 core.fileMode::
132         If false, the executable bit differences between the index and
133         the working copy are ignored; useful on broken filesystems like FAT.
134         See linkgit:git-update-index[1]. True by default.
136 core.ignoreCygwinFSTricks::
137         This option is only used by Cygwin implementation of Git. If false,
138         the Cygwin stat() and lstat() functions are used. This may be useful
139         if your repository consists of a few separate directories joined in
140         one hierarchy using Cygwin mount. If true, Git uses native Win32 API
141         whenever it is possible and falls back to Cygwin functions only to
142         handle symbol links. The native mode is more than twice faster than
143         normal Cygwin l/stat() functions. True by default, unless core.filemode
144         is true, in which case ignoreCygwinFSTricks is ignored as Cygwin's
145         POSIX emulation is required to support core.filemode.
147 core.trustctime::
148         If false, the ctime differences between the index and the
149         working copy are ignored; useful when the inode change time
150         is regularly modified by something outside Git (file system
151         crawlers and some backup systems).
152         See linkgit:git-update-index[1]. True by default.
154 core.quotepath::
155         The commands that output paths (e.g. 'ls-files',
156         'diff'), when not given the `-z` option, will quote
157         "unusual" characters in the pathname by enclosing the
158         pathname in a double-quote pair and with backslashes the
159         same way strings in C source code are quoted.  If this
160         variable is set to false, the bytes higher than 0x80 are
161         not quoted but output as verbatim.  Note that double
162         quote, backslash and control characters are always
163         quoted without `-z` regardless of the setting of this
164         variable.
166 core.autocrlf::
167         If true, makes git convert `CRLF` at the end of lines in text files to
168         `LF` when reading from the filesystem, and convert in reverse when
169         writing to the filesystem.  The variable can be set to
170         'input', in which case the conversion happens only while
171         reading from the filesystem but files are written out with
172         `LF` at the end of lines.  Currently, which paths to consider
173         "text" (i.e. be subjected to the autocrlf mechanism) is
174         decided purely based on the contents.
176 core.safecrlf::
177         If true, makes git check if converting `CRLF` as controlled by
178         `core.autocrlf` is reversible.  Git will verify if a command
179         modifies a file in the work tree either directly or indirectly.
180         For example, committing a file followed by checking out the
181         same file should yield the original file in the work tree.  If
182         this is not the case for the current setting of
183         `core.autocrlf`, git will reject the file.  The variable can
184         be set to "warn", in which case git will only warn about an
185         irreversible conversion but continue the operation.
187 CRLF conversion bears a slight chance of corrupting data.
188 autocrlf=true will convert CRLF to LF during commit and LF to
189 CRLF during checkout.  A file that contains a mixture of LF and
190 CRLF before the commit cannot be recreated by git.  For text
191 files this is the right thing to do: it corrects line endings
192 such that we have only LF line endings in the repository.
193 But for binary files that are accidentally classified as text the
194 conversion can corrupt data.
196 If you recognize such corruption early you can easily fix it by
197 setting the conversion type explicitly in .gitattributes.  Right
198 after committing you still have the original file in your work
199 tree and this file is not yet corrupted.  You can explicitly tell
200 git that this file is binary and git will handle the file
201 appropriately.
203 Unfortunately, the desired effect of cleaning up text files with
204 mixed line endings and the undesired effect of corrupting binary
205 files cannot be distinguished.  In both cases CRLFs are removed
206 in an irreversible way.  For text files this is the right thing
207 to do because CRLFs are line endings, while for binary files
208 converting CRLFs corrupts data.
210 Note, this safety check does not mean that a checkout will generate a
211 file identical to the original file for a different setting of
212 `core.autocrlf`, but only for the current one.  For example, a text
213 file with `LF` would be accepted with `core.autocrlf=input` and could
214 later be checked out with `core.autocrlf=true`, in which case the
215 resulting file would contain `CRLF`, although the original file
216 contained `LF`.  However, in both work trees the line endings would be
217 consistent, that is either all `LF` or all `CRLF`, but never mixed.  A
218 file with mixed line endings would be reported by the `core.safecrlf`
219 mechanism.
221 core.symlinks::
222         If false, symbolic links are checked out as small plain files that
223         contain the link text. linkgit:git-update-index[1] and
224         linkgit:git-add[1] will not change the recorded type to regular
225         file. Useful on filesystems like FAT that do not support
226         symbolic links. True by default.
228 core.gitProxy::
229         A "proxy command" to execute (as 'command host port') instead
230         of establishing direct connection to the remote server when
231         using the git protocol for fetching. If the variable value is
232         in the "COMMAND for DOMAIN" format, the command is applied only
233         on hostnames ending with the specified domain string. This variable
234         may be set multiple times and is matched in the given order;
235         the first match wins.
237 Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
238 (which always applies universally, without the special "for"
239 handling).
241 The special string `none` can be used as the proxy command to
242 specify that no proxy be used for a given domain pattern.
243 This is useful for excluding servers inside a firewall from
244 proxy use, while defaulting to a common proxy for external domains.
246 core.ignoreStat::
247         If true, commands which modify both the working tree and the index
248         will mark the updated paths with the "assume unchanged" bit in the
249         index. These marked files are then assumed to stay unchanged in the
250         working copy, until you mark them otherwise manually - Git will not
251         detect the file changes by lstat() calls. This is useful on systems
252         where those are very slow, such as Microsoft Windows.
253         See linkgit:git-update-index[1].
254         False by default.
256 core.preferSymlinkRefs::
257         Instead of the default "symref" format for HEAD
258         and other symbolic reference files, use symbolic links.
259         This is sometimes needed to work with old scripts that
260         expect HEAD to be a symbolic link.
262 core.bare::
263         If true this repository is assumed to be 'bare' and has no
264         working directory associated with it.  If this is the case a
265         number of commands that require a working directory will be
266         disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
268 This setting is automatically guessed by linkgit:git-clone[1] or
269 linkgit:git-init[1] when the repository was created.  By default a
270 repository that ends in "/.git" is assumed to be not bare (bare =
271 false), while all other repositories are assumed to be bare (bare
272 = true).
274 core.worktree::
275         Set the path to the working tree.  The value will not be
276         used in combination with repositories found automatically in
277         a .git directory (i.e. $GIT_DIR is not set).
278         This can be overridden by the GIT_WORK_TREE environment
279         variable and the '--work-tree' command line option. It can be
280         a absolute path or relative path to the directory specified by
281         --git-dir or GIT_DIR.
282         Note: If --git-dir or GIT_DIR are specified but none of
283         --work-tree, GIT_WORK_TREE and core.worktree is specified,
284         the current working directory is regarded as the top directory
285         of your working tree.
287 core.logAllRefUpdates::
288         Enable the reflog. Updates to a ref <ref> is logged to the file
289         "$GIT_DIR/logs/<ref>", by appending the new and old
290         SHA1, the date/time and the reason of the update, but
291         only when the file exists.  If this configuration
292         variable is set to true, missing "$GIT_DIR/logs/<ref>"
293         file is automatically created for branch heads.
295 This information can be used to determine what commit
296 was the tip of a branch "2 days ago".
298 This value is true by default in a repository that has
299 a working directory associated with it, and false by
300 default in a bare repository.
302 core.repositoryFormatVersion::
303         Internal variable identifying the repository format and layout
304         version.
306 core.sharedRepository::
307         When 'group' (or 'true'), the repository is made shareable between
308         several users in a group (making sure all the files and objects are
309         group-writable). When 'all' (or 'world' or 'everybody'), the
310         repository will be readable by all users, additionally to being
311         group-shareable. When 'umask' (or 'false'), git will use permissions
312         reported by umask(2). When '0xxx', where '0xxx' is an octal number,
313         files in the repository will have this mode value. '0xxx' will override
314         user's umask value (whereas the other options will only override
315         requested parts of the user's umask value). Examples: '0660' will make
316         the repo read/write-able for the owner and group, but inaccessible to
317         others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
318         repository that is group-readable but not group-writable.
319         See linkgit:git-init[1]. False by default.
321 core.warnAmbiguousRefs::
322         If true, git will warn you if the ref name you passed it is ambiguous
323         and might match multiple refs in the .git/refs/ tree. True by default.
325 core.compression::
326         An integer -1..9, indicating a default compression level.
327         -1 is the zlib default. 0 means no compression,
328         and 1..9 are various speed/size tradeoffs, 9 being slowest.
329         If set, this provides a default to other compression variables,
330         such as 'core.loosecompression' and 'pack.compression'.
332 core.loosecompression::
333         An integer -1..9, indicating the compression level for objects that
334         are not in a pack file. -1 is the zlib default. 0 means no
335         compression, and 1..9 are various speed/size tradeoffs, 9 being
336         slowest.  If not set,  defaults to core.compression.  If that is
337         not set,  defaults to 1 (best speed).
339 core.packedGitWindowSize::
340         Number of bytes of a pack file to map into memory in a
341         single mapping operation.  Larger window sizes may allow
342         your system to process a smaller number of large pack files
343         more quickly.  Smaller window sizes will negatively affect
344         performance due to increased calls to the operating system's
345         memory manager, but may improve performance when accessing
346         a large number of large pack files.
348 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
349 MiB on 32 bit platforms and 1 GiB on 64 bit platforms.  This should
350 be reasonable for all users/operating systems.  You probably do
351 not need to adjust this value.
353 Common unit suffixes of 'k', 'm', or 'g' are supported.
355 core.packedGitLimit::
356         Maximum number of bytes to map simultaneously into memory
357         from pack files.  If Git needs to access more than this many
358         bytes at once to complete an operation it will unmap existing
359         regions to reclaim virtual address space within the process.
361 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
362 This should be reasonable for all users/operating systems, except on
363 the largest projects.  You probably do not need to adjust this value.
365 Common unit suffixes of 'k', 'm', or 'g' are supported.
367 core.deltaBaseCacheLimit::
368         Maximum number of bytes to reserve for caching base objects
369         that multiple deltafied objects reference.  By storing the
370         entire decompressed base objects in a cache Git is able
371         to avoid unpacking and decompressing frequently used base
372         objects multiple times.
374 Default is 16 MiB on all platforms.  This should be reasonable
375 for all users/operating systems, except on the largest projects.
376 You probably do not need to adjust this value.
378 Common unit suffixes of 'k', 'm', or 'g' are supported.
380 core.excludesfile::
381         In addition to '.gitignore' (per-directory) and
382         '.git/info/exclude', git looks into this file for patterns
383         of files which are not meant to be tracked.  See
384         linkgit:gitignore[5].
386 core.editor::
387         Commands such as `commit` and `tag` that lets you edit
388         messages by launching an editor uses the value of this
389         variable when it is set, and the environment variable
390         `GIT_EDITOR` is not set.  The order of preference is
391         `GIT_EDITOR` environment, `core.editor`, `VISUAL` and
392         `EDITOR` environment variables and then finally `vi`.
394 core.pager::
395         The command that git will use to paginate output.  Can
396         be overridden with the `GIT_PAGER` environment
397         variable.  Note that git sets the `LESS` environment
398         variable to `FRSX` if it is unset when it runs the
399         pager.  One can change these settings by setting the
400         `LESS` variable to some other value.  Alternately,
401         these settings can be overridden on a project or
402         global basis by setting the `core.pager` option.
403         Setting `core.pager` has no affect on the `LESS`
404         environment variable behaviour above, so if you want
405         to override git's default settings this way, you need
406         to be explicit.  For example, to disable the S option
407         in a backward compatible manner, set `core.pager`
408         to `less -+$LESS -FRX`.  This will be passed to the
409         shell by git, which will translate the final command to
410         `LESS=FRSX less -+FRSX -FRX`.
412 core.whitespace::
413         A comma separated list of common whitespace problems to
414         notice.  'git-diff' will use `color.diff.whitespace` to
415         highlight them, and 'git-apply --whitespace=error' will
416         consider them as errors.  You can prefix `-` to disable
417         any of them (e.g. `-trailing-space`):
419 * `blank-at-eol` treats trailing whitespaces at the end of the line
420   as an error (enabled by default).
421 * `space-before-tab` treats a space character that appears immediately
422   before a tab character in the initial indent part of the line as an
423   error (enabled by default).
424 * `indent-with-non-tab` treats a line that is indented with 8 or more
425   space characters as an error (not enabled by default).
426 * `blank-at-eof` treats blank lines added at the end of file as an error
427   (enabled by default).
428 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
429   `blank-at-eof`.
430 * `cr-at-eol` treats a carriage-return at the end of line as
431   part of the line terminator, i.e. with it, `trailing-space`
432   does not trigger if the character before such a carriage-return
433   is not a whitespace (not enabled by default).
435 core.fsyncobjectfiles::
436         This boolean will enable 'fsync()' when writing object files.
438 This is a total waste of time and effort on a filesystem that orders
439 data writes properly, but can be useful for filesystems that do not use
440 journalling (traditional UNIX filesystems) or that only journal metadata
441 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
443 core.preloadindex::
444         Enable parallel index preload for operations like 'git diff'
446 This can speed up operations like 'git diff' and 'git status' especially
447 on filesystems like NFS that have weak caching semantics and thus
448 relatively high IO latencies.  With this set to 'true', git will do the
449 index comparison to the filesystem data in parallel, allowing
450 overlapping IO's.
452 core.createObject::
453         You can set this to 'link', in which case a hardlink followed by
454         a delete of the source are used to make sure that object creation
455         will not overwrite existing objects.
457 On some file system/operating system combinations, this is unreliable.
458 Set this config setting to 'rename' there; However, This will remove the
459 check that makes sure that existing object files will not get overwritten.
461 core.notesRef::
462         When showing commit messages, also show notes which are stored in
463         the given ref.  This ref is expected to contain files named
464         after the full SHA-1 of the commit they annotate.
466 If such a file exists in the given ref, the referenced blob is read, and
467 appended to the commit message, separated by a "Notes:" line.  If the
468 given ref itself does not exist, it is not an error, but means that no
469 notes should be printed.
471 This setting defaults to "refs/notes/commits", and can be overridden by
472 the `GIT_NOTES_REF` environment variable.
474 add.ignore-errors::
475         Tells 'git-add' to continue adding files when some files cannot be
476         added due to indexing errors. Equivalent to the '--ignore-errors'
477         option of linkgit:git-add[1].
479 alias.*::
480         Command aliases for the linkgit:git[1] command wrapper - e.g.
481         after defining "alias.last = cat-file commit HEAD", the invocation
482         "git last" is equivalent to "git cat-file commit HEAD". To avoid
483         confusion and troubles with script usage, aliases that
484         hide existing git commands are ignored. Arguments are split by
485         spaces, the usual shell quoting and escaping is supported.
486         quote pair and a backslash can be used to quote them.
488 If the alias expansion is prefixed with an exclamation point,
489 it will be treated as a shell command.  For example, defining
490 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
491 "git new" is equivalent to running the shell command
492 "gitk --all --not ORIG_HEAD".  Note that shell commands will be
493 executed from the top-level directory of a repository, which may
494 not necessarily be the current directory.
496 apply.ignorewhitespace::
497         When set to 'change', tells 'git-apply' to ignore changes in
498         whitespace, in the same way as the '--ignore-space-change'
499         option.
500         When set to one of: no, none, never, false tells 'git-apply' to
501         respect all whitespace differences.
502         See linkgit:git-apply[1].
504 apply.whitespace::
505         Tells 'git-apply' how to handle whitespaces, in the same way
506         as the '--whitespace' option. See linkgit:git-apply[1].
508 branch.autosetupmerge::
509         Tells 'git-branch' and 'git-checkout' to setup new branches
510         so that linkgit:git-pull[1] will appropriately merge from the
511         starting point branch. Note that even if this option is not set,
512         this behavior can be chosen per-branch using the `--track`
513         and `--no-track` options. The valid settings are: `false` -- no
514         automatic setup is done; `true` -- automatic setup is done when the
515         starting point is a remote branch; `always` -- automatic setup is
516         done when the starting point is either a local branch or remote
517         branch. This option defaults to true.
519 branch.autosetuprebase::
520         When a new branch is created with 'git-branch' or 'git-checkout'
521         that tracks another branch, this variable tells git to set
522         up pull to rebase instead of merge (see "branch.<name>.rebase").
523         When `never`, rebase is never automatically set to true.
524         When `local`, rebase is set to true for tracked branches of
525         other local branches.
526         When `remote`, rebase is set to true for tracked branches of
527         remote branches.
528         When `always`, rebase will be set to true for all tracking
529         branches.
530         See "branch.autosetupmerge" for details on how to set up a
531         branch to track another branch.
532         This option defaults to never.
534 branch.<name>.remote::
535         When in branch <name>, it tells 'git-fetch' and 'git-push' which
536         remote to fetch from/push to.  It defaults to `origin` if no remote is
537         configured. `origin` is also used if you are not on any branch.
539 branch.<name>.merge::
540         Defines, together with branch.<name>.remote, the upstream branch
541         for the given branch. It tells 'git-fetch'/'git-pull' which
542         branch to merge and can also affect 'git-push' (see push.default).
543         When in branch <name>, it tells 'git-fetch' the default
544         refspec to be marked for merging in FETCH_HEAD. The value is
545         handled like the remote part of a refspec, and must match a
546         ref which is fetched from the remote given by
547         "branch.<name>.remote".
548         The merge information is used by 'git-pull' (which at first calls
549         'git-fetch') to lookup the default branch for merging. Without
550         this option, 'git-pull' defaults to merge the first refspec fetched.
551         Specify multiple values to get an octopus merge.
552         If you wish to setup 'git-pull' so that it merges into <name> from
553         another branch in the local repository, you can point
554         branch.<name>.merge to the desired branch, and use the special setting
555         `.` (a period) for branch.<name>.remote.
557 branch.<name>.mergeoptions::
558         Sets default options for merging into branch <name>. The syntax and
559         supported options are equal to that of linkgit:git-merge[1], but
560         option values containing whitespace characters are currently not
561         supported.
563 branch.<name>.rebase::
564         When true, rebase the branch <name> on top of the fetched branch,
565         instead of merging the default branch from the default remote when
566         "git pull" is run.
567         *NOTE*: this is a possibly dangerous operation; do *not* use
568         it unless you understand the implications (see linkgit:git-rebase[1]
569         for details).
571 browser.<tool>.cmd::
572         Specify the command to invoke the specified browser. The
573         specified command is evaluated in shell with the URLs passed
574         as arguments. (See linkgit:git-web--browse[1].)
576 browser.<tool>.path::
577         Override the path for the given tool that may be used to
578         browse HTML help (see '-w' option in linkgit:git-help[1]) or a
579         working repository in gitweb (see linkgit:git-instaweb[1]).
581 clean.requireForce::
582         A boolean to make git-clean do nothing unless given -f
583         or -n.   Defaults to true.
585 color.branch::
586         A boolean to enable/disable color in the output of
587         linkgit:git-branch[1]. May be set to `always`,
588         `false` (or `never`) or `auto` (or `true`), in which case colors are used
589         only when the output is to a terminal. Defaults to false.
591 color.branch.<slot>::
592         Use customized color for branch coloration. `<slot>` is one of
593         `current` (the current branch), `local` (a local branch),
594         `remote` (a tracking branch in refs/remotes/), `plain` (other
595         refs).
597 The value for these configuration variables is a list of colors (at most
598 two) and attributes (at most one), separated by spaces.  The colors
599 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
600 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
601 `blink` and `reverse`.  The first color given is the foreground; the
602 second is the background.  The position of the attribute, if any,
603 doesn't matter.
605 color.diff::
606         When set to `always`, always use colors in patch.
607         When false (or `never`), never.  When set to `true` or `auto`, use
608         colors only when the output is to the terminal. Defaults to false.
610 color.diff.<slot>::
611         Use customized color for diff colorization.  `<slot>` specifies
612         which part of the patch to use the specified color, and is one
613         of `plain` (context text), `meta` (metainformation), `frag`
614         (hunk header), `old` (removed lines), `new` (added lines),
615         `commit` (commit headers), or `whitespace` (highlighting
616         whitespace errors). The values of these variables may be specified as
617         in color.branch.<slot>.
619 color.grep::
620         When set to `always`, always highlight matches.  When `false` (or
621         `never`), never.  When set to `true` or `auto`, use color only
622         when the output is written to the terminal.  Defaults to `false`.
624 color.grep.external::
625         The string value of this variable is passed to an external 'grep'
626         command as a command line option if match highlighting is turned
627         on.  If set to an empty string, no option is passed at all,
628         turning off coloring for external 'grep' calls; this is the default.
629         For GNU grep, set it to `--color=always` to highlight matches even
630         when a pager is used.
632 color.grep.match::
633         Use customized color for matches.  The value of this variable
634         may be specified as in color.branch.<slot>.  It is passed using
635         the environment variables 'GREP_COLOR' and 'GREP_COLORS' when
636         calling an external 'grep'.
638 color.interactive::
639         When set to `always`, always use colors for interactive prompts
640         and displays (such as those used by "git-add --interactive").
641         When false (or `never`), never.  When set to `true` or `auto`, use
642         colors only when the output is to the terminal. Defaults to false.
644 color.interactive.<slot>::
645         Use customized color for 'git-add --interactive'
646         output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
647         four distinct types of normal output from interactive
648         commands.  The values of these variables may be specified as
649         in color.branch.<slot>.
651 color.pager::
652         A boolean to enable/disable colored output when the pager is in
653         use (default is true).
655 color.showbranch::
656         A boolean to enable/disable color in the output of
657         linkgit:git-show-branch[1]. May be set to `always`,
658         `false` (or `never`) or `auto` (or `true`), in which case colors are used
659         only when the output is to a terminal. Defaults to false.
661 color.status::
662         A boolean to enable/disable color in the output of
663         linkgit:git-status[1]. May be set to `always`,
664         `false` (or `never`) or `auto` (or `true`), in which case colors are used
665         only when the output is to a terminal. Defaults to false.
667 color.status.<slot>::
668         Use customized color for status colorization. `<slot>` is
669         one of `header` (the header text of the status message),
670         `added` or `updated` (files which are added but not committed),
671         `changed` (files which are changed but not added in the index),
672         `untracked` (files which are not tracked by git), or
673         `nobranch` (the color the 'no branch' warning is shown in, defaulting
674         to red). The values of these variables may be specified as in
675         color.branch.<slot>.
677 color.ui::
678         When set to `always`, always use colors in all git commands which
679         are capable of colored output. When false (or `never`), never. When
680         set to `true` or `auto`, use colors only when the output is to the
681         terminal. When more specific variables of color.* are set, they always
682         take precedence over this setting. Defaults to false.
684 commit.template::
685         Specify a file to use as the template for new commit messages.
687 diff.autorefreshindex::
688         When using 'git-diff' to compare with work tree
689         files, do not consider stat-only change as changed.
690         Instead, silently run `git update-index --refresh` to
691         update the cached stat information for paths whose
692         contents in the work tree match the contents in the
693         index.  This option defaults to true.  Note that this
694         affects only 'git-diff' Porcelain, and not lower level
695         'diff' commands, such as 'git-diff-files'.
697 diff.external::
698         If this config variable is set, diff generation is not
699         performed using the internal diff machinery, but using the
700         given command.  Can be overridden with the `GIT_EXTERNAL_DIFF'
701         environment variable.  The command is called with parameters
702         as described under "git Diffs" in linkgit:git[1].  Note: if
703         you want to use an external diff program only on a subset of
704         your files, you might want to use linkgit:gitattributes[5] instead.
706 diff.mnemonicprefix::
707         If set, 'git-diff' uses a prefix pair that is different from the
708         standard "a/" and "b/" depending on what is being compared.  When
709         this configuration is in effect, reverse diff output also swaps
710         the order of the prefixes:
711 'git-diff';;
712         compares the (i)ndex and the (w)ork tree;
713 'git-diff HEAD';;
714          compares a (c)ommit and the (w)ork tree;
715 'git diff --cached';;
716         compares a (c)ommit and the (i)ndex;
717 'git-diff HEAD:file1 file2';;
718         compares an (o)bject and a (w)ork tree entity;
719 'git diff --no-index a b';;
720         compares two non-git things (1) and (2).
722 diff.renameLimit::
723         The number of files to consider when performing the copy/rename
724         detection; equivalent to the 'git-diff' option '-l'.
726 diff.renames::
727         Tells git to detect renames.  If set to any boolean value, it
728         will enable basic rename detection.  If set to "copies" or
729         "copy", it will detect copies, as well.
731 diff.suppressBlankEmpty::
732         A boolean to inhibit the standard behavior of printing a space
733         before each empty output line. Defaults to false.
735 diff.tool::
736         Controls which diff tool is used.  `diff.tool` overrides
737         `merge.tool` when used by linkgit:git-difftool[1] and has
738         the same valid values as `merge.tool` minus "tortoisemerge"
739         and plus "kompare".
741 difftool.<tool>.path::
742         Override the path for the given tool.  This is useful in case
743         your tool is not in the PATH.
745 difftool.<tool>.cmd::
746         Specify the command to invoke the specified diff tool.
747         The specified command is evaluated in shell with the following
748         variables available:  'LOCAL' is set to the name of the temporary
749         file containing the contents of the diff pre-image and 'REMOTE'
750         is set to the name of the temporary file containing the contents
751         of the diff post-image.
753 difftool.prompt::
754         Prompt before each invocation of the diff tool.
756 diff.wordRegex::
757         A POSIX Extended Regular Expression used to determine what is a "word"
758         when performing word-by-word difference calculations.  Character
759         sequences that match the regular expression are "words", all other
760         characters are *ignorable* whitespace.
762 fetch.unpackLimit::
763         If the number of objects fetched over the git native
764         transfer is below this
765         limit, then the objects will be unpacked into loose object
766         files. However if the number of received objects equals or
767         exceeds this limit then the received pack will be stored as
768         a pack, after adding any missing delta bases.  Storing the
769         pack from a push can make the push operation complete faster,
770         especially on slow filesystems.  If not set, the value of
771         `transfer.unpackLimit` is used instead.
773 format.attach::
774         Enable multipart/mixed attachments as the default for
775         'format-patch'.  The value can also be a double quoted string
776         which will enable attachments as the default and set the
777         value as the boundary.  See the --attach option in
778         linkgit:git-format-patch[1].
780 format.numbered::
781         A boolean which can enable or disable sequence numbers in patch
782         subjects.  It defaults to "auto" which enables it only if there
783         is more than one patch.  It can be enabled or disabled for all
784         messages by setting it to "true" or "false".  See --numbered
785         option in linkgit:git-format-patch[1].
787 format.headers::
788         Additional email headers to include in a patch to be submitted
789         by mail.  See linkgit:git-format-patch[1].
791 format.cc::
792         Additional "Cc:" headers to include in a patch to be submitted
793         by mail.  See the --cc option in linkgit:git-format-patch[1].
795 format.subjectprefix::
796         The default for format-patch is to output files with the '[PATCH]'
797         subject prefix. Use this variable to change that prefix.
799 format.suffix::
800         The default for format-patch is to output files with the suffix
801         `.patch`. Use this variable to change that suffix (make sure to
802         include the dot if you want it).
804 format.pretty::
805         The default pretty format for log/show/whatchanged command,
806         See linkgit:git-log[1], linkgit:git-show[1],
807         linkgit:git-whatchanged[1].
809 format.thread::
810         The default threading style for 'git-format-patch'.  Can be
811         either a boolean value, `shallow` or `deep`.  `shallow`
812         threading makes every mail a reply to the head of the series,
813         where the head is chosen from the cover letter, the
814         `\--in-reply-to`, and the first patch mail, in this order.
815         `deep` threading makes every mail a reply to the previous one.
816         A true boolean value is the same as `shallow`, and a false
817         value disables threading.
819 format.signoff::
820     A boolean value which lets you enable the `-s/--signoff` option of
821     format-patch by default. *Note:* Adding the Signed-off-by: line to a
822     patch should be a conscious act and means that you certify you have
823     the rights to submit this work under the same open source license.
824     Please see the 'SubmittingPatches' document for further discussion.
826 gc.aggressiveWindow::
827         The window size parameter used in the delta compression
828         algorithm used by 'git-gc --aggressive'.  This defaults
829         to 10.
831 gc.auto::
832         When there are approximately more than this many loose
833         objects in the repository, `git gc --auto` will pack them.
834         Some Porcelain commands use this command to perform a
835         light-weight garbage collection from time to time.  The
836         default value is 6700.  Setting this to 0 disables it.
838 gc.autopacklimit::
839         When there are more than this many packs that are not
840         marked with `*.keep` file in the repository, `git gc
841         --auto` consolidates them into one larger pack.  The
842         default value is 50.  Setting this to 0 disables it.
844 gc.packrefs::
845         'git-gc' does not run `git pack-refs` in a bare repository by
846         default so that older dumb-transport clients can still fetch
847         from the repository.  Setting this to `true` lets 'git-gc'
848         to run `git pack-refs`.  Setting this to `false` tells
849         'git-gc' never to run `git pack-refs`. The default setting is
850         `notbare`. Enable it only when you know you do not have to
851         support such clients.  The default setting will change to `true`
852         at some stage, and setting this to `false` will continue to
853         prevent `git pack-refs` from being run from 'git-gc'.
855 gc.pruneexpire::
856         When 'git-gc' is run, it will call 'prune --expire 2.weeks.ago'.
857         Override the grace period with this config variable.  The value
858         "now" may be used to disable this  grace period and always prune
859         unreachable objects immediately.
861 gc.reflogexpire::
862         'git-reflog expire' removes reflog entries older than
863         this time; defaults to 90 days.
865 gc.reflogexpireunreachable::
866         'git-reflog expire' removes reflog entries older than
867         this time and are not reachable from the current tip;
868         defaults to 30 days.
870 gc.rerereresolved::
871         Records of conflicted merge you resolved earlier are
872         kept for this many days when 'git-rerere gc' is run.
873         The default is 60 days.  See linkgit:git-rerere[1].
875 gc.rerereunresolved::
876         Records of conflicted merge you have not resolved are
877         kept for this many days when 'git-rerere gc' is run.
878         The default is 15 days.  See linkgit:git-rerere[1].
880 gitcvs.commitmsgannotation::
881         Append this string to each commit message. Set to empty string
882         to disable this feature. Defaults to "via git-CVS emulator".
884 gitcvs.enabled::
885         Whether the CVS server interface is enabled for this repository.
886         See linkgit:git-cvsserver[1].
888 gitcvs.logfile::
889         Path to a log file where the CVS server interface well... logs
890         various stuff. See linkgit:git-cvsserver[1].
892 gitcvs.usecrlfattr::
893         If true, the server will look up the `crlf` attribute for
894         files to determine the '-k' modes to use. If `crlf` is set,
895         the '-k' mode will be left blank, so cvs clients will
896         treat it as text. If `crlf` is explicitly unset, the file
897         will be set with '-kb' mode, which suppresses any newline munging
898         the client might otherwise do. If `crlf` is not specified,
899         then 'gitcvs.allbinary' is used. See linkgit:gitattributes[5].
901 gitcvs.allbinary::
902         This is used if 'gitcvs.usecrlfattr' does not resolve
903         the correct '-kb' mode to use. If true, all
904         unresolved files are sent to the client in
905         mode '-kb'. This causes the client to treat them
906         as binary files, which suppresses any newline munging it
907         otherwise might do. Alternatively, if it is set to "guess",
908         then the contents of the file are examined to decide if
909         it is binary, similar to 'core.autocrlf'.
911 gitcvs.dbname::
912         Database used by git-cvsserver to cache revision information
913         derived from the git repository. The exact meaning depends on the
914         used database driver, for SQLite (which is the default driver) this
915         is a filename. Supports variable substitution (see
916         linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
917         Default: '%Ggitcvs.%m.sqlite'
919 gitcvs.dbdriver::
920         Used Perl DBI driver. You can specify any available driver
921         for this here, but it might not work. git-cvsserver is tested
922         with 'DBD::SQLite', reported to work with 'DBD::Pg', and
923         reported *not* to work with 'DBD::mysql'. Experimental feature.
924         May not contain double colons (`:`). Default: 'SQLite'.
925         See linkgit:git-cvsserver[1].
927 gitcvs.dbuser, gitcvs.dbpass::
928         Database user and password. Only useful if setting 'gitcvs.dbdriver',
929         since SQLite has no concept of database users and/or passwords.
930         'gitcvs.dbuser' supports variable substitution (see
931         linkgit:git-cvsserver[1] for details).
933 gitcvs.dbTableNamePrefix::
934         Database table name prefix.  Prepended to the names of any
935         database tables used, allowing a single database to be used
936         for several repositories.  Supports variable substitution (see
937         linkgit:git-cvsserver[1] for details).  Any non-alphabetic
938         characters will be replaced with underscores.
940 All gitcvs variables except for 'gitcvs.usecrlfattr' and
941 'gitcvs.allbinary' can also be specified as
942 'gitcvs.<access_method>.<varname>' (where 'access_method'
943 is one of "ext" and "pserver") to make them apply only for the given
944 access method.
946 gui.commitmsgwidth::
947         Defines how wide the commit message window is in the
948         linkgit:git-gui[1]. "75" is the default.
950 gui.diffcontext::
951         Specifies how many context lines should be used in calls to diff
952         made by the linkgit:git-gui[1]. The default is "5".
954 gui.encoding::
955         Specifies the default encoding to use for displaying of
956         file contents in linkgit:git-gui[1] and linkgit:gitk[1].
957         It can be overridden by setting the 'encoding' attribute
958         for relevant files (see linkgit:gitattributes[5]).
959         If this option is not set, the tools default to the
960         locale encoding.
962 gui.matchtrackingbranch::
963         Determines if new branches created with linkgit:git-gui[1] should
964         default to tracking remote branches with matching names or
965         not. Default: "false".
967 gui.newbranchtemplate::
968         Is used as suggested name when creating new branches using the
969         linkgit:git-gui[1].
971 gui.pruneduringfetch::
972         "true" if linkgit:git-gui[1] should prune tracking branches when
973         performing a fetch. The default value is "false".
975 gui.trustmtime::
976         Determines if linkgit:git-gui[1] should trust the file modification
977         timestamp or not. By default the timestamps are not trusted.
979 gui.spellingdictionary::
980         Specifies the dictionary used for spell checking commit messages in
981         the linkgit:git-gui[1]. When set to "none" spell checking is turned
982         off.
984 gui.fastcopyblame::
985         If true, 'git gui blame' uses '-C' instead of '-C -C' for original
986         location detection. It makes blame significantly faster on huge
987         repositories at the expense of less thorough copy detection.
989 gui.copyblamethreshold::
990         Specifies the threshold to use in 'git gui blame' original location
991         detection, measured in alphanumeric characters. See the
992         linkgit:git-blame[1] manual for more information on copy detection.
994 gui.blamehistoryctx::
995         Specifies the radius of history context in days to show in
996         linkgit:gitk[1] for the selected commit, when the `Show History
997         Context` menu item is invoked from 'git gui blame'. If this
998         variable is set to zero, the whole history is shown.
1000 guitool.<name>.cmd::
1001         Specifies the shell command line to execute when the corresponding item
1002         of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1003         mandatory for every tool. The command is executed from the root of
1004         the working directory, and in the environment it receives the name of
1005         the tool as 'GIT_GUITOOL', the name of the currently selected file as
1006         'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1007         the head is detached, 'CUR_BRANCH' is empty).
1009 guitool.<name>.needsfile::
1010         Run the tool only if a diff is selected in the GUI. It guarantees
1011         that 'FILENAME' is not empty.
1013 guitool.<name>.noconsole::
1014         Run the command silently, without creating a window to display its
1015         output.
1017 guitool.<name>.norescan::
1018         Don't rescan the working directory for changes after the tool
1019         finishes execution.
1021 guitool.<name>.confirm::
1022         Show a confirmation dialog before actually running the tool.
1024 guitool.<name>.argprompt::
1025         Request a string argument from the user, and pass it to the tool
1026         through the 'ARGS' environment variable. Since requesting an
1027         argument implies confirmation, the 'confirm' option has no effect
1028         if this is enabled. If the option is set to 'true', 'yes', or '1',
1029         the dialog uses a built-in generic prompt; otherwise the exact
1030         value of the variable is used.
1032 guitool.<name>.revprompt::
1033         Request a single valid revision from the user, and set the
1034         'REVISION' environment variable. In other aspects this option
1035         is similar to 'argprompt', and can be used together with it.
1037 guitool.<name>.revunmerged::
1038         Show only unmerged branches in the 'revprompt' subdialog.
1039         This is useful for tools similar to merge or rebase, but not
1040         for things like checkout or reset.
1042 guitool.<name>.title::
1043         Specifies the title to use for the prompt dialog. The default
1044         is the tool name.
1046 guitool.<name>.prompt::
1047         Specifies the general prompt string to display at the top of
1048         the dialog, before subsections for 'argprompt' and 'revprompt'.
1049         The default value includes the actual command.
1051 help.browser::
1052         Specify the browser that will be used to display help in the
1053         'web' format. See linkgit:git-help[1].
1055 help.format::
1056         Override the default help format used by linkgit:git-help[1].
1057         Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1058         the default. 'web' and 'html' are the same.
1060 help.autocorrect::
1061         Automatically correct and execute mistyped commands after
1062         waiting for the given number of deciseconds (0.1 sec). If more
1063         than one command can be deduced from the entered text, nothing
1064         will be executed.  If the value of this option is negative,
1065         the corrected command will be executed immediately. If the
1066         value is 0 - the command will be just shown but not executed.
1067         This is the default.
1069 http.proxy::
1070         Override the HTTP proxy, normally configured using the 'http_proxy'
1071         environment variable (see linkgit:curl[1]).  This can be overridden
1072         on a per-remote basis; see remote.<name>.proxy
1074 http.sslVerify::
1075         Whether to verify the SSL certificate when fetching or pushing
1076         over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1077         variable.
1079 http.sslCert::
1080         File containing the SSL certificate when fetching or pushing
1081         over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1082         variable.
1084 http.sslKey::
1085         File containing the SSL private key when fetching or pushing
1086         over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1087         variable.
1089 http.sslCertPasswordProtected::
1090         Enable git's password prompt for the SSL certificate.  Otherwise
1091         OpenSSL will prompt the user, possibly many times, if the
1092         certificate or private key is encrypted.  Can be overridden by the
1093         'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1095 http.sslCAInfo::
1096         File containing the certificates to verify the peer with when
1097         fetching or pushing over HTTPS. Can be overridden by the
1098         'GIT_SSL_CAINFO' environment variable.
1100 http.sslCAPath::
1101         Path containing files with the CA certificates to verify the peer
1102         with when fetching or pushing over HTTPS. Can be overridden
1103         by the 'GIT_SSL_CAPATH' environment variable.
1105 http.maxRequests::
1106         How many HTTP requests to launch in parallel. Can be overridden
1107         by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1109 http.lowSpeedLimit, http.lowSpeedTime::
1110         If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1111         for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1112         Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1113         'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1115 http.noEPSV::
1116         A boolean which disables using of EPSV ftp command by curl.
1117         This can helpful with some "poor" ftp servers which don't
1118         support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1119         environment variable. Default is false (curl will use EPSV).
1121 i18n.commitEncoding::
1122         Character encoding the commit messages are stored in; git itself
1123         does not care per se, but this information is necessary e.g. when
1124         importing commits from emails or in the gitk graphical history
1125         browser (and possibly at other places in the future or in other
1126         porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1128 i18n.logOutputEncoding::
1129         Character encoding the commit messages are converted to when
1130         running 'git-log' and friends.
1132 imap::
1133         The configuration variables in the 'imap' section are described
1134         in linkgit:git-imap-send[1].
1136 instaweb.browser::
1137         Specify the program that will be used to browse your working
1138         repository in gitweb. See linkgit:git-instaweb[1].
1140 instaweb.httpd::
1141         The HTTP daemon command-line to start gitweb on your working
1142         repository. See linkgit:git-instaweb[1].
1144 instaweb.local::
1145         If true the web server started by linkgit:git-instaweb[1] will
1146         be bound to the local IP (127.0.0.1).
1148 instaweb.modulepath::
1149         The module path for an apache httpd used by linkgit:git-instaweb[1].
1151 instaweb.port::
1152         The port number to bind the gitweb httpd to. See
1153         linkgit:git-instaweb[1].
1155 interactive.singlekey::
1156         In interactive commands, allow the user to provide one-letter
1157         input with a single key (i.e., without hitting enter).
1158         Currently this is used only by the `\--patch` mode of
1159         linkgit:git-add[1].  Note that this setting is silently
1160         ignored if portable keystroke input is not available.
1162 log.date::
1163         Set default date-time mode for the log command. Setting log.date
1164         value is similar to using 'git-log'\'s --date option. The value is one of the
1165         following alternatives: {relative,local,default,iso,rfc,short}.
1166         See linkgit:git-log[1].
1168 log.showroot::
1169         If true, the initial commit will be shown as a big creation event.
1170         This is equivalent to a diff against an empty tree.
1171         Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1172         normally hide the root commit will now show it. True by default.
1174 mailmap.file::
1175         The location of an augmenting mailmap file. The default
1176         mailmap, located in the root of the repository, is loaded
1177         first, then the mailmap file pointed to by this variable.
1178         The location of the mailmap file may be in a repository
1179         subdirectory, or somewhere outside of the repository itself.
1180         See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1182 man.viewer::
1183         Specify the programs that may be used to display help in the
1184         'man' format. See linkgit:git-help[1].
1186 man.<tool>.cmd::
1187         Specify the command to invoke the specified man viewer. The
1188         specified command is evaluated in shell with the man page
1189         passed as argument. (See linkgit:git-help[1].)
1191 man.<tool>.path::
1192         Override the path for the given tool that may be used to
1193         display help in the 'man' format. See linkgit:git-help[1].
1195 include::merge-config.txt[]
1197 mergetool.<tool>.path::
1198         Override the path for the given tool.  This is useful in case
1199         your tool is not in the PATH.
1201 mergetool.<tool>.cmd::
1202         Specify the command to invoke the specified merge tool.  The
1203         specified command is evaluated in shell with the following
1204         variables available: 'BASE' is the name of a temporary file
1205         containing the common base of the files to be merged, if available;
1206         'LOCAL' is the name of a temporary file containing the contents of
1207         the file on the current branch; 'REMOTE' is the name of a temporary
1208         file containing the contents of the file from the branch being
1209         merged; 'MERGED' contains the name of the file to which the merge
1210         tool should write the results of a successful merge.
1212 mergetool.<tool>.trustExitCode::
1213         For a custom merge command, specify whether the exit code of
1214         the merge command can be used to determine whether the merge was
1215         successful.  If this is not set to true then the merge target file
1216         timestamp is checked and the merge assumed to have been successful
1217         if the file has been updated, otherwise the user is prompted to
1218         indicate the success of the merge.
1220 mergetool.keepBackup::
1221         After performing a merge, the original file with conflict markers
1222         can be saved as a file with a `.orig` extension.  If this variable
1223         is set to `false` then this file is not preserved.  Defaults to
1224         `true` (i.e. keep the backup files).
1226 mergetool.keepTemporaries::
1227         When invoking a custom merge tool, git uses a set of temporary
1228         files to pass to the tool. If the tool returns an error and this
1229         variable is set to `true`, then these temporary files will be
1230         preserved, otherwise they will be removed after the tool has
1231         exited. Defaults to `false`.
1233 mergetool.prompt::
1234         Prompt before each invocation of the merge resolution program.
1236 pack.window::
1237         The size of the window used by linkgit:git-pack-objects[1] when no
1238         window size is given on the command line. Defaults to 10.
1240 pack.depth::
1241         The maximum delta depth used by linkgit:git-pack-objects[1] when no
1242         maximum depth is given on the command line. Defaults to 50.
1244 pack.windowMemory::
1245         The window memory size limit used by linkgit:git-pack-objects[1]
1246         when no limit is given on the command line.  The value can be
1247         suffixed with "k", "m", or "g".  Defaults to 0, meaning no
1248         limit.
1250 pack.compression::
1251         An integer -1..9, indicating the compression level for objects
1252         in a pack file. -1 is the zlib default. 0 means no
1253         compression, and 1..9 are various speed/size tradeoffs, 9 being
1254         slowest.  If not set,  defaults to core.compression.  If that is
1255         not set,  defaults to -1, the zlib default, which is "a default
1256         compromise between speed and compression (currently equivalent
1257         to level 6)."
1259 pack.deltaCacheSize::
1260         The maximum memory in bytes used for caching deltas in
1261         linkgit:git-pack-objects[1] before writing them out to a pack.
1262         This cache is used to speed up the writing object phase by not
1263         having to recompute the final delta result once the best match
1264         for all objects is found.  Repacking large repositories on machines
1265         which are tight with memory might be badly impacted by this though,
1266         especially if this cache pushes the system into swapping.
1267         A value of 0 means no limit. The smallest size of 1 byte may be
1268         used to virtually disable this cache. Defaults to 256 MiB.
1270 pack.deltaCacheLimit::
1271         The maximum size of a delta, that is cached in
1272         linkgit:git-pack-objects[1]. This cache is used to speed up the
1273         writing object phase by not having to recompute the final delta
1274         result once the best match for all objects is found. Defaults to 1000.
1276 pack.threads::
1277         Specifies the number of threads to spawn when searching for best
1278         delta matches.  This requires that linkgit:git-pack-objects[1]
1279         be compiled with pthreads otherwise this option is ignored with a
1280         warning. This is meant to reduce packing time on multiprocessor
1281         machines. The required amount of memory for the delta search window
1282         is however multiplied by the number of threads.
1283         Specifying 0 will cause git to auto-detect the number of CPU's
1284         and set the number of threads accordingly.
1286 pack.indexVersion::
1287         Specify the default pack index version.  Valid values are 1 for
1288         legacy pack index used by Git versions prior to 1.5.2, and 2 for
1289         the new pack index with capabilities for packs larger than 4 GB
1290         as well as proper protection against the repacking of corrupted
1291         packs.  Version 2 is the default.  Note that version 2 is enforced
1292         and this config option ignored whenever the corresponding pack is
1293         larger than 2 GB.
1295 If you have an old git that does not understand the version 2 `{asterisk}.idx` file,
1296 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1297 that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the
1298 other side may give you a repository that cannot be accessed with your
1299 older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,
1300 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1301 the `{asterisk}.idx` file.
1303 pack.packSizeLimit::
1304         The default maximum size of a pack.  This setting only affects
1305         packing to a file, i.e. the git:// protocol is unaffected.  It
1306         can be overridden by the `\--max-pack-size` option of
1307         linkgit:git-repack[1].
1309 pager.<cmd>::
1310         Allows turning on or off pagination of the output of a
1311         particular git subcommand when writing to a tty.  If
1312         `\--paginate` or `\--no-pager` is specified on the command line,
1313         it takes precedence over this option.  To disable pagination for
1314         all commands, set `core.pager` or `GIT_PAGER` to `cat`.
1316 pull.octopus::
1317         The default merge strategy to use when pulling multiple branches
1318         at once.
1320 pull.twohead::
1321         The default merge strategy to use when pulling a single branch.
1323 push.default::
1324         Defines the action git push should take if no refspec is given
1325         on the command line, no refspec is configured in the remote, and
1326         no refspec is implied by any of the options given on the command
1327         line. Possible values are:
1329 * `nothing` do not push anything.
1330 * `matching` push all matching branches.
1331   All branches having the same name in both ends are considered to be
1332   matching. This is the default.
1333 * `tracking` push the current branch to its upstream branch.
1334 * `current` push the current branch to a branch of the same name.
1336 rebase.stat::
1337         Whether to show a diffstat of what changed upstream since the last
1338         rebase. False by default.
1340 receive.fsckObjects::
1341         If it is set to true, git-receive-pack will check all received
1342         objects. It will abort in the case of a malformed object or a
1343         broken link. The result of an abort are only dangling objects.
1344         Defaults to false.
1346 receive.unpackLimit::
1347         If the number of objects received in a push is below this
1348         limit then the objects will be unpacked into loose object
1349         files. However if the number of received objects equals or
1350         exceeds this limit then the received pack will be stored as
1351         a pack, after adding any missing delta bases.  Storing the
1352         pack from a push can make the push operation complete faster,
1353         especially on slow filesystems.  If not set, the value of
1354         `transfer.unpackLimit` is used instead.
1356 receive.denyDeletes::
1357         If set to true, git-receive-pack will deny a ref update that deletes
1358         the ref. Use this to prevent such a ref deletion via a push.
1360 receive.denyCurrentBranch::
1361         If set to true or "refuse", receive-pack will deny a ref update
1362         to the currently checked out branch of a non-bare repository.
1363         Such a push is potentially dangerous because it brings the HEAD
1364         out of sync with the index and working tree. If set to "warn",
1365         print a warning of such a push to stderr, but allow the push to
1366         proceed. If set to false or "ignore", allow such pushes with no
1367         message. Defaults to "warn".
1369 receive.denyNonFastForwards::
1370         If set to true, git-receive-pack will deny a ref update which is
1371         not a fast forward. Use this to prevent such an update via a push,
1372         even if that push is forced. This configuration variable is
1373         set when initializing a shared repository.
1375 remote.<name>.url::
1376         The URL of a remote repository.  See linkgit:git-fetch[1] or
1377         linkgit:git-push[1].
1379 remote.<name>.pushurl::
1380         The push URL of a remote repository.  See linkgit:git-push[1].
1382 remote.<name>.proxy::
1383         For remotes that require curl (http, https and ftp), the URL to
1384         the proxy to use for that remote.  Set to the empty string to
1385         disable proxying for that remote.
1387 remote.<name>.fetch::
1388         The default set of "refspec" for linkgit:git-fetch[1]. See
1389         linkgit:git-fetch[1].
1391 remote.<name>.push::
1392         The default set of "refspec" for linkgit:git-push[1]. See
1393         linkgit:git-push[1].
1395 remote.<name>.mirror::
1396         If true, pushing to this remote will automatically behave
1397         as if the `\--mirror` option was given on the command line.
1399 remote.<name>.skipDefaultUpdate::
1400         If true, this remote will be skipped by default when updating
1401         using the update subcommand of linkgit:git-remote[1].
1403 remote.<name>.receivepack::
1404         The default program to execute on the remote side when pushing.  See
1405         option \--receive-pack of linkgit:git-push[1].
1407 remote.<name>.uploadpack::
1408         The default program to execute on the remote side when fetching.  See
1409         option \--upload-pack of linkgit:git-fetch-pack[1].
1411 remote.<name>.tagopt::
1412         Setting this value to \--no-tags disables automatic tag following when
1413         fetching from remote <name>
1415 remotes.<group>::
1416         The list of remotes which are fetched by "git remote update
1417         <group>".  See linkgit:git-remote[1].
1419 repack.usedeltabaseoffset::
1420         By default, linkgit:git-repack[1] creates packs that use
1421         delta-base offset. If you need to share your repository with
1422         git older than version 1.4.4, either directly or via a dumb
1423         protocol such as http, then you need to set this option to
1424         "false" and repack. Access from old git versions over the
1425         native protocol are unaffected by this option.
1427 rerere.autoupdate::
1428         When set to true, `git-rerere` updates the index with the
1429         resulting contents after it cleanly resolves conflicts using
1430         previously recorded resolution.  Defaults to false.
1432 rerere.enabled::
1433         Activate recording of resolved conflicts, so that identical
1434         conflict hunks can be resolved automatically, should they
1435         be encountered again.  linkgit:git-rerere[1] command is by
1436         default enabled if you create `rr-cache` directory under
1437         `$GIT_DIR`, but can be disabled by setting this option to false.
1439 sendemail.identity::
1440         A configuration identity. When given, causes values in the
1441         'sendemail.<identity>' subsection to take precedence over
1442         values in the 'sendemail' section. The default identity is
1443         the value of 'sendemail.identity'.
1445 sendemail.smtpencryption::
1446         See linkgit:git-send-email[1] for description.  Note that this
1447         setting is not subject to the 'identity' mechanism.
1449 sendemail.smtpssl::
1450         Deprecated alias for 'sendemail.smtpencryption = ssl'.
1452 sendemail.<identity>.*::
1453         Identity-specific versions of the 'sendemail.*' parameters
1454         found below, taking precedence over those when the this
1455         identity is selected, through command-line or
1456         'sendemail.identity'.
1458 sendemail.aliasesfile::
1459 sendemail.aliasfiletype::
1460 sendemail.bcc::
1461 sendemail.cc::
1462 sendemail.cccmd::
1463 sendemail.chainreplyto::
1464 sendemail.confirm::
1465 sendemail.envelopesender::
1466 sendemail.from::
1467 sendemail.multiedit::
1468 sendemail.signedoffbycc::
1469 sendemail.smtppass::
1470 sendemail.suppresscc::
1471 sendemail.suppressfrom::
1472 sendemail.to::
1473 sendemail.smtpserver::
1474 sendemail.smtpserverport::
1475 sendemail.smtpuser::
1476 sendemail.thread::
1477 sendemail.validate::
1478         See linkgit:git-send-email[1] for description.
1480 sendemail.signedoffcc::
1481         Deprecated alias for 'sendemail.signedoffbycc'.
1483 showbranch.default::
1484         The default set of branches for linkgit:git-show-branch[1].
1485         See linkgit:git-show-branch[1].
1487 status.relativePaths::
1488         By default, linkgit:git-status[1] shows paths relative to the
1489         current directory. Setting this variable to `false` shows paths
1490         relative to the repository root (this was the default for git
1491         prior to v1.5.4).
1493 status.showUntrackedFiles::
1494         By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1495         files which are not currently tracked by Git. Directories which
1496         contain only untracked files, are shown with the directory name
1497         only. Showing untracked files means that Git needs to lstat() all
1498         all the files in the whole repository, which might be slow on some
1499         systems. So, this variable controls how the commands displays
1500         the untracked files. Possible values are:
1503         - 'no'     - Show no untracked files
1504         - 'normal' - Shows untracked files and directories
1505         - 'all'    - Shows also individual files in untracked directories.
1508 If this variable is not specified, it defaults to 'normal'.
1509 This variable can be overridden with the -u|--untracked-files option
1510 of linkgit:git-status[1] and linkgit:git-commit[1].
1512 tar.umask::
1513         This variable can be used to restrict the permission bits of
1514         tar archive entries.  The default is 0002, which turns off the
1515         world write bit.  The special value "user" indicates that the
1516         archiving user's umask will be used instead.  See umask(2) and
1517         linkgit:git-archive[1].
1519 transfer.unpackLimit::
1520         When `fetch.unpackLimit` or `receive.unpackLimit` are
1521         not set, the value of this variable is used instead.
1522         The default value is 100.
1524 url.<base>.insteadOf::
1525         Any URL that starts with this value will be rewritten to
1526         start, instead, with <base>. In cases where some site serves a
1527         large number of repositories, and serves them with multiple
1528         access methods, and some users need to use different access
1529         methods, this feature allows people to specify any of the
1530         equivalent URLs and have git automatically rewrite the URL to
1531         the best alternative for the particular user, even for a
1532         never-before-seen repository on the site.  When more than one
1533         insteadOf strings match a given URL, the longest match is used.
1535 url.<base>.pushInsteadOf::
1536         Any URL that starts with this value will not be pushed to;
1537         instead, it will be rewritten to start with <base>, and the
1538         resulting URL will be pushed to. In cases where some site serves
1539         a large number of repositories, and serves them with multiple
1540         access methods, some of which do not allow push, this feature
1541         allows people to specify a pull-only URL and have git
1542         automatically use an appropriate URL to push, even for a
1543         never-before-seen repository on the site.  When more than one
1544         pushInsteadOf strings match a given URL, the longest match is
1545         used.  If a remote has an explicit pushurl, git will ignore this
1546         setting for that remote.
1548 user.email::
1549         Your email address to be recorded in any newly created commits.
1550         Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
1551         'EMAIL' environment variables.  See linkgit:git-commit-tree[1].
1553 user.name::
1554         Your full name to be recorded in any newly created commits.
1555         Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
1556         environment variables.  See linkgit:git-commit-tree[1].
1558 user.signingkey::
1559         If linkgit:git-tag[1] is not selecting the key you want it to
1560         automatically when creating a signed tag, you can override the
1561         default selection with this variable.  This option is passed
1562         unchanged to gpg's --local-user parameter, so you may specify a key
1563         using any method that gpg supports.
1565 web.browser::
1566         Specify a web browser that may be used by some commands.
1567         Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
1568         may use it.