push: switch default from "matching" to "simple"
[alt-git.git] / Documentation / config.txt
blob2fe88f00a84a5e0752b46c8dfb05733aa0b936a6
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, allow only alphanumeric
16 characters and `-`, and must start with an alphabetic character.  Some
17 variables may appear multiple times.
19 Syntax
20 ~~~~~~
22 The syntax is fairly flexible and permissive; whitespaces are mostly
23 ignored.  The '#' and ';' characters begin comments to the end of line,
24 blank lines are ignored.
26 The file consists of sections and variables.  A section begins with
27 the name of the section in square brackets and continues until the next
28 section begins.  Section names are not case sensitive.  Only alphanumeric
29 characters, `-` and `.` are allowed in section names.  Each variable
30 must belong to some section, which means that there must be a section
31 header before the first setting of a variable.
33 Sections can be further divided into subsections.  To begin a subsection
34 put its name in double quotes, separated by space from the section name,
35 in the section header, like in the example below:
37 --------
38         [section "subsection"]
40 --------
42 Subsection names are case sensitive and can contain any characters except
43 newline (doublequote `"` and backslash have to be escaped as `\"` and `\\`,
44 respectively).  Section headers cannot span multiple
45 lines.  Variables may belong directly to a section or to a given subsection.
46 You can have `[section]` if you have `[section "subsection"]`, but you
47 don't need to.
49 There is also a deprecated `[section.subsection]` syntax. With this
50 syntax, the subsection name is converted to lower-case and is also
51 compared case sensitively. These subsection names follow the same
52 restrictions as section names.
54 All the other lines (and the remainder of the line after the section
55 header) are recognized as setting variables, in the form
56 'name = value'.  If there is no equal sign on the line, the entire line
57 is taken as 'name' and the variable is recognized as boolean "true".
58 The variable names are case-insensitive, allow only alphanumeric characters
59 and `-`, and must start with an alphabetic character.  There can be more
60 than one value for a given variable; we say then that the variable is
61 multivalued.
63 Leading and trailing whitespace in a variable value is discarded.
64 Internal whitespace within a variable value is retained verbatim.
66 The values following the equals sign in variable assign are all either
67 a string, an integer, or a boolean.  Boolean values may be given as yes/no,
68 1/0, true/false or on/off.  Case is not significant in boolean values, when
69 converting value to the canonical form using '--bool' type specifier;
70 'git config' will ensure that the output is "true" or "false".
72 String values may be entirely or partially enclosed in double quotes.
73 You need to enclose variable values in double quotes if you want to
74 preserve leading or trailing whitespace, or if the variable value contains
75 comment characters (i.e. it contains '#' or ';').
76 Double quote `"` and backslash `\` characters in variable values must
77 be escaped: use `\"` for `"` and `\\` for `\`.
79 The following escape sequences (beside `\"` and `\\`) are recognized:
80 `\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
81 and `\b` for backspace (BS).  No other char escape sequence, nor octal
82 char sequences are valid.
84 Variable values ending in a `\` are continued on the next line in the
85 customary UNIX fashion.
87 Some variables may require a special value format.
89 Includes
90 ~~~~~~~~
92 You can include one config file from another by setting the special
93 `include.path` variable to the name of the file to be included. The
94 included file is expanded immediately, as if its contents had been
95 found at the location of the include directive. If the value of the
96 `include.path` variable is a relative path, the path is considered to be
97 relative to the configuration file in which the include directive was
98 found. The value of `include.path` is subject to tilde expansion: `~/`
99 is expanded to the value of `$HOME`, and `~user/` to the specified
100 user's home directory. See below for examples.
102 Example
103 ~~~~~~~
105         # Core variables
106         [core]
107                 ; Don't trust file modes
108                 filemode = false
110         # Our diff algorithm
111         [diff]
112                 external = /usr/local/bin/diff-wrapper
113                 renames = true
115         [branch "devel"]
116                 remote = origin
117                 merge = refs/heads/devel
119         # Proxy settings
120         [core]
121                 gitProxy="ssh" for "kernel.org"
122                 gitProxy=default-proxy ; for the rest
124         [include]
125                 path = /path/to/foo.inc ; include by absolute path
126                 path = foo ; expand "foo" relative to the current file
127                 path = ~/foo ; expand "foo" in your $HOME directory
129 Variables
130 ~~~~~~~~~
132 Note that this list is non-comprehensive and not necessarily complete.
133 For command-specific variables, you will find a more detailed description
134 in the appropriate manual page. You will find a description of non-core
135 porcelain configuration variables in the respective porcelain documentation.
137 advice.*::
138         These variables control various optional help messages designed to
139         aid new users. All 'advice.*' variables default to 'true', and you
140         can tell Git that you do not need help by setting these to 'false':
143         pushNonFastForward::
144                 Set this variable to 'false' if you want to disable
145                 'pushNonFFCurrent', and
146                 'pushNonFFMatching' simultaneously.
147         pushNonFFCurrent::
148                 Advice shown when linkgit:git-push[1] fails due to a
149                 non-fast-forward update to the current branch.
150         pushNonFFMatching::
151                 Advice shown when you ran linkgit:git-push[1] and pushed
152                 'matching refs' explicitly (i.e. you used ':', or
153                 specified a refspec that isn't your current branch) and
154                 it resulted in a non-fast-forward error.
155         statusHints::
156                 Show directions on how to proceed from the current
157                 state in the output of linkgit:git-status[1], in
158                 the template shown when writing commit messages in
159                 linkgit:git-commit[1], and in the help message shown
160                 by linkgit:git-checkout[1] when switching branch.
161         commitBeforeMerge::
162                 Advice shown when linkgit:git-merge[1] refuses to
163                 merge to avoid overwriting local changes.
164         resolveConflict::
165                 Advices shown by various commands when conflicts
166                 prevent the operation from being performed.
167         implicitIdentity::
168                 Advice on how to set your identity configuration when
169                 your information is guessed from the system username and
170                 domain name.
171         detachedHead::
172                 Advice shown when you used linkgit:git-checkout[1] to
173                 move to the detach HEAD state, to instruct how to create
174                 a local branch after the fact.
175         amWorkDir::
176                 Advice that shows the location of the patch file when
177                 linkgit:git-am[1] fails to apply it.
180 core.fileMode::
181         If false, the executable bit differences between the index and
182         the working tree are ignored; useful on broken filesystems like FAT.
183         See linkgit:git-update-index[1].
185 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
186 will probe and set core.fileMode false if appropriate when the
187 repository is created.
189 core.ignoreCygwinFSTricks::
190         This option is only used by Cygwin implementation of Git. If false,
191         the Cygwin stat() and lstat() functions are used. This may be useful
192         if your repository consists of a few separate directories joined in
193         one hierarchy using Cygwin mount. If true, Git uses native Win32 API
194         whenever it is possible and falls back to Cygwin functions only to
195         handle symbol links. The native mode is more than twice faster than
196         normal Cygwin l/stat() functions. True by default, unless core.filemode
197         is true, in which case ignoreCygwinFSTricks is ignored as Cygwin's
198         POSIX emulation is required to support core.filemode.
200 core.ignorecase::
201         If true, this option enables various workarounds to enable
202         git to work better on filesystems that are not case sensitive,
203         like FAT. For example, if a directory listing finds
204         "makefile" when git expects "Makefile", git will assume
205         it is really the same file, and continue to remember it as
206         "Makefile".
208 The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
209 will probe and set core.ignorecase true if appropriate when the repository
210 is created.
212 core.precomposeunicode::
213         This option is only used by Mac OS implementation of git.
214         When core.precomposeunicode=true, git reverts the unicode decomposition
215         of filenames done by Mac OS. This is useful when sharing a repository
216         between Mac OS and Linux or Windows.
217         (Git for Windows 1.7.10 or higher is needed, or git under cygwin 1.7).
218         When false, file names are handled fully transparent by git,
219         which is backward compatible with older versions of git.
221 core.trustctime::
222         If false, the ctime differences between the index and the
223         working tree are ignored; useful when the inode change time
224         is regularly modified by something outside Git (file system
225         crawlers and some backup systems).
226         See linkgit:git-update-index[1]. True by default.
228 core.quotepath::
229         The commands that output paths (e.g. 'ls-files',
230         'diff'), when not given the `-z` option, will quote
231         "unusual" characters in the pathname by enclosing the
232         pathname in a double-quote pair and with backslashes the
233         same way strings in C source code are quoted.  If this
234         variable is set to false, the bytes higher than 0x80 are
235         not quoted but output as verbatim.  Note that double
236         quote, backslash and control characters are always
237         quoted without `-z` regardless of the setting of this
238         variable.
240 core.eol::
241         Sets the line ending type to use in the working directory for
242         files that have the `text` property set.  Alternatives are
243         'lf', 'crlf' and 'native', which uses the platform's native
244         line ending.  The default value is `native`.  See
245         linkgit:gitattributes[5] for more information on end-of-line
246         conversion.
248 core.safecrlf::
249         If true, makes git check if converting `CRLF` is reversible when
250         end-of-line conversion is active.  Git will verify if a command
251         modifies a file in the work tree either directly or indirectly.
252         For example, committing a file followed by checking out the
253         same file should yield the original file in the work tree.  If
254         this is not the case for the current setting of
255         `core.autocrlf`, git will reject the file.  The variable can
256         be set to "warn", in which case git will only warn about an
257         irreversible conversion but continue the operation.
259 CRLF conversion bears a slight chance of corrupting data.
260 When it is enabled, git will convert CRLF to LF during commit and LF to
261 CRLF during checkout.  A file that contains a mixture of LF and
262 CRLF before the commit cannot be recreated by git.  For text
263 files this is the right thing to do: it corrects line endings
264 such that we have only LF line endings in the repository.
265 But for binary files that are accidentally classified as text the
266 conversion can corrupt data.
268 If you recognize such corruption early you can easily fix it by
269 setting the conversion type explicitly in .gitattributes.  Right
270 after committing you still have the original file in your work
271 tree and this file is not yet corrupted.  You can explicitly tell
272 git that this file is binary and git will handle the file
273 appropriately.
275 Unfortunately, the desired effect of cleaning up text files with
276 mixed line endings and the undesired effect of corrupting binary
277 files cannot be distinguished.  In both cases CRLFs are removed
278 in an irreversible way.  For text files this is the right thing
279 to do because CRLFs are line endings, while for binary files
280 converting CRLFs corrupts data.
282 Note, this safety check does not mean that a checkout will generate a
283 file identical to the original file for a different setting of
284 `core.eol` and `core.autocrlf`, but only for the current one.  For
285 example, a text file with `LF` would be accepted with `core.eol=lf`
286 and could later be checked out with `core.eol=crlf`, in which case the
287 resulting file would contain `CRLF`, although the original file
288 contained `LF`.  However, in both work trees the line endings would be
289 consistent, that is either all `LF` or all `CRLF`, but never mixed.  A
290 file with mixed line endings would be reported by the `core.safecrlf`
291 mechanism.
293 core.autocrlf::
294         Setting this variable to "true" is almost the same as setting
295         the `text` attribute to "auto" on all files except that text
296         files are not guaranteed to be normalized: files that contain
297         `CRLF` in the repository will not be touched.  Use this
298         setting if you want to have `CRLF` line endings in your
299         working directory even though the repository does not have
300         normalized line endings.  This variable can be set to 'input',
301         in which case no output conversion is performed.
303 core.symlinks::
304         If false, symbolic links are checked out as small plain files that
305         contain the link text. linkgit:git-update-index[1] and
306         linkgit:git-add[1] will not change the recorded type to regular
307         file. Useful on filesystems like FAT that do not support
308         symbolic links.
310 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
311 will probe and set core.symlinks false if appropriate when the repository
312 is created.
314 core.gitProxy::
315         A "proxy command" to execute (as 'command host port') instead
316         of establishing direct connection to the remote server when
317         using the git protocol for fetching. If the variable value is
318         in the "COMMAND for DOMAIN" format, the command is applied only
319         on hostnames ending with the specified domain string. This variable
320         may be set multiple times and is matched in the given order;
321         the first match wins.
323 Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
324 (which always applies universally, without the special "for"
325 handling).
327 The special string `none` can be used as the proxy command to
328 specify that no proxy be used for a given domain pattern.
329 This is useful for excluding servers inside a firewall from
330 proxy use, while defaulting to a common proxy for external domains.
332 core.ignoreStat::
333         If true, commands which modify both the working tree and the index
334         will mark the updated paths with the "assume unchanged" bit in the
335         index. These marked files are then assumed to stay unchanged in the
336         working tree, until you mark them otherwise manually - Git will not
337         detect the file changes by lstat() calls. This is useful on systems
338         where those are very slow, such as Microsoft Windows.
339         See linkgit:git-update-index[1].
340         False by default.
342 core.preferSymlinkRefs::
343         Instead of the default "symref" format for HEAD
344         and other symbolic reference files, use symbolic links.
345         This is sometimes needed to work with old scripts that
346         expect HEAD to be a symbolic link.
348 core.bare::
349         If true this repository is assumed to be 'bare' and has no
350         working directory associated with it.  If this is the case a
351         number of commands that require a working directory will be
352         disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
354 This setting is automatically guessed by linkgit:git-clone[1] or
355 linkgit:git-init[1] when the repository was created.  By default a
356 repository that ends in "/.git" is assumed to be not bare (bare =
357 false), while all other repositories are assumed to be bare (bare
358 = true).
360 core.worktree::
361         Set the path to the root of the working tree.
362         This can be overridden by the GIT_WORK_TREE environment
363         variable and the '--work-tree' command line option.
364         The value can be an absolute path or relative to the path to
365         the .git directory, which is either specified by --git-dir
366         or GIT_DIR, or automatically discovered.
367         If --git-dir or GIT_DIR is specified but none of
368         --work-tree, GIT_WORK_TREE and core.worktree is specified,
369         the current working directory is regarded as the top level
370         of your working tree.
372 Note that this variable is honored even when set in a configuration
373 file in a ".git" subdirectory of a directory and its value differs
374 from the latter directory (e.g. "/path/to/.git/config" has
375 core.worktree set to "/different/path"), which is most likely a
376 misconfiguration.  Running git commands in the "/path/to" directory will
377 still use "/different/path" as the root of the work tree and can cause
378 confusion unless you know what you are doing (e.g. you are creating a
379 read-only snapshot of the same index to a location different from the
380 repository's usual working tree).
382 core.logAllRefUpdates::
383         Enable the reflog. Updates to a ref <ref> is logged to the file
384         "$GIT_DIR/logs/<ref>", by appending the new and old
385         SHA1, the date/time and the reason of the update, but
386         only when the file exists.  If this configuration
387         variable is set to true, missing "$GIT_DIR/logs/<ref>"
388         file is automatically created for branch heads (i.e. under
389         refs/heads/), remote refs (i.e. under refs/remotes/),
390         note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
392 This information can be used to determine what commit
393 was the tip of a branch "2 days ago".
395 This value is true by default in a repository that has
396 a working directory associated with it, and false by
397 default in a bare repository.
399 core.repositoryFormatVersion::
400         Internal variable identifying the repository format and layout
401         version.
403 core.sharedRepository::
404         When 'group' (or 'true'), the repository is made shareable between
405         several users in a group (making sure all the files and objects are
406         group-writable). When 'all' (or 'world' or 'everybody'), the
407         repository will be readable by all users, additionally to being
408         group-shareable. When 'umask' (or 'false'), git will use permissions
409         reported by umask(2). When '0xxx', where '0xxx' is an octal number,
410         files in the repository will have this mode value. '0xxx' will override
411         user's umask value (whereas the other options will only override
412         requested parts of the user's umask value). Examples: '0660' will make
413         the repo read/write-able for the owner and group, but inaccessible to
414         others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
415         repository that is group-readable but not group-writable.
416         See linkgit:git-init[1]. False by default.
418 core.warnAmbiguousRefs::
419         If true, git will warn you if the ref name you passed it is ambiguous
420         and might match multiple refs in the .git/refs/ tree. True by default.
422 core.compression::
423         An integer -1..9, indicating a default compression level.
424         -1 is the zlib default. 0 means no compression,
425         and 1..9 are various speed/size tradeoffs, 9 being slowest.
426         If set, this provides a default to other compression variables,
427         such as 'core.loosecompression' and 'pack.compression'.
429 core.loosecompression::
430         An integer -1..9, indicating the compression level for objects that
431         are not in a pack file. -1 is the zlib default. 0 means no
432         compression, and 1..9 are various speed/size tradeoffs, 9 being
433         slowest.  If not set,  defaults to core.compression.  If that is
434         not set,  defaults to 1 (best speed).
436 core.packedGitWindowSize::
437         Number of bytes of a pack file to map into memory in a
438         single mapping operation.  Larger window sizes may allow
439         your system to process a smaller number of large pack files
440         more quickly.  Smaller window sizes will negatively affect
441         performance due to increased calls to the operating system's
442         memory manager, but may improve performance when accessing
443         a large number of large pack files.
445 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
446 MiB on 32 bit platforms and 1 GiB on 64 bit platforms.  This should
447 be reasonable for all users/operating systems.  You probably do
448 not need to adjust this value.
450 Common unit suffixes of 'k', 'm', or 'g' are supported.
452 core.packedGitLimit::
453         Maximum number of bytes to map simultaneously into memory
454         from pack files.  If Git needs to access more than this many
455         bytes at once to complete an operation it will unmap existing
456         regions to reclaim virtual address space within the process.
458 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
459 This should be reasonable for all users/operating systems, except on
460 the largest projects.  You probably do not need to adjust this value.
462 Common unit suffixes of 'k', 'm', or 'g' are supported.
464 core.deltaBaseCacheLimit::
465         Maximum number of bytes to reserve for caching base objects
466         that may be referenced by multiple deltified objects.  By storing the
467         entire decompressed base objects in a cache Git is able
468         to avoid unpacking and decompressing frequently used base
469         objects multiple times.
471 Default is 16 MiB on all platforms.  This should be reasonable
472 for all users/operating systems, except on the largest projects.
473 You probably do not need to adjust this value.
475 Common unit suffixes of 'k', 'm', or 'g' are supported.
477 core.bigFileThreshold::
478         Files larger than this size are stored deflated, without
479         attempting delta compression.  Storing large files without
480         delta compression avoids excessive memory usage, at the
481         slight expense of increased disk usage.
483 Default is 512 MiB on all platforms.  This should be reasonable
484 for most projects as source code and other text files can still
485 be delta compressed, but larger binary media files won't be.
487 Common unit suffixes of 'k', 'm', or 'g' are supported.
489 core.excludesfile::
490         In addition to '.gitignore' (per-directory) and
491         '.git/info/exclude', git looks into this file for patterns
492         of files which are not meant to be tracked.  "`~/`" is expanded
493         to the value of `$HOME` and "`~user/`" to the specified user's
494         home directory. Its default value is $XDG_CONFIG_HOME/git/ignore.
495         If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore
496         is used instead. See linkgit:gitignore[5].
498 core.askpass::
499         Some commands (e.g. svn and http interfaces) that interactively
500         ask for a password can be told to use an external program given
501         via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
502         environment variable. If not set, fall back to the value of the
503         'SSH_ASKPASS' environment variable or, failing that, a simple password
504         prompt. The external program shall be given a suitable prompt as
505         command line argument and write the password on its STDOUT.
507 core.attributesfile::
508         In addition to '.gitattributes' (per-directory) and
509         '.git/info/attributes', git looks into this file for attributes
510         (see linkgit:gitattributes[5]). Path expansions are made the same
511         way as for `core.excludesfile`. Its default value is
512         $XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not
513         set or empty, $HOME/.config/git/attributes is used instead.
515 core.editor::
516         Commands such as `commit` and `tag` that lets you edit
517         messages by launching an editor uses the value of this
518         variable when it is set, and the environment variable
519         `GIT_EDITOR` is not set.  See linkgit:git-var[1].
521 sequence.editor::
522         Text editor used by `git rebase -i` for editing the rebase insn file.
523         The value is meant to be interpreted by the shell when it is used.
524         It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
525         When not configured the default commit message editor is used instead.
527 core.pager::
528         The command that git will use to paginate output.  Can
529         be overridden with the `GIT_PAGER` environment
530         variable.  Note that git sets the `LESS` environment
531         variable to `FRSX` if it is unset when it runs the
532         pager.  One can change these settings by setting the
533         `LESS` variable to some other value.  Alternately,
534         these settings can be overridden on a project or
535         global basis by setting the `core.pager` option.
536         Setting `core.pager` has no effect on the `LESS`
537         environment variable behaviour above, so if you want
538         to override git's default settings this way, you need
539         to be explicit.  For example, to disable the S option
540         in a backward compatible manner, set `core.pager`
541         to `less -+S`.  This will be passed to the shell by
542         git, which will translate the final command to
543         `LESS=FRSX less -+S`.
545 core.whitespace::
546         A comma separated list of common whitespace problems to
547         notice.  'git diff' will use `color.diff.whitespace` to
548         highlight them, and 'git apply --whitespace=error' will
549         consider them as errors.  You can prefix `-` to disable
550         any of them (e.g. `-trailing-space`):
552 * `blank-at-eol` treats trailing whitespaces at the end of the line
553   as an error (enabled by default).
554 * `space-before-tab` treats a space character that appears immediately
555   before a tab character in the initial indent part of the line as an
556   error (enabled by default).
557 * `indent-with-non-tab` treats a line that is indented with space
558   characters instead of the equivalent tabs as an error (not enabled by
559   default).
560 * `tab-in-indent` treats a tab character in the initial indent part of
561   the line as an error (not enabled by default).
562 * `blank-at-eof` treats blank lines added at the end of file as an error
563   (enabled by default).
564 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
565   `blank-at-eof`.
566 * `cr-at-eol` treats a carriage-return at the end of line as
567   part of the line terminator, i.e. with it, `trailing-space`
568   does not trigger if the character before such a carriage-return
569   is not a whitespace (not enabled by default).
570 * `tabwidth=<n>` tells how many character positions a tab occupies; this
571   is relevant for `indent-with-non-tab` and when git fixes `tab-in-indent`
572   errors. The default tab width is 8. Allowed values are 1 to 63.
574 core.fsyncobjectfiles::
575         This boolean will enable 'fsync()' when writing object files.
577 This is a total waste of time and effort on a filesystem that orders
578 data writes properly, but can be useful for filesystems that do not use
579 journalling (traditional UNIX filesystems) or that only journal metadata
580 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
582 core.preloadindex::
583         Enable parallel index preload for operations like 'git diff'
585 This can speed up operations like 'git diff' and 'git status' especially
586 on filesystems like NFS that have weak caching semantics and thus
587 relatively high IO latencies.  With this set to 'true', git will do the
588 index comparison to the filesystem data in parallel, allowing
589 overlapping IO's.
591 core.createObject::
592         You can set this to 'link', in which case a hardlink followed by
593         a delete of the source are used to make sure that object creation
594         will not overwrite existing objects.
596 On some file system/operating system combinations, this is unreliable.
597 Set this config setting to 'rename' there; However, This will remove the
598 check that makes sure that existing object files will not get overwritten.
600 core.notesRef::
601         When showing commit messages, also show notes which are stored in
602         the given ref.  The ref must be fully qualified.  If the given
603         ref does not exist, it is not an error but means that no
604         notes should be printed.
606 This setting defaults to "refs/notes/commits", and it can be overridden by
607 the 'GIT_NOTES_REF' environment variable.  See linkgit:git-notes[1].
609 core.sparseCheckout::
610         Enable "sparse checkout" feature. See section "Sparse checkout" in
611         linkgit:git-read-tree[1] for more information.
613 core.abbrev::
614         Set the length object names are abbreviated to.  If unspecified,
615         many commands abbreviate to 7 hexdigits, which may not be enough
616         for abbreviated object names to stay unique for sufficiently long
617         time.
619 add.ignore-errors::
620 add.ignoreErrors::
621         Tells 'git add' to continue adding files when some files cannot be
622         added due to indexing errors. Equivalent to the '--ignore-errors'
623         option of linkgit:git-add[1].  Older versions of git accept only
624         `add.ignore-errors`, which does not follow the usual naming
625         convention for configuration variables.  Newer versions of git
626         honor `add.ignoreErrors` as well.
628 alias.*::
629         Command aliases for the linkgit:git[1] command wrapper - e.g.
630         after defining "alias.last = cat-file commit HEAD", the invocation
631         "git last" is equivalent to "git cat-file commit HEAD". To avoid
632         confusion and troubles with script usage, aliases that
633         hide existing git commands are ignored. Arguments are split by
634         spaces, the usual shell quoting and escaping is supported.
635         quote pair and a backslash can be used to quote them.
637 If the alias expansion is prefixed with an exclamation point,
638 it will be treated as a shell command.  For example, defining
639 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
640 "git new" is equivalent to running the shell command
641 "gitk --all --not ORIG_HEAD".  Note that shell commands will be
642 executed from the top-level directory of a repository, which may
643 not necessarily be the current directory.
644 'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
645 from the original current directory. See linkgit:git-rev-parse[1].
647 am.keepcr::
648         If true, git-am will call git-mailsplit for patches in mbox format
649         with parameter '--keep-cr'. In this case git-mailsplit will
650         not remove `\r` from lines ending with `\r\n`. Can be overridden
651         by giving '--no-keep-cr' from the command line.
652         See linkgit:git-am[1], linkgit:git-mailsplit[1].
654 apply.ignorewhitespace::
655         When set to 'change', tells 'git apply' to ignore changes in
656         whitespace, in the same way as the '--ignore-space-change'
657         option.
658         When set to one of: no, none, never, false tells 'git apply' to
659         respect all whitespace differences.
660         See linkgit:git-apply[1].
662 apply.whitespace::
663         Tells 'git apply' how to handle whitespaces, in the same way
664         as the '--whitespace' option. See linkgit:git-apply[1].
666 branch.autosetupmerge::
667         Tells 'git branch' and 'git checkout' to set up new branches
668         so that linkgit:git-pull[1] will appropriately merge from the
669         starting point branch. Note that even if this option is not set,
670         this behavior can be chosen per-branch using the `--track`
671         and `--no-track` options. The valid settings are: `false` -- no
672         automatic setup is done; `true` -- automatic setup is done when the
673         starting point is a remote-tracking branch; `always` --
674         automatic setup is done when the starting point is either a
675         local branch or remote-tracking
676         branch. This option defaults to true.
678 branch.autosetuprebase::
679         When a new branch is created with 'git branch' or 'git checkout'
680         that tracks another branch, this variable tells git to set
681         up pull to rebase instead of merge (see "branch.<name>.rebase").
682         When `never`, rebase is never automatically set to true.
683         When `local`, rebase is set to true for tracked branches of
684         other local branches.
685         When `remote`, rebase is set to true for tracked branches of
686         remote-tracking branches.
687         When `always`, rebase will be set to true for all tracking
688         branches.
689         See "branch.autosetupmerge" for details on how to set up a
690         branch to track another branch.
691         This option defaults to never.
693 branch.<name>.remote::
694         When in branch <name>, it tells 'git fetch' and 'git push' which
695         remote to fetch from/push to.  It defaults to `origin` if no remote is
696         configured. `origin` is also used if you are not on any branch.
698 branch.<name>.merge::
699         Defines, together with branch.<name>.remote, the upstream branch
700         for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
701         branch to merge and can also affect 'git push' (see push.default).
702         When in branch <name>, it tells 'git fetch' the default
703         refspec to be marked for merging in FETCH_HEAD. The value is
704         handled like the remote part of a refspec, and must match a
705         ref which is fetched from the remote given by
706         "branch.<name>.remote".
707         The merge information is used by 'git pull' (which at first calls
708         'git fetch') to lookup the default branch for merging. Without
709         this option, 'git pull' defaults to merge the first refspec fetched.
710         Specify multiple values to get an octopus merge.
711         If you wish to setup 'git pull' so that it merges into <name> from
712         another branch in the local repository, you can point
713         branch.<name>.merge to the desired branch, and use the special setting
714         `.` (a period) for branch.<name>.remote.
716 branch.<name>.mergeoptions::
717         Sets default options for merging into branch <name>. The syntax and
718         supported options are the same as those of linkgit:git-merge[1], but
719         option values containing whitespace characters are currently not
720         supported.
722 branch.<name>.rebase::
723         When true, rebase the branch <name> on top of the fetched branch,
724         instead of merging the default branch from the default remote when
725         "git pull" is run. See "pull.rebase" for doing this in a non
726         branch-specific manner.
728 *NOTE*: this is a possibly dangerous operation; do *not* use
729 it unless you understand the implications (see linkgit:git-rebase[1]
730 for details).
732 browser.<tool>.cmd::
733         Specify the command to invoke the specified browser. The
734         specified command is evaluated in shell with the URLs passed
735         as arguments. (See linkgit:git-web{litdd}browse[1].)
737 browser.<tool>.path::
738         Override the path for the given tool that may be used to
739         browse HTML help (see '-w' option in linkgit:git-help[1]) or a
740         working repository in gitweb (see linkgit:git-instaweb[1]).
742 clean.requireForce::
743         A boolean to make git-clean do nothing unless given -f
744         or -n.   Defaults to true.
746 color.branch::
747         A boolean to enable/disable color in the output of
748         linkgit:git-branch[1]. May be set to `always`,
749         `false` (or `never`) or `auto` (or `true`), in which case colors are used
750         only when the output is to a terminal. Defaults to false.
752 color.branch.<slot>::
753         Use customized color for branch coloration. `<slot>` is one of
754         `current` (the current branch), `local` (a local branch),
755         `remote` (a remote-tracking branch in refs/remotes/), `plain` (other
756         refs).
758 The value for these configuration variables is a list of colors (at most
759 two) and attributes (at most one), separated by spaces.  The colors
760 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
761 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
762 `blink` and `reverse`.  The first color given is the foreground; the
763 second is the background.  The position of the attribute, if any,
764 doesn't matter.
766 color.diff::
767         Whether to use ANSI escape sequences to add color to patches.
768         If this is set to `always`, linkgit:git-diff[1],
769         linkgit:git-log[1], and linkgit:git-show[1] will use color
770         for all patches.  If it is set to `true` or `auto`, those
771         commands will only use color when output is to the terminal.
772         Defaults to false.
774 This does not affect linkgit:git-format-patch[1] nor the
775 'git-diff-{asterisk}' plumbing commands.  Can be overridden on the
776 command line with the `--color[=<when>]` option.
778 color.diff.<slot>::
779         Use customized color for diff colorization.  `<slot>` specifies
780         which part of the patch to use the specified color, and is one
781         of `plain` (context text), `meta` (metainformation), `frag`
782         (hunk header), 'func' (function in hunk header), `old` (removed lines),
783         `new` (added lines), `commit` (commit headers), or `whitespace`
784         (highlighting whitespace errors). The values of these variables may be
785         specified as in color.branch.<slot>.
787 color.decorate.<slot>::
788         Use customized color for 'git log --decorate' output.  `<slot>` is one
789         of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
790         branches, remote-tracking branches, tags, stash and HEAD, respectively.
792 color.grep::
793         When set to `always`, always highlight matches.  When `false` (or
794         `never`), never.  When set to `true` or `auto`, use color only
795         when the output is written to the terminal.  Defaults to `false`.
797 color.grep.<slot>::
798         Use customized color for grep colorization.  `<slot>` specifies which
799         part of the line to use the specified color, and is one of
802 `context`;;
803         non-matching text in context lines (when using `-A`, `-B`, or `-C`)
804 `filename`;;
805         filename prefix (when not using `-h`)
806 `function`;;
807         function name lines (when using `-p`)
808 `linenumber`;;
809         line number prefix (when using `-n`)
810 `match`;;
811         matching text
812 `selected`;;
813         non-matching text in selected lines
814 `separator`;;
815         separators between fields on a line (`:`, `-`, and `=`)
816         and between hunks (`--`)
819 The values of these variables may be specified as in color.branch.<slot>.
821 color.interactive::
822         When set to `always`, always use colors for interactive prompts
823         and displays (such as those used by "git-add --interactive").
824         When false (or `never`), never.  When set to `true` or `auto`, use
825         colors only when the output is to the terminal. Defaults to false.
827 color.interactive.<slot>::
828         Use customized color for 'git add --interactive'
829         output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
830         four distinct types of normal output from interactive
831         commands.  The values of these variables may be specified as
832         in color.branch.<slot>.
834 color.pager::
835         A boolean to enable/disable colored output when the pager is in
836         use (default is true).
838 color.showbranch::
839         A boolean to enable/disable color in the output of
840         linkgit:git-show-branch[1]. May be set to `always`,
841         `false` (or `never`) or `auto` (or `true`), in which case colors are used
842         only when the output is to a terminal. Defaults to false.
844 color.status::
845         A boolean to enable/disable color in the output of
846         linkgit:git-status[1]. May be set to `always`,
847         `false` (or `never`) or `auto` (or `true`), in which case colors are used
848         only when the output is to a terminal. Defaults to false.
850 color.status.<slot>::
851         Use customized color for status colorization. `<slot>` is
852         one of `header` (the header text of the status message),
853         `added` or `updated` (files which are added but not committed),
854         `changed` (files which are changed but not added in the index),
855         `untracked` (files which are not tracked by git),
856         `branch` (the current branch), or
857         `nobranch` (the color the 'no branch' warning is shown in, defaulting
858         to red). The values of these variables may be specified as in
859         color.branch.<slot>.
861 color.ui::
862         This variable determines the default value for variables such
863         as `color.diff` and `color.grep` that control the use of color
864         per command family. Its scope will expand as more commands learn
865         configuration to set a default for the `--color` option.  Set it
866         to `always` if you want all output not intended for machine
867         consumption to use color, to `true` or `auto` if you want such
868         output to use color when written to the terminal, or to `false` or
869         `never` if you prefer git commands not to use color unless enabled
870         explicitly with some other configuration or the `--color` option.
872 column.ui::
873         Specify whether supported commands should output in columns.
874         This variable consists of a list of tokens separated by spaces
875         or commas:
878 `always`;;
879         always show in columns
880 `never`;;
881         never show in columns
882 `auto`;;
883         show in columns if the output is to the terminal
884 `column`;;
885         fill columns before rows (default)
886 `row`;;
887         fill rows before columns
888 `plain`;;
889         show in one column
890 `dense`;;
891         make unequal size columns to utilize more space
892 `nodense`;;
893         make equal size columns
896 This option defaults to 'never'.
898 column.branch::
899         Specify whether to output branch listing in `git branch` in columns.
900         See `column.ui` for details.
902 column.status::
903         Specify whether to output untracked files in `git status` in columns.
904         See `column.ui` for details.
906 column.tag::
907         Specify whether to output tag listing in `git tag` in columns.
908         See `column.ui` for details.
910 commit.status::
911         A boolean to enable/disable inclusion of status information in the
912         commit message template when using an editor to prepare the commit
913         message.  Defaults to true.
915 commit.template::
916         Specify a file to use as the template for new commit messages.
917         "`~/`" is expanded to the value of `$HOME` and "`~user/`" to the
918         specified user's home directory.
920 credential.helper::
921         Specify an external helper to be called when a username or
922         password credential is needed; the helper may consult external
923         storage to avoid prompting the user for the credentials. See
924         linkgit:gitcredentials[7] for details.
926 credential.useHttpPath::
927         When acquiring credentials, consider the "path" component of an http
928         or https URL to be important. Defaults to false. See
929         linkgit:gitcredentials[7] for more information.
931 credential.username::
932         If no username is set for a network authentication, use this username
933         by default. See credential.<context>.* below, and
934         linkgit:gitcredentials[7].
936 credential.<url>.*::
937         Any of the credential.* options above can be applied selectively to
938         some credentials. For example "credential.https://example.com.username"
939         would set the default username only for https connections to
940         example.com. See linkgit:gitcredentials[7] for details on how URLs are
941         matched.
943 include::diff-config.txt[]
945 difftool.<tool>.path::
946         Override the path for the given tool.  This is useful in case
947         your tool is not in the PATH.
949 difftool.<tool>.cmd::
950         Specify the command to invoke the specified diff tool.
951         The specified command is evaluated in shell with the following
952         variables available:  'LOCAL' is set to the name of the temporary
953         file containing the contents of the diff pre-image and 'REMOTE'
954         is set to the name of the temporary file containing the contents
955         of the diff post-image.
957 difftool.prompt::
958         Prompt before each invocation of the diff tool.
960 fetch.recurseSubmodules::
961         This option can be either set to a boolean value or to 'on-demand'.
962         Setting it to a boolean changes the behavior of fetch and pull to
963         unconditionally recurse into submodules when set to true or to not
964         recurse at all when set to false. When set to 'on-demand' (the default
965         value), fetch and pull will only recurse into a populated submodule
966         when its superproject retrieves a commit that updates the submodule's
967         reference.
969 fetch.fsckObjects::
970         If it is set to true, git-fetch-pack will check all fetched
971         objects. It will abort in the case of a malformed object or a
972         broken link. The result of an abort are only dangling objects.
973         Defaults to false. If not set, the value of `transfer.fsckObjects`
974         is used instead.
976 fetch.unpackLimit::
977         If the number of objects fetched over the git native
978         transfer is below this
979         limit, then the objects will be unpacked into loose object
980         files. However if the number of received objects equals or
981         exceeds this limit then the received pack will be stored as
982         a pack, after adding any missing delta bases.  Storing the
983         pack from a push can make the push operation complete faster,
984         especially on slow filesystems.  If not set, the value of
985         `transfer.unpackLimit` is used instead.
987 format.attach::
988         Enable multipart/mixed attachments as the default for
989         'format-patch'.  The value can also be a double quoted string
990         which will enable attachments as the default and set the
991         value as the boundary.  See the --attach option in
992         linkgit:git-format-patch[1].
994 format.numbered::
995         A boolean which can enable or disable sequence numbers in patch
996         subjects.  It defaults to "auto" which enables it only if there
997         is more than one patch.  It can be enabled or disabled for all
998         messages by setting it to "true" or "false".  See --numbered
999         option in linkgit:git-format-patch[1].
1001 format.headers::
1002         Additional email headers to include in a patch to be submitted
1003         by mail.  See linkgit:git-format-patch[1].
1005 format.to::
1006 format.cc::
1007         Additional recipients to include in a patch to be submitted
1008         by mail.  See the --to and --cc options in
1009         linkgit:git-format-patch[1].
1011 format.subjectprefix::
1012         The default for format-patch is to output files with the '[PATCH]'
1013         subject prefix. Use this variable to change that prefix.
1015 format.signature::
1016         The default for format-patch is to output a signature containing
1017         the git version number. Use this variable to change that default.
1018         Set this variable to the empty string ("") to suppress
1019         signature generation.
1021 format.suffix::
1022         The default for format-patch is to output files with the suffix
1023         `.patch`. Use this variable to change that suffix (make sure to
1024         include the dot if you want it).
1026 format.pretty::
1027         The default pretty format for log/show/whatchanged command,
1028         See linkgit:git-log[1], linkgit:git-show[1],
1029         linkgit:git-whatchanged[1].
1031 format.thread::
1032         The default threading style for 'git format-patch'.  Can be
1033         a boolean value, or `shallow` or `deep`.  `shallow` threading
1034         makes every mail a reply to the head of the series,
1035         where the head is chosen from the cover letter, the
1036         `--in-reply-to`, and the first patch mail, in this order.
1037         `deep` threading makes every mail a reply to the previous one.
1038         A true boolean value is the same as `shallow`, and a false
1039         value disables threading.
1041 format.signoff::
1042     A boolean value which lets you enable the `-s/--signoff` option of
1043     format-patch by default. *Note:* Adding the Signed-off-by: line to a
1044     patch should be a conscious act and means that you certify you have
1045     the rights to submit this work under the same open source license.
1046     Please see the 'SubmittingPatches' document for further discussion.
1048 filter.<driver>.clean::
1049         The command which is used to convert the content of a worktree
1050         file to a blob upon checkin.  See linkgit:gitattributes[5] for
1051         details.
1053 filter.<driver>.smudge::
1054         The command which is used to convert the content of a blob
1055         object to a worktree file upon checkout.  See
1056         linkgit:gitattributes[5] for details.
1058 gc.aggressiveWindow::
1059         The window size parameter used in the delta compression
1060         algorithm used by 'git gc --aggressive'.  This defaults
1061         to 250.
1063 gc.auto::
1064         When there are approximately more than this many loose
1065         objects in the repository, `git gc --auto` will pack them.
1066         Some Porcelain commands use this command to perform a
1067         light-weight garbage collection from time to time.  The
1068         default value is 6700.  Setting this to 0 disables it.
1070 gc.autopacklimit::
1071         When there are more than this many packs that are not
1072         marked with `*.keep` file in the repository, `git gc
1073         --auto` consolidates them into one larger pack.  The
1074         default value is 50.  Setting this to 0 disables it.
1076 gc.packrefs::
1077         Running `git pack-refs` in a repository renders it
1078         unclonable by Git versions prior to 1.5.1.2 over dumb
1079         transports such as HTTP.  This variable determines whether
1080         'git gc' runs `git pack-refs`. This can be set to `notbare`
1081         to enable it within all non-bare repos or it can be set to a
1082         boolean value.  The default is `true`.
1084 gc.pruneexpire::
1085         When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1086         Override the grace period with this config variable.  The value
1087         "now" may be used to disable this  grace period and always prune
1088         unreachable objects immediately.
1090 gc.reflogexpire::
1091 gc.<pattern>.reflogexpire::
1092         'git reflog expire' removes reflog entries older than
1093         this time; defaults to 90 days.  With "<pattern>" (e.g.
1094         "refs/stash") in the middle the setting applies only to
1095         the refs that match the <pattern>.
1097 gc.reflogexpireunreachable::
1098 gc.<ref>.reflogexpireunreachable::
1099         'git reflog expire' removes reflog entries older than
1100         this time and are not reachable from the current tip;
1101         defaults to 30 days.  With "<pattern>" (e.g. "refs/stash")
1102         in the middle, the setting applies only to the refs that
1103         match the <pattern>.
1105 gc.rerereresolved::
1106         Records of conflicted merge you resolved earlier are
1107         kept for this many days when 'git rerere gc' is run.
1108         The default is 60 days.  See linkgit:git-rerere[1].
1110 gc.rerereunresolved::
1111         Records of conflicted merge you have not resolved are
1112         kept for this many days when 'git rerere gc' is run.
1113         The default is 15 days.  See linkgit:git-rerere[1].
1115 gitcvs.commitmsgannotation::
1116         Append this string to each commit message. Set to empty string
1117         to disable this feature. Defaults to "via git-CVS emulator".
1119 gitcvs.enabled::
1120         Whether the CVS server interface is enabled for this repository.
1121         See linkgit:git-cvsserver[1].
1123 gitcvs.logfile::
1124         Path to a log file where the CVS server interface well... logs
1125         various stuff. See linkgit:git-cvsserver[1].
1127 gitcvs.usecrlfattr::
1128         If true, the server will look up the end-of-line conversion
1129         attributes for files to determine the '-k' modes to use. If
1130         the attributes force git to treat a file as text,
1131         the '-k' mode will be left blank so CVS clients will
1132         treat it as text. If they suppress text conversion, the file
1133         will be set with '-kb' mode, which suppresses any newline munging
1134         the client might otherwise do. If the attributes do not allow
1135         the file type to be determined, then 'gitcvs.allbinary' is
1136         used. See linkgit:gitattributes[5].
1138 gitcvs.allbinary::
1139         This is used if 'gitcvs.usecrlfattr' does not resolve
1140         the correct '-kb' mode to use. If true, all
1141         unresolved files are sent to the client in
1142         mode '-kb'. This causes the client to treat them
1143         as binary files, which suppresses any newline munging it
1144         otherwise might do. Alternatively, if it is set to "guess",
1145         then the contents of the file are examined to decide if
1146         it is binary, similar to 'core.autocrlf'.
1148 gitcvs.dbname::
1149         Database used by git-cvsserver to cache revision information
1150         derived from the git repository. The exact meaning depends on the
1151         used database driver, for SQLite (which is the default driver) this
1152         is a filename. Supports variable substitution (see
1153         linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1154         Default: '%Ggitcvs.%m.sqlite'
1156 gitcvs.dbdriver::
1157         Used Perl DBI driver. You can specify any available driver
1158         for this here, but it might not work. git-cvsserver is tested
1159         with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1160         reported *not* to work with 'DBD::mysql'. Experimental feature.
1161         May not contain double colons (`:`). Default: 'SQLite'.
1162         See linkgit:git-cvsserver[1].
1164 gitcvs.dbuser, gitcvs.dbpass::
1165         Database user and password. Only useful if setting 'gitcvs.dbdriver',
1166         since SQLite has no concept of database users and/or passwords.
1167         'gitcvs.dbuser' supports variable substitution (see
1168         linkgit:git-cvsserver[1] for details).
1170 gitcvs.dbTableNamePrefix::
1171         Database table name prefix.  Prepended to the names of any
1172         database tables used, allowing a single database to be used
1173         for several repositories.  Supports variable substitution (see
1174         linkgit:git-cvsserver[1] for details).  Any non-alphabetic
1175         characters will be replaced with underscores.
1177 All gitcvs variables except for 'gitcvs.usecrlfattr' and
1178 'gitcvs.allbinary' can also be specified as
1179 'gitcvs.<access_method>.<varname>' (where 'access_method'
1180 is one of "ext" and "pserver") to make them apply only for the given
1181 access method.
1183 gitweb.category::
1184 gitweb.description::
1185 gitweb.owner::
1186 gitweb.url::
1187         See linkgit:gitweb[1] for description.
1189 gitweb.avatar::
1190 gitweb.blame::
1191 gitweb.grep::
1192 gitweb.highlight::
1193 gitweb.patches::
1194 gitweb.pickaxe::
1195 gitweb.remote_heads::
1196 gitweb.showsizes::
1197 gitweb.snapshot::
1198         See linkgit:gitweb.conf[5] for description.
1200 grep.lineNumber::
1201         If set to true, enable '-n' option by default.
1203 grep.patternType::
1204         Set the default matching behavior. Using a value of 'basic', 'extended',
1205         'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',
1206         '--fixed-strings', or '--perl-regexp' option accordingly, while the
1207         value 'default' will return to the default matching behavior.
1209 grep.extendedRegexp::
1210         If set to true, enable '--extended-regexp' option by default. This
1211         option is ignored when the 'grep.patternType' option is set to a value
1212         other than 'default'.
1214 gpg.program::
1215         Use this custom program instead of "gpg" found on $PATH when
1216         making or verifying a PGP signature. The program must support the
1217         same command line interface as GPG, namely, to verify a detached
1218         signature, "gpg --verify $file - <$signature" is run, and the
1219         program is expected to signal a good signature by exiting with
1220         code 0, and to generate an ascii-armored detached signature, the
1221         standard input of "gpg -bsau $key" is fed with the contents to be
1222         signed, and the program is expected to send the result to its
1223         standard output.
1225 gui.commitmsgwidth::
1226         Defines how wide the commit message window is in the
1227         linkgit:git-gui[1]. "75" is the default.
1229 gui.diffcontext::
1230         Specifies how many context lines should be used in calls to diff
1231         made by the linkgit:git-gui[1]. The default is "5".
1233 gui.encoding::
1234         Specifies the default encoding to use for displaying of
1235         file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1236         It can be overridden by setting the 'encoding' attribute
1237         for relevant files (see linkgit:gitattributes[5]).
1238         If this option is not set, the tools default to the
1239         locale encoding.
1241 gui.matchtrackingbranch::
1242         Determines if new branches created with linkgit:git-gui[1] should
1243         default to tracking remote branches with matching names or
1244         not. Default: "false".
1246 gui.newbranchtemplate::
1247         Is used as suggested name when creating new branches using the
1248         linkgit:git-gui[1].
1250 gui.pruneduringfetch::
1251         "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1252         performing a fetch. The default value is "false".
1254 gui.trustmtime::
1255         Determines if linkgit:git-gui[1] should trust the file modification
1256         timestamp or not. By default the timestamps are not trusted.
1258 gui.spellingdictionary::
1259         Specifies the dictionary used for spell checking commit messages in
1260         the linkgit:git-gui[1]. When set to "none" spell checking is turned
1261         off.
1263 gui.fastcopyblame::
1264         If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1265         location detection. It makes blame significantly faster on huge
1266         repositories at the expense of less thorough copy detection.
1268 gui.copyblamethreshold::
1269         Specifies the threshold to use in 'git gui blame' original location
1270         detection, measured in alphanumeric characters. See the
1271         linkgit:git-blame[1] manual for more information on copy detection.
1273 gui.blamehistoryctx::
1274         Specifies the radius of history context in days to show in
1275         linkgit:gitk[1] for the selected commit, when the `Show History
1276         Context` menu item is invoked from 'git gui blame'. If this
1277         variable is set to zero, the whole history is shown.
1279 guitool.<name>.cmd::
1280         Specifies the shell command line to execute when the corresponding item
1281         of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1282         mandatory for every tool. The command is executed from the root of
1283         the working directory, and in the environment it receives the name of
1284         the tool as 'GIT_GUITOOL', the name of the currently selected file as
1285         'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1286         the head is detached, 'CUR_BRANCH' is empty).
1288 guitool.<name>.needsfile::
1289         Run the tool only if a diff is selected in the GUI. It guarantees
1290         that 'FILENAME' is not empty.
1292 guitool.<name>.noconsole::
1293         Run the command silently, without creating a window to display its
1294         output.
1296 guitool.<name>.norescan::
1297         Don't rescan the working directory for changes after the tool
1298         finishes execution.
1300 guitool.<name>.confirm::
1301         Show a confirmation dialog before actually running the tool.
1303 guitool.<name>.argprompt::
1304         Request a string argument from the user, and pass it to the tool
1305         through the 'ARGS' environment variable. Since requesting an
1306         argument implies confirmation, the 'confirm' option has no effect
1307         if this is enabled. If the option is set to 'true', 'yes', or '1',
1308         the dialog uses a built-in generic prompt; otherwise the exact
1309         value of the variable is used.
1311 guitool.<name>.revprompt::
1312         Request a single valid revision from the user, and set the
1313         'REVISION' environment variable. In other aspects this option
1314         is similar to 'argprompt', and can be used together with it.
1316 guitool.<name>.revunmerged::
1317         Show only unmerged branches in the 'revprompt' subdialog.
1318         This is useful for tools similar to merge or rebase, but not
1319         for things like checkout or reset.
1321 guitool.<name>.title::
1322         Specifies the title to use for the prompt dialog. The default
1323         is the tool name.
1325 guitool.<name>.prompt::
1326         Specifies the general prompt string to display at the top of
1327         the dialog, before subsections for 'argprompt' and 'revprompt'.
1328         The default value includes the actual command.
1330 help.browser::
1331         Specify the browser that will be used to display help in the
1332         'web' format. See linkgit:git-help[1].
1334 help.format::
1335         Override the default help format used by linkgit:git-help[1].
1336         Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1337         the default. 'web' and 'html' are the same.
1339 help.autocorrect::
1340         Automatically correct and execute mistyped commands after
1341         waiting for the given number of deciseconds (0.1 sec). If more
1342         than one command can be deduced from the entered text, nothing
1343         will be executed.  If the value of this option is negative,
1344         the corrected command will be executed immediately. If the
1345         value is 0 - the command will be just shown but not executed.
1346         This is the default.
1348 http.proxy::
1349         Override the HTTP proxy, normally configured using the 'http_proxy',
1350         'https_proxy', and 'all_proxy' environment variables (see
1351         `curl(1)`).  This can be overridden on a per-remote basis; see
1352         remote.<name>.proxy
1354 http.cookiefile::
1355         File containing previously stored cookie lines which should be used
1356         in the git http session, if they match the server. The file format
1357         of the file to read cookies from should be plain HTTP headers or
1358         the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
1359         NOTE that the file specified with http.cookiefile is only used as
1360         input. No cookies will be stored in the file.
1362 http.sslVerify::
1363         Whether to verify the SSL certificate when fetching or pushing
1364         over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1365         variable.
1367 http.sslCert::
1368         File containing the SSL certificate when fetching or pushing
1369         over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1370         variable.
1372 http.sslKey::
1373         File containing the SSL private key when fetching or pushing
1374         over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1375         variable.
1377 http.sslCertPasswordProtected::
1378         Enable git's password prompt for the SSL certificate.  Otherwise
1379         OpenSSL will prompt the user, possibly many times, if the
1380         certificate or private key is encrypted.  Can be overridden by the
1381         'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1383 http.sslCAInfo::
1384         File containing the certificates to verify the peer with when
1385         fetching or pushing over HTTPS. Can be overridden by the
1386         'GIT_SSL_CAINFO' environment variable.
1388 http.sslCAPath::
1389         Path containing files with the CA certificates to verify the peer
1390         with when fetching or pushing over HTTPS. Can be overridden
1391         by the 'GIT_SSL_CAPATH' environment variable.
1393 http.maxRequests::
1394         How many HTTP requests to launch in parallel. Can be overridden
1395         by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1397 http.minSessions::
1398         The number of curl sessions (counted across slots) to be kept across
1399         requests. They will not be ended with curl_easy_cleanup() until
1400         http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1401         value will be capped at 1. Defaults to 1.
1403 http.postBuffer::
1404         Maximum size in bytes of the buffer used by smart HTTP
1405         transports when POSTing data to the remote system.
1406         For requests larger than this buffer size, HTTP/1.1 and
1407         Transfer-Encoding: chunked is used to avoid creating a
1408         massive pack file locally.  Default is 1 MiB, which is
1409         sufficient for most requests.
1411 http.lowSpeedLimit, http.lowSpeedTime::
1412         If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1413         for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1414         Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1415         'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1417 http.noEPSV::
1418         A boolean which disables using of EPSV ftp command by curl.
1419         This can helpful with some "poor" ftp servers which don't
1420         support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1421         environment variable. Default is false (curl will use EPSV).
1423 http.useragent::
1424         The HTTP USER_AGENT string presented to an HTTP server.  The default
1425         value represents the version of the client git such as git/1.7.1.
1426         This option allows you to override this value to a more common value
1427         such as Mozilla/4.0.  This may be necessary, for instance, if
1428         connecting through a firewall that restricts HTTP connections to a set
1429         of common USER_AGENT strings (but not including those like git/1.7.1).
1430         Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1432 i18n.commitEncoding::
1433         Character encoding the commit messages are stored in; git itself
1434         does not care per se, but this information is necessary e.g. when
1435         importing commits from emails or in the gitk graphical history
1436         browser (and possibly at other places in the future or in other
1437         porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1439 i18n.logOutputEncoding::
1440         Character encoding the commit messages are converted to when
1441         running 'git log' and friends.
1443 imap::
1444         The configuration variables in the 'imap' section are described
1445         in linkgit:git-imap-send[1].
1447 init.templatedir::
1448         Specify the directory from which templates will be copied.
1449         (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1451 instaweb.browser::
1452         Specify the program that will be used to browse your working
1453         repository in gitweb. See linkgit:git-instaweb[1].
1455 instaweb.httpd::
1456         The HTTP daemon command-line to start gitweb on your working
1457         repository. See linkgit:git-instaweb[1].
1459 instaweb.local::
1460         If true the web server started by linkgit:git-instaweb[1] will
1461         be bound to the local IP (127.0.0.1).
1463 instaweb.modulepath::
1464         The default module path for linkgit:git-instaweb[1] to use
1465         instead of /usr/lib/apache2/modules.  Only used if httpd
1466         is Apache.
1468 instaweb.port::
1469         The port number to bind the gitweb httpd to. See
1470         linkgit:git-instaweb[1].
1472 interactive.singlekey::
1473         In interactive commands, allow the user to provide one-letter
1474         input with a single key (i.e., without hitting enter).
1475         Currently this is used by the `--patch` mode of
1476         linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1477         linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1478         setting is silently ignored if portable keystroke input
1479         is not available.
1481 log.abbrevCommit::
1482         If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1483         linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
1484         override this option with `--no-abbrev-commit`.
1486 log.date::
1487         Set the default date-time mode for the 'log' command.
1488         Setting a value for log.date is similar to using 'git log''s
1489         `--date` option.  Possible values are `relative`, `local`,
1490         `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1491         for details.
1493 log.decorate::
1494         Print out the ref names of any commits that are shown by the log
1495         command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1496         'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1497         specified, the full ref name (including prefix) will be printed.
1498         This is the same as the log commands '--decorate' option.
1500 log.showroot::
1501         If true, the initial commit will be shown as a big creation event.
1502         This is equivalent to a diff against an empty tree.
1503         Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1504         normally hide the root commit will now show it. True by default.
1506 mailmap.file::
1507         The location of an augmenting mailmap file. The default
1508         mailmap, located in the root of the repository, is loaded
1509         first, then the mailmap file pointed to by this variable.
1510         The location of the mailmap file may be in a repository
1511         subdirectory, or somewhere outside of the repository itself.
1512         See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1514 man.viewer::
1515         Specify the programs that may be used to display help in the
1516         'man' format. See linkgit:git-help[1].
1518 man.<tool>.cmd::
1519         Specify the command to invoke the specified man viewer. The
1520         specified command is evaluated in shell with the man page
1521         passed as argument. (See linkgit:git-help[1].)
1523 man.<tool>.path::
1524         Override the path for the given tool that may be used to
1525         display help in the 'man' format. See linkgit:git-help[1].
1527 include::merge-config.txt[]
1529 mergetool.<tool>.path::
1530         Override the path for the given tool.  This is useful in case
1531         your tool is not in the PATH.
1533 mergetool.<tool>.cmd::
1534         Specify the command to invoke the specified merge tool.  The
1535         specified command is evaluated in shell with the following
1536         variables available: 'BASE' is the name of a temporary file
1537         containing the common base of the files to be merged, if available;
1538         'LOCAL' is the name of a temporary file containing the contents of
1539         the file on the current branch; 'REMOTE' is the name of a temporary
1540         file containing the contents of the file from the branch being
1541         merged; 'MERGED' contains the name of the file to which the merge
1542         tool should write the results of a successful merge.
1544 mergetool.<tool>.trustExitCode::
1545         For a custom merge command, specify whether the exit code of
1546         the merge command can be used to determine whether the merge was
1547         successful.  If this is not set to true then the merge target file
1548         timestamp is checked and the merge assumed to have been successful
1549         if the file has been updated, otherwise the user is prompted to
1550         indicate the success of the merge.
1552 mergetool.keepBackup::
1553         After performing a merge, the original file with conflict markers
1554         can be saved as a file with a `.orig` extension.  If this variable
1555         is set to `false` then this file is not preserved.  Defaults to
1556         `true` (i.e. keep the backup files).
1558 mergetool.keepTemporaries::
1559         When invoking a custom merge tool, git uses a set of temporary
1560         files to pass to the tool. If the tool returns an error and this
1561         variable is set to `true`, then these temporary files will be
1562         preserved, otherwise they will be removed after the tool has
1563         exited. Defaults to `false`.
1565 mergetool.prompt::
1566         Prompt before each invocation of the merge resolution program.
1568 notes.displayRef::
1569         The (fully qualified) refname from which to show notes when
1570         showing commit messages.  The value of this variable can be set
1571         to a glob, in which case notes from all matching refs will be
1572         shown.  You may also specify this configuration variable
1573         several times.  A warning will be issued for refs that do not
1574         exist, but a glob that does not match any refs is silently
1575         ignored.
1577 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1578 environment variable, which must be a colon separated list of refs or
1579 globs.
1581 The effective value of "core.notesRef" (possibly overridden by
1582 GIT_NOTES_REF) is also implicitly added to the list of refs to be
1583 displayed.
1585 notes.rewrite.<command>::
1586         When rewriting commits with <command> (currently `amend` or
1587         `rebase`) and this variable is set to `true`, git
1588         automatically copies your notes from the original to the
1589         rewritten commit.  Defaults to `true`, but see
1590         "notes.rewriteRef" below.
1592 notes.rewriteMode::
1593         When copying notes during a rewrite (see the
1594         "notes.rewrite.<command>" option), determines what to do if
1595         the target commit already has a note.  Must be one of
1596         `overwrite`, `concatenate`, or `ignore`.  Defaults to
1597         `concatenate`.
1599 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1600 environment variable.
1602 notes.rewriteRef::
1603         When copying notes during a rewrite, specifies the (fully
1604         qualified) ref whose notes should be copied.  The ref may be a
1605         glob, in which case notes in all matching refs will be copied.
1606         You may also specify this configuration several times.
1608 Does not have a default value; you must configure this variable to
1609 enable note rewriting.  Set it to `refs/notes/commits` to enable
1610 rewriting for the default commit notes.
1612 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1613 environment variable, which must be a colon separated list of refs or
1614 globs.
1616 pack.window::
1617         The size of the window used by linkgit:git-pack-objects[1] when no
1618         window size is given on the command line. Defaults to 10.
1620 pack.depth::
1621         The maximum delta depth used by linkgit:git-pack-objects[1] when no
1622         maximum depth is given on the command line. Defaults to 50.
1624 pack.windowMemory::
1625         The window memory size limit used by linkgit:git-pack-objects[1]
1626         when no limit is given on the command line.  The value can be
1627         suffixed with "k", "m", or "g".  Defaults to 0, meaning no
1628         limit.
1630 pack.compression::
1631         An integer -1..9, indicating the compression level for objects
1632         in a pack file. -1 is the zlib default. 0 means no
1633         compression, and 1..9 are various speed/size tradeoffs, 9 being
1634         slowest.  If not set,  defaults to core.compression.  If that is
1635         not set,  defaults to -1, the zlib default, which is "a default
1636         compromise between speed and compression (currently equivalent
1637         to level 6)."
1639 Note that changing the compression level will not automatically recompress
1640 all existing objects. You can force recompression by passing the -F option
1641 to linkgit:git-repack[1].
1643 pack.deltaCacheSize::
1644         The maximum memory in bytes used for caching deltas in
1645         linkgit:git-pack-objects[1] before writing them out to a pack.
1646         This cache is used to speed up the writing object phase by not
1647         having to recompute the final delta result once the best match
1648         for all objects is found.  Repacking large repositories on machines
1649         which are tight with memory might be badly impacted by this though,
1650         especially if this cache pushes the system into swapping.
1651         A value of 0 means no limit. The smallest size of 1 byte may be
1652         used to virtually disable this cache. Defaults to 256 MiB.
1654 pack.deltaCacheLimit::
1655         The maximum size of a delta, that is cached in
1656         linkgit:git-pack-objects[1]. This cache is used to speed up the
1657         writing object phase by not having to recompute the final delta
1658         result once the best match for all objects is found. Defaults to 1000.
1660 pack.threads::
1661         Specifies the number of threads to spawn when searching for best
1662         delta matches.  This requires that linkgit:git-pack-objects[1]
1663         be compiled with pthreads otherwise this option is ignored with a
1664         warning. This is meant to reduce packing time on multiprocessor
1665         machines. The required amount of memory for the delta search window
1666         is however multiplied by the number of threads.
1667         Specifying 0 will cause git to auto-detect the number of CPU's
1668         and set the number of threads accordingly.
1670 pack.indexVersion::
1671         Specify the default pack index version.  Valid values are 1 for
1672         legacy pack index used by Git versions prior to 1.5.2, and 2 for
1673         the new pack index with capabilities for packs larger than 4 GB
1674         as well as proper protection against the repacking of corrupted
1675         packs.  Version 2 is the default.  Note that version 2 is enforced
1676         and this config option ignored whenever the corresponding pack is
1677         larger than 2 GB.
1679 If you have an old git that does not understand the version 2 `*.idx` file,
1680 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1681 that will copy both `*.pack` file and corresponding `*.idx` file from the
1682 other side may give you a repository that cannot be accessed with your
1683 older version of git. If the `*.pack` file is smaller than 2 GB, however,
1684 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1685 the `*.idx` file.
1687 pack.packSizeLimit::
1688         The maximum size of a pack.  This setting only affects
1689         packing to a file when repacking, i.e. the git:// protocol
1690         is unaffected.  It can be overridden by the `--max-pack-size`
1691         option of linkgit:git-repack[1]. The minimum size allowed is
1692         limited to 1 MiB. The default is unlimited.
1693         Common unit suffixes of 'k', 'm', or 'g' are
1694         supported.
1696 pager.<cmd>::
1697         If the value is boolean, turns on or off pagination of the
1698         output of a particular git subcommand when writing to a tty.
1699         Otherwise, turns on pagination for the subcommand using the
1700         pager specified by the value of `pager.<cmd>`.  If `--paginate`
1701         or `--no-pager` is specified on the command line, it takes
1702         precedence over this option.  To disable pagination for all
1703         commands, set `core.pager` or `GIT_PAGER` to `cat`.
1705 pretty.<name>::
1706         Alias for a --pretty= format string, as specified in
1707         linkgit:git-log[1]. Any aliases defined here can be used just
1708         as the built-in pretty formats could. For example,
1709         running `git config pretty.changelog "format:* %H %s"`
1710         would cause the invocation `git log --pretty=changelog`
1711         to be equivalent to running `git log "--pretty=format:* %H %s"`.
1712         Note that an alias with the same name as a built-in format
1713         will be silently ignored.
1715 pull.rebase::
1716         When true, rebase branches on top of the fetched branch, instead
1717         of merging the default branch from the default remote when "git
1718         pull" is run. See "branch.<name>.rebase" for setting this on a
1719         per-branch basis.
1721 *NOTE*: this is a possibly dangerous operation; do *not* use
1722 it unless you understand the implications (see linkgit:git-rebase[1]
1723 for details).
1725 pull.octopus::
1726         The default merge strategy to use when pulling multiple branches
1727         at once.
1729 pull.twohead::
1730         The default merge strategy to use when pulling a single branch.
1732 push.default::
1733         Defines the action git push should take if no refspec is given
1734         on the command line, no refspec is configured in the remote, and
1735         no refspec is implied by any of the options given on the command
1736         line. Possible values are:
1739 * `nothing` - do not push anything.
1740 * `matching` - push all branches having the same name in both ends.
1741   This is for those who prepare all the branches into a publishable
1742   shape and then push them out with a single command.  It is not
1743   appropriate for pushing into a repository shared by multiple users,
1744   since locally stalled branches will attempt a non-fast forward push
1745   if other users updated the branch.
1746   +
1747   This used to be the default, and stale web sites may still say so,
1748   but Git 2.0 has changed the default to `simple`.
1749 * `upstream` - push the current branch to its upstream branch.
1750   With this, `git push` will update the same remote ref as the one which
1751   is merged by `git pull`, making `push` and `pull` symmetrical.
1752   See "branch.<name>.merge" for how to configure the upstream branch.
1753 * `simple` - like `upstream`, but refuses to push if the upstream
1754   branch's name is different from the local one. This is the safest
1755   option and is well-suited for beginners. It has become the default
1756   in Git 2.0.
1757 * `current` - push the current branch to a branch of the same name.
1760 The `simple`, `current` and `upstream` modes are for those who want to
1761 push out a single branch after finishing work, even when the other
1762 branches are not yet ready to be pushed out. If you are working with
1763 other people to push into the same shared repository, you would want
1764 to use one of these.
1766 rebase.stat::
1767         Whether to show a diffstat of what changed upstream since the last
1768         rebase. False by default.
1770 rebase.autosquash::
1771         If set to true enable '--autosquash' option by default.
1773 receive.autogc::
1774         By default, git-receive-pack will run "git-gc --auto" after
1775         receiving data from git-push and updating refs.  You can stop
1776         it by setting this variable to false.
1778 receive.fsckObjects::
1779         If it is set to true, git-receive-pack will check all received
1780         objects. It will abort in the case of a malformed object or a
1781         broken link. The result of an abort are only dangling objects.
1782         Defaults to false. If not set, the value of `transfer.fsckObjects`
1783         is used instead.
1785 receive.unpackLimit::
1786         If the number of objects received in a push is below this
1787         limit then the objects will be unpacked into loose object
1788         files. However if the number of received objects equals or
1789         exceeds this limit then the received pack will be stored as
1790         a pack, after adding any missing delta bases.  Storing the
1791         pack from a push can make the push operation complete faster,
1792         especially on slow filesystems.  If not set, the value of
1793         `transfer.unpackLimit` is used instead.
1795 receive.denyDeletes::
1796         If set to true, git-receive-pack will deny a ref update that deletes
1797         the ref. Use this to prevent such a ref deletion via a push.
1799 receive.denyDeleteCurrent::
1800         If set to true, git-receive-pack will deny a ref update that
1801         deletes the currently checked out branch of a non-bare repository.
1803 receive.denyCurrentBranch::
1804         If set to true or "refuse", git-receive-pack will deny a ref update
1805         to the currently checked out branch of a non-bare repository.
1806         Such a push is potentially dangerous because it brings the HEAD
1807         out of sync with the index and working tree. If set to "warn",
1808         print a warning of such a push to stderr, but allow the push to
1809         proceed. If set to false or "ignore", allow such pushes with no
1810         message. Defaults to "refuse".
1812 receive.denyNonFastForwards::
1813         If set to true, git-receive-pack will deny a ref update which is
1814         not a fast-forward. Use this to prevent such an update via a push,
1815         even if that push is forced. This configuration variable is
1816         set when initializing a shared repository.
1818 receive.updateserverinfo::
1819         If set to true, git-receive-pack will run git-update-server-info
1820         after receiving data from git-push and updating refs.
1822 remote.<name>.url::
1823         The URL of a remote repository.  See linkgit:git-fetch[1] or
1824         linkgit:git-push[1].
1826 remote.<name>.pushurl::
1827         The push URL of a remote repository.  See linkgit:git-push[1].
1829 remote.<name>.proxy::
1830         For remotes that require curl (http, https and ftp), the URL to
1831         the proxy to use for that remote.  Set to the empty string to
1832         disable proxying for that remote.
1834 remote.<name>.fetch::
1835         The default set of "refspec" for linkgit:git-fetch[1]. See
1836         linkgit:git-fetch[1].
1838 remote.<name>.push::
1839         The default set of "refspec" for linkgit:git-push[1]. See
1840         linkgit:git-push[1].
1842 remote.<name>.mirror::
1843         If true, pushing to this remote will automatically behave
1844         as if the `--mirror` option was given on the command line.
1846 remote.<name>.skipDefaultUpdate::
1847         If true, this remote will be skipped by default when updating
1848         using linkgit:git-fetch[1] or the `update` subcommand of
1849         linkgit:git-remote[1].
1851 remote.<name>.skipFetchAll::
1852         If true, this remote will be skipped by default when updating
1853         using linkgit:git-fetch[1] or the `update` subcommand of
1854         linkgit:git-remote[1].
1856 remote.<name>.receivepack::
1857         The default program to execute on the remote side when pushing.  See
1858         option \--receive-pack of linkgit:git-push[1].
1860 remote.<name>.uploadpack::
1861         The default program to execute on the remote side when fetching.  See
1862         option \--upload-pack of linkgit:git-fetch-pack[1].
1864 remote.<name>.tagopt::
1865         Setting this value to \--no-tags disables automatic tag following when
1866         fetching from remote <name>. Setting it to \--tags will fetch every
1867         tag from remote <name>, even if they are not reachable from remote
1868         branch heads. Passing these flags directly to linkgit:git-fetch[1] can
1869         override this setting. See options \--tags and \--no-tags of
1870         linkgit:git-fetch[1].
1872 remote.<name>.vcs::
1873         Setting this to a value <vcs> will cause git to interact with
1874         the remote with the git-remote-<vcs> helper.
1876 remotes.<group>::
1877         The list of remotes which are fetched by "git remote update
1878         <group>".  See linkgit:git-remote[1].
1880 repack.usedeltabaseoffset::
1881         By default, linkgit:git-repack[1] creates packs that use
1882         delta-base offset. If you need to share your repository with
1883         git older than version 1.4.4, either directly or via a dumb
1884         protocol such as http, then you need to set this option to
1885         "false" and repack. Access from old git versions over the
1886         native protocol are unaffected by this option.
1888 rerere.autoupdate::
1889         When set to true, `git-rerere` updates the index with the
1890         resulting contents after it cleanly resolves conflicts using
1891         previously recorded resolution.  Defaults to false.
1893 rerere.enabled::
1894         Activate recording of resolved conflicts, so that identical
1895         conflict hunks can be resolved automatically, should they be
1896         encountered again.  By default, linkgit:git-rerere[1] is
1897         enabled if there is an `rr-cache` directory under the
1898         `$GIT_DIR`, e.g. if "rerere" was previously used in the
1899         repository.
1901 sendemail.identity::
1902         A configuration identity. When given, causes values in the
1903         'sendemail.<identity>' subsection to take precedence over
1904         values in the 'sendemail' section. The default identity is
1905         the value of 'sendemail.identity'.
1907 sendemail.smtpencryption::
1908         See linkgit:git-send-email[1] for description.  Note that this
1909         setting is not subject to the 'identity' mechanism.
1911 sendemail.smtpssl::
1912         Deprecated alias for 'sendemail.smtpencryption = ssl'.
1914 sendemail.<identity>.*::
1915         Identity-specific versions of the 'sendemail.*' parameters
1916         found below, taking precedence over those when the this
1917         identity is selected, through command-line or
1918         'sendemail.identity'.
1920 sendemail.aliasesfile::
1921 sendemail.aliasfiletype::
1922 sendemail.bcc::
1923 sendemail.cc::
1924 sendemail.cccmd::
1925 sendemail.chainreplyto::
1926 sendemail.confirm::
1927 sendemail.envelopesender::
1928 sendemail.from::
1929 sendemail.multiedit::
1930 sendemail.signedoffbycc::
1931 sendemail.smtppass::
1932 sendemail.suppresscc::
1933 sendemail.suppressfrom::
1934 sendemail.to::
1935 sendemail.smtpdomain::
1936 sendemail.smtpserver::
1937 sendemail.smtpserverport::
1938 sendemail.smtpserveroption::
1939 sendemail.smtpuser::
1940 sendemail.thread::
1941 sendemail.validate::
1942         See linkgit:git-send-email[1] for description.
1944 sendemail.signedoffcc::
1945         Deprecated alias for 'sendemail.signedoffbycc'.
1947 showbranch.default::
1948         The default set of branches for linkgit:git-show-branch[1].
1949         See linkgit:git-show-branch[1].
1951 status.relativePaths::
1952         By default, linkgit:git-status[1] shows paths relative to the
1953         current directory. Setting this variable to `false` shows paths
1954         relative to the repository root (this was the default for git
1955         prior to v1.5.4).
1957 status.showUntrackedFiles::
1958         By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1959         files which are not currently tracked by Git. Directories which
1960         contain only untracked files, are shown with the directory name
1961         only. Showing untracked files means that Git needs to lstat() all
1962         all the files in the whole repository, which might be slow on some
1963         systems. So, this variable controls how the commands displays
1964         the untracked files. Possible values are:
1967 * `no` - Show no untracked files.
1968 * `normal` - Show untracked files and directories.
1969 * `all` - Show also individual files in untracked directories.
1972 If this variable is not specified, it defaults to 'normal'.
1973 This variable can be overridden with the -u|--untracked-files option
1974 of linkgit:git-status[1] and linkgit:git-commit[1].
1976 status.submodulesummary::
1977         Defaults to false.
1978         If this is set to a non zero number or true (identical to -1 or an
1979         unlimited number), the submodule summary will be enabled and a
1980         summary of commits for modified submodules will be shown (see
1981         --summary-limit option of linkgit:git-submodule[1]).
1983 submodule.<name>.path::
1984 submodule.<name>.url::
1985 submodule.<name>.update::
1986         The path within this project, URL, and the updating strategy
1987         for a submodule.  These variables are initially populated
1988         by 'git submodule init'; edit them to override the
1989         URL and other values found in the `.gitmodules` file.  See
1990         linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
1992 submodule.<name>.fetchRecurseSubmodules::
1993         This option can be used to control recursive fetching of this
1994         submodule. It can be overridden by using the --[no-]recurse-submodules
1995         command line option to "git fetch" and "git pull".
1996         This setting will override that from in the linkgit:gitmodules[5]
1997         file.
1999 submodule.<name>.ignore::
2000         Defines under what circumstances "git status" and the diff family show
2001         a submodule as modified. When set to "all", it will never be considered
2002         modified, "dirty" will ignore all changes to the submodules work tree and
2003         takes only differences between the HEAD of the submodule and the commit
2004         recorded in the superproject into account. "untracked" will additionally
2005         let submodules with modified tracked files in their work tree show up.
2006         Using "none" (the default when this option is not set) also shows
2007         submodules that have untracked files in their work tree as changed.
2008         This setting overrides any setting made in .gitmodules for this submodule,
2009         both settings can be overridden on the command line by using the
2010         "--ignore-submodules" option.
2012 tar.umask::
2013         This variable can be used to restrict the permission bits of
2014         tar archive entries.  The default is 0002, which turns off the
2015         world write bit.  The special value "user" indicates that the
2016         archiving user's umask will be used instead.  See umask(2) and
2017         linkgit:git-archive[1].
2019 transfer.fsckObjects::
2020         When `fetch.fsckObjects` or `receive.fsckObjects` are
2021         not set, the value of this variable is used instead.
2022         Defaults to false.
2024 transfer.unpackLimit::
2025         When `fetch.unpackLimit` or `receive.unpackLimit` are
2026         not set, the value of this variable is used instead.
2027         The default value is 100.
2029 url.<base>.insteadOf::
2030         Any URL that starts with this value will be rewritten to
2031         start, instead, with <base>. In cases where some site serves a
2032         large number of repositories, and serves them with multiple
2033         access methods, and some users need to use different access
2034         methods, this feature allows people to specify any of the
2035         equivalent URLs and have git automatically rewrite the URL to
2036         the best alternative for the particular user, even for a
2037         never-before-seen repository on the site.  When more than one
2038         insteadOf strings match a given URL, the longest match is used.
2040 url.<base>.pushInsteadOf::
2041         Any URL that starts with this value will not be pushed to;
2042         instead, it will be rewritten to start with <base>, and the
2043         resulting URL will be pushed to. In cases where some site serves
2044         a large number of repositories, and serves them with multiple
2045         access methods, some of which do not allow push, this feature
2046         allows people to specify a pull-only URL and have git
2047         automatically use an appropriate URL to push, even for a
2048         never-before-seen repository on the site.  When more than one
2049         pushInsteadOf strings match a given URL, the longest match is
2050         used.  If a remote has an explicit pushurl, git will ignore this
2051         setting for that remote.
2053 user.email::
2054         Your email address to be recorded in any newly created commits.
2055         Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
2056         'EMAIL' environment variables.  See linkgit:git-commit-tree[1].
2058 user.name::
2059         Your full name to be recorded in any newly created commits.
2060         Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
2061         environment variables.  See linkgit:git-commit-tree[1].
2063 user.signingkey::
2064         If linkgit:git-tag[1] is not selecting the key you want it to
2065         automatically when creating a signed tag, you can override the
2066         default selection with this variable.  This option is passed
2067         unchanged to gpg's --local-user parameter, so you may specify a key
2068         using any method that gpg supports.
2070 web.browser::
2071         Specify a web browser that may be used by some commands.
2072         Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
2073         may use it.