Merge branch 'mm/mediawiki-tests'
[git/jnareb-git.git] / Documentation / config.txt
blobc6ff15e59413eb731e983ac2c1de010e12336001
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                 Show directions on how to proceed from the current
163                 state in the output of linkgit:git-status[1] and in
164                 the template shown when writing commit messages in
165                 linkgit:git-commit[1].
166         commitBeforeMerge::
167                 Advice shown when linkgit:git-merge[1] refuses to
168                 merge to avoid overwriting local changes.
169         resolveConflict::
170                 Advices shown by various commands when conflicts
171                 prevent the operation from being performed.
172         implicitIdentity::
173                 Advice on how to set your identity configuration when
174                 your information is guessed from the system username and
175                 domain name.
176         detachedHead::
177                 Advice shown when you used linkgit:git-checkout[1] to
178                 move to the detach HEAD state, to instruct how to create
179                 a local branch after the fact.
182 core.fileMode::
183         If false, the executable bit differences between the index and
184         the working tree are ignored; useful on broken filesystems like FAT.
185         See linkgit:git-update-index[1].
187 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
188 will probe and set core.fileMode false if appropriate when the
189 repository is created.
191 core.ignoreCygwinFSTricks::
192         This option is only used by Cygwin implementation of Git. If false,
193         the Cygwin stat() and lstat() functions are used. This may be useful
194         if your repository consists of a few separate directories joined in
195         one hierarchy using Cygwin mount. If true, Git uses native Win32 API
196         whenever it is possible and falls back to Cygwin functions only to
197         handle symbol links. The native mode is more than twice faster than
198         normal Cygwin l/stat() functions. True by default, unless core.filemode
199         is true, in which case ignoreCygwinFSTricks is ignored as Cygwin's
200         POSIX emulation is required to support core.filemode.
202 core.ignorecase::
203         If true, this option enables various workarounds to enable
204         git to work better on filesystems that are not case sensitive,
205         like FAT. For example, if a directory listing finds
206         "makefile" when git expects "Makefile", git will assume
207         it is really the same file, and continue to remember it as
208         "Makefile".
210 The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
211 will probe and set core.ignorecase true if appropriate when the repository
212 is created.
214 core.trustctime::
215         If false, the ctime differences between the index and the
216         working tree are ignored; useful when the inode change time
217         is regularly modified by something outside Git (file system
218         crawlers and some backup systems).
219         See linkgit:git-update-index[1]. True by default.
221 core.quotepath::
222         The commands that output paths (e.g. 'ls-files',
223         'diff'), when not given the `-z` option, will quote
224         "unusual" characters in the pathname by enclosing the
225         pathname in a double-quote pair and with backslashes the
226         same way strings in C source code are quoted.  If this
227         variable is set to false, the bytes higher than 0x80 are
228         not quoted but output as verbatim.  Note that double
229         quote, backslash and control characters are always
230         quoted without `-z` regardless of the setting of this
231         variable.
233 core.eol::
234         Sets the line ending type to use in the working directory for
235         files that have the `text` property set.  Alternatives are
236         'lf', 'crlf' and 'native', which uses the platform's native
237         line ending.  The default value is `native`.  See
238         linkgit:gitattributes[5] for more information on end-of-line
239         conversion.
241 core.safecrlf::
242         If true, makes git check if converting `CRLF` is reversible when
243         end-of-line conversion is active.  Git will verify if a command
244         modifies a file in the work tree either directly or indirectly.
245         For example, committing a file followed by checking out the
246         same file should yield the original file in the work tree.  If
247         this is not the case for the current setting of
248         `core.autocrlf`, git will reject the file.  The variable can
249         be set to "warn", in which case git will only warn about an
250         irreversible conversion but continue the operation.
252 CRLF conversion bears a slight chance of corrupting data.
253 When it is enabled, git will convert CRLF to LF during commit and LF to
254 CRLF during checkout.  A file that contains a mixture of LF and
255 CRLF before the commit cannot be recreated by git.  For text
256 files this is the right thing to do: it corrects line endings
257 such that we have only LF line endings in the repository.
258 But for binary files that are accidentally classified as text the
259 conversion can corrupt data.
261 If you recognize such corruption early you can easily fix it by
262 setting the conversion type explicitly in .gitattributes.  Right
263 after committing you still have the original file in your work
264 tree and this file is not yet corrupted.  You can explicitly tell
265 git that this file is binary and git will handle the file
266 appropriately.
268 Unfortunately, the desired effect of cleaning up text files with
269 mixed line endings and the undesired effect of corrupting binary
270 files cannot be distinguished.  In both cases CRLFs are removed
271 in an irreversible way.  For text files this is the right thing
272 to do because CRLFs are line endings, while for binary files
273 converting CRLFs corrupts data.
275 Note, this safety check does not mean that a checkout will generate a
276 file identical to the original file for a different setting of
277 `core.eol` and `core.autocrlf`, but only for the current one.  For
278 example, a text file with `LF` would be accepted with `core.eol=lf`
279 and could later be checked out with `core.eol=crlf`, in which case the
280 resulting file would contain `CRLF`, although the original file
281 contained `LF`.  However, in both work trees the line endings would be
282 consistent, that is either all `LF` or all `CRLF`, but never mixed.  A
283 file with mixed line endings would be reported by the `core.safecrlf`
284 mechanism.
286 core.autocrlf::
287         Setting this variable to "true" is almost the same as setting
288         the `text` attribute to "auto" on all files except that text
289         files are not guaranteed to be normalized: files that contain
290         `CRLF` in the repository will not be touched.  Use this
291         setting if you want to have `CRLF` line endings in your
292         working directory even though the repository does not have
293         normalized line endings.  This variable can be set to 'input',
294         in which case no output conversion is performed.
296 core.symlinks::
297         If false, symbolic links are checked out as small plain files that
298         contain the link text. linkgit:git-update-index[1] and
299         linkgit:git-add[1] will not change the recorded type to regular
300         file. Useful on filesystems like FAT that do not support
301         symbolic links.
303 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
304 will probe and set core.symlinks false if appropriate when the repository
305 is created.
307 core.gitProxy::
308         A "proxy command" to execute (as 'command host port') instead
309         of establishing direct connection to the remote server when
310         using the git protocol for fetching. If the variable value is
311         in the "COMMAND for DOMAIN" format, the command is applied only
312         on hostnames ending with the specified domain string. This variable
313         may be set multiple times and is matched in the given order;
314         the first match wins.
316 Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
317 (which always applies universally, without the special "for"
318 handling).
320 The special string `none` can be used as the proxy command to
321 specify that no proxy be used for a given domain pattern.
322 This is useful for excluding servers inside a firewall from
323 proxy use, while defaulting to a common proxy for external domains.
325 core.ignoreStat::
326         If true, commands which modify both the working tree and the index
327         will mark the updated paths with the "assume unchanged" bit in the
328         index. These marked files are then assumed to stay unchanged in the
329         working tree, until you mark them otherwise manually - Git will not
330         detect the file changes by lstat() calls. This is useful on systems
331         where those are very slow, such as Microsoft Windows.
332         See linkgit:git-update-index[1].
333         False by default.
335 core.preferSymlinkRefs::
336         Instead of the default "symref" format for HEAD
337         and other symbolic reference files, use symbolic links.
338         This is sometimes needed to work with old scripts that
339         expect HEAD to be a symbolic link.
341 core.bare::
342         If true this repository is assumed to be 'bare' and has no
343         working directory associated with it.  If this is the case a
344         number of commands that require a working directory will be
345         disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
347 This setting is automatically guessed by linkgit:git-clone[1] or
348 linkgit:git-init[1] when the repository was created.  By default a
349 repository that ends in "/.git" is assumed to be not bare (bare =
350 false), while all other repositories are assumed to be bare (bare
351 = true).
353 core.worktree::
354         Set the path to the root of the working tree.
355         This can be overridden by the GIT_WORK_TREE environment
356         variable and the '--work-tree' command line option.
357         The value can be an absolute path or relative to the path to
358         the .git directory, which is either specified by --git-dir
359         or GIT_DIR, or automatically discovered.
360         If --git-dir or GIT_DIR is specified but none of
361         --work-tree, GIT_WORK_TREE and core.worktree is specified,
362         the current working directory is regarded as the top level
363         of your working tree.
365 Note that this variable is honored even when set in a configuration
366 file in a ".git" subdirectory of a directory and its value differs
367 from the latter directory (e.g. "/path/to/.git/config" has
368 core.worktree set to "/different/path"), which is most likely a
369 misconfiguration.  Running git commands in the "/path/to" directory will
370 still use "/different/path" as the root of the work tree and can cause
371 confusion unless you know what you are doing (e.g. you are creating a
372 read-only snapshot of the same index to a location different from the
373 repository's usual working tree).
375 core.logAllRefUpdates::
376         Enable the reflog. Updates to a ref <ref> is logged to the file
377         "$GIT_DIR/logs/<ref>", by appending the new and old
378         SHA1, the date/time and the reason of the update, but
379         only when the file exists.  If this configuration
380         variable is set to true, missing "$GIT_DIR/logs/<ref>"
381         file is automatically created for branch heads (i.e. under
382         refs/heads/), remote refs (i.e. under refs/remotes/),
383         note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
385 This information can be used to determine what commit
386 was the tip of a branch "2 days ago".
388 This value is true by default in a repository that has
389 a working directory associated with it, and false by
390 default in a bare repository.
392 core.repositoryFormatVersion::
393         Internal variable identifying the repository format and layout
394         version.
396 core.sharedRepository::
397         When 'group' (or 'true'), the repository is made shareable between
398         several users in a group (making sure all the files and objects are
399         group-writable). When 'all' (or 'world' or 'everybody'), the
400         repository will be readable by all users, additionally to being
401         group-shareable. When 'umask' (or 'false'), git will use permissions
402         reported by umask(2). When '0xxx', where '0xxx' is an octal number,
403         files in the repository will have this mode value. '0xxx' will override
404         user's umask value (whereas the other options will only override
405         requested parts of the user's umask value). Examples: '0660' will make
406         the repo read/write-able for the owner and group, but inaccessible to
407         others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
408         repository that is group-readable but not group-writable.
409         See linkgit:git-init[1]. False by default.
411 core.warnAmbiguousRefs::
412         If true, git will warn you if the ref name you passed it is ambiguous
413         and might match multiple refs in the .git/refs/ tree. True by default.
415 core.compression::
416         An integer -1..9, indicating a default compression level.
417         -1 is the zlib default. 0 means no compression,
418         and 1..9 are various speed/size tradeoffs, 9 being slowest.
419         If set, this provides a default to other compression variables,
420         such as 'core.loosecompression' and 'pack.compression'.
422 core.loosecompression::
423         An integer -1..9, indicating the compression level for objects that
424         are not in a pack file. -1 is the zlib default. 0 means no
425         compression, and 1..9 are various speed/size tradeoffs, 9 being
426         slowest.  If not set,  defaults to core.compression.  If that is
427         not set,  defaults to 1 (best speed).
429 core.packedGitWindowSize::
430         Number of bytes of a pack file to map into memory in a
431         single mapping operation.  Larger window sizes may allow
432         your system to process a smaller number of large pack files
433         more quickly.  Smaller window sizes will negatively affect
434         performance due to increased calls to the operating system's
435         memory manager, but may improve performance when accessing
436         a large number of large pack files.
438 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
439 MiB on 32 bit platforms and 1 GiB on 64 bit platforms.  This should
440 be reasonable for all users/operating systems.  You probably do
441 not need to adjust this value.
443 Common unit suffixes of 'k', 'm', or 'g' are supported.
445 core.packedGitLimit::
446         Maximum number of bytes to map simultaneously into memory
447         from pack files.  If Git needs to access more than this many
448         bytes at once to complete an operation it will unmap existing
449         regions to reclaim virtual address space within the process.
451 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
452 This should be reasonable for all users/operating systems, except on
453 the largest projects.  You probably do not need to adjust this value.
455 Common unit suffixes of 'k', 'm', or 'g' are supported.
457 core.deltaBaseCacheLimit::
458         Maximum number of bytes to reserve for caching base objects
459         that may be referenced by multiple deltified objects.  By storing the
460         entire decompressed base objects in a cache Git is able
461         to avoid unpacking and decompressing frequently used base
462         objects multiple times.
464 Default is 16 MiB on all platforms.  This should be reasonable
465 for all users/operating systems, except on the largest projects.
466 You probably do not need to adjust this value.
468 Common unit suffixes of 'k', 'm', or 'g' are supported.
470 core.bigFileThreshold::
471         Files larger than this size are stored deflated, without
472         attempting delta compression.  Storing large files without
473         delta compression avoids excessive memory usage, at the
474         slight expense of increased disk usage.
476 Default is 512 MiB on all platforms.  This should be reasonable
477 for most projects as source code and other text files can still
478 be delta compressed, but larger binary media files won't be.
480 Common unit suffixes of 'k', 'm', or 'g' are supported.
482 core.excludesfile::
483         In addition to '.gitignore' (per-directory) and
484         '.git/info/exclude', git looks into this file for patterns
485         of files which are not meant to be tracked.  "`~/`" is expanded
486         to the value of `$HOME` and "`~user/`" to the specified user's
487         home directory. Its default value is $XDG_CONFIG_HOME/git/ignore.
488         If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore
489         is used instead. See linkgit:gitignore[5].
491 core.askpass::
492         Some commands (e.g. svn and http interfaces) that interactively
493         ask for a password can be told to use an external program given
494         via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
495         environment variable. If not set, fall back to the value of the
496         'SSH_ASKPASS' environment variable or, failing that, a simple password
497         prompt. The external program shall be given a suitable prompt as
498         command line argument and write the password on its STDOUT.
500 core.attributesfile::
501         In addition to '.gitattributes' (per-directory) and
502         '.git/info/attributes', git looks into this file for attributes
503         (see linkgit:gitattributes[5]). Path expansions are made the same
504         way as for `core.excludesfile`. Its default value is
505         $XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not
506         set or empty, $HOME/.config/git/attributes is used instead.
508 core.editor::
509         Commands such as `commit` and `tag` that lets you edit
510         messages by launching an editor uses the value of this
511         variable when it is set, and the environment variable
512         `GIT_EDITOR` is not set.  See linkgit:git-var[1].
514 sequence.editor::
515         Text editor used by `git rebase -i` for editing the rebase insn file.
516         The value is meant to be interpreted by the shell when it is used.
517         It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
518         When not configured the default commit message editor is used instead.
520 core.pager::
521         The command that git will use to paginate output.  Can
522         be overridden with the `GIT_PAGER` environment
523         variable.  Note that git sets the `LESS` environment
524         variable to `FRSX` if it is unset when it runs the
525         pager.  One can change these settings by setting the
526         `LESS` variable to some other value.  Alternately,
527         these settings can be overridden on a project or
528         global basis by setting the `core.pager` option.
529         Setting `core.pager` has no affect on the `LESS`
530         environment variable behaviour above, so if you want
531         to override git's default settings this way, you need
532         to be explicit.  For example, to disable the S option
533         in a backward compatible manner, set `core.pager`
534         to `less -+$LESS -FRX`.  This will be passed to the
535         shell by git, which will translate the final command to
536         `LESS=FRSX less -+FRSX -FRX`.
538 core.whitespace::
539         A comma separated list of common whitespace problems to
540         notice.  'git diff' will use `color.diff.whitespace` to
541         highlight them, and 'git apply --whitespace=error' will
542         consider them as errors.  You can prefix `-` to disable
543         any of them (e.g. `-trailing-space`):
545 * `blank-at-eol` treats trailing whitespaces at the end of the line
546   as an error (enabled by default).
547 * `space-before-tab` treats a space character that appears immediately
548   before a tab character in the initial indent part of the line as an
549   error (enabled by default).
550 * `indent-with-non-tab` treats a line that is indented with 8 or more
551   space characters as an error (not enabled by default).
552 * `tab-in-indent` treats a tab character in the initial indent part of
553   the line as an error (not enabled by default).
554 * `blank-at-eof` treats blank lines added at the end of file as an error
555   (enabled by default).
556 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
557   `blank-at-eof`.
558 * `cr-at-eol` treats a carriage-return at the end of line as
559   part of the line terminator, i.e. with it, `trailing-space`
560   does not trigger if the character before such a carriage-return
561   is not a whitespace (not enabled by default).
562 * `tabwidth=<n>` tells how many character positions a tab occupies; this
563   is relevant for `indent-with-non-tab` and when git fixes `tab-in-indent`
564   errors. The default tab width is 8. Allowed values are 1 to 63.
566 core.fsyncobjectfiles::
567         This boolean will enable 'fsync()' when writing object files.
569 This is a total waste of time and effort on a filesystem that orders
570 data writes properly, but can be useful for filesystems that do not use
571 journalling (traditional UNIX filesystems) or that only journal metadata
572 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
574 core.preloadindex::
575         Enable parallel index preload for operations like 'git diff'
577 This can speed up operations like 'git diff' and 'git status' especially
578 on filesystems like NFS that have weak caching semantics and thus
579 relatively high IO latencies.  With this set to 'true', git will do the
580 index comparison to the filesystem data in parallel, allowing
581 overlapping IO's.
583 core.createObject::
584         You can set this to 'link', in which case a hardlink followed by
585         a delete of the source are used to make sure that object creation
586         will not overwrite existing objects.
588 On some file system/operating system combinations, this is unreliable.
589 Set this config setting to 'rename' there; However, This will remove the
590 check that makes sure that existing object files will not get overwritten.
592 core.notesRef::
593         When showing commit messages, also show notes which are stored in
594         the given ref.  The ref must be fully qualified.  If the given
595         ref does not exist, it is not an error but means that no
596         notes should be printed.
598 This setting defaults to "refs/notes/commits", and it can be overridden by
599 the 'GIT_NOTES_REF' environment variable.  See linkgit:git-notes[1].
601 core.sparseCheckout::
602         Enable "sparse checkout" feature. See section "Sparse checkout" in
603         linkgit:git-read-tree[1] for more information.
605 core.abbrev::
606         Set the length object names are abbreviated to.  If unspecified,
607         many commands abbreviate to 7 hexdigits, which may not be enough
608         for abbreviated object names to stay unique for sufficiently long
609         time.
611 add.ignore-errors::
612 add.ignoreErrors::
613         Tells 'git add' to continue adding files when some files cannot be
614         added due to indexing errors. Equivalent to the '--ignore-errors'
615         option of linkgit:git-add[1].  Older versions of git accept only
616         `add.ignore-errors`, which does not follow the usual naming
617         convention for configuration variables.  Newer versions of git
618         honor `add.ignoreErrors` as well.
620 alias.*::
621         Command aliases for the linkgit:git[1] command wrapper - e.g.
622         after defining "alias.last = cat-file commit HEAD", the invocation
623         "git last" is equivalent to "git cat-file commit HEAD". To avoid
624         confusion and troubles with script usage, aliases that
625         hide existing git commands are ignored. Arguments are split by
626         spaces, the usual shell quoting and escaping is supported.
627         quote pair and a backslash can be used to quote them.
629 If the alias expansion is prefixed with an exclamation point,
630 it will be treated as a shell command.  For example, defining
631 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
632 "git new" is equivalent to running the shell command
633 "gitk --all --not ORIG_HEAD".  Note that shell commands will be
634 executed from the top-level directory of a repository, which may
635 not necessarily be the current directory.
636 'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
637 from the original current directory. See linkgit:git-rev-parse[1].
639 am.keepcr::
640         If true, git-am will call git-mailsplit for patches in mbox format
641         with parameter '--keep-cr'. In this case git-mailsplit will
642         not remove `\r` from lines ending with `\r\n`. Can be overridden
643         by giving '--no-keep-cr' from the command line.
644         See linkgit:git-am[1], linkgit:git-mailsplit[1].
646 apply.ignorewhitespace::
647         When set to 'change', tells 'git apply' to ignore changes in
648         whitespace, in the same way as the '--ignore-space-change'
649         option.
650         When set to one of: no, none, never, false tells 'git apply' to
651         respect all whitespace differences.
652         See linkgit:git-apply[1].
654 apply.whitespace::
655         Tells 'git apply' how to handle whitespaces, in the same way
656         as the '--whitespace' option. See linkgit:git-apply[1].
658 branch.autosetupmerge::
659         Tells 'git branch' and 'git checkout' to set up new branches
660         so that linkgit:git-pull[1] will appropriately merge from the
661         starting point branch. Note that even if this option is not set,
662         this behavior can be chosen per-branch using the `--track`
663         and `--no-track` options. The valid settings are: `false` -- no
664         automatic setup is done; `true` -- automatic setup is done when the
665         starting point is a remote-tracking branch; `always` --
666         automatic setup is done when the starting point is either a
667         local branch or remote-tracking
668         branch. This option defaults to true.
670 branch.autosetuprebase::
671         When a new branch is created with 'git branch' or 'git checkout'
672         that tracks another branch, this variable tells git to set
673         up pull to rebase instead of merge (see "branch.<name>.rebase").
674         When `never`, rebase is never automatically set to true.
675         When `local`, rebase is set to true for tracked branches of
676         other local branches.
677         When `remote`, rebase is set to true for tracked branches of
678         remote-tracking branches.
679         When `always`, rebase will be set to true for all tracking
680         branches.
681         See "branch.autosetupmerge" for details on how to set up a
682         branch to track another branch.
683         This option defaults to never.
685 branch.<name>.remote::
686         When in branch <name>, it tells 'git fetch' and 'git push' which
687         remote to fetch from/push to.  It defaults to `origin` if no remote is
688         configured. `origin` is also used if you are not on any branch.
690 branch.<name>.merge::
691         Defines, together with branch.<name>.remote, the upstream branch
692         for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
693         branch to merge and can also affect 'git push' (see push.default).
694         When in branch <name>, it tells 'git fetch' the default
695         refspec to be marked for merging in FETCH_HEAD. The value is
696         handled like the remote part of a refspec, and must match a
697         ref which is fetched from the remote given by
698         "branch.<name>.remote".
699         The merge information is used by 'git pull' (which at first calls
700         'git fetch') to lookup the default branch for merging. Without
701         this option, 'git pull' defaults to merge the first refspec fetched.
702         Specify multiple values to get an octopus merge.
703         If you wish to setup 'git pull' so that it merges into <name> from
704         another branch in the local repository, you can point
705         branch.<name>.merge to the desired branch, and use the special setting
706         `.` (a period) for branch.<name>.remote.
708 branch.<name>.mergeoptions::
709         Sets default options for merging into branch <name>. The syntax and
710         supported options are the same as those of linkgit:git-merge[1], but
711         option values containing whitespace characters are currently not
712         supported.
714 branch.<name>.rebase::
715         When true, rebase the branch <name> on top of the fetched branch,
716         instead of merging the default branch from the default remote when
717         "git pull" is run. See "pull.rebase" for doing this in a non
718         branch-specific manner.
720 *NOTE*: this is a possibly dangerous operation; do *not* use
721 it unless you understand the implications (see linkgit:git-rebase[1]
722 for details).
724 browser.<tool>.cmd::
725         Specify the command to invoke the specified browser. The
726         specified command is evaluated in shell with the URLs passed
727         as arguments. (See linkgit:git-web{litdd}browse[1].)
729 browser.<tool>.path::
730         Override the path for the given tool that may be used to
731         browse HTML help (see '-w' option in linkgit:git-help[1]) or a
732         working repository in gitweb (see linkgit:git-instaweb[1]).
734 clean.requireForce::
735         A boolean to make git-clean do nothing unless given -f
736         or -n.   Defaults to true.
738 color.branch::
739         A boolean to enable/disable color in the output of
740         linkgit:git-branch[1]. May be set to `always`,
741         `false` (or `never`) or `auto` (or `true`), in which case colors are used
742         only when the output is to a terminal. Defaults to false.
744 color.branch.<slot>::
745         Use customized color for branch coloration. `<slot>` is one of
746         `current` (the current branch), `local` (a local branch),
747         `remote` (a remote-tracking branch in refs/remotes/), `plain` (other
748         refs).
750 The value for these configuration variables is a list of colors (at most
751 two) and attributes (at most one), separated by spaces.  The colors
752 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
753 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
754 `blink` and `reverse`.  The first color given is the foreground; the
755 second is the background.  The position of the attribute, if any,
756 doesn't matter.
758 color.diff::
759         Whether to use ANSI escape sequences to add color to patches.
760         If this is set to `always`, linkgit:git-diff[1],
761         linkgit:git-log[1], and linkgit:git-show[1] will use color
762         for all patches.  If it is set to `true` or `auto`, those
763         commands will only use color when output is to the terminal.
764         Defaults to false.
766 This does not affect linkgit:git-format-patch[1] nor the
767 'git-diff-{asterisk}' plumbing commands.  Can be overridden on the
768 command line with the `--color[=<when>]` option.
770 color.diff.<slot>::
771         Use customized color for diff colorization.  `<slot>` specifies
772         which part of the patch to use the specified color, and is one
773         of `plain` (context text), `meta` (metainformation), `frag`
774         (hunk header), 'func' (function in hunk header), `old` (removed lines),
775         `new` (added lines), `commit` (commit headers), or `whitespace`
776         (highlighting whitespace errors). The values of these variables may be
777         specified as in color.branch.<slot>.
779 color.decorate.<slot>::
780         Use customized color for 'git log --decorate' output.  `<slot>` is one
781         of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
782         branches, remote-tracking branches, tags, stash and HEAD, respectively.
784 color.grep::
785         When set to `always`, always highlight matches.  When `false` (or
786         `never`), never.  When set to `true` or `auto`, use color only
787         when the output is written to the terminal.  Defaults to `false`.
789 color.grep.<slot>::
790         Use customized color for grep colorization.  `<slot>` specifies which
791         part of the line to use the specified color, and is one of
794 `context`;;
795         non-matching text in context lines (when using `-A`, `-B`, or `-C`)
796 `filename`;;
797         filename prefix (when not using `-h`)
798 `function`;;
799         function name lines (when using `-p`)
800 `linenumber`;;
801         line number prefix (when using `-n`)
802 `match`;;
803         matching text
804 `selected`;;
805         non-matching text in selected lines
806 `separator`;;
807         separators between fields on a line (`:`, `-`, and `=`)
808         and between hunks (`--`)
811 The values of these variables may be specified as in color.branch.<slot>.
813 color.interactive::
814         When set to `always`, always use colors for interactive prompts
815         and displays (such as those used by "git-add --interactive").
816         When false (or `never`), never.  When set to `true` or `auto`, use
817         colors only when the output is to the terminal. Defaults to false.
819 color.interactive.<slot>::
820         Use customized color for 'git add --interactive'
821         output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
822         four distinct types of normal output from interactive
823         commands.  The values of these variables may be specified as
824         in color.branch.<slot>.
826 color.pager::
827         A boolean to enable/disable colored output when the pager is in
828         use (default is true).
830 color.showbranch::
831         A boolean to enable/disable color in the output of
832         linkgit:git-show-branch[1]. May be set to `always`,
833         `false` (or `never`) or `auto` (or `true`), in which case colors are used
834         only when the output is to a terminal. Defaults to false.
836 color.status::
837         A boolean to enable/disable color in the output of
838         linkgit:git-status[1]. May be set to `always`,
839         `false` (or `never`) or `auto` (or `true`), in which case colors are used
840         only when the output is to a terminal. Defaults to false.
842 color.status.<slot>::
843         Use customized color for status colorization. `<slot>` is
844         one of `header` (the header text of the status message),
845         `added` or `updated` (files which are added but not committed),
846         `changed` (files which are changed but not added in the index),
847         `untracked` (files which are not tracked by git),
848         `branch` (the current branch), or
849         `nobranch` (the color the 'no branch' warning is shown in, defaulting
850         to red). The values of these variables may be specified as in
851         color.branch.<slot>.
853 color.ui::
854         This variable determines the default value for variables such
855         as `color.diff` and `color.grep` that control the use of color
856         per command family. Its scope will expand as more commands learn
857         configuration to set a default for the `--color` option.  Set it
858         to `always` if you want all output not intended for machine
859         consumption to use color, to `true` or `auto` if you want such
860         output to use color when written to the terminal, or to `false` or
861         `never` if you prefer git commands not to use color unless enabled
862         explicitly with some other configuration or the `--color` option.
864 column.ui::
865         Specify whether supported commands should output in columns.
866         This variable consists of a list of tokens separated by spaces
867         or commas:
870 `always`;;
871         always show in columns
872 `never`;;
873         never show in columns
874 `auto`;;
875         show in columns if the output is to the terminal
876 `column`;;
877         fill columns before rows (default)
878 `row`;;
879         fill rows before columns
880 `plain`;;
881         show in one column
882 `dense`;;
883         make unequal size columns to utilize more space
884 `nodense`;;
885         make equal size columns
888 This option defaults to 'never'.
890 column.branch::
891         Specify whether to output branch listing in `git branch` in columns.
892         See `column.ui` for details.
894 column.status::
895         Specify whether to output untracked files in `git status` in columns.
896         See `column.ui` for details.
898 column.tag::
899         Specify whether to output tag listing in `git tag` in columns.
900         See `column.ui` for details.
902 commit.status::
903         A boolean to enable/disable inclusion of status information in the
904         commit message template when using an editor to prepare the commit
905         message.  Defaults to true.
907 commit.template::
908         Specify a file to use as the template for new commit messages.
909         "`~/`" is expanded to the value of `$HOME` and "`~user/`" to the
910         specified user's home directory.
912 credential.helper::
913         Specify an external helper to be called when a username or
914         password credential is needed; the helper may consult external
915         storage to avoid prompting the user for the credentials. See
916         linkgit:gitcredentials[7] for details.
918 credential.useHttpPath::
919         When acquiring credentials, consider the "path" component of an http
920         or https URL to be important. Defaults to false. See
921         linkgit:gitcredentials[7] for more information.
923 credential.username::
924         If no username is set for a network authentication, use this username
925         by default. See credential.<context>.* below, and
926         linkgit:gitcredentials[7].
928 credential.<url>.*::
929         Any of the credential.* options above can be applied selectively to
930         some credentials. For example "credential.https://example.com.username"
931         would set the default username only for https connections to
932         example.com. See linkgit:gitcredentials[7] for details on how URLs are
933         matched.
935 include::diff-config.txt[]
937 difftool.<tool>.path::
938         Override the path for the given tool.  This is useful in case
939         your tool is not in the PATH.
941 difftool.<tool>.cmd::
942         Specify the command to invoke the specified diff tool.
943         The specified command is evaluated in shell with the following
944         variables available:  'LOCAL' is set to the name of the temporary
945         file containing the contents of the diff pre-image and 'REMOTE'
946         is set to the name of the temporary file containing the contents
947         of the diff post-image.
949 difftool.prompt::
950         Prompt before each invocation of the diff tool.
952 diff.wordRegex::
953         A POSIX Extended Regular Expression used to determine what is a "word"
954         when performing word-by-word difference calculations.  Character
955         sequences that match the regular expression are "words", all other
956         characters are *ignorable* whitespace.
958 fetch.recurseSubmodules::
959         This option can be either set to a boolean value or to 'on-demand'.
960         Setting it to a boolean changes the behavior of fetch and pull to
961         unconditionally recurse into submodules when set to true or to not
962         recurse at all when set to false. When set to 'on-demand' (the default
963         value), fetch and pull will only recurse into a populated submodule
964         when its superproject retrieves a commit that updates the submodule's
965         reference.
967 fetch.fsckObjects::
968         If it is set to true, git-fetch-pack will check all fetched
969         objects. It will abort in the case of a malformed object or a
970         broken link. The result of an abort are only dangling objects.
971         Defaults to false. If not set, the value of `transfer.fsckObjects`
972         is used instead.
974 fetch.unpackLimit::
975         If the number of objects fetched over the git native
976         transfer is below this
977         limit, then the objects will be unpacked into loose object
978         files. However if the number of received objects equals or
979         exceeds this limit then the received pack will be stored as
980         a pack, after adding any missing delta bases.  Storing the
981         pack from a push can make the push operation complete faster,
982         especially on slow filesystems.  If not set, the value of
983         `transfer.unpackLimit` is used instead.
985 format.attach::
986         Enable multipart/mixed attachments as the default for
987         'format-patch'.  The value can also be a double quoted string
988         which will enable attachments as the default and set the
989         value as the boundary.  See the --attach option in
990         linkgit:git-format-patch[1].
992 format.numbered::
993         A boolean which can enable or disable sequence numbers in patch
994         subjects.  It defaults to "auto" which enables it only if there
995         is more than one patch.  It can be enabled or disabled for all
996         messages by setting it to "true" or "false".  See --numbered
997         option in linkgit:git-format-patch[1].
999 format.headers::
1000         Additional email headers to include in a patch to be submitted
1001         by mail.  See linkgit:git-format-patch[1].
1003 format.to::
1004 format.cc::
1005         Additional recipients to include in a patch to be submitted
1006         by mail.  See the --to and --cc options in
1007         linkgit:git-format-patch[1].
1009 format.subjectprefix::
1010         The default for format-patch is to output files with the '[PATCH]'
1011         subject prefix. Use this variable to change that prefix.
1013 format.signature::
1014         The default for format-patch is to output a signature containing
1015         the git version number. Use this variable to change that default.
1016         Set this variable to the empty string ("") to suppress
1017         signature generation.
1019 format.suffix::
1020         The default for format-patch is to output files with the suffix
1021         `.patch`. Use this variable to change that suffix (make sure to
1022         include the dot if you want it).
1024 format.pretty::
1025         The default pretty format for log/show/whatchanged command,
1026         See linkgit:git-log[1], linkgit:git-show[1],
1027         linkgit:git-whatchanged[1].
1029 format.thread::
1030         The default threading style for 'git format-patch'.  Can be
1031         a boolean value, or `shallow` or `deep`.  `shallow` threading
1032         makes every mail a reply to the head of the series,
1033         where the head is chosen from the cover letter, the
1034         `--in-reply-to`, and the first patch mail, in this order.
1035         `deep` threading makes every mail a reply to the previous one.
1036         A true boolean value is the same as `shallow`, and a false
1037         value disables threading.
1039 format.signoff::
1040     A boolean value which lets you enable the `-s/--signoff` option of
1041     format-patch by default. *Note:* Adding the Signed-off-by: line to a
1042     patch should be a conscious act and means that you certify you have
1043     the rights to submit this work under the same open source license.
1044     Please see the 'SubmittingPatches' document for further discussion.
1046 filter.<driver>.clean::
1047         The command which is used to convert the content of a worktree
1048         file to a blob upon checkin.  See linkgit:gitattributes[5] for
1049         details.
1051 filter.<driver>.smudge::
1052         The command which is used to convert the content of a blob
1053         object to a worktree file upon checkout.  See
1054         linkgit:gitattributes[5] for details.
1056 gc.aggressiveWindow::
1057         The window size parameter used in the delta compression
1058         algorithm used by 'git gc --aggressive'.  This defaults
1059         to 250.
1061 gc.auto::
1062         When there are approximately more than this many loose
1063         objects in the repository, `git gc --auto` will pack them.
1064         Some Porcelain commands use this command to perform a
1065         light-weight garbage collection from time to time.  The
1066         default value is 6700.  Setting this to 0 disables it.
1068 gc.autopacklimit::
1069         When there are more than this many packs that are not
1070         marked with `*.keep` file in the repository, `git gc
1071         --auto` consolidates them into one larger pack.  The
1072         default value is 50.  Setting this to 0 disables it.
1074 gc.packrefs::
1075         Running `git pack-refs` in a repository renders it
1076         unclonable by Git versions prior to 1.5.1.2 over dumb
1077         transports such as HTTP.  This variable determines whether
1078         'git gc' runs `git pack-refs`. This can be set to `notbare`
1079         to enable it within all non-bare repos or it can be set to a
1080         boolean value.  The default is `true`.
1082 gc.pruneexpire::
1083         When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1084         Override the grace period with this config variable.  The value
1085         "now" may be used to disable this  grace period and always prune
1086         unreachable objects immediately.
1088 gc.reflogexpire::
1089 gc.<pattern>.reflogexpire::
1090         'git reflog expire' removes reflog entries older than
1091         this time; defaults to 90 days.  With "<pattern>" (e.g.
1092         "refs/stash") in the middle the setting applies only to
1093         the refs that match the <pattern>.
1095 gc.reflogexpireunreachable::
1096 gc.<ref>.reflogexpireunreachable::
1097         'git reflog expire' removes reflog entries older than
1098         this time and are not reachable from the current tip;
1099         defaults to 30 days.  With "<pattern>" (e.g. "refs/stash")
1100         in the middle, the setting applies only to the refs that
1101         match the <pattern>.
1103 gc.rerereresolved::
1104         Records of conflicted merge you resolved earlier are
1105         kept for this many days when 'git rerere gc' is run.
1106         The default is 60 days.  See linkgit:git-rerere[1].
1108 gc.rerereunresolved::
1109         Records of conflicted merge you have not resolved are
1110         kept for this many days when 'git rerere gc' is run.
1111         The default is 15 days.  See linkgit:git-rerere[1].
1113 gitcvs.commitmsgannotation::
1114         Append this string to each commit message. Set to empty string
1115         to disable this feature. Defaults to "via git-CVS emulator".
1117 gitcvs.enabled::
1118         Whether the CVS server interface is enabled for this repository.
1119         See linkgit:git-cvsserver[1].
1121 gitcvs.logfile::
1122         Path to a log file where the CVS server interface well... logs
1123         various stuff. See linkgit:git-cvsserver[1].
1125 gitcvs.usecrlfattr::
1126         If true, the server will look up the end-of-line conversion
1127         attributes for files to determine the '-k' modes to use. If
1128         the attributes force git to treat a file as text,
1129         the '-k' mode will be left blank so CVS clients will
1130         treat it as text. If they suppress text conversion, the file
1131         will be set with '-kb' mode, which suppresses any newline munging
1132         the client might otherwise do. If the attributes do not allow
1133         the file type to be determined, then 'gitcvs.allbinary' is
1134         used. See linkgit:gitattributes[5].
1136 gitcvs.allbinary::
1137         This is used if 'gitcvs.usecrlfattr' does not resolve
1138         the correct '-kb' mode to use. If true, all
1139         unresolved files are sent to the client in
1140         mode '-kb'. This causes the client to treat them
1141         as binary files, which suppresses any newline munging it
1142         otherwise might do. Alternatively, if it is set to "guess",
1143         then the contents of the file are examined to decide if
1144         it is binary, similar to 'core.autocrlf'.
1146 gitcvs.dbname::
1147         Database used by git-cvsserver to cache revision information
1148         derived from the git repository. The exact meaning depends on the
1149         used database driver, for SQLite (which is the default driver) this
1150         is a filename. Supports variable substitution (see
1151         linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1152         Default: '%Ggitcvs.%m.sqlite'
1154 gitcvs.dbdriver::
1155         Used Perl DBI driver. You can specify any available driver
1156         for this here, but it might not work. git-cvsserver is tested
1157         with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1158         reported *not* to work with 'DBD::mysql'. Experimental feature.
1159         May not contain double colons (`:`). Default: 'SQLite'.
1160         See linkgit:git-cvsserver[1].
1162 gitcvs.dbuser, gitcvs.dbpass::
1163         Database user and password. Only useful if setting 'gitcvs.dbdriver',
1164         since SQLite has no concept of database users and/or passwords.
1165         'gitcvs.dbuser' supports variable substitution (see
1166         linkgit:git-cvsserver[1] for details).
1168 gitcvs.dbTableNamePrefix::
1169         Database table name prefix.  Prepended to the names of any
1170         database tables used, allowing a single database to be used
1171         for several repositories.  Supports variable substitution (see
1172         linkgit:git-cvsserver[1] for details).  Any non-alphabetic
1173         characters will be replaced with underscores.
1175 All gitcvs variables except for 'gitcvs.usecrlfattr' and
1176 'gitcvs.allbinary' can also be specified as
1177 'gitcvs.<access_method>.<varname>' (where 'access_method'
1178 is one of "ext" and "pserver") to make them apply only for the given
1179 access method.
1181 gitweb.category::
1182 gitweb.description::
1183 gitweb.owner::
1184 gitweb.url::
1185         See linkgit:gitweb[1] for description.
1187 gitweb.avatar::
1188 gitweb.blame::
1189 gitweb.grep::
1190 gitweb.highlight::
1191 gitweb.patches::
1192 gitweb.pickaxe::
1193 gitweb.remote_heads::
1194 gitweb.showsizes::
1195 gitweb.snapshot::
1196         See linkgit:gitweb.conf[5] for description.
1198 grep.lineNumber::
1199         If set to true, enable '-n' option by default.
1201 grep.extendedRegexp::
1202         If set to true, enable '--extended-regexp' option by default.
1204 gpg.program::
1205         Use this custom program instead of "gpg" found on $PATH when
1206         making or verifying a PGP signature. The program must support the
1207         same command line interface as GPG, namely, to verify a detached
1208         signature, "gpg --verify $file - <$signature" is run, and the
1209         program is expected to signal a good signature by exiting with
1210         code 0, and to generate an ascii-armored detached signature, the
1211         standard input of "gpg -bsau $key" is fed with the contents to be
1212         signed, and the program is expected to send the result to its
1213         standard output.
1215 gui.commitmsgwidth::
1216         Defines how wide the commit message window is in the
1217         linkgit:git-gui[1]. "75" is the default.
1219 gui.diffcontext::
1220         Specifies how many context lines should be used in calls to diff
1221         made by the linkgit:git-gui[1]. The default is "5".
1223 gui.encoding::
1224         Specifies the default encoding to use for displaying of
1225         file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1226         It can be overridden by setting the 'encoding' attribute
1227         for relevant files (see linkgit:gitattributes[5]).
1228         If this option is not set, the tools default to the
1229         locale encoding.
1231 gui.matchtrackingbranch::
1232         Determines if new branches created with linkgit:git-gui[1] should
1233         default to tracking remote branches with matching names or
1234         not. Default: "false".
1236 gui.newbranchtemplate::
1237         Is used as suggested name when creating new branches using the
1238         linkgit:git-gui[1].
1240 gui.pruneduringfetch::
1241         "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1242         performing a fetch. The default value is "false".
1244 gui.trustmtime::
1245         Determines if linkgit:git-gui[1] should trust the file modification
1246         timestamp or not. By default the timestamps are not trusted.
1248 gui.spellingdictionary::
1249         Specifies the dictionary used for spell checking commit messages in
1250         the linkgit:git-gui[1]. When set to "none" spell checking is turned
1251         off.
1253 gui.fastcopyblame::
1254         If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1255         location detection. It makes blame significantly faster on huge
1256         repositories at the expense of less thorough copy detection.
1258 gui.copyblamethreshold::
1259         Specifies the threshold to use in 'git gui blame' original location
1260         detection, measured in alphanumeric characters. See the
1261         linkgit:git-blame[1] manual for more information on copy detection.
1263 gui.blamehistoryctx::
1264         Specifies the radius of history context in days to show in
1265         linkgit:gitk[1] for the selected commit, when the `Show History
1266         Context` menu item is invoked from 'git gui blame'. If this
1267         variable is set to zero, the whole history is shown.
1269 guitool.<name>.cmd::
1270         Specifies the shell command line to execute when the corresponding item
1271         of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1272         mandatory for every tool. The command is executed from the root of
1273         the working directory, and in the environment it receives the name of
1274         the tool as 'GIT_GUITOOL', the name of the currently selected file as
1275         'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1276         the head is detached, 'CUR_BRANCH' is empty).
1278 guitool.<name>.needsfile::
1279         Run the tool only if a diff is selected in the GUI. It guarantees
1280         that 'FILENAME' is not empty.
1282 guitool.<name>.noconsole::
1283         Run the command silently, without creating a window to display its
1284         output.
1286 guitool.<name>.norescan::
1287         Don't rescan the working directory for changes after the tool
1288         finishes execution.
1290 guitool.<name>.confirm::
1291         Show a confirmation dialog before actually running the tool.
1293 guitool.<name>.argprompt::
1294         Request a string argument from the user, and pass it to the tool
1295         through the 'ARGS' environment variable. Since requesting an
1296         argument implies confirmation, the 'confirm' option has no effect
1297         if this is enabled. If the option is set to 'true', 'yes', or '1',
1298         the dialog uses a built-in generic prompt; otherwise the exact
1299         value of the variable is used.
1301 guitool.<name>.revprompt::
1302         Request a single valid revision from the user, and set the
1303         'REVISION' environment variable. In other aspects this option
1304         is similar to 'argprompt', and can be used together with it.
1306 guitool.<name>.revunmerged::
1307         Show only unmerged branches in the 'revprompt' subdialog.
1308         This is useful for tools similar to merge or rebase, but not
1309         for things like checkout or reset.
1311 guitool.<name>.title::
1312         Specifies the title to use for the prompt dialog. The default
1313         is the tool name.
1315 guitool.<name>.prompt::
1316         Specifies the general prompt string to display at the top of
1317         the dialog, before subsections for 'argprompt' and 'revprompt'.
1318         The default value includes the actual command.
1320 help.browser::
1321         Specify the browser that will be used to display help in the
1322         'web' format. See linkgit:git-help[1].
1324 help.format::
1325         Override the default help format used by linkgit:git-help[1].
1326         Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1327         the default. 'web' and 'html' are the same.
1329 help.autocorrect::
1330         Automatically correct and execute mistyped commands after
1331         waiting for the given number of deciseconds (0.1 sec). If more
1332         than one command can be deduced from the entered text, nothing
1333         will be executed.  If the value of this option is negative,
1334         the corrected command will be executed immediately. If the
1335         value is 0 - the command will be just shown but not executed.
1336         This is the default.
1338 http.proxy::
1339         Override the HTTP proxy, normally configured using the 'http_proxy',
1340         'https_proxy', and 'all_proxy' environment variables (see
1341         `curl(1)`).  This can be overridden on a per-remote basis; see
1342         remote.<name>.proxy
1344 http.cookiefile::
1345         File containing previously stored cookie lines which should be used
1346         in the git http session, if they match the server. The file format
1347         of the file to read cookies from should be plain HTTP headers or
1348         the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
1349         NOTE that the file specified with http.cookiefile is only used as
1350         input. No cookies will be stored in the file.
1352 http.sslVerify::
1353         Whether to verify the SSL certificate when fetching or pushing
1354         over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1355         variable.
1357 http.sslCert::
1358         File containing the SSL certificate when fetching or pushing
1359         over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1360         variable.
1362 http.sslKey::
1363         File containing the SSL private key when fetching or pushing
1364         over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1365         variable.
1367 http.sslCertPasswordProtected::
1368         Enable git's password prompt for the SSL certificate.  Otherwise
1369         OpenSSL will prompt the user, possibly many times, if the
1370         certificate or private key is encrypted.  Can be overridden by the
1371         'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1373 http.sslCAInfo::
1374         File containing the certificates to verify the peer with when
1375         fetching or pushing over HTTPS. Can be overridden by the
1376         'GIT_SSL_CAINFO' environment variable.
1378 http.sslCAPath::
1379         Path containing files with the CA certificates to verify the peer
1380         with when fetching or pushing over HTTPS. Can be overridden
1381         by the 'GIT_SSL_CAPATH' environment variable.
1383 http.maxRequests::
1384         How many HTTP requests to launch in parallel. Can be overridden
1385         by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1387 http.minSessions::
1388         The number of curl sessions (counted across slots) to be kept across
1389         requests. They will not be ended with curl_easy_cleanup() until
1390         http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1391         value will be capped at 1. Defaults to 1.
1393 http.postBuffer::
1394         Maximum size in bytes of the buffer used by smart HTTP
1395         transports when POSTing data to the remote system.
1396         For requests larger than this buffer size, HTTP/1.1 and
1397         Transfer-Encoding: chunked is used to avoid creating a
1398         massive pack file locally.  Default is 1 MiB, which is
1399         sufficient for most requests.
1401 http.lowSpeedLimit, http.lowSpeedTime::
1402         If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1403         for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1404         Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1405         'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1407 http.noEPSV::
1408         A boolean which disables using of EPSV ftp command by curl.
1409         This can helpful with some "poor" ftp servers which don't
1410         support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1411         environment variable. Default is false (curl will use EPSV).
1413 http.useragent::
1414         The HTTP USER_AGENT string presented to an HTTP server.  The default
1415         value represents the version of the client git such as git/1.7.1.
1416         This option allows you to override this value to a more common value
1417         such as Mozilla/4.0.  This may be necessary, for instance, if
1418         connecting through a firewall that restricts HTTP connections to a set
1419         of common USER_AGENT strings (but not including those like git/1.7.1).
1420         Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1422 i18n.commitEncoding::
1423         Character encoding the commit messages are stored in; git itself
1424         does not care per se, but this information is necessary e.g. when
1425         importing commits from emails or in the gitk graphical history
1426         browser (and possibly at other places in the future or in other
1427         porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1429 i18n.logOutputEncoding::
1430         Character encoding the commit messages are converted to when
1431         running 'git log' and friends.
1433 imap::
1434         The configuration variables in the 'imap' section are described
1435         in linkgit:git-imap-send[1].
1437 init.templatedir::
1438         Specify the directory from which templates will be copied.
1439         (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1441 instaweb.browser::
1442         Specify the program that will be used to browse your working
1443         repository in gitweb. See linkgit:git-instaweb[1].
1445 instaweb.httpd::
1446         The HTTP daemon command-line to start gitweb on your working
1447         repository. See linkgit:git-instaweb[1].
1449 instaweb.local::
1450         If true the web server started by linkgit:git-instaweb[1] will
1451         be bound to the local IP (127.0.0.1).
1453 instaweb.modulepath::
1454         The default module path for linkgit:git-instaweb[1] to use
1455         instead of /usr/lib/apache2/modules.  Only used if httpd
1456         is Apache.
1458 instaweb.port::
1459         The port number to bind the gitweb httpd to. See
1460         linkgit:git-instaweb[1].
1462 interactive.singlekey::
1463         In interactive commands, allow the user to provide one-letter
1464         input with a single key (i.e., without hitting enter).
1465         Currently this is used by the `--patch` mode of
1466         linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1467         linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1468         setting is silently ignored if portable keystroke input
1469         is not available.
1471 log.abbrevCommit::
1472         If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1473         linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
1474         override this option with `--no-abbrev-commit`.
1476 log.date::
1477         Set the default date-time mode for the 'log' command.
1478         Setting a value for log.date is similar to using 'git log''s
1479         `--date` option.  Possible values are `relative`, `local`,
1480         `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1481         for details.
1483 log.decorate::
1484         Print out the ref names of any commits that are shown by the log
1485         command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1486         'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1487         specified, the full ref name (including prefix) will be printed.
1488         This is the same as the log commands '--decorate' option.
1490 log.showroot::
1491         If true, the initial commit will be shown as a big creation event.
1492         This is equivalent to a diff against an empty tree.
1493         Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1494         normally hide the root commit will now show it. True by default.
1496 mailmap.file::
1497         The location of an augmenting mailmap file. The default
1498         mailmap, located in the root of the repository, is loaded
1499         first, then the mailmap file pointed to by this variable.
1500         The location of the mailmap file may be in a repository
1501         subdirectory, or somewhere outside of the repository itself.
1502         See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1504 man.viewer::
1505         Specify the programs that may be used to display help in the
1506         'man' format. See linkgit:git-help[1].
1508 man.<tool>.cmd::
1509         Specify the command to invoke the specified man viewer. The
1510         specified command is evaluated in shell with the man page
1511         passed as argument. (See linkgit:git-help[1].)
1513 man.<tool>.path::
1514         Override the path for the given tool that may be used to
1515         display help in the 'man' format. See linkgit:git-help[1].
1517 include::merge-config.txt[]
1519 mergetool.<tool>.path::
1520         Override the path for the given tool.  This is useful in case
1521         your tool is not in the PATH.
1523 mergetool.<tool>.cmd::
1524         Specify the command to invoke the specified merge tool.  The
1525         specified command is evaluated in shell with the following
1526         variables available: 'BASE' is the name of a temporary file
1527         containing the common base of the files to be merged, if available;
1528         'LOCAL' is the name of a temporary file containing the contents of
1529         the file on the current branch; 'REMOTE' is the name of a temporary
1530         file containing the contents of the file from the branch being
1531         merged; 'MERGED' contains the name of the file to which the merge
1532         tool should write the results of a successful merge.
1534 mergetool.<tool>.trustExitCode::
1535         For a custom merge command, specify whether the exit code of
1536         the merge command can be used to determine whether the merge was
1537         successful.  If this is not set to true then the merge target file
1538         timestamp is checked and the merge assumed to have been successful
1539         if the file has been updated, otherwise the user is prompted to
1540         indicate the success of the merge.
1542 mergetool.keepBackup::
1543         After performing a merge, the original file with conflict markers
1544         can be saved as a file with a `.orig` extension.  If this variable
1545         is set to `false` then this file is not preserved.  Defaults to
1546         `true` (i.e. keep the backup files).
1548 mergetool.keepTemporaries::
1549         When invoking a custom merge tool, git uses a set of temporary
1550         files to pass to the tool. If the tool returns an error and this
1551         variable is set to `true`, then these temporary files will be
1552         preserved, otherwise they will be removed after the tool has
1553         exited. Defaults to `false`.
1555 mergetool.prompt::
1556         Prompt before each invocation of the merge resolution program.
1558 notes.displayRef::
1559         The (fully qualified) refname from which to show notes when
1560         showing commit messages.  The value of this variable can be set
1561         to a glob, in which case notes from all matching refs will be
1562         shown.  You may also specify this configuration variable
1563         several times.  A warning will be issued for refs that do not
1564         exist, but a glob that does not match any refs is silently
1565         ignored.
1567 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1568 environment variable, which must be a colon separated list of refs or
1569 globs.
1571 The effective value of "core.notesRef" (possibly overridden by
1572 GIT_NOTES_REF) is also implicitly added to the list of refs to be
1573 displayed.
1575 notes.rewrite.<command>::
1576         When rewriting commits with <command> (currently `amend` or
1577         `rebase`) and this variable is set to `true`, git
1578         automatically copies your notes from the original to the
1579         rewritten commit.  Defaults to `true`, but see
1580         "notes.rewriteRef" below.
1582 notes.rewriteMode::
1583         When copying notes during a rewrite (see the
1584         "notes.rewrite.<command>" option), determines what to do if
1585         the target commit already has a note.  Must be one of
1586         `overwrite`, `concatenate`, or `ignore`.  Defaults to
1587         `concatenate`.
1589 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1590 environment variable.
1592 notes.rewriteRef::
1593         When copying notes during a rewrite, specifies the (fully
1594         qualified) ref whose notes should be copied.  The ref may be a
1595         glob, in which case notes in all matching refs will be copied.
1596         You may also specify this configuration several times.
1598 Does not have a default value; you must configure this variable to
1599 enable note rewriting.  Set it to `refs/notes/commits` to enable
1600 rewriting for the default commit notes.
1602 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1603 environment variable, which must be a colon separated list of refs or
1604 globs.
1606 pack.window::
1607         The size of the window used by linkgit:git-pack-objects[1] when no
1608         window size is given on the command line. Defaults to 10.
1610 pack.depth::
1611         The maximum delta depth used by linkgit:git-pack-objects[1] when no
1612         maximum depth is given on the command line. Defaults to 50.
1614 pack.windowMemory::
1615         The window memory size limit used by linkgit:git-pack-objects[1]
1616         when no limit is given on the command line.  The value can be
1617         suffixed with "k", "m", or "g".  Defaults to 0, meaning no
1618         limit.
1620 pack.compression::
1621         An integer -1..9, indicating the compression level for objects
1622         in a pack file. -1 is the zlib default. 0 means no
1623         compression, and 1..9 are various speed/size tradeoffs, 9 being
1624         slowest.  If not set,  defaults to core.compression.  If that is
1625         not set,  defaults to -1, the zlib default, which is "a default
1626         compromise between speed and compression (currently equivalent
1627         to level 6)."
1629 Note that changing the compression level will not automatically recompress
1630 all existing objects. You can force recompression by passing the -F option
1631 to linkgit:git-repack[1].
1633 pack.deltaCacheSize::
1634         The maximum memory in bytes used for caching deltas in
1635         linkgit:git-pack-objects[1] before writing them out to a pack.
1636         This cache is used to speed up the writing object phase by not
1637         having to recompute the final delta result once the best match
1638         for all objects is found.  Repacking large repositories on machines
1639         which are tight with memory might be badly impacted by this though,
1640         especially if this cache pushes the system into swapping.
1641         A value of 0 means no limit. The smallest size of 1 byte may be
1642         used to virtually disable this cache. Defaults to 256 MiB.
1644 pack.deltaCacheLimit::
1645         The maximum size of a delta, that is cached in
1646         linkgit:git-pack-objects[1]. This cache is used to speed up the
1647         writing object phase by not having to recompute the final delta
1648         result once the best match for all objects is found. Defaults to 1000.
1650 pack.threads::
1651         Specifies the number of threads to spawn when searching for best
1652         delta matches.  This requires that linkgit:git-pack-objects[1]
1653         be compiled with pthreads otherwise this option is ignored with a
1654         warning. This is meant to reduce packing time on multiprocessor
1655         machines. The required amount of memory for the delta search window
1656         is however multiplied by the number of threads.
1657         Specifying 0 will cause git to auto-detect the number of CPU's
1658         and set the number of threads accordingly.
1660 pack.indexVersion::
1661         Specify the default pack index version.  Valid values are 1 for
1662         legacy pack index used by Git versions prior to 1.5.2, and 2 for
1663         the new pack index with capabilities for packs larger than 4 GB
1664         as well as proper protection against the repacking of corrupted
1665         packs.  Version 2 is the default.  Note that version 2 is enforced
1666         and this config option ignored whenever the corresponding pack is
1667         larger than 2 GB.
1669 If you have an old git that does not understand the version 2 `*.idx` file,
1670 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1671 that will copy both `*.pack` file and corresponding `*.idx` file from the
1672 other side may give you a repository that cannot be accessed with your
1673 older version of git. If the `*.pack` file is smaller than 2 GB, however,
1674 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1675 the `*.idx` file.
1677 pack.packSizeLimit::
1678         The maximum size of a pack.  This setting only affects
1679         packing to a file when repacking, i.e. the git:// protocol
1680         is unaffected.  It can be overridden by the `--max-pack-size`
1681         option of linkgit:git-repack[1]. The minimum size allowed is
1682         limited to 1 MiB. The default is unlimited.
1683         Common unit suffixes of 'k', 'm', or 'g' are
1684         supported.
1686 pager.<cmd>::
1687         If the value is boolean, turns on or off pagination of the
1688         output of a particular git subcommand when writing to a tty.
1689         Otherwise, turns on pagination for the subcommand using the
1690         pager specified by the value of `pager.<cmd>`.  If `--paginate`
1691         or `--no-pager` is specified on the command line, it takes
1692         precedence over this option.  To disable pagination for all
1693         commands, set `core.pager` or `GIT_PAGER` to `cat`.
1695 pretty.<name>::
1696         Alias for a --pretty= format string, as specified in
1697         linkgit:git-log[1]. Any aliases defined here can be used just
1698         as the built-in pretty formats could. For example,
1699         running `git config pretty.changelog "format:* %H %s"`
1700         would cause the invocation `git log --pretty=changelog`
1701         to be equivalent to running `git log "--pretty=format:* %H %s"`.
1702         Note that an alias with the same name as a built-in format
1703         will be silently ignored.
1705 pull.rebase::
1706         When true, rebase branches on top of the fetched branch, instead
1707         of merging the default branch from the default remote when "git
1708         pull" is run. See "branch.<name>.rebase" for setting this on a
1709         per-branch basis.
1711 *NOTE*: this is a possibly dangerous operation; do *not* use
1712 it unless you understand the implications (see linkgit:git-rebase[1]
1713 for details).
1715 pull.octopus::
1716         The default merge strategy to use when pulling multiple branches
1717         at once.
1719 pull.twohead::
1720         The default merge strategy to use when pulling a single branch.
1722 push.default::
1723         Defines the action git push should take if no refspec is given
1724         on the command line, no refspec is configured in the remote, and
1725         no refspec is implied by any of the options given on the command
1726         line. Possible values are:
1729 * `nothing` - do not push anything.
1730 * `matching` - push all branches having the same name in both ends.
1731   This is for those who prepare all the branches into a publishable
1732   shape and then push them out with a single command.  It is not
1733   appropriate for pushing into a repository shared by multiple users,
1734   since locally stalled branches will attempt a non-fast forward push
1735   if other users updated the branch.
1736   +
1737   This is currently the default, but Git 2.0 will change the default
1738   to `simple`.
1739 * `upstream` - push the current branch to its upstream branch.
1740   With this, `git push` will update the same remote ref as the one which
1741   is merged by `git pull`, making `push` and `pull` symmetrical.
1742   See "branch.<name>.merge" for how to configure the upstream branch.
1743 * `simple` - like `upstream`, but refuses to push if the upstream
1744   branch's name is different from the local one. This is the safest
1745   option and is well-suited for beginners. It will become the default
1746   in Git 2.0.
1747 * `current` - push the current branch to a branch of the same name.
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 receive.denyNonFastForwards::
1803         If set to true, git-receive-pack will deny a ref update which is
1804         not a fast-forward. Use this to prevent such an update via a push,
1805         even if that push is forced. This configuration variable is
1806         set when initializing a shared repository.
1808 receive.updateserverinfo::
1809         If set to true, git-receive-pack will run git-update-server-info
1810         after receiving data from git-push and updating refs.
1812 remote.<name>.url::
1813         The URL of a remote repository.  See linkgit:git-fetch[1] or
1814         linkgit:git-push[1].
1816 remote.<name>.pushurl::
1817         The push URL of a remote repository.  See linkgit:git-push[1].
1819 remote.<name>.proxy::
1820         For remotes that require curl (http, https and ftp), the URL to
1821         the proxy to use for that remote.  Set to the empty string to
1822         disable proxying for that remote.
1824 remote.<name>.fetch::
1825         The default set of "refspec" for linkgit:git-fetch[1]. See
1826         linkgit:git-fetch[1].
1828 remote.<name>.push::
1829         The default set of "refspec" for linkgit:git-push[1]. See
1830         linkgit:git-push[1].
1832 remote.<name>.mirror::
1833         If true, pushing to this remote will automatically behave
1834         as if the `--mirror` option was given on the command line.
1836 remote.<name>.skipDefaultUpdate::
1837         If true, this remote will be skipped by default when updating
1838         using linkgit:git-fetch[1] or the `update` subcommand of
1839         linkgit:git-remote[1].
1841 remote.<name>.skipFetchAll::
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>.receivepack::
1847         The default program to execute on the remote side when pushing.  See
1848         option \--receive-pack of linkgit:git-push[1].
1850 remote.<name>.uploadpack::
1851         The default program to execute on the remote side when fetching.  See
1852         option \--upload-pack of linkgit:git-fetch-pack[1].
1854 remote.<name>.tagopt::
1855         Setting this value to \--no-tags disables automatic tag following when
1856         fetching from remote <name>. Setting it to \--tags will fetch every
1857         tag from remote <name>, even if they are not reachable from remote
1858         branch heads. Passing these flags directly to linkgit:git-fetch[1] can
1859         override this setting. See options \--tags and \--no-tags of
1860         linkgit:git-fetch[1].
1862 remote.<name>.vcs::
1863         Setting this to a value <vcs> will cause git to interact with
1864         the remote with the git-remote-<vcs> helper.
1866 remotes.<group>::
1867         The list of remotes which are fetched by "git remote update
1868         <group>".  See linkgit:git-remote[1].
1870 repack.usedeltabaseoffset::
1871         By default, linkgit:git-repack[1] creates packs that use
1872         delta-base offset. If you need to share your repository with
1873         git older than version 1.4.4, either directly or via a dumb
1874         protocol such as http, then you need to set this option to
1875         "false" and repack. Access from old git versions over the
1876         native protocol are unaffected by this option.
1878 rerere.autoupdate::
1879         When set to true, `git-rerere` updates the index with the
1880         resulting contents after it cleanly resolves conflicts using
1881         previously recorded resolution.  Defaults to false.
1883 rerere.enabled::
1884         Activate recording of resolved conflicts, so that identical
1885         conflict hunks can be resolved automatically, should they be
1886         encountered again.  By default, linkgit:git-rerere[1] is
1887         enabled if there is an `rr-cache` directory under the
1888         `$GIT_DIR`, e.g. if "rerere" was previously used in the
1889         repository.
1891 sendemail.identity::
1892         A configuration identity. When given, causes values in the
1893         'sendemail.<identity>' subsection to take precedence over
1894         values in the 'sendemail' section. The default identity is
1895         the value of 'sendemail.identity'.
1897 sendemail.smtpencryption::
1898         See linkgit:git-send-email[1] for description.  Note that this
1899         setting is not subject to the 'identity' mechanism.
1901 sendemail.smtpssl::
1902         Deprecated alias for 'sendemail.smtpencryption = ssl'.
1904 sendemail.<identity>.*::
1905         Identity-specific versions of the 'sendemail.*' parameters
1906         found below, taking precedence over those when the this
1907         identity is selected, through command-line or
1908         'sendemail.identity'.
1910 sendemail.aliasesfile::
1911 sendemail.aliasfiletype::
1912 sendemail.bcc::
1913 sendemail.cc::
1914 sendemail.cccmd::
1915 sendemail.chainreplyto::
1916 sendemail.confirm::
1917 sendemail.envelopesender::
1918 sendemail.from::
1919 sendemail.multiedit::
1920 sendemail.signedoffbycc::
1921 sendemail.smtppass::
1922 sendemail.suppresscc::
1923 sendemail.suppressfrom::
1924 sendemail.to::
1925 sendemail.smtpdomain::
1926 sendemail.smtpserver::
1927 sendemail.smtpserverport::
1928 sendemail.smtpserveroption::
1929 sendemail.smtpuser::
1930 sendemail.thread::
1931 sendemail.validate::
1932         See linkgit:git-send-email[1] for description.
1934 sendemail.signedoffcc::
1935         Deprecated alias for 'sendemail.signedoffbycc'.
1937 showbranch.default::
1938         The default set of branches for linkgit:git-show-branch[1].
1939         See linkgit:git-show-branch[1].
1941 status.relativePaths::
1942         By default, linkgit:git-status[1] shows paths relative to the
1943         current directory. Setting this variable to `false` shows paths
1944         relative to the repository root (this was the default for git
1945         prior to v1.5.4).
1947 status.showUntrackedFiles::
1948         By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1949         files which are not currently tracked by Git. Directories which
1950         contain only untracked files, are shown with the directory name
1951         only. Showing untracked files means that Git needs to lstat() all
1952         all the files in the whole repository, which might be slow on some
1953         systems. So, this variable controls how the commands displays
1954         the untracked files. Possible values are:
1957 * `no` - Show no untracked files.
1958 * `normal` - Show untracked files and directories.
1959 * `all` - Show also individual files in untracked directories.
1962 If this variable is not specified, it defaults to 'normal'.
1963 This variable can be overridden with the -u|--untracked-files option
1964 of linkgit:git-status[1] and linkgit:git-commit[1].
1966 status.submodulesummary::
1967         Defaults to false.
1968         If this is set to a non zero number or true (identical to -1 or an
1969         unlimited number), the submodule summary will be enabled and a
1970         summary of commits for modified submodules will be shown (see
1971         --summary-limit option of linkgit:git-submodule[1]).
1973 submodule.<name>.path::
1974 submodule.<name>.url::
1975 submodule.<name>.update::
1976         The path within this project, URL, and the updating strategy
1977         for a submodule.  These variables are initially populated
1978         by 'git submodule init'; edit them to override the
1979         URL and other values found in the `.gitmodules` file.  See
1980         linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
1982 submodule.<name>.fetchRecurseSubmodules::
1983         This option can be used to control recursive fetching of this
1984         submodule. It can be overridden by using the --[no-]recurse-submodules
1985         command line option to "git fetch" and "git pull".
1986         This setting will override that from in the linkgit:gitmodules[5]
1987         file.
1989 submodule.<name>.ignore::
1990         Defines under what circumstances "git status" and the diff family show
1991         a submodule as modified. When set to "all", it will never be considered
1992         modified, "dirty" will ignore all changes to the submodules work tree and
1993         takes only differences between the HEAD of the submodule and the commit
1994         recorded in the superproject into account. "untracked" will additionally
1995         let submodules with modified tracked files in their work tree show up.
1996         Using "none" (the default when this option is not set) also shows
1997         submodules that have untracked files in their work tree as changed.
1998         This setting overrides any setting made in .gitmodules for this submodule,
1999         both settings can be overridden on the command line by using the
2000         "--ignore-submodules" option.
2002 tar.umask::
2003         This variable can be used to restrict the permission bits of
2004         tar archive entries.  The default is 0002, which turns off the
2005         world write bit.  The special value "user" indicates that the
2006         archiving user's umask will be used instead.  See umask(2) and
2007         linkgit:git-archive[1].
2009 transfer.fsckObjects::
2010         When `fetch.fsckObjects` or `receive.fsckObjects` are
2011         not set, the value of this variable is used instead.
2012         Defaults to false.
2014 transfer.unpackLimit::
2015         When `fetch.unpackLimit` or `receive.unpackLimit` are
2016         not set, the value of this variable is used instead.
2017         The default value is 100.
2019 url.<base>.insteadOf::
2020         Any URL that starts with this value will be rewritten to
2021         start, instead, with <base>. In cases where some site serves a
2022         large number of repositories, and serves them with multiple
2023         access methods, and some users need to use different access
2024         methods, this feature allows people to specify any of the
2025         equivalent URLs and have git automatically rewrite the URL to
2026         the best alternative for the particular user, even for a
2027         never-before-seen repository on the site.  When more than one
2028         insteadOf strings match a given URL, the longest match is used.
2030 url.<base>.pushInsteadOf::
2031         Any URL that starts with this value will not be pushed to;
2032         instead, it will be rewritten to start with <base>, and the
2033         resulting URL will be pushed to. In cases where some site serves
2034         a large number of repositories, and serves them with multiple
2035         access methods, some of which do not allow push, this feature
2036         allows people to specify a pull-only URL and have git
2037         automatically use an appropriate URL to push, even for a
2038         never-before-seen repository on the site.  When more than one
2039         pushInsteadOf strings match a given URL, the longest match is
2040         used.  If a remote has an explicit pushurl, git will ignore this
2041         setting for that remote.
2043 user.email::
2044         Your email address to be recorded in any newly created commits.
2045         Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
2046         'EMAIL' environment variables.  See linkgit:git-commit-tree[1].
2048 user.name::
2049         Your full name to be recorded in any newly created commits.
2050         Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
2051         environment variables.  See linkgit:git-commit-tree[1].
2053 user.signingkey::
2054         If linkgit:git-tag[1] is not selecting the key you want it to
2055         automatically when creating a signed tag, you can override the
2056         default selection with this variable.  This option is passed
2057         unchanged to gpg's --local-user parameter, so you may specify a key
2058         using any method that gpg supports.
2060 web.browser::
2061         Specify a web browser that may be used by some commands.
2062         Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
2063         may use it.