MSVC: require pton and ntop emulation
[git/dscho.git] / Documentation / config.txt
blob2aba2a88fb3d4d1207c6dcf97a98e29e85936e62
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', 'pushNonFFDefault', 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         pushNonFFDefault::
151                 Advice to set 'push.default' to 'upstream' or 'current'
152                 when you ran linkgit:git-push[1] and pushed 'matching
153                 refs' by default (i.e. you did not provide an explicit
154                 refspec, and no 'push.default' configuration was set)
155                 and it resulted in a non-fast-forward error.
156         pushNonFFMatching::
157                 Advice shown when you ran linkgit:git-push[1] and pushed
158                 'matching refs' explicitly (i.e. you used ':', or
159                 specified a refspec that isn't your current branch) and
160                 it resulted in a non-fast-forward error.
161         statusHints::
162                 Directions on how to stage/unstage/add shown in the
163                 output of linkgit:git-status[1] and the template shown
164                 when writing commit messages.
165         commitBeforeMerge::
166                 Advice shown when linkgit:git-merge[1] refuses to
167                 merge to avoid overwriting local changes.
168         resolveConflict::
169                 Advices shown by various commands when conflicts
170                 prevent the operation from being performed.
171         implicitIdentity::
172                 Advice on how to set your identity configuration when
173                 your information is guessed from the system username and
174                 domain name.
175         detachedHead::
176                 Advice shown when you used linkgit:git-checkout[1] to
177                 move to the detach HEAD state, to instruct how to create
178                 a local branch after the fact.
181 core.fileMode::
182         If false, the executable bit differences between the index and
183         the working tree are ignored; useful on broken filesystems like FAT.
184         See linkgit:git-update-index[1].
186 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
187 will probe and set core.fileMode false if appropriate when the
188 repository is created.
190 core.hideDotFiles::
191         (Windows-only) If true (which is the default), mark newly-created
192         directories and files whose name starts with a dot as hidden.
193         If 'dotGitOnly', only the .git/ directory is hidden, but no other
194         files starting with a dot.
196 core.ignoreCygwinFSTricks::
197         This option is only used by Cygwin implementation of Git. If false,
198         the Cygwin stat() and lstat() functions are used. This may be useful
199         if your repository consists of a few separate directories joined in
200         one hierarchy using Cygwin mount. If true, Git uses native Win32 API
201         whenever it is possible and falls back to Cygwin functions only to
202         handle symbol links. The native mode is more than twice faster than
203         normal Cygwin l/stat() functions. True by default, unless core.filemode
204         is true, in which case ignoreCygwinFSTricks is ignored as Cygwin's
205         POSIX emulation is required to support core.filemode.
207 core.ignorecase::
208         If true, this option enables various workarounds to enable
209         git to work better on filesystems that are not case sensitive,
210         like FAT. For example, if a directory listing finds
211         "makefile" when git expects "Makefile", git will assume
212         it is really the same file, and continue to remember it as
213         "Makefile".
215 The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
216 will probe and set core.ignorecase true if appropriate when the repository
217 is created.
219 core.trustctime::
220         If false, the ctime differences between the index and the
221         working tree are ignored; useful when the inode change time
222         is regularly modified by something outside Git (file system
223         crawlers and some backup systems).
224         See linkgit:git-update-index[1]. True by default.
226 core.quotepath::
227         The commands that output paths (e.g. 'ls-files',
228         'diff'), when not given the `-z` option, will quote
229         "unusual" characters in the pathname by enclosing the
230         pathname in a double-quote pair and with backslashes the
231         same way strings in C source code are quoted.  If this
232         variable is set to false, the bytes higher than 0x80 are
233         not quoted but output as verbatim.  Note that double
234         quote, backslash and control characters are always
235         quoted without `-z` regardless of the setting of this
236         variable.
238 core.eol::
239         Sets the line ending type to use in the working directory for
240         files that have the `text` property set.  Alternatives are
241         'lf', 'crlf' and 'native', which uses the platform's native
242         line ending.  The default value is `native`.  See
243         linkgit:gitattributes[5] for more information on end-of-line
244         conversion.
246 core.safecrlf::
247         If true, makes git check if converting `CRLF` is reversible when
248         end-of-line conversion is active.  Git will verify if a command
249         modifies a file in the work tree either directly or indirectly.
250         For example, committing a file followed by checking out the
251         same file should yield the original file in the work tree.  If
252         this is not the case for the current setting of
253         `core.autocrlf`, git will reject the file.  The variable can
254         be set to "warn", in which case git will only warn about an
255         irreversible conversion but continue the operation.
257 CRLF conversion bears a slight chance of corrupting data.
258 When it is enabled, git will convert CRLF to LF during commit and LF to
259 CRLF during checkout.  A file that contains a mixture of LF and
260 CRLF before the commit cannot be recreated by git.  For text
261 files this is the right thing to do: it corrects line endings
262 such that we have only LF line endings in the repository.
263 But for binary files that are accidentally classified as text the
264 conversion can corrupt data.
266 If you recognize such corruption early you can easily fix it by
267 setting the conversion type explicitly in .gitattributes.  Right
268 after committing you still have the original file in your work
269 tree and this file is not yet corrupted.  You can explicitly tell
270 git that this file is binary and git will handle the file
271 appropriately.
273 Unfortunately, the desired effect of cleaning up text files with
274 mixed line endings and the undesired effect of corrupting binary
275 files cannot be distinguished.  In both cases CRLFs are removed
276 in an irreversible way.  For text files this is the right thing
277 to do because CRLFs are line endings, while for binary files
278 converting CRLFs corrupts data.
280 Note, this safety check does not mean that a checkout will generate a
281 file identical to the original file for a different setting of
282 `core.eol` and `core.autocrlf`, but only for the current one.  For
283 example, a text file with `LF` would be accepted with `core.eol=lf`
284 and could later be checked out with `core.eol=crlf`, in which case the
285 resulting file would contain `CRLF`, although the original file
286 contained `LF`.  However, in both work trees the line endings would be
287 consistent, that is either all `LF` or all `CRLF`, but never mixed.  A
288 file with mixed line endings would be reported by the `core.safecrlf`
289 mechanism.
291 core.autocrlf::
292         Setting this variable to "true" is almost the same as setting
293         the `text` attribute to "auto" on all files except that text
294         files are not guaranteed to be normalized: files that contain
295         `CRLF` in the repository will not be touched.  Use this
296         setting if you want to have `CRLF` line endings in your
297         working directory even though the repository does not have
298         normalized line endings.  This variable can be set to 'input',
299         in which case no output conversion is performed.
301 core.symlinks::
302         If false, symbolic links are checked out as small plain files that
303         contain the link text. linkgit:git-update-index[1] and
304         linkgit:git-add[1] will not change the recorded type to regular
305         file. Useful on filesystems like FAT that do not support
306         symbolic links.
308 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
309 will probe and set core.symlinks false if appropriate when the repository
310 is created.
312 core.gitProxy::
313         A "proxy command" to execute (as 'command host port') instead
314         of establishing direct connection to the remote server when
315         using the git protocol for fetching. If the variable value is
316         in the "COMMAND for DOMAIN" format, the command is applied only
317         on hostnames ending with the specified domain string. This variable
318         may be set multiple times and is matched in the given order;
319         the first match wins.
321 Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
322 (which always applies universally, without the special "for"
323 handling).
325 The special string `none` can be used as the proxy command to
326 specify that no proxy be used for a given domain pattern.
327 This is useful for excluding servers inside a firewall from
328 proxy use, while defaulting to a common proxy for external domains.
330 core.ignoreStat::
331         If true, commands which modify both the working tree and the index
332         will mark the updated paths with the "assume unchanged" bit in the
333         index. These marked files are then assumed to stay unchanged in the
334         working tree, until you mark them otherwise manually - Git will not
335         detect the file changes by lstat() calls. This is useful on systems
336         where those are very slow, such as Microsoft Windows.
337         See linkgit:git-update-index[1].
338         False by default.
340 core.preferSymlinkRefs::
341         Instead of the default "symref" format for HEAD
342         and other symbolic reference files, use symbolic links.
343         This is sometimes needed to work with old scripts that
344         expect HEAD to be a symbolic link.
346 core.bare::
347         If true this repository is assumed to be 'bare' and has no
348         working directory associated with it.  If this is the case a
349         number of commands that require a working directory will be
350         disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
352 This setting is automatically guessed by linkgit:git-clone[1] or
353 linkgit:git-init[1] when the repository was created.  By default a
354 repository that ends in "/.git" is assumed to be not bare (bare =
355 false), while all other repositories are assumed to be bare (bare
356 = true).
358 core.worktree::
359         Set the path to the root of the working tree.
360         This can be overridden by the GIT_WORK_TREE environment
361         variable and the '--work-tree' command line option.
362         The value can be an absolute path or relative to the path to
363         the .git directory, which is either specified by --git-dir
364         or GIT_DIR, or automatically discovered.
365         If --git-dir or GIT_DIR is specified but none of
366         --work-tree, GIT_WORK_TREE and core.worktree is specified,
367         the current working directory is regarded as the top level
368         of your working tree.
370 Note that this variable is honored even when set in a configuration
371 file in a ".git" subdirectory of a directory and its value differs
372 from the latter directory (e.g. "/path/to/.git/config" has
373 core.worktree set to "/different/path"), which is most likely a
374 misconfiguration.  Running git commands in the "/path/to" directory will
375 still use "/different/path" as the root of the work tree and can cause
376 confusion unless you know what you are doing (e.g. you are creating a
377 read-only snapshot of the same index to a location different from the
378 repository's usual working tree).
380 core.logAllRefUpdates::
381         Enable the reflog. Updates to a ref <ref> is logged to the file
382         "$GIT_DIR/logs/<ref>", by appending the new and old
383         SHA1, the date/time and the reason of the update, but
384         only when the file exists.  If this configuration
385         variable is set to true, missing "$GIT_DIR/logs/<ref>"
386         file is automatically created for branch heads (i.e. under
387         refs/heads/), remote refs (i.e. under refs/remotes/),
388         note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
390 This information can be used to determine what commit
391 was the tip of a branch "2 days ago".
393 This value is true by default in a repository that has
394 a working directory associated with it, and false by
395 default in a bare repository.
397 core.repositoryFormatVersion::
398         Internal variable identifying the repository format and layout
399         version.
401 core.sharedRepository::
402         When 'group' (or 'true'), the repository is made shareable between
403         several users in a group (making sure all the files and objects are
404         group-writable). When 'all' (or 'world' or 'everybody'), the
405         repository will be readable by all users, additionally to being
406         group-shareable. When 'umask' (or 'false'), git will use permissions
407         reported by umask(2). When '0xxx', where '0xxx' is an octal number,
408         files in the repository will have this mode value. '0xxx' will override
409         user's umask value (whereas the other options will only override
410         requested parts of the user's umask value). Examples: '0660' will make
411         the repo read/write-able for the owner and group, but inaccessible to
412         others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
413         repository that is group-readable but not group-writable.
414         See linkgit:git-init[1]. False by default.
416 core.warnAmbiguousRefs::
417         If true, git will warn you if the ref name you passed it is ambiguous
418         and might match multiple refs in the .git/refs/ tree. True by default.
420 core.compression::
421         An integer -1..9, indicating a default compression level.
422         -1 is the zlib default. 0 means no compression,
423         and 1..9 are various speed/size tradeoffs, 9 being slowest.
424         If set, this provides a default to other compression variables,
425         such as 'core.loosecompression' and 'pack.compression'.
427 core.loosecompression::
428         An integer -1..9, indicating the compression level for objects that
429         are not in a pack file. -1 is the zlib default. 0 means no
430         compression, and 1..9 are various speed/size tradeoffs, 9 being
431         slowest.  If not set,  defaults to core.compression.  If that is
432         not set,  defaults to 1 (best speed).
434 core.packedGitWindowSize::
435         Number of bytes of a pack file to map into memory in a
436         single mapping operation.  Larger window sizes may allow
437         your system to process a smaller number of large pack files
438         more quickly.  Smaller window sizes will negatively affect
439         performance due to increased calls to the operating system's
440         memory manager, but may improve performance when accessing
441         a large number of large pack files.
443 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
444 MiB on 32 bit platforms and 1 GiB on 64 bit platforms.  This should
445 be reasonable for all users/operating systems.  You probably do
446 not need to adjust this value.
448 Common unit suffixes of 'k', 'm', or 'g' are supported.
450 core.packedGitLimit::
451         Maximum number of bytes to map simultaneously into memory
452         from pack files.  If Git needs to access more than this many
453         bytes at once to complete an operation it will unmap existing
454         regions to reclaim virtual address space within the process.
456 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
457 This should be reasonable for all users/operating systems, except on
458 the largest projects.  You probably do not need to adjust this value.
460 Common unit suffixes of 'k', 'm', or 'g' are supported.
462 core.deltaBaseCacheLimit::
463         Maximum number of bytes to reserve for caching base objects
464         that may be referenced by multiple deltified objects.  By storing the
465         entire decompressed base objects in a cache Git is able
466         to avoid unpacking and decompressing frequently used base
467         objects multiple times.
469 Default is 16 MiB on all platforms.  This should be reasonable
470 for all users/operating systems, except on the largest projects.
471 You probably do not need to adjust this value.
473 Common unit suffixes of 'k', 'm', or 'g' are supported.
475 core.bigFileThreshold::
476         Files larger than this size are stored deflated, without
477         attempting delta compression.  Storing large files without
478         delta compression avoids excessive memory usage, at the
479         slight expense of increased disk usage.
481 Default is 512 MiB on all platforms.  This should be reasonable
482 for most projects as source code and other text files can still
483 be delta compressed, but larger binary media files won't be.
485 Common unit suffixes of 'k', 'm', or 'g' are supported.
487 core.excludesfile::
488         In addition to '.gitignore' (per-directory) and
489         '.git/info/exclude', git looks into this file for patterns
490         of files which are not meant to be tracked.  "`~/`" is expanded
491         to the value of `$HOME` and "`~user/`" to the specified user's
492         home directory.  See linkgit:gitignore[5].
494 core.askpass::
495         Some commands (e.g. svn and http interfaces) that interactively
496         ask for a password can be told to use an external program given
497         via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
498         environment variable. If not set, fall back to the value of the
499         'SSH_ASKPASS' environment variable or, failing that, a simple password
500         prompt. The external program shall be given a suitable prompt as
501         command line argument and write the password on its STDOUT.
503 core.attributesfile::
504         In addition to '.gitattributes' (per-directory) and
505         '.git/info/attributes', git looks into this file for attributes
506         (see linkgit:gitattributes[5]). Path expansions are made the same
507         way as for `core.excludesfile`.
509 core.editor::
510         Commands such as `commit` and `tag` that lets you edit
511         messages by launching an editor uses the value of this
512         variable when it is set, and the environment variable
513         `GIT_EDITOR` is not set.  See linkgit:git-var[1].
515 sequence.editor::
516         Text editor used by `git rebase -i` for editing the rebase insn file.
517         The value is meant to be interpreted by the shell when it is used.
518         It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
519         When not configured the default commit message editor is used instead.
521 core.pager::
522         The command that git will use to paginate output.  Can
523         be overridden with the `GIT_PAGER` environment
524         variable.  Note that git sets the `LESS` environment
525         variable to `FRSX` if it is unset when it runs the
526         pager.  One can change these settings by setting the
527         `LESS` variable to some other value.  Alternately,
528         these settings can be overridden on a project or
529         global basis by setting the `core.pager` option.
530         Setting `core.pager` has no affect on the `LESS`
531         environment variable behaviour above, so if you want
532         to override git's default settings this way, you need
533         to be explicit.  For example, to disable the S option
534         in a backward compatible manner, set `core.pager`
535         to `less -+$LESS -FRX`.  This will be passed to the
536         shell by git, which will translate the final command to
537         `LESS=FRSX less -+FRSX -FRX`.
539 core.whitespace::
540         A comma separated list of common whitespace problems to
541         notice.  'git diff' will use `color.diff.whitespace` to
542         highlight them, and 'git apply --whitespace=error' will
543         consider them as errors.  You can prefix `-` to disable
544         any of them (e.g. `-trailing-space`):
546 * `blank-at-eol` treats trailing whitespaces at the end of the line
547   as an error (enabled by default).
548 * `space-before-tab` treats a space character that appears immediately
549   before a tab character in the initial indent part of the line as an
550   error (enabled by default).
551 * `indent-with-non-tab` treats a line that is indented with 8 or more
552   space characters as an error (not enabled by default).
553 * `tab-in-indent` treats a tab character in the initial indent part of
554   the line as an error (not enabled by default).
555 * `blank-at-eof` treats blank lines added at the end of file as an error
556   (enabled by default).
557 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
558   `blank-at-eof`.
559 * `cr-at-eol` treats a carriage-return at the end of line as
560   part of the line terminator, i.e. with it, `trailing-space`
561   does not trigger if the character before such a carriage-return
562   is not a whitespace (not enabled by default).
563 * `tabwidth=<n>` tells how many character positions a tab occupies; this
564   is relevant for `indent-with-non-tab` and when git fixes `tab-in-indent`
565   errors. The default tab width is 8. Allowed values are 1 to 63.
567 core.fsyncobjectfiles::
568         This boolean will enable 'fsync()' when writing object files.
570 This is a total waste of time and effort on a filesystem that orders
571 data writes properly, but can be useful for filesystems that do not use
572 journalling (traditional UNIX filesystems) or that only journal metadata
573 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
575 core.preloadindex::
576         Enable parallel index preload for operations like 'git diff'
578 This can speed up operations like 'git diff' and 'git status' especially
579 on filesystems like NFS that have weak caching semantics and thus
580 relatively high IO latencies.  With this set to 'true', git will do the
581 index comparison to the filesystem data in parallel, allowing
582 overlapping IO's.
584 core.createObject::
585         You can set this to 'link', in which case a hardlink followed by
586         a delete of the source are used to make sure that object creation
587         will not overwrite existing objects.
589 On some file system/operating system combinations, this is unreliable.
590 Set this config setting to 'rename' there; However, This will remove the
591 check that makes sure that existing object files will not get overwritten.
593 core.notesRef::
594         When showing commit messages, also show notes which are stored in
595         the given ref.  The ref must be fully qualified.  If the given
596         ref does not exist, it is not an error but means that no
597         notes should be printed.
599 This setting defaults to "refs/notes/commits", and it can be overridden by
600 the 'GIT_NOTES_REF' environment variable.  See linkgit:git-notes[1].
602 core.sparseCheckout::
603         Enable "sparse checkout" feature. See section "Sparse checkout" in
604         linkgit:git-read-tree[1] for more information.
606 core.abbrev::
607         Set the length object names are abbreviated to.  If unspecified,
608         many commands abbreviate to 7 hexdigits, which may not be enough
609         for abbreviated object names to stay unique for sufficiently long
610         time.
612 add.ignore-errors::
613 add.ignoreErrors::
614         Tells 'git add' to continue adding files when some files cannot be
615         added due to indexing errors. Equivalent to the '--ignore-errors'
616         option of linkgit:git-add[1].  Older versions of git accept only
617         `add.ignore-errors`, which does not follow the usual naming
618         convention for configuration variables.  Newer versions of git
619         honor `add.ignoreErrors` as well.
621 alias.*::
622         Command aliases for the linkgit:git[1] command wrapper - e.g.
623         after defining "alias.last = cat-file commit HEAD", the invocation
624         "git last" is equivalent to "git cat-file commit HEAD". To avoid
625         confusion and troubles with script usage, aliases that
626         hide existing git commands are ignored. Arguments are split by
627         spaces, the usual shell quoting and escaping is supported.
628         quote pair and a backslash can be used to quote them.
630 If the alias expansion is prefixed with an exclamation point,
631 it will be treated as a shell command.  For example, defining
632 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
633 "git new" is equivalent to running the shell command
634 "gitk --all --not ORIG_HEAD".  Note that shell commands will be
635 executed from the top-level directory of a repository, which may
636 not necessarily be the current directory.
637 'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
638 from the original current directory. See linkgit:git-rev-parse[1].
640 am.keepcr::
641         If true, git-am will call git-mailsplit for patches in mbox format
642         with parameter '--keep-cr'. In this case git-mailsplit will
643         not remove `\r` from lines ending with `\r\n`. Can be overridden
644         by giving '--no-keep-cr' from the command line.
645         See linkgit:git-am[1], linkgit:git-mailsplit[1].
647 apply.ignorewhitespace::
648         When set to 'change', tells 'git apply' to ignore changes in
649         whitespace, in the same way as the '--ignore-space-change'
650         option.
651         When set to one of: no, none, never, false tells 'git apply' to
652         respect all whitespace differences.
653         See linkgit:git-apply[1].
655 apply.whitespace::
656         Tells 'git apply' how to handle whitespaces, in the same way
657         as the '--whitespace' option. See linkgit:git-apply[1].
659 branch.autosetupmerge::
660         Tells 'git branch' and 'git checkout' to set up new branches
661         so that linkgit:git-pull[1] will appropriately merge from the
662         starting point branch. Note that even if this option is not set,
663         this behavior can be chosen per-branch using the `--track`
664         and `--no-track` options. The valid settings are: `false` -- no
665         automatic setup is done; `true` -- automatic setup is done when the
666         starting point is a remote-tracking branch; `always` --
667         automatic setup is done when the starting point is either a
668         local branch or remote-tracking
669         branch. This option defaults to true.
671 branch.autosetuprebase::
672         When a new branch is created with 'git branch' or 'git checkout'
673         that tracks another branch, this variable tells git to set
674         up pull to rebase instead of merge (see "branch.<name>.rebase").
675         When `never`, rebase is never automatically set to true.
676         When `local`, rebase is set to true for tracked branches of
677         other local branches.
678         When `remote`, rebase is set to true for tracked branches of
679         remote-tracking branches.
680         When `always`, rebase will be set to true for all tracking
681         branches.
682         See "branch.autosetupmerge" for details on how to set up a
683         branch to track another branch.
684         This option defaults to never.
686 branch.<name>.remote::
687         When in branch <name>, it tells 'git fetch' and 'git push' which
688         remote to fetch from/push to.  It defaults to `origin` if no remote is
689         configured. `origin` is also used if you are not on any branch.
691 branch.<name>.merge::
692         Defines, together with branch.<name>.remote, the upstream branch
693         for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
694         branch to merge and can also affect 'git push' (see push.default).
695         When in branch <name>, it tells 'git fetch' the default
696         refspec to be marked for merging in FETCH_HEAD. The value is
697         handled like the remote part of a refspec, and must match a
698         ref which is fetched from the remote given by
699         "branch.<name>.remote".
700         The merge information is used by 'git pull' (which at first calls
701         'git fetch') to lookup the default branch for merging. Without
702         this option, 'git pull' defaults to merge the first refspec fetched.
703         Specify multiple values to get an octopus merge.
704         If you wish to setup 'git pull' so that it merges into <name> from
705         another branch in the local repository, you can point
706         branch.<name>.merge to the desired branch, and use the special setting
707         `.` (a period) for branch.<name>.remote.
709 branch.<name>.mergeoptions::
710         Sets default options for merging into branch <name>. The syntax and
711         supported options are the same as those of linkgit:git-merge[1], but
712         option values containing whitespace characters are currently not
713         supported.
715 branch.<name>.rebase::
716         When true, rebase the branch <name> on top of the fetched branch,
717         instead of merging the default branch from the default remote when
718         "git pull" is run. See "pull.rebase" for doing this in a non
719         branch-specific manner.
720         When the value is `interactive`, the rebase is run in interactive mode.
722 *NOTE*: this is a possibly dangerous operation; do *not* use
723 it unless you understand the implications (see linkgit:git-rebase[1]
724 for details).
726 browser.<tool>.cmd::
727         Specify the command to invoke the specified browser. The
728         specified command is evaluated in shell with the URLs passed
729         as arguments. (See linkgit:git-web{litdd}browse[1].)
731 browser.<tool>.path::
732         Override the path for the given tool that may be used to
733         browse HTML help (see '-w' option in linkgit:git-help[1]) or a
734         working repository in gitweb (see linkgit:git-instaweb[1]).
736 clean.requireForce::
737         A boolean to make git-clean do nothing unless given -f
738         or -n.   Defaults to true.
740 color.branch::
741         A boolean to enable/disable color in the output of
742         linkgit:git-branch[1]. May be set to `always`,
743         `false` (or `never`) or `auto` (or `true`), in which case colors are used
744         only when the output is to a terminal. Defaults to false.
746 color.branch.<slot>::
747         Use customized color for branch coloration. `<slot>` is one of
748         `current` (the current branch), `local` (a local branch),
749         `remote` (a remote-tracking branch in refs/remotes/), `plain` (other
750         refs).
752 The value for these configuration variables is a list of colors (at most
753 two) and attributes (at most one), separated by spaces.  The colors
754 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
755 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
756 `blink` and `reverse`.  The first color given is the foreground; the
757 second is the background.  The position of the attribute, if any,
758 doesn't matter.
760 color.diff::
761         Whether to use ANSI escape sequences to add color to patches.
762         If this is set to `always`, linkgit:git-diff[1],
763         linkgit:git-log[1], and linkgit:git-show[1] will use color
764         for all patches.  If it is set to `true` or `auto`, those
765         commands will only use color when output is to the terminal.
766         Defaults to false.
768 This does not affect linkgit:git-format-patch[1] nor the
769 'git-diff-{asterisk}' plumbing commands.  Can be overridden on the
770 command line with the `--color[=<when>]` option.
772 color.diff.<slot>::
773         Use customized color for diff colorization.  `<slot>` specifies
774         which part of the patch to use the specified color, and is one
775         of `plain` (context text), `meta` (metainformation), `frag`
776         (hunk header), 'func' (function in hunk header), `old` (removed lines),
777         `new` (added lines), `commit` (commit headers), or `whitespace`
778         (highlighting whitespace errors). The values of these variables may be
779         specified as in color.branch.<slot>.
781 color.decorate.<slot>::
782         Use customized color for 'git log --decorate' output.  `<slot>` is one
783         of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
784         branches, remote-tracking branches, tags, stash and HEAD, respectively.
786 color.grep::
787         When set to `always`, always highlight matches.  When `false` (or
788         `never`), never.  When set to `true` or `auto`, use color only
789         when the output is written to the terminal.  Defaults to `false`.
791 color.grep.<slot>::
792         Use customized color for grep colorization.  `<slot>` specifies which
793         part of the line to use the specified color, and is one of
796 `context`;;
797         non-matching text in context lines (when using `-A`, `-B`, or `-C`)
798 `filename`;;
799         filename prefix (when not using `-h`)
800 `function`;;
801         function name lines (when using `-p`)
802 `linenumber`;;
803         line number prefix (when using `-n`)
804 `match`;;
805         matching text
806 `selected`;;
807         non-matching text in selected lines
808 `separator`;;
809         separators between fields on a line (`:`, `-`, and `=`)
810         and between hunks (`--`)
813 The values of these variables may be specified as in color.branch.<slot>.
815 color.interactive::
816         When set to `always`, always use colors for interactive prompts
817         and displays (such as those used by "git-add --interactive").
818         When false (or `never`), never.  When set to `true` or `auto`, use
819         colors only when the output is to the terminal. Defaults to false.
821 color.interactive.<slot>::
822         Use customized color for 'git add --interactive'
823         output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
824         four distinct types of normal output from interactive
825         commands.  The values of these variables may be specified as
826         in color.branch.<slot>.
828 color.pager::
829         A boolean to enable/disable colored output when the pager is in
830         use (default is true).
832 color.showbranch::
833         A boolean to enable/disable color in the output of
834         linkgit:git-show-branch[1]. May be set to `always`,
835         `false` (or `never`) or `auto` (or `true`), in which case colors are used
836         only when the output is to a terminal. Defaults to false.
838 color.status::
839         A boolean to enable/disable color in the output of
840         linkgit:git-status[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.<slot>::
845         Use customized color for status colorization. `<slot>` is
846         one of `header` (the header text of the status message),
847         `added` or `updated` (files which are added but not committed),
848         `changed` (files which are changed but not added in the index),
849         `untracked` (files which are not tracked by git),
850         `branch` (the current branch), or
851         `nobranch` (the color the 'no branch' warning is shown in, defaulting
852         to red). The values of these variables may be specified as in
853         color.branch.<slot>.
855 color.ui::
856         This variable determines the default value for variables such
857         as `color.diff` and `color.grep` that control the use of color
858         per command family. Its scope will expand as more commands learn
859         configuration to set a default for the `--color` option.  Set it
860         to `always` if you want all output not intended for machine
861         consumption to use color, to `true` or `auto` if you want such
862         output to use color when written to the terminal, or to `false` or
863         `never` if you prefer git commands not to use color unless enabled
864         explicitly with some other configuration or the `--color` option.
866 column.ui::
867         Specify whether supported commands should output in columns.
868         This variable consists of a list of tokens separated by spaces
869         or commas:
872 `always`;;
873         always show in columns
874 `never`;;
875         never show in columns
876 `auto`;;
877         show in columns if the output is to the terminal
878 `column`;;
879         fill columns before rows (default)
880 `row`;;
881         fill rows before columns
882 `plain`;;
883         show in one column
884 `dense`;;
885         make unequal size columns to utilize more space
886 `nodense`;;
887         make equal size columns
890         This option defaults to 'never'.
892 column.branch::
893         Specify whether to output branch listing in `git branch` in columns.
894         See `column.ui` for details.
896 column.status::
897         Specify whether to output untracked files in `git status` in columns.
898         See `column.ui` for details.
900 column.tag::
901         Specify whether to output tag listing in `git tag` in columns.
902         See `column.ui` for details.
904 commit.status::
905         A boolean to enable/disable inclusion of status information in the
906         commit message template when using an editor to prepare the commit
907         message.  Defaults to true.
909 commit.template::
910         Specify a file to use as the template for new commit messages.
911         "`~/`" is expanded to the value of `$HOME` and "`~user/`" to the
912         specified user's home directory.
914 credential.helper::
915         Specify an external helper to be called when a username or
916         password credential is needed; the helper may consult external
917         storage to avoid prompting the user for the credentials. See
918         linkgit:gitcredentials[7] for details.
920 credential.useHttpPath::
921         When acquiring credentials, consider the "path" component of an http
922         or https URL to be important. Defaults to false. See
923         linkgit:gitcredentials[7] for more information.
925 credential.username::
926         If no username is set for a network authentication, use this username
927         by default. See credential.<context>.* below, and
928         linkgit:gitcredentials[7].
930 credential.<url>.*::
931         Any of the credential.* options above can be applied selectively to
932         some credentials. For example "credential.https://example.com.username"
933         would set the default username only for https connections to
934         example.com. See linkgit:gitcredentials[7] for details on how URLs are
935         matched.
937 include::diff-config.txt[]
939 difftool.<tool>.path::
940         Override the path for the given tool.  This is useful in case
941         your tool is not in the PATH.
943 difftool.<tool>.cmd::
944         Specify the command to invoke the specified diff tool.
945         The specified command is evaluated in shell with the following
946         variables available:  'LOCAL' is set to the name of the temporary
947         file containing the contents of the diff pre-image and 'REMOTE'
948         is set to the name of the temporary file containing the contents
949         of the diff post-image.
951 difftool.prompt::
952         Prompt before each invocation of the diff tool.
954 diff.wordRegex::
955         A POSIX Extended Regular Expression used to determine what is a "word"
956         when performing word-by-word difference calculations.  Character
957         sequences that match the regular expression are "words", all other
958         characters are *ignorable* whitespace.
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.extendedRegexp::
1204         If set to true, enable '--extended-regexp' option by default.
1206 gpg.program::
1207         Use this custom program instead of "gpg" found on $PATH when
1208         making or verifying a PGP signature. The program must support the
1209         same command line interface as GPG, namely, to verify a detached
1210         signature, "gpg --verify $file - <$signature" is run, and the
1211         program is expected to signal a good signature by exiting with
1212         code 0, and to generate an ascii-armored detached signature, the
1213         standard input of "gpg -bsau $key" is fed with the contents to be
1214         signed, and the program is expected to send the result to its
1215         standard output.
1217 gui.commitmsgwidth::
1218         Defines how wide the commit message window is in the
1219         linkgit:git-gui[1]. "75" is the default.
1221 gui.diffcontext::
1222         Specifies how many context lines should be used in calls to diff
1223         made by the linkgit:git-gui[1]. The default is "5".
1225 gui.encoding::
1226         Specifies the default encoding to use for displaying of
1227         file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1228         It can be overridden by setting the 'encoding' attribute
1229         for relevant files (see linkgit:gitattributes[5]).
1230         If this option is not set, the tools default to the
1231         locale encoding.
1233 gui.matchtrackingbranch::
1234         Determines if new branches created with linkgit:git-gui[1] should
1235         default to tracking remote branches with matching names or
1236         not. Default: "false".
1238 gui.newbranchtemplate::
1239         Is used as suggested name when creating new branches using the
1240         linkgit:git-gui[1].
1242 gui.pruneduringfetch::
1243         "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1244         performing a fetch. The default value is "false".
1246 gui.trustmtime::
1247         Determines if linkgit:git-gui[1] should trust the file modification
1248         timestamp or not. By default the timestamps are not trusted.
1250 gui.spellingdictionary::
1251         Specifies the dictionary used for spell checking commit messages in
1252         the linkgit:git-gui[1]. When set to "none" spell checking is turned
1253         off.
1255 gui.fastcopyblame::
1256         If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1257         location detection. It makes blame significantly faster on huge
1258         repositories at the expense of less thorough copy detection.
1260 gui.copyblamethreshold::
1261         Specifies the threshold to use in 'git gui blame' original location
1262         detection, measured in alphanumeric characters. See the
1263         linkgit:git-blame[1] manual for more information on copy detection.
1265 gui.blamehistoryctx::
1266         Specifies the radius of history context in days to show in
1267         linkgit:gitk[1] for the selected commit, when the `Show History
1268         Context` menu item is invoked from 'git gui blame'. If this
1269         variable is set to zero, the whole history is shown.
1271 guitool.<name>.cmd::
1272         Specifies the shell command line to execute when the corresponding item
1273         of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1274         mandatory for every tool. The command is executed from the root of
1275         the working directory, and in the environment it receives the name of
1276         the tool as 'GIT_GUITOOL', the name of the currently selected file as
1277         'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1278         the head is detached, 'CUR_BRANCH' is empty).
1280 guitool.<name>.needsfile::
1281         Run the tool only if a diff is selected in the GUI. It guarantees
1282         that 'FILENAME' is not empty.
1284 guitool.<name>.noconsole::
1285         Run the command silently, without creating a window to display its
1286         output.
1288 guitool.<name>.norescan::
1289         Don't rescan the working directory for changes after the tool
1290         finishes execution.
1292 guitool.<name>.confirm::
1293         Show a confirmation dialog before actually running the tool.
1295 guitool.<name>.argprompt::
1296         Request a string argument from the user, and pass it to the tool
1297         through the 'ARGS' environment variable. Since requesting an
1298         argument implies confirmation, the 'confirm' option has no effect
1299         if this is enabled. If the option is set to 'true', 'yes', or '1',
1300         the dialog uses a built-in generic prompt; otherwise the exact
1301         value of the variable is used.
1303 guitool.<name>.revprompt::
1304         Request a single valid revision from the user, and set the
1305         'REVISION' environment variable. In other aspects this option
1306         is similar to 'argprompt', and can be used together with it.
1308 guitool.<name>.revunmerged::
1309         Show only unmerged branches in the 'revprompt' subdialog.
1310         This is useful for tools similar to merge or rebase, but not
1311         for things like checkout or reset.
1313 guitool.<name>.title::
1314         Specifies the title to use for the prompt dialog. The default
1315         is the tool name.
1317 guitool.<name>.prompt::
1318         Specifies the general prompt string to display at the top of
1319         the dialog, before subsections for 'argprompt' and 'revprompt'.
1320         The default value includes the actual command.
1322 help.browser::
1323         Specify the browser that will be used to display help in the
1324         'web' format. See linkgit:git-help[1].
1326 help.format::
1327         Override the default help format used by linkgit:git-help[1].
1328         Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1329         the default. 'web' and 'html' are the same.
1331 help.autocorrect::
1332         Automatically correct and execute mistyped commands after
1333         waiting for the given number of deciseconds (0.1 sec). If more
1334         than one command can be deduced from the entered text, nothing
1335         will be executed.  If the value of this option is negative,
1336         the corrected command will be executed immediately. If the
1337         value is 0 - the command will be just shown but not executed.
1338         This is the default.
1340 http.proxy::
1341         Override the HTTP proxy, normally configured using the 'http_proxy',
1342         'https_proxy', and 'all_proxy' environment variables (see
1343         `curl(1)`).  This can be overridden on a per-remote basis; see
1344         remote.<name>.proxy
1346 http.cookiefile::
1347         File containing previously stored cookie lines which should be used
1348         in the git http session, if they match the server. The file format
1349         of the file to read cookies from should be plain HTTP headers or
1350         the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
1351         NOTE that the file specified with http.cookiefile is only used as
1352         input. No cookies will be stored in the file.
1354 http.sslVerify::
1355         Whether to verify the SSL certificate when fetching or pushing
1356         over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1357         variable.
1359 http.sslCert::
1360         File containing the SSL certificate when fetching or pushing
1361         over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1362         variable.
1364 http.sslKey::
1365         File containing the SSL private key when fetching or pushing
1366         over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1367         variable.
1369 http.sslCertPasswordProtected::
1370         Enable git's password prompt for the SSL certificate.  Otherwise
1371         OpenSSL will prompt the user, possibly many times, if the
1372         certificate or private key is encrypted.  Can be overridden by the
1373         'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1375 http.sslCAInfo::
1376         File containing the certificates to verify the peer with when
1377         fetching or pushing over HTTPS. Can be overridden by the
1378         'GIT_SSL_CAINFO' environment variable.
1380 http.sslCAPath::
1381         Path containing files with the CA certificates to verify the peer
1382         with when fetching or pushing over HTTPS. Can be overridden
1383         by the 'GIT_SSL_CAPATH' environment variable.
1385 http.maxRequests::
1386         How many HTTP requests to launch in parallel. Can be overridden
1387         by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1389 http.minSessions::
1390         The number of curl sessions (counted across slots) to be kept across
1391         requests. They will not be ended with curl_easy_cleanup() until
1392         http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1393         value will be capped at 1. Defaults to 1.
1395 http.postBuffer::
1396         Maximum size in bytes of the buffer used by smart HTTP
1397         transports when POSTing data to the remote system.
1398         For requests larger than this buffer size, HTTP/1.1 and
1399         Transfer-Encoding: chunked is used to avoid creating a
1400         massive pack file locally.  Default is 1 MiB, which is
1401         sufficient for most requests.
1403 http.lowSpeedLimit, http.lowSpeedTime::
1404         If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1405         for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1406         Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1407         'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1409 http.noEPSV::
1410         A boolean which disables using of EPSV ftp command by curl.
1411         This can helpful with some "poor" ftp servers which don't
1412         support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1413         environment variable. Default is false (curl will use EPSV).
1415 http.useragent::
1416         The HTTP USER_AGENT string presented to an HTTP server.  The default
1417         value represents the version of the client git such as git/1.7.1.
1418         This option allows you to override this value to a more common value
1419         such as Mozilla/4.0.  This may be necessary, for instance, if
1420         connecting through a firewall that restricts HTTP connections to a set
1421         of common USER_AGENT strings (but not including those like git/1.7.1).
1422         Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1424 i18n.commitEncoding::
1425         Character encoding the commit messages are stored in; git itself
1426         does not care per se, but this information is necessary e.g. when
1427         importing commits from emails or in the gitk graphical history
1428         browser (and possibly at other places in the future or in other
1429         porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1431 i18n.logOutputEncoding::
1432         Character encoding the commit messages are converted to when
1433         running 'git log' and friends.
1435 imap::
1436         The configuration variables in the 'imap' section are described
1437         in linkgit:git-imap-send[1].
1439 init.templatedir::
1440         Specify the directory from which templates will be copied.
1441         (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1443 instaweb.browser::
1444         Specify the program that will be used to browse your working
1445         repository in gitweb. See linkgit:git-instaweb[1].
1447 instaweb.httpd::
1448         The HTTP daemon command-line to start gitweb on your working
1449         repository. See linkgit:git-instaweb[1].
1451 instaweb.local::
1452         If true the web server started by linkgit:git-instaweb[1] will
1453         be bound to the local IP (127.0.0.1).
1455 instaweb.modulepath::
1456         The default module path for linkgit:git-instaweb[1] to use
1457         instead of /usr/lib/apache2/modules.  Only used if httpd
1458         is Apache.
1460 instaweb.port::
1461         The port number to bind the gitweb httpd to. See
1462         linkgit:git-instaweb[1].
1464 interactive.singlekey::
1465         In interactive commands, allow the user to provide one-letter
1466         input with a single key (i.e., without hitting enter).
1467         Currently this is used by the `--patch` mode of
1468         linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1469         linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1470         setting is silently ignored if portable keystroke input
1471         is not available.
1473 log.abbrevCommit::
1474         If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1475         linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
1476         override this option with `--no-abbrev-commit`.
1478 log.date::
1479         Set the default date-time mode for the 'log' command.
1480         Setting a value for log.date is similar to using 'git log''s
1481         `--date` option.  Possible values are `relative`, `local`,
1482         `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1483         for details.
1485 log.decorate::
1486         Print out the ref names of any commits that are shown by the log
1487         command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1488         'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1489         specified, the full ref name (including prefix) will be printed.
1490         This is the same as the log commands '--decorate' option.
1492 log.showroot::
1493         If true, the initial commit will be shown as a big creation event.
1494         This is equivalent to a diff against an empty tree.
1495         Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1496         normally hide the root commit will now show it. True by default.
1498 mailmap.file::
1499         The location of an augmenting mailmap file. The default
1500         mailmap, located in the root of the repository, is loaded
1501         first, then the mailmap file pointed to by this variable.
1502         The location of the mailmap file may be in a repository
1503         subdirectory, or somewhere outside of the repository itself.
1504         See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1506 man.viewer::
1507         Specify the programs that may be used to display help in the
1508         'man' format. See linkgit:git-help[1].
1510 man.<tool>.cmd::
1511         Specify the command to invoke the specified man viewer. The
1512         specified command is evaluated in shell with the man page
1513         passed as argument. (See linkgit:git-help[1].)
1515 man.<tool>.path::
1516         Override the path for the given tool that may be used to
1517         display help in the 'man' format. See linkgit:git-help[1].
1519 include::merge-config.txt[]
1521 mergetool.<tool>.path::
1522         Override the path for the given tool.  This is useful in case
1523         your tool is not in the PATH.
1525 mergetool.<tool>.cmd::
1526         Specify the command to invoke the specified merge tool.  The
1527         specified command is evaluated in shell with the following
1528         variables available: 'BASE' is the name of a temporary file
1529         containing the common base of the files to be merged, if available;
1530         'LOCAL' is the name of a temporary file containing the contents of
1531         the file on the current branch; 'REMOTE' is the name of a temporary
1532         file containing the contents of the file from the branch being
1533         merged; 'MERGED' contains the name of the file to which the merge
1534         tool should write the results of a successful merge.
1536 mergetool.<tool>.trustExitCode::
1537         For a custom merge command, specify whether the exit code of
1538         the merge command can be used to determine whether the merge was
1539         successful.  If this is not set to true then the merge target file
1540         timestamp is checked and the merge assumed to have been successful
1541         if the file has been updated, otherwise the user is prompted to
1542         indicate the success of the merge.
1544 mergetool.keepBackup::
1545         After performing a merge, the original file with conflict markers
1546         can be saved as a file with a `.orig` extension.  If this variable
1547         is set to `false` then this file is not preserved.  Defaults to
1548         `true` (i.e. keep the backup files).
1550 mergetool.keepTemporaries::
1551         When invoking a custom merge tool, git uses a set of temporary
1552         files to pass to the tool. If the tool returns an error and this
1553         variable is set to `true`, then these temporary files will be
1554         preserved, otherwise they will be removed after the tool has
1555         exited. Defaults to `false`.
1557 mergetool.prompt::
1558         Prompt before each invocation of the merge resolution program.
1560 notes.displayRef::
1561         The (fully qualified) refname from which to show notes when
1562         showing commit messages.  The value of this variable can be set
1563         to a glob, in which case notes from all matching refs will be
1564         shown.  You may also specify this configuration variable
1565         several times.  A warning will be issued for refs that do not
1566         exist, but a glob that does not match any refs is silently
1567         ignored.
1569 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1570 environment variable, which must be a colon separated list of refs or
1571 globs.
1573 The effective value of "core.notesRef" (possibly overridden by
1574 GIT_NOTES_REF) is also implicitly added to the list of refs to be
1575 displayed.
1577 notes.rewrite.<command>::
1578         When rewriting commits with <command> (currently `amend` or
1579         `rebase`) and this variable is set to `true`, git
1580         automatically copies your notes from the original to the
1581         rewritten commit.  Defaults to `true`, but see
1582         "notes.rewriteRef" below.
1584 notes.rewriteMode::
1585         When copying notes during a rewrite (see the
1586         "notes.rewrite.<command>" option), determines what to do if
1587         the target commit already has a note.  Must be one of
1588         `overwrite`, `concatenate`, or `ignore`.  Defaults to
1589         `concatenate`.
1591 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1592 environment variable.
1594 notes.rewriteRef::
1595         When copying notes during a rewrite, specifies the (fully
1596         qualified) ref whose notes should be copied.  The ref may be a
1597         glob, in which case notes in all matching refs will be copied.
1598         You may also specify this configuration several times.
1600 Does not have a default value; you must configure this variable to
1601 enable note rewriting.  Set it to `refs/notes/commits` to enable
1602 rewriting for the default commit notes.
1604 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1605 environment variable, which must be a colon separated list of refs or
1606 globs.
1608 pack.window::
1609         The size of the window used by linkgit:git-pack-objects[1] when no
1610         window size is given on the command line. Defaults to 10.
1612 pack.depth::
1613         The maximum delta depth used by linkgit:git-pack-objects[1] when no
1614         maximum depth is given on the command line. Defaults to 50.
1616 pack.windowMemory::
1617         The window memory size limit used by linkgit:git-pack-objects[1]
1618         when no limit is given on the command line.  The value can be
1619         suffixed with "k", "m", or "g".  Defaults to 0, meaning no
1620         limit.
1622 pack.compression::
1623         An integer -1..9, indicating the compression level for objects
1624         in a pack file. -1 is the zlib default. 0 means no
1625         compression, and 1..9 are various speed/size tradeoffs, 9 being
1626         slowest.  If not set,  defaults to core.compression.  If that is
1627         not set,  defaults to -1, the zlib default, which is "a default
1628         compromise between speed and compression (currently equivalent
1629         to level 6)."
1631 Note that changing the compression level will not automatically recompress
1632 all existing objects. You can force recompression by passing the -F option
1633 to linkgit:git-repack[1].
1635 pack.deltaCacheSize::
1636         The maximum memory in bytes used for caching deltas in
1637         linkgit:git-pack-objects[1] before writing them out to a pack.
1638         This cache is used to speed up the writing object phase by not
1639         having to recompute the final delta result once the best match
1640         for all objects is found.  Repacking large repositories on machines
1641         which are tight with memory might be badly impacted by this though,
1642         especially if this cache pushes the system into swapping.
1643         A value of 0 means no limit. The smallest size of 1 byte may be
1644         used to virtually disable this cache. Defaults to 256 MiB.
1646 pack.deltaCacheLimit::
1647         The maximum size of a delta, that is cached in
1648         linkgit:git-pack-objects[1]. This cache is used to speed up the
1649         writing object phase by not having to recompute the final delta
1650         result once the best match for all objects is found. Defaults to 1000.
1652 pack.threads::
1653         Specifies the number of threads to spawn when searching for best
1654         delta matches.  This requires that linkgit:git-pack-objects[1]
1655         be compiled with pthreads otherwise this option is ignored with a
1656         warning. This is meant to reduce packing time on multiprocessor
1657         machines. The required amount of memory for the delta search window
1658         is however multiplied by the number of threads.
1659         Specifying 0 will cause git to auto-detect the number of CPU's
1660         and set the number of threads accordingly.
1662 pack.indexVersion::
1663         Specify the default pack index version.  Valid values are 1 for
1664         legacy pack index used by Git versions prior to 1.5.2, and 2 for
1665         the new pack index with capabilities for packs larger than 4 GB
1666         as well as proper protection against the repacking of corrupted
1667         packs.  Version 2 is the default.  Note that version 2 is enforced
1668         and this config option ignored whenever the corresponding pack is
1669         larger than 2 GB.
1671 If you have an old git that does not understand the version 2 `*.idx` file,
1672 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1673 that will copy both `*.pack` file and corresponding `*.idx` file from the
1674 other side may give you a repository that cannot be accessed with your
1675 older version of git. If the `*.pack` file is smaller than 2 GB, however,
1676 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1677 the `*.idx` file.
1679 pack.packSizeLimit::
1680         The maximum size of a pack.  This setting only affects
1681         packing to a file when repacking, i.e. the git:// protocol
1682         is unaffected.  It can be overridden by the `--max-pack-size`
1683         option of linkgit:git-repack[1]. The minimum size allowed is
1684         limited to 1 MiB. The default is unlimited.
1685         Common unit suffixes of 'k', 'm', or 'g' are
1686         supported.
1688 pager.<cmd>::
1689         If the value is boolean, turns on or off pagination of the
1690         output of a particular git subcommand when writing to a tty.
1691         Otherwise, turns on pagination for the subcommand using the
1692         pager specified by the value of `pager.<cmd>`.  If `--paginate`
1693         or `--no-pager` is specified on the command line, it takes
1694         precedence over this option.  To disable pagination for all
1695         commands, set `core.pager` or `GIT_PAGER` to `cat`.
1697 pretty.<name>::
1698         Alias for a --pretty= format string, as specified in
1699         linkgit:git-log[1]. Any aliases defined here can be used just
1700         as the built-in pretty formats could. For example,
1701         running `git config pretty.changelog "format:* %H %s"`
1702         would cause the invocation `git log --pretty=changelog`
1703         to be equivalent to running `git log "--pretty=format:* %H %s"`.
1704         Note that an alias with the same name as a built-in format
1705         will be silently ignored.
1707 pull.rebase::
1708         When true, rebase branches on top of the fetched branch, instead
1709         of merging the default branch from the default remote when "git
1710         pull" is run. See "branch.<name>.rebase" for setting this on a
1711         per-branch basis.
1713 *NOTE*: this is a possibly dangerous operation; do *not* use
1714 it unless you understand the implications (see linkgit:git-rebase[1]
1715 for details).
1717 pull.octopus::
1718         The default merge strategy to use when pulling multiple branches
1719         at once.
1721 pull.twohead::
1722         The default merge strategy to use when pulling a single branch.
1724 push.default::
1725         Defines the action git push should take if no refspec is given
1726         on the command line, no refspec is configured in the remote, and
1727         no refspec is implied by any of the options given on the command
1728         line. Possible values are:
1730 * `nothing` - do not push anything.
1731 * `matching` - push all branches having the same name in both ends.
1732   This is for those who prepare all the branches into a publishable
1733   shape and then push them out with a single command.  It is not
1734   appropriate for pushing into a repository shared by multiple users,
1735   since locally stalled branches will attempt a non-fast forward push
1736   if other users updated the branch.
1737   +
1738   This is currently the default, but Git 2.0 will change the default
1739   to `simple`.
1740 * `upstream` - push the current branch to its upstream branch.
1741   With this, `git push` will update the same remote ref as the one which
1742   is merged by `git pull`, making `push` and `pull` symmetrical.
1743   See "branch.<name>.merge" for how to configure the upstream branch.
1744 * `simple` - like `upstream`, but refuses to push if the upstream
1745   branch's name is different from the local one. This is the safest
1746   option and is well-suited for beginners. It will become the default
1747   in Git 2.0.
1748 * `current` - push the current branch to a branch of the same name.
1749   +
1750   The `simple`, `current` and `upstream` modes are for those who want to
1751   push out a single branch after finishing work, even when the other
1752   branches are not yet ready to be pushed out. If you are working with
1753   other people to push into the same shared repository, you would want
1754   to use one of these.
1756 rebase.stat::
1757         Whether to show a diffstat of what changed upstream since the last
1758         rebase. False by default.
1760 rebase.autosquash::
1761         If set to true enable '--autosquash' option by default.
1763 receive.autogc::
1764         By default, git-receive-pack will run "git-gc --auto" after
1765         receiving data from git-push and updating refs.  You can stop
1766         it by setting this variable to false.
1768 receive.fsckObjects::
1769         If it is set to true, git-receive-pack will check all received
1770         objects. It will abort in the case of a malformed object or a
1771         broken link. The result of an abort are only dangling objects.
1772         Defaults to false. If not set, the value of `transfer.fsckObjects`
1773         is used instead.
1775 receive.unpackLimit::
1776         If the number of objects received in a push is below this
1777         limit then the objects will be unpacked into loose object
1778         files. However if the number of received objects equals or
1779         exceeds this limit then the received pack will be stored as
1780         a pack, after adding any missing delta bases.  Storing the
1781         pack from a push can make the push operation complete faster,
1782         especially on slow filesystems.  If not set, the value of
1783         `transfer.unpackLimit` is used instead.
1785 receive.denyDeletes::
1786         If set to true, git-receive-pack will deny a ref update that deletes
1787         the ref. Use this to prevent such a ref deletion via a push.
1789 receive.denyDeleteCurrent::
1790         If set to true, git-receive-pack will deny a ref update that
1791         deletes the currently checked out branch of a non-bare repository.
1793 receive.denyCurrentBranch::
1794         If set to true or "refuse", git-receive-pack will deny a ref update
1795         to the currently checked out branch of a non-bare repository.
1796         Such a push is potentially dangerous because it brings the HEAD
1797         out of sync with the index and working tree. If set to "warn",
1798         print a warning of such a push to stderr, but allow the push to
1799         proceed. If set to false or "ignore", allow such pushes with no
1800         message. Defaults to "refuse".
1802 There are two more options that are meant for Git experts: "updateInstead"
1803 which will run `read-tree -u -m HEAD` and "detachInstead" which will detach
1804 the HEAD so it does not need to change.  Both options come with their own
1805 set of possible *complications*, but can be appropriate in rare workflows.
1807 receive.denyNonFastForwards::
1808         If set to true, git-receive-pack will deny a ref update which is
1809         not a fast-forward. Use this to prevent such an update via a push,
1810         even if that push is forced. This configuration variable is
1811         set when initializing a shared repository.
1813 receive.updateserverinfo::
1814         If set to true, git-receive-pack will run git-update-server-info
1815         after receiving data from git-push and updating refs.
1817 remote.<name>.url::
1818         The URL of a remote repository.  See linkgit:git-fetch[1] or
1819         linkgit:git-push[1].
1821 remote.<name>.pushurl::
1822         The push URL of a remote repository.  See linkgit:git-push[1].
1824 remote.<name>.proxy::
1825         For remotes that require curl (http, https and ftp), the URL to
1826         the proxy to use for that remote.  Set to the empty string to
1827         disable proxying for that remote.
1829 remote.<name>.fetch::
1830         The default set of "refspec" for linkgit:git-fetch[1]. See
1831         linkgit:git-fetch[1].
1833 remote.<name>.push::
1834         The default set of "refspec" for linkgit:git-push[1]. See
1835         linkgit:git-push[1].
1837 remote.<name>.mirror::
1838         If true, pushing to this remote will automatically behave
1839         as if the `--mirror` option was given on the command line.
1841 remote.<name>.skipDefaultUpdate::
1842         If true, this remote will be skipped by default when updating
1843         using linkgit:git-fetch[1] or the `update` subcommand of
1844         linkgit:git-remote[1].
1846 remote.<name>.skipFetchAll::
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>.receivepack::
1852         The default program to execute on the remote side when pushing.  See
1853         option \--receive-pack of linkgit:git-push[1].
1855 remote.<name>.uploadpack::
1856         The default program to execute on the remote side when fetching.  See
1857         option \--upload-pack of linkgit:git-fetch-pack[1].
1859 remote.<name>.tagopt::
1860         Setting this value to \--no-tags disables automatic tag following when
1861         fetching from remote <name>. Setting it to \--tags will fetch every
1862         tag from remote <name>, even if they are not reachable from remote
1863         branch heads. Passing these flags directly to linkgit:git-fetch[1] can
1864         override this setting. See options \--tags and \--no-tags of
1865         linkgit:git-fetch[1].
1867 remote.<name>.vcs::
1868         Setting this to a value <vcs> will cause git to interact with
1869         the remote with the git-remote-<vcs> helper.
1871 remotes.<group>::
1872         The list of remotes which are fetched by "git remote update
1873         <group>".  See linkgit:git-remote[1].
1875 repack.usedeltabaseoffset::
1876         By default, linkgit:git-repack[1] creates packs that use
1877         delta-base offset. If you need to share your repository with
1878         git older than version 1.4.4, either directly or via a dumb
1879         protocol such as http, then you need to set this option to
1880         "false" and repack. Access from old git versions over the
1881         native protocol are unaffected by this option.
1883 rerere.autoupdate::
1884         When set to true, `git-rerere` updates the index with the
1885         resulting contents after it cleanly resolves conflicts using
1886         previously recorded resolution.  Defaults to false.
1888 rerere.enabled::
1889         Activate recording of resolved conflicts, so that identical
1890         conflict hunks can be resolved automatically, should they be
1891         encountered again.  By default, linkgit:git-rerere[1] is
1892         enabled if there is an `rr-cache` directory under the
1893         `$GIT_DIR`, e.g. if "rerere" was previously used in the
1894         repository.
1896 sendemail.identity::
1897         A configuration identity. When given, causes values in the
1898         'sendemail.<identity>' subsection to take precedence over
1899         values in the 'sendemail' section. The default identity is
1900         the value of 'sendemail.identity'.
1902 sendemail.smtpencryption::
1903         See linkgit:git-send-email[1] for description.  Note that this
1904         setting is not subject to the 'identity' mechanism.
1906 sendemail.smtpssl::
1907         Deprecated alias for 'sendemail.smtpencryption = ssl'.
1909 sendemail.<identity>.*::
1910         Identity-specific versions of the 'sendemail.*' parameters
1911         found below, taking precedence over those when the this
1912         identity is selected, through command-line or
1913         'sendemail.identity'.
1915 sendemail.aliasesfile::
1916 sendemail.aliasfiletype::
1917 sendemail.bcc::
1918 sendemail.cc::
1919 sendemail.cccmd::
1920 sendemail.chainreplyto::
1921 sendemail.confirm::
1922 sendemail.envelopesender::
1923 sendemail.from::
1924 sendemail.multiedit::
1925 sendemail.signedoffbycc::
1926 sendemail.smtppass::
1927 sendemail.suppresscc::
1928 sendemail.suppressfrom::
1929 sendemail.to::
1930 sendemail.smtpdomain::
1931 sendemail.smtpserver::
1932 sendemail.smtpserverport::
1933 sendemail.smtpserveroption::
1934 sendemail.smtpuser::
1935 sendemail.thread::
1936 sendemail.validate::
1937         See linkgit:git-send-email[1] for description.
1939 sendemail.signedoffcc::
1940         Deprecated alias for 'sendemail.signedoffbycc'.
1942 showbranch.default::
1943         The default set of branches for linkgit:git-show-branch[1].
1944         See linkgit:git-show-branch[1].
1946 status.relativePaths::
1947         By default, linkgit:git-status[1] shows paths relative to the
1948         current directory. Setting this variable to `false` shows paths
1949         relative to the repository root (this was the default for git
1950         prior to v1.5.4).
1952 status.showUntrackedFiles::
1953         By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1954         files which are not currently tracked by Git. Directories which
1955         contain only untracked files, are shown with the directory name
1956         only. Showing untracked files means that Git needs to lstat() all
1957         all the files in the whole repository, which might be slow on some
1958         systems. So, this variable controls how the commands displays
1959         the untracked files. Possible values are:
1962 * `no` - Show no untracked files.
1963 * `normal` - Show untracked files and directories.
1964 * `all` - Show also individual files in untracked directories.
1967 If this variable is not specified, it defaults to 'normal'.
1968 This variable can be overridden with the -u|--untracked-files option
1969 of linkgit:git-status[1] and linkgit:git-commit[1].
1971 status.submodulesummary::
1972         Defaults to false.
1973         If this is set to a non zero number or true (identical to -1 or an
1974         unlimited number), the submodule summary will be enabled and a
1975         summary of commits for modified submodules will be shown (see
1976         --summary-limit option of linkgit:git-submodule[1]).
1978 submodule.<name>.path::
1979 submodule.<name>.url::
1980 submodule.<name>.update::
1981         The path within this project, URL, and the updating strategy
1982         for a submodule.  These variables are initially populated
1983         by 'git submodule init'; edit them to override the
1984         URL and other values found in the `.gitmodules` file.  See
1985         linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
1987 submodule.<name>.fetchRecurseSubmodules::
1988         This option can be used to control recursive fetching of this
1989         submodule. It can be overridden by using the --[no-]recurse-submodules
1990         command line option to "git fetch" and "git pull".
1991         This setting will override that from in the linkgit:gitmodules[5]
1992         file.
1994 submodule.<name>.ignore::
1995         Defines under what circumstances "git status" and the diff family show
1996         a submodule as modified. When set to "all", it will never be considered
1997         modified, "dirty" will ignore all changes to the submodules work tree and
1998         takes only differences between the HEAD of the submodule and the commit
1999         recorded in the superproject into account. "untracked" will additionally
2000         let submodules with modified tracked files in their work tree show up.
2001         Using "none" (the default when this option is not set) also shows
2002         submodules that have untracked files in their work tree as changed.
2003         This setting overrides any setting made in .gitmodules for this submodule,
2004         both settings can be overridden on the command line by using the
2005         "--ignore-submodules" option.
2007 tar.umask::
2008         This variable can be used to restrict the permission bits of
2009         tar archive entries.  The default is 0002, which turns off the
2010         world write bit.  The special value "user" indicates that the
2011         archiving user's umask will be used instead.  See umask(2) and
2012         linkgit:git-archive[1].
2014 transfer.fsckObjects::
2015         When `fetch.fsckObjects` or `receive.fsckObjects` are
2016         not set, the value of this variable is used instead.
2017         Defaults to false.
2019 transfer.unpackLimit::
2020         When `fetch.unpackLimit` or `receive.unpackLimit` are
2021         not set, the value of this variable is used instead.
2022         The default value is 100.
2024 url.<base>.insteadOf::
2025         Any URL that starts with this value will be rewritten to
2026         start, instead, with <base>. In cases where some site serves a
2027         large number of repositories, and serves them with multiple
2028         access methods, and some users need to use different access
2029         methods, this feature allows people to specify any of the
2030         equivalent URLs and have git automatically rewrite the URL to
2031         the best alternative for the particular user, even for a
2032         never-before-seen repository on the site.  When more than one
2033         insteadOf strings match a given URL, the longest match is used.
2035 url.<base>.pushInsteadOf::
2036         Any URL that starts with this value will not be pushed to;
2037         instead, it will be rewritten to start with <base>, and the
2038         resulting URL will be pushed to. In cases where some site serves
2039         a large number of repositories, and serves them with multiple
2040         access methods, some of which do not allow push, this feature
2041         allows people to specify a pull-only URL and have git
2042         automatically use an appropriate URL to push, even for a
2043         never-before-seen repository on the site.  When more than one
2044         pushInsteadOf strings match a given URL, the longest match is
2045         used.  If a remote has an explicit pushurl, git will ignore this
2046         setting for that remote.
2048 user.email::
2049         Your email address to be recorded in any newly created commits.
2050         Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
2051         'EMAIL' environment variables.  See linkgit:git-commit-tree[1].
2053 user.name::
2054         Your full name to be recorded in any newly created commits.
2055         Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
2056         environment variables.  See linkgit:git-commit-tree[1].
2058 user.signingkey::
2059         If linkgit:git-tag[1] is not selecting the key you want it to
2060         automatically when creating a signed tag, you can override the
2061         default selection with this variable.  This option is passed
2062         unchanged to gpg's --local-user parameter, so you may specify a key
2063         using any method that gpg supports.
2065 web.browser::
2066         Specify a web browser that may be used by some commands.
2067         Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
2068         may use it.