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