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