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