core.hidedotfiles: hide '.git' dir by default
[git/mingw/4msysgit.git] / Documentation / config.txt
blob9ce009f2162069302e2aa1a6507093f4f5e851b2
1 CONFIGURATION FILE
2 ------------------
4 The Git configuration file contains a number of variables that affect
5 the Git commands' 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).  Other char escape sequences (including octal
82 escape sequences) are invalid.
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         pushUpdateRejected::
144                 Set this variable to 'false' if you want to disable
145                 'pushNonFFCurrent', 'pushNonFFDefault',
146                 'pushNonFFMatching', 'pushAlreadyExists',
147                 'pushFetchFirst', and 'pushNeedsForce'
148                 simultaneously.
149         pushNonFFCurrent::
150                 Advice shown when linkgit:git-push[1] fails due to a
151                 non-fast-forward update to the current branch.
152         pushNonFFDefault::
153                 Advice to set 'push.default' to 'upstream' or 'current'
154                 when you ran linkgit:git-push[1] and pushed 'matching
155                 refs' by default (i.e. you did not provide an explicit
156                 refspec, and no 'push.default' configuration was set)
157                 and it resulted in a non-fast-forward error.
158         pushNonFFMatching::
159                 Advice shown when you ran linkgit:git-push[1] and pushed
160                 'matching refs' explicitly (i.e. you used ':', or
161                 specified a refspec that isn't your current branch) and
162                 it resulted in a non-fast-forward error.
163         pushAlreadyExists::
164                 Shown when linkgit:git-push[1] rejects an update that
165                 does not qualify for fast-forwarding (e.g., a tag.)
166         pushFetchFirst::
167                 Shown when linkgit:git-push[1] rejects an update that
168                 tries to overwrite a remote ref that points at an
169                 object we do not have.
170         pushNeedsForce::
171                 Shown when linkgit:git-push[1] rejects an update that
172                 tries to overwrite a remote ref that points at an
173                 object that is not a commit-ish, or make the remote
174                 ref point at an object that is not a commit-ish.
175         statusHints::
176                 Show directions on how to proceed from the current
177                 state in the output of linkgit:git-status[1], in
178                 the template shown when writing commit messages in
179                 linkgit:git-commit[1], and in the help message shown
180                 by linkgit:git-checkout[1] when switching branch.
181         statusUoption::
182                 Advise to consider using the `-u` option to linkgit:git-status[1]
183                 when the command takes more than 2 seconds to enumerate untracked
184                 files.
185         commitBeforeMerge::
186                 Advice shown when linkgit:git-merge[1] refuses to
187                 merge to avoid overwriting local changes.
188         resolveConflict::
189                 Advice shown by various commands when conflicts
190                 prevent the operation from being performed.
191         implicitIdentity::
192                 Advice on how to set your identity configuration when
193                 your information is guessed from the system username and
194                 domain name.
195         detachedHead::
196                 Advice shown when you used linkgit:git-checkout[1] to
197                 move to the detach HEAD state, to instruct how to create
198                 a local branch after the fact.
199         amWorkDir::
200                 Advice that shows the location of the patch file when
201                 linkgit:git-am[1] fails to apply it.
202         rmHints::
203                 In case of failure in the output of linkgit:git-rm[1],
204                 show directions on how to proceed from the current state.
207 core.fileMode::
208         If false, the executable bit differences between the index and
209         the working tree are ignored; useful on broken filesystems like FAT.
210         See linkgit:git-update-index[1].
212 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
213 will probe and set core.fileMode false if appropriate when the
214 repository is created.
216 core.hideDotFiles::
217         (Windows-only) If true (which is the default), mark newly-created
218         directories and files whose name starts with a dot as hidden.
219         If 'dotGitOnly', only the .git/ directory is hidden, but no other
220         files starting with a dot.
222 core.ignorecase::
223         If true, this option enables various workarounds to enable
224         Git to work better on filesystems that are not case sensitive,
225         like FAT. For example, if a directory listing finds
226         "makefile" when Git expects "Makefile", Git will assume
227         it is really the same file, and continue to remember it as
228         "Makefile".
230 The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
231 will probe and set core.ignorecase true if appropriate when the repository
232 is created.
234 core.precomposeunicode::
235         This option is only used by Mac OS implementation of Git.
236         When core.precomposeunicode=true, Git reverts the unicode decomposition
237         of filenames done by Mac OS. This is useful when sharing a repository
238         between Mac OS and Linux or Windows.
239         (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
240         When false, file names are handled fully transparent by Git,
241         which is backward compatible with older versions of Git.
243 core.trustctime::
244         If false, the ctime differences between the index and the
245         working tree are ignored; useful when the inode change time
246         is regularly modified by something outside Git (file system
247         crawlers and some backup systems).
248         See linkgit:git-update-index[1]. True by default.
250 core.checkstat::
251         Determines which stat fields to match between the index
252         and work tree. The user can set this to 'default' or
253         'minimal'. Default (or explicitly 'default'), is to check
254         all fields, including the sub-second part of mtime and ctime.
256 core.quotepath::
257         The commands that output paths (e.g. 'ls-files',
258         'diff'), when not given the `-z` option, will quote
259         "unusual" characters in the pathname by enclosing the
260         pathname in a double-quote pair and with backslashes the
261         same way strings in C source code are quoted.  If this
262         variable is set to false, the bytes higher than 0x80 are
263         not quoted but output as verbatim.  Note that double
264         quote, backslash and control characters are always
265         quoted without `-z` regardless of the setting of this
266         variable.
268 core.eol::
269         Sets the line ending type to use in the working directory for
270         files that have the `text` property set.  Alternatives are
271         'lf', 'crlf' and 'native', which uses the platform's native
272         line ending.  The default value is `native`.  See
273         linkgit:gitattributes[5] for more information on end-of-line
274         conversion.
276 core.safecrlf::
277         If true, makes Git check if converting `CRLF` is reversible when
278         end-of-line conversion is active.  Git will verify if a command
279         modifies a file in the work tree either directly or indirectly.
280         For example, committing a file followed by checking out the
281         same file should yield the original file in the work tree.  If
282         this is not the case for the current setting of
283         `core.autocrlf`, Git will reject the file.  The variable can
284         be set to "warn", in which case Git will only warn about an
285         irreversible conversion but continue the operation.
287 CRLF conversion bears a slight chance of corrupting data.
288 When it is enabled, Git will convert CRLF to LF during commit and LF to
289 CRLF during checkout.  A file that contains a mixture of LF and
290 CRLF before the commit cannot be recreated by Git.  For text
291 files this is the right thing to do: it corrects line endings
292 such that we have only LF line endings in the repository.
293 But for binary files that are accidentally classified as text the
294 conversion can corrupt data.
296 If you recognize such corruption early you can easily fix it by
297 setting the conversion type explicitly in .gitattributes.  Right
298 after committing you still have the original file in your work
299 tree and this file is not yet corrupted.  You can explicitly tell
300 Git that this file is binary and Git will handle the file
301 appropriately.
303 Unfortunately, the desired effect of cleaning up text files with
304 mixed line endings and the undesired effect of corrupting binary
305 files cannot be distinguished.  In both cases CRLFs are removed
306 in an irreversible way.  For text files this is the right thing
307 to do because CRLFs are line endings, while for binary files
308 converting CRLFs corrupts data.
310 Note, this safety check does not mean that a checkout will generate a
311 file identical to the original file for a different setting of
312 `core.eol` and `core.autocrlf`, but only for the current one.  For
313 example, a text file with `LF` would be accepted with `core.eol=lf`
314 and could later be checked out with `core.eol=crlf`, in which case the
315 resulting file would contain `CRLF`, although the original file
316 contained `LF`.  However, in both work trees the line endings would be
317 consistent, that is either all `LF` or all `CRLF`, but never mixed.  A
318 file with mixed line endings would be reported by the `core.safecrlf`
319 mechanism.
321 core.autocrlf::
322         Setting this variable to "true" is almost the same as setting
323         the `text` attribute to "auto" on all files except that text
324         files are not guaranteed to be normalized: files that contain
325         `CRLF` in the repository will not be touched.  Use this
326         setting if you want to have `CRLF` line endings in your
327         working directory even though the repository does not have
328         normalized line endings.  This variable can be set to 'input',
329         in which case no output conversion is performed.
331 core.symlinks::
332         If false, symbolic links are checked out as small plain files that
333         contain the link text. linkgit:git-update-index[1] and
334         linkgit:git-add[1] will not change the recorded type to regular
335         file. Useful on filesystems like FAT that do not support
336         symbolic links.
338 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
339 will probe and set core.symlinks false if appropriate when the repository
340 is created.
342 core.gitProxy::
343         A "proxy command" to execute (as 'command host port') instead
344         of establishing direct connection to the remote server when
345         using the Git protocol for fetching. If the variable value is
346         in the "COMMAND for DOMAIN" format, the command is applied only
347         on hostnames ending with the specified domain string. This variable
348         may be set multiple times and is matched in the given order;
349         the first match wins.
351 Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
352 (which always applies universally, without the special "for"
353 handling).
355 The special string `none` can be used as the proxy command to
356 specify that no proxy be used for a given domain pattern.
357 This is useful for excluding servers inside a firewall from
358 proxy use, while defaulting to a common proxy for external domains.
360 core.ignoreStat::
361         If true, commands which modify both the working tree and the index
362         will mark the updated paths with the "assume unchanged" bit in the
363         index. These marked files are then assumed to stay unchanged in the
364         working tree, until you mark them otherwise manually - Git will not
365         detect the file changes by lstat() calls. This is useful on systems
366         where those are very slow, such as Microsoft Windows.
367         See linkgit:git-update-index[1].
368         False by default.
370 core.preferSymlinkRefs::
371         Instead of the default "symref" format for HEAD
372         and other symbolic reference files, use symbolic links.
373         This is sometimes needed to work with old scripts that
374         expect HEAD to be a symbolic link.
376 core.bare::
377         If true this repository is assumed to be 'bare' and has no
378         working directory associated with it.  If this is the case a
379         number of commands that require a working directory will be
380         disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
382 This setting is automatically guessed by linkgit:git-clone[1] or
383 linkgit:git-init[1] when the repository was created.  By default a
384 repository that ends in "/.git" is assumed to be not bare (bare =
385 false), while all other repositories are assumed to be bare (bare
386 = true).
388 core.worktree::
389         Set the path to the root of the working tree.
390         This can be overridden by the GIT_WORK_TREE environment
391         variable and the '--work-tree' command line option.
392         The value can be an absolute path or relative to the path to
393         the .git directory, which is either specified by --git-dir
394         or GIT_DIR, or automatically discovered.
395         If --git-dir or GIT_DIR is specified but none of
396         --work-tree, GIT_WORK_TREE and core.worktree is specified,
397         the current working directory is regarded as the top level
398         of your working tree.
400 Note that this variable is honored even when set in a configuration
401 file in a ".git" subdirectory of a directory and its value differs
402 from the latter directory (e.g. "/path/to/.git/config" has
403 core.worktree set to "/different/path"), which is most likely a
404 misconfiguration.  Running Git commands in the "/path/to" directory will
405 still use "/different/path" as the root of the work tree and can cause
406 confusion unless you know what you are doing (e.g. you are creating a
407 read-only snapshot of the same index to a location different from the
408 repository's usual working tree).
410 core.logAllRefUpdates::
411         Enable the reflog. Updates to a ref <ref> is logged to the file
412         "$GIT_DIR/logs/<ref>", by appending the new and old
413         SHA-1, the date/time and the reason of the update, but
414         only when the file exists.  If this configuration
415         variable is set to true, missing "$GIT_DIR/logs/<ref>"
416         file is automatically created for branch heads (i.e. under
417         refs/heads/), remote refs (i.e. under refs/remotes/),
418         note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
420 This information can be used to determine what commit
421 was the tip of a branch "2 days ago".
423 This value is true by default in a repository that has
424 a working directory associated with it, and false by
425 default in a bare repository.
427 core.repositoryFormatVersion::
428         Internal variable identifying the repository format and layout
429         version.
431 core.sharedRepository::
432         When 'group' (or 'true'), the repository is made shareable between
433         several users in a group (making sure all the files and objects are
434         group-writable). When 'all' (or 'world' or 'everybody'), the
435         repository will be readable by all users, additionally to being
436         group-shareable. When 'umask' (or 'false'), Git will use permissions
437         reported by umask(2). When '0xxx', where '0xxx' is an octal number,
438         files in the repository will have this mode value. '0xxx' will override
439         user's umask value (whereas the other options will only override
440         requested parts of the user's umask value). Examples: '0660' will make
441         the repo read/write-able for the owner and group, but inaccessible to
442         others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
443         repository that is group-readable but not group-writable.
444         See linkgit:git-init[1]. False by default.
446 core.warnAmbiguousRefs::
447         If true, Git will warn you if the ref name you passed it is ambiguous
448         and might match multiple refs in the repository. True by default.
450 core.compression::
451         An integer -1..9, indicating a default compression level.
452         -1 is the zlib default. 0 means no compression,
453         and 1..9 are various speed/size tradeoffs, 9 being slowest.
454         If set, this provides a default to other compression variables,
455         such as 'core.loosecompression' and 'pack.compression'.
457 core.loosecompression::
458         An integer -1..9, indicating the compression level for objects that
459         are not in a pack file. -1 is the zlib default. 0 means no
460         compression, and 1..9 are various speed/size tradeoffs, 9 being
461         slowest.  If not set,  defaults to core.compression.  If that is
462         not set,  defaults to 1 (best speed).
464 core.packedGitWindowSize::
465         Number of bytes of a pack file to map into memory in a
466         single mapping operation.  Larger window sizes may allow
467         your system to process a smaller number of large pack files
468         more quickly.  Smaller window sizes will negatively affect
469         performance due to increased calls to the operating system's
470         memory manager, but may improve performance when accessing
471         a large number of large pack files.
473 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
474 MiB on 32 bit platforms and 1 GiB on 64 bit platforms.  This should
475 be reasonable for all users/operating systems.  You probably do
476 not need to adjust this value.
478 Common unit suffixes of 'k', 'm', or 'g' are supported.
480 core.packedGitLimit::
481         Maximum number of bytes to map simultaneously into memory
482         from pack files.  If Git needs to access more than this many
483         bytes at once to complete an operation it will unmap existing
484         regions to reclaim virtual address space within the process.
486 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
487 This should be reasonable for all users/operating systems, except on
488 the largest projects.  You probably do not need to adjust this value.
490 Common unit suffixes of 'k', 'm', or 'g' are supported.
492 core.deltaBaseCacheLimit::
493         Maximum number of bytes to reserve for caching base objects
494         that may be referenced by multiple deltified objects.  By storing the
495         entire decompressed base objects in a cache Git is able
496         to avoid unpacking and decompressing frequently used base
497         objects multiple times.
499 Default is 16 MiB on all platforms.  This should be reasonable
500 for all users/operating systems, except on the largest projects.
501 You probably do not need to adjust this value.
503 Common unit suffixes of 'k', 'm', or 'g' are supported.
505 core.bigFileThreshold::
506         Files larger than this size are stored deflated, without
507         attempting delta compression.  Storing large files without
508         delta compression avoids excessive memory usage, at the
509         slight expense of increased disk usage.
511 Default is 512 MiB on all platforms.  This should be reasonable
512 for most projects as source code and other text files can still
513 be delta compressed, but larger binary media files won't be.
515 Common unit suffixes of 'k', 'm', or 'g' are supported.
517 core.excludesfile::
518         In addition to '.gitignore' (per-directory) and
519         '.git/info/exclude', Git looks into this file for patterns
520         of files which are not meant to be tracked.  "`~/`" is expanded
521         to the value of `$HOME` and "`~user/`" to the specified user's
522         home directory. Its default value is $XDG_CONFIG_HOME/git/ignore.
523         If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore
524         is used instead. See linkgit:gitignore[5].
526 core.askpass::
527         Some commands (e.g. svn and http interfaces) that interactively
528         ask for a password can be told to use an external program given
529         via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
530         environment variable. If not set, fall back to the value of the
531         'SSH_ASKPASS' environment variable or, failing that, a simple password
532         prompt. The external program shall be given a suitable prompt as
533         command line argument and write the password on its STDOUT.
535 core.attributesfile::
536         In addition to '.gitattributes' (per-directory) and
537         '.git/info/attributes', Git looks into this file for attributes
538         (see linkgit:gitattributes[5]). Path expansions are made the same
539         way as for `core.excludesfile`. Its default value is
540         $XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not
541         set or empty, $HOME/.config/git/attributes is used instead.
543 core.editor::
544         Commands such as `commit` and `tag` that lets you edit
545         messages by launching an editor uses the value of this
546         variable when it is set, and the environment variable
547         `GIT_EDITOR` is not set.  See linkgit:git-var[1].
549 core.commentchar::
550         Commands such as `commit` and `tag` that lets you edit
551         messages consider a line that begins with this character
552         commented, and removes them after the editor returns
553         (default '#').
555 sequence.editor::
556         Text editor used by `git rebase -i` for editing the rebase instruction file.
557         The value is meant to be interpreted by the shell when it is used.
558         It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
559         When not configured the default commit message editor is used instead.
561 core.pager::
562         Text viewer for use by Git commands (e.g., 'less').  The value
563         is meant to be interpreted by the shell.  The order of preference
564         is the `$GIT_PAGER` environment variable, then `core.pager`
565         configuration, then `$PAGER`, and then the default chosen at
566         compile time (usually 'less').
568 When the `LESS` environment variable is unset, Git sets it to `FRSX`
569 (if `LESS` environment variable is set, Git does not change it at
570 all).  If you want to selectively override Git's default setting
571 for `LESS`, you can set `core.pager` to e.g. `less -+S`.  This will
572 be passed to the shell by Git, which will translate the final
573 command to `LESS=FRSX less -+S`. The environment tells the command
574 to set the `S` option to chop long lines but the command line
575 resets it to the default to fold long lines.
577 Likewise, when the `LV` environment variable is unset, Git sets it
578 to `-c`.  You can override this setting by exporting `LV` with
579 another value or setting `core.pager` to `lv +c`.
581 core.whitespace::
582         A comma separated list of common whitespace problems to
583         notice.  'git diff' will use `color.diff.whitespace` to
584         highlight them, and 'git apply --whitespace=error' will
585         consider them as errors.  You can prefix `-` to disable
586         any of them (e.g. `-trailing-space`):
588 * `blank-at-eol` treats trailing whitespaces at the end of the line
589   as an error (enabled by default).
590 * `space-before-tab` treats a space character that appears immediately
591   before a tab character in the initial indent part of the line as an
592   error (enabled by default).
593 * `indent-with-non-tab` treats a line that is indented with space
594   characters instead of the equivalent tabs as an error (not enabled by
595   default).
596 * `tab-in-indent` treats a tab character in the initial indent part of
597   the line as an error (not enabled by default).
598 * `blank-at-eof` treats blank lines added at the end of file as an error
599   (enabled by default).
600 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
601   `blank-at-eof`.
602 * `cr-at-eol` treats a carriage-return at the end of line as
603   part of the line terminator, i.e. with it, `trailing-space`
604   does not trigger if the character before such a carriage-return
605   is not a whitespace (not enabled by default).
606 * `tabwidth=<n>` tells how many character positions a tab occupies; this
607   is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
608   errors. The default tab width is 8. Allowed values are 1 to 63.
610 core.fsyncobjectfiles::
611         This boolean will enable 'fsync()' when writing object files.
613 This is a total waste of time and effort on a filesystem that orders
614 data writes properly, but can be useful for filesystems that do not use
615 journalling (traditional UNIX filesystems) or that only journal metadata
616 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
618 core.preloadindex::
619         Enable parallel index preload for operations like 'git diff'
621 This can speed up operations like 'git diff' and 'git status' especially
622 on filesystems like NFS that have weak caching semantics and thus
623 relatively high IO latencies.  With this set to 'true', Git will do the
624 index comparison to the filesystem data in parallel, allowing
625 overlapping IO's.
627 core.createObject::
628         You can set this to 'link', in which case a hardlink followed by
629         a delete of the source are used to make sure that object creation
630         will not overwrite existing objects.
632 On some file system/operating system combinations, this is unreliable.
633 Set this config setting to 'rename' there; However, This will remove the
634 check that makes sure that existing object files will not get overwritten.
636 core.notesRef::
637         When showing commit messages, also show notes which are stored in
638         the given ref.  The ref must be fully qualified.  If the given
639         ref does not exist, it is not an error but means that no
640         notes should be printed.
642 This setting defaults to "refs/notes/commits", and it can be overridden by
643 the 'GIT_NOTES_REF' environment variable.  See linkgit:git-notes[1].
645 core.sparseCheckout::
646         Enable "sparse checkout" feature. See section "Sparse checkout" in
647         linkgit:git-read-tree[1] for more information.
649 core.abbrev::
650         Set the length object names are abbreviated to.  If unspecified,
651         many commands abbreviate to 7 hexdigits, which may not be enough
652         for abbreviated object names to stay unique for sufficiently long
653         time.
655 add.ignore-errors::
656 add.ignoreErrors::
657         Tells 'git add' to continue adding files when some files cannot be
658         added due to indexing errors. Equivalent to the '--ignore-errors'
659         option of linkgit:git-add[1].  Older versions of Git accept only
660         `add.ignore-errors`, which does not follow the usual naming
661         convention for configuration variables.  Newer versions of Git
662         honor `add.ignoreErrors` as well.
664 alias.*::
665         Command aliases for the linkgit:git[1] command wrapper - e.g.
666         after defining "alias.last = cat-file commit HEAD", the invocation
667         "git last" is equivalent to "git cat-file commit HEAD". To avoid
668         confusion and troubles with script usage, aliases that
669         hide existing Git commands are ignored. Arguments are split by
670         spaces, the usual shell quoting and escaping is supported.
671         quote pair and a backslash can be used to quote them.
673 If the alias expansion is prefixed with an exclamation point,
674 it will be treated as a shell command.  For example, defining
675 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
676 "git new" is equivalent to running the shell command
677 "gitk --all --not ORIG_HEAD".  Note that shell commands will be
678 executed from the top-level directory of a repository, which may
679 not necessarily be the current directory.
680 'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
681 from the original current directory. See linkgit:git-rev-parse[1].
683 am.keepcr::
684         If true, git-am will call git-mailsplit for patches in mbox format
685         with parameter '--keep-cr'. In this case git-mailsplit will
686         not remove `\r` from lines ending with `\r\n`. Can be overridden
687         by giving '--no-keep-cr' from the command line.
688         See linkgit:git-am[1], linkgit:git-mailsplit[1].
690 apply.ignorewhitespace::
691         When set to 'change', tells 'git apply' to ignore changes in
692         whitespace, in the same way as the '--ignore-space-change'
693         option.
694         When set to one of: no, none, never, false tells 'git apply' to
695         respect all whitespace differences.
696         See linkgit:git-apply[1].
698 apply.whitespace::
699         Tells 'git apply' how to handle whitespaces, in the same way
700         as the '--whitespace' option. See linkgit:git-apply[1].
702 branch.autosetupmerge::
703         Tells 'git branch' and 'git checkout' to set up new branches
704         so that linkgit:git-pull[1] will appropriately merge from the
705         starting point branch. Note that even if this option is not set,
706         this behavior can be chosen per-branch using the `--track`
707         and `--no-track` options. The valid settings are: `false` -- no
708         automatic setup is done; `true` -- automatic setup is done when the
709         starting point is a remote-tracking branch; `always` --
710         automatic setup is done when the starting point is either a
711         local branch or remote-tracking
712         branch. This option defaults to true.
714 branch.autosetuprebase::
715         When a new branch is created with 'git branch' or 'git checkout'
716         that tracks another branch, this variable tells Git to set
717         up pull to rebase instead of merge (see "branch.<name>.rebase").
718         When `never`, rebase is never automatically set to true.
719         When `local`, rebase is set to true for tracked branches of
720         other local branches.
721         When `remote`, rebase is set to true for tracked branches of
722         remote-tracking branches.
723         When `always`, rebase will be set to true for all tracking
724         branches.
725         See "branch.autosetupmerge" for details on how to set up a
726         branch to track another branch.
727         This option defaults to never.
729 branch.<name>.remote::
730         When on branch <name>, it tells 'git fetch' and 'git push'
731         which remote to fetch from/push to.  The remote to push to
732         may be overridden with `remote.pushdefault` (for all branches).
733         The remote to push to, for the current branch, may be further
734         overridden by `branch.<name>.pushremote`.  If no remote is
735         configured, or if you are not on any branch, it defaults to
736         `origin` for fetching and `remote.pushdefault` for pushing.
737         Additionally, `.` (a period) is the current local repository
738         (a dot-repository), see `branch.<name>.merge`'s final note below.
740 branch.<name>.pushremote::
741         When on branch <name>, it overrides `branch.<name>.remote` for
742         pushing.  It also overrides `remote.pushdefault` for pushing
743         from branch <name>.  When you pull from one place (e.g. your
744         upstream) and push to another place (e.g. your own publishing
745         repository), you would want to set `remote.pushdefault` to
746         specify the remote to push to for all branches, and use this
747         option to override it for a specific branch.
749 branch.<name>.merge::
750         Defines, together with branch.<name>.remote, the upstream branch
751         for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
752         branch to merge and can also affect 'git push' (see push.default).
753         When in branch <name>, it tells 'git fetch' the default
754         refspec to be marked for merging in FETCH_HEAD. The value is
755         handled like the remote part of a refspec, and must match a
756         ref which is fetched from the remote given by
757         "branch.<name>.remote".
758         The merge information is used by 'git pull' (which at first calls
759         'git fetch') to lookup the default branch for merging. Without
760         this option, 'git pull' defaults to merge the first refspec fetched.
761         Specify multiple values to get an octopus merge.
762         If you wish to setup 'git pull' so that it merges into <name> from
763         another branch in the local repository, you can point
764         branch.<name>.merge to the desired branch, and use the relative path
765         setting `.` (a period) for branch.<name>.remote.
767 branch.<name>.mergeoptions::
768         Sets default options for merging into branch <name>. The syntax and
769         supported options are the same as those of linkgit:git-merge[1], but
770         option values containing whitespace characters are currently not
771         supported.
773 branch.<name>.rebase::
774         When true, rebase the branch <name> on top of the fetched branch,
775         instead of merging the default branch from the default remote when
776         "git pull" is run. See "pull.rebase" for doing this in a non
777         branch-specific manner.
779         When preserve, also pass `--preserve-merges` along to 'git rebase'
780         so that locally committed merge commits will not be flattened
781         by running 'git pull'.
783 *NOTE*: this is a possibly dangerous operation; do *not* use
784 it unless you understand the implications (see linkgit:git-rebase[1]
785 for details).
787 branch.<name>.description::
788         Branch description, can be edited with
789         `git branch --edit-description`. Branch description is
790         automatically added in the format-patch cover letter or
791         request-pull summary.
793 browser.<tool>.cmd::
794         Specify the command to invoke the specified browser. The
795         specified command is evaluated in shell with the URLs passed
796         as arguments. (See linkgit:git-web{litdd}browse[1].)
798 browser.<tool>.path::
799         Override the path for the given tool that may be used to
800         browse HTML help (see '-w' option in linkgit:git-help[1]) or a
801         working repository in gitweb (see linkgit:git-instaweb[1]).
803 clean.requireForce::
804         A boolean to make git-clean do nothing unless given -f,
805         -i or -n.   Defaults to true.
807 color.branch::
808         A boolean to enable/disable color in the output of
809         linkgit:git-branch[1]. May be set to `always`,
810         `false` (or `never`) or `auto` (or `true`), in which case colors are used
811         only when the output is to a terminal. Defaults to false.
813 color.branch.<slot>::
814         Use customized color for branch coloration. `<slot>` is one of
815         `current` (the current branch), `local` (a local branch),
816         `remote` (a remote-tracking branch in refs/remotes/),
817         `upstream` (upstream tracking branch), `plain` (other
818         refs).
820 The value for these configuration variables is a list of colors (at most
821 two) and attributes (at most one), separated by spaces.  The colors
822 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
823 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
824 `blink` and `reverse`.  The first color given is the foreground; the
825 second is the background.  The position of the attribute, if any,
826 doesn't matter.
828 color.diff::
829         Whether to use ANSI escape sequences to add color to patches.
830         If this is set to `always`, linkgit:git-diff[1],
831         linkgit:git-log[1], and linkgit:git-show[1] will use color
832         for all patches.  If it is set to `true` or `auto`, those
833         commands will only use color when output is to the terminal.
834         Defaults to false.
836 This does not affect linkgit:git-format-patch[1] or the
837 'git-diff-{asterisk}' plumbing commands.  Can be overridden on the
838 command line with the `--color[=<when>]` option.
840 color.diff.<slot>::
841         Use customized color for diff colorization.  `<slot>` specifies
842         which part of the patch to use the specified color, and is one
843         of `plain` (context text), `meta` (metainformation), `frag`
844         (hunk header), 'func' (function in hunk header), `old` (removed lines),
845         `new` (added lines), `commit` (commit headers), or `whitespace`
846         (highlighting whitespace errors). The values of these variables may be
847         specified as in color.branch.<slot>.
849 color.decorate.<slot>::
850         Use customized color for 'git log --decorate' output.  `<slot>` is one
851         of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
852         branches, remote-tracking branches, tags, stash and HEAD, respectively.
854 color.grep::
855         When set to `always`, always highlight matches.  When `false` (or
856         `never`), never.  When set to `true` or `auto`, use color only
857         when the output is written to the terminal.  Defaults to `false`.
859 color.grep.<slot>::
860         Use customized color for grep colorization.  `<slot>` specifies which
861         part of the line to use the specified color, and is one of
864 `context`;;
865         non-matching text in context lines (when using `-A`, `-B`, or `-C`)
866 `filename`;;
867         filename prefix (when not using `-h`)
868 `function`;;
869         function name lines (when using `-p`)
870 `linenumber`;;
871         line number prefix (when using `-n`)
872 `match`;;
873         matching text
874 `selected`;;
875         non-matching text in selected lines
876 `separator`;;
877         separators between fields on a line (`:`, `-`, and `=`)
878         and between hunks (`--`)
881 The values of these variables may be specified as in color.branch.<slot>.
883 color.interactive::
884         When set to `always`, always use colors for interactive prompts
885         and displays (such as those used by "git-add --interactive" and
886         "git-clean --interactive"). When false (or `never`), never.
887         When set to `true` or `auto`, use colors only when the output is
888         to the terminal. Defaults to false.
890 color.interactive.<slot>::
891         Use customized color for 'git add --interactive' and 'git clean
892         --interactive' output. `<slot>` may be `prompt`, `header`, `help`
893         or `error`, for four distinct types of normal output from
894         interactive commands.  The values of these variables may be
895         specified as in color.branch.<slot>.
897 color.pager::
898         A boolean to enable/disable colored output when the pager is in
899         use (default is true).
901 color.showbranch::
902         A boolean to enable/disable color in the output of
903         linkgit:git-show-branch[1]. May be set to `always`,
904         `false` (or `never`) or `auto` (or `true`), in which case colors are used
905         only when the output is to a terminal. Defaults to false.
907 color.status::
908         A boolean to enable/disable color in the output of
909         linkgit:git-status[1]. May be set to `always`,
910         `false` (or `never`) or `auto` (or `true`), in which case colors are used
911         only when the output is to a terminal. Defaults to false.
913 color.status.<slot>::
914         Use customized color for status colorization. `<slot>` is
915         one of `header` (the header text of the status message),
916         `added` or `updated` (files which are added but not committed),
917         `changed` (files which are changed but not added in the index),
918         `untracked` (files which are not tracked by Git),
919         `branch` (the current branch), or
920         `nobranch` (the color the 'no branch' warning is shown in, defaulting
921         to red). The values of these variables may be specified as in
922         color.branch.<slot>.
924 color.ui::
925         This variable determines the default value for variables such
926         as `color.diff` and `color.grep` that control the use of color
927         per command family. Its scope will expand as more commands learn
928         configuration to set a default for the `--color` option.  Set it
929         to `false` or `never` if you prefer Git commands not to use
930         color unless enabled explicitly with some other configuration
931         or the `--color` option. Set it to `always` if you want all
932         output not intended for machine consumption to use color, to
933         `true` or `auto` (this is the default since Git 1.8.4) if you
934         want such output to use color when written to the terminal.
936 column.ui::
937         Specify whether supported commands should output in columns.
938         This variable consists of a list of tokens separated by spaces
939         or commas:
941 These options control when the feature should be enabled
942 (defaults to 'never'):
945 `always`;;
946         always show in columns
947 `never`;;
948         never show in columns
949 `auto`;;
950         show in columns if the output is to the terminal
953 These options control layout (defaults to 'column').  Setting any
954 of these implies 'always' if none of 'always', 'never', or 'auto' are
955 specified.
958 `column`;;
959         fill columns before rows
960 `row`;;
961         fill rows before columns
962 `plain`;;
963         show in one column
966 Finally, these options can be combined with a layout option (defaults
967 to 'nodense'):
970 `dense`;;
971         make unequal size columns to utilize more space
972 `nodense`;;
973         make equal size columns
976 column.branch::
977         Specify whether to output branch listing in `git branch` in columns.
978         See `column.ui` for details.
980 column.clean::
981         Specify the layout when list items in `git clean -i`, which always
982         shows files and directories in columns. See `column.ui` for details.
984 column.status::
985         Specify whether to output untracked files in `git status` in columns.
986         See `column.ui` for details.
988 column.tag::
989         Specify whether to output tag listing in `git tag` in columns.
990         See `column.ui` for details.
992 commit.cleanup::
993         This setting overrides the default of the `--cleanup` option in
994         `git commit`. See linkgit:git-commit[1] for details. Changing the
995         default can be useful when you always want to keep lines that begin
996         with comment character `#` in your log message, in which case you
997         would do `git config commit.cleanup whitespace` (note that you will
998         have to remove the help lines that begin with `#` in the commit log
999         template yourself, if you do this).
1001 commit.status::
1002         A boolean to enable/disable inclusion of status information in the
1003         commit message template when using an editor to prepare the commit
1004         message.  Defaults to true.
1006 commit.template::
1007         Specify a file to use as the template for new commit messages.
1008         "`~/`" is expanded to the value of `$HOME` and "`~user/`" to the
1009         specified user's home directory.
1011 credential.helper::
1012         Specify an external helper to be called when a username or
1013         password credential is needed; the helper may consult external
1014         storage to avoid prompting the user for the credentials. See
1015         linkgit:gitcredentials[7] for details.
1017 credential.useHttpPath::
1018         When acquiring credentials, consider the "path" component of an http
1019         or https URL to be important. Defaults to false. See
1020         linkgit:gitcredentials[7] for more information.
1022 credential.username::
1023         If no username is set for a network authentication, use this username
1024         by default. See credential.<context>.* below, and
1025         linkgit:gitcredentials[7].
1027 credential.<url>.*::
1028         Any of the credential.* options above can be applied selectively to
1029         some credentials. For example "credential.https://example.com.username"
1030         would set the default username only for https connections to
1031         example.com. See linkgit:gitcredentials[7] for details on how URLs are
1032         matched.
1034 include::diff-config.txt[]
1036 difftool.<tool>.path::
1037         Override the path for the given tool.  This is useful in case
1038         your tool is not in the PATH.
1040 difftool.<tool>.cmd::
1041         Specify the command to invoke the specified diff tool.
1042         The specified command is evaluated in shell with the following
1043         variables available:  'LOCAL' is set to the name of the temporary
1044         file containing the contents of the diff pre-image and 'REMOTE'
1045         is set to the name of the temporary file containing the contents
1046         of the diff post-image.
1048 difftool.prompt::
1049         Prompt before each invocation of the diff tool.
1051 fetch.recurseSubmodules::
1052         This option can be either set to a boolean value or to 'on-demand'.
1053         Setting it to a boolean changes the behavior of fetch and pull to
1054         unconditionally recurse into submodules when set to true or to not
1055         recurse at all when set to false. When set to 'on-demand' (the default
1056         value), fetch and pull will only recurse into a populated submodule
1057         when its superproject retrieves a commit that updates the submodule's
1058         reference.
1060 fetch.fsckObjects::
1061         If it is set to true, git-fetch-pack will check all fetched
1062         objects. It will abort in the case of a malformed object or a
1063         broken link. The result of an abort are only dangling objects.
1064         Defaults to false. If not set, the value of `transfer.fsckObjects`
1065         is used instead.
1067 fetch.unpackLimit::
1068         If the number of objects fetched over the Git native
1069         transfer is below this
1070         limit, then the objects will be unpacked into loose object
1071         files. However if the number of received objects equals or
1072         exceeds this limit then the received pack will be stored as
1073         a pack, after adding any missing delta bases.  Storing the
1074         pack from a push can make the push operation complete faster,
1075         especially on slow filesystems.  If not set, the value of
1076         `transfer.unpackLimit` is used instead.
1078 fetch.prune::
1079         If true, fetch will automatically behave as if the `--prune`
1080         option was given on the command line.  See also `remote.<name>.prune`.
1082 format.attach::
1083         Enable multipart/mixed attachments as the default for
1084         'format-patch'.  The value can also be a double quoted string
1085         which will enable attachments as the default and set the
1086         value as the boundary.  See the --attach option in
1087         linkgit:git-format-patch[1].
1089 format.numbered::
1090         A boolean which can enable or disable sequence numbers in patch
1091         subjects.  It defaults to "auto" which enables it only if there
1092         is more than one patch.  It can be enabled or disabled for all
1093         messages by setting it to "true" or "false".  See --numbered
1094         option in linkgit:git-format-patch[1].
1096 format.headers::
1097         Additional email headers to include in a patch to be submitted
1098         by mail.  See linkgit:git-format-patch[1].
1100 format.to::
1101 format.cc::
1102         Additional recipients to include in a patch to be submitted
1103         by mail.  See the --to and --cc options in
1104         linkgit:git-format-patch[1].
1106 format.subjectprefix::
1107         The default for format-patch is to output files with the '[PATCH]'
1108         subject prefix. Use this variable to change that prefix.
1110 format.signature::
1111         The default for format-patch is to output a signature containing
1112         the Git version number. Use this variable to change that default.
1113         Set this variable to the empty string ("") to suppress
1114         signature generation.
1116 format.suffix::
1117         The default for format-patch is to output files with the suffix
1118         `.patch`. Use this variable to change that suffix (make sure to
1119         include the dot if you want it).
1121 format.pretty::
1122         The default pretty format for log/show/whatchanged command,
1123         See linkgit:git-log[1], linkgit:git-show[1],
1124         linkgit:git-whatchanged[1].
1126 format.thread::
1127         The default threading style for 'git format-patch'.  Can be
1128         a boolean value, or `shallow` or `deep`.  `shallow` threading
1129         makes every mail a reply to the head of the series,
1130         where the head is chosen from the cover letter, the
1131         `--in-reply-to`, and the first patch mail, in this order.
1132         `deep` threading makes every mail a reply to the previous one.
1133         A true boolean value is the same as `shallow`, and a false
1134         value disables threading.
1136 format.signoff::
1137         A boolean value which lets you enable the `-s/--signoff` option of
1138         format-patch by default. *Note:* Adding the Signed-off-by: line to a
1139         patch should be a conscious act and means that you certify you have
1140         the rights to submit this work under the same open source license.
1141         Please see the 'SubmittingPatches' document for further discussion.
1143 format.coverLetter::
1144         A boolean that controls whether to generate a cover-letter when
1145         format-patch is invoked, but in addition can be set to "auto", to
1146         generate a cover-letter only when there's more than one patch.
1148 filter.<driver>.clean::
1149         The command which is used to convert the content of a worktree
1150         file to a blob upon checkin.  See linkgit:gitattributes[5] for
1151         details.
1153 filter.<driver>.smudge::
1154         The command which is used to convert the content of a blob
1155         object to a worktree file upon checkout.  See
1156         linkgit:gitattributes[5] for details.
1158 gc.aggressiveWindow::
1159         The window size parameter used in the delta compression
1160         algorithm used by 'git gc --aggressive'.  This defaults
1161         to 250.
1163 gc.auto::
1164         When there are approximately more than this many loose
1165         objects in the repository, `git gc --auto` will pack them.
1166         Some Porcelain commands use this command to perform a
1167         light-weight garbage collection from time to time.  The
1168         default value is 6700.  Setting this to 0 disables it.
1170 gc.autopacklimit::
1171         When there are more than this many packs that are not
1172         marked with `*.keep` file in the repository, `git gc
1173         --auto` consolidates them into one larger pack.  The
1174         default value is 50.  Setting this to 0 disables it.
1176 gc.packrefs::
1177         Running `git pack-refs` in a repository renders it
1178         unclonable by Git versions prior to 1.5.1.2 over dumb
1179         transports such as HTTP.  This variable determines whether
1180         'git gc' runs `git pack-refs`. This can be set to `notbare`
1181         to enable it within all non-bare repos or it can be set to a
1182         boolean value.  The default is `true`.
1184 gc.pruneexpire::
1185         When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1186         Override the grace period with this config variable.  The value
1187         "now" may be used to disable this  grace period and always prune
1188         unreachable objects immediately.
1190 gc.reflogexpire::
1191 gc.<pattern>.reflogexpire::
1192         'git reflog expire' removes reflog entries older than
1193         this time; defaults to 90 days.  With "<pattern>" (e.g.
1194         "refs/stash") in the middle the setting applies only to
1195         the refs that match the <pattern>.
1197 gc.reflogexpireunreachable::
1198 gc.<ref>.reflogexpireunreachable::
1199         'git reflog expire' removes reflog entries older than
1200         this time and are not reachable from the current tip;
1201         defaults to 30 days.  With "<pattern>" (e.g. "refs/stash")
1202         in the middle, the setting applies only to the refs that
1203         match the <pattern>.
1205 gc.rerereresolved::
1206         Records of conflicted merge you resolved earlier are
1207         kept for this many days when 'git rerere gc' is run.
1208         The default is 60 days.  See linkgit:git-rerere[1].
1210 gc.rerereunresolved::
1211         Records of conflicted merge you have not resolved are
1212         kept for this many days when 'git rerere gc' is run.
1213         The default is 15 days.  See linkgit:git-rerere[1].
1215 gitcvs.commitmsgannotation::
1216         Append this string to each commit message. Set to empty string
1217         to disable this feature. Defaults to "via git-CVS emulator".
1219 gitcvs.enabled::
1220         Whether the CVS server interface is enabled for this repository.
1221         See linkgit:git-cvsserver[1].
1223 gitcvs.logfile::
1224         Path to a log file where the CVS server interface well... logs
1225         various stuff. See linkgit:git-cvsserver[1].
1227 gitcvs.usecrlfattr::
1228         If true, the server will look up the end-of-line conversion
1229         attributes for files to determine the '-k' modes to use. If
1230         the attributes force Git to treat a file as text,
1231         the '-k' mode will be left blank so CVS clients will
1232         treat it as text. If they suppress text conversion, the file
1233         will be set with '-kb' mode, which suppresses any newline munging
1234         the client might otherwise do. If the attributes do not allow
1235         the file type to be determined, then 'gitcvs.allbinary' is
1236         used. See linkgit:gitattributes[5].
1238 gitcvs.allbinary::
1239         This is used if 'gitcvs.usecrlfattr' does not resolve
1240         the correct '-kb' mode to use. If true, all
1241         unresolved files are sent to the client in
1242         mode '-kb'. This causes the client to treat them
1243         as binary files, which suppresses any newline munging it
1244         otherwise might do. Alternatively, if it is set to "guess",
1245         then the contents of the file are examined to decide if
1246         it is binary, similar to 'core.autocrlf'.
1248 gitcvs.dbname::
1249         Database used by git-cvsserver to cache revision information
1250         derived from the Git repository. The exact meaning depends on the
1251         used database driver, for SQLite (which is the default driver) this
1252         is a filename. Supports variable substitution (see
1253         linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1254         Default: '%Ggitcvs.%m.sqlite'
1256 gitcvs.dbdriver::
1257         Used Perl DBI driver. You can specify any available driver
1258         for this here, but it might not work. git-cvsserver is tested
1259         with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1260         reported *not* to work with 'DBD::mysql'. Experimental feature.
1261         May not contain double colons (`:`). Default: 'SQLite'.
1262         See linkgit:git-cvsserver[1].
1264 gitcvs.dbuser, gitcvs.dbpass::
1265         Database user and password. Only useful if setting 'gitcvs.dbdriver',
1266         since SQLite has no concept of database users and/or passwords.
1267         'gitcvs.dbuser' supports variable substitution (see
1268         linkgit:git-cvsserver[1] for details).
1270 gitcvs.dbTableNamePrefix::
1271         Database table name prefix.  Prepended to the names of any
1272         database tables used, allowing a single database to be used
1273         for several repositories.  Supports variable substitution (see
1274         linkgit:git-cvsserver[1] for details).  Any non-alphabetic
1275         characters will be replaced with underscores.
1277 All gitcvs variables except for 'gitcvs.usecrlfattr' and
1278 'gitcvs.allbinary' can also be specified as
1279 'gitcvs.<access_method>.<varname>' (where 'access_method'
1280 is one of "ext" and "pserver") to make them apply only for the given
1281 access method.
1283 gitweb.category::
1284 gitweb.description::
1285 gitweb.owner::
1286 gitweb.url::
1287         See linkgit:gitweb[1] for description.
1289 gitweb.avatar::
1290 gitweb.blame::
1291 gitweb.grep::
1292 gitweb.highlight::
1293 gitweb.patches::
1294 gitweb.pickaxe::
1295 gitweb.remote_heads::
1296 gitweb.showsizes::
1297 gitweb.snapshot::
1298         See linkgit:gitweb.conf[5] for description.
1300 grep.lineNumber::
1301         If set to true, enable '-n' option by default.
1303 grep.patternType::
1304         Set the default matching behavior. Using a value of 'basic', 'extended',
1305         'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',
1306         '--fixed-strings', or '--perl-regexp' option accordingly, while the
1307         value 'default' will return to the default matching behavior.
1309 grep.extendedRegexp::
1310         If set to true, enable '--extended-regexp' option by default. This
1311         option is ignored when the 'grep.patternType' option is set to a value
1312         other than 'default'.
1314 gpg.program::
1315         Use this custom program instead of "gpg" found on $PATH when
1316         making or verifying a PGP signature. The program must support the
1317         same command line interface as GPG, namely, to verify a detached
1318         signature, "gpg --verify $file - <$signature" is run, and the
1319         program is expected to signal a good signature by exiting with
1320         code 0, and to generate an ascii-armored detached signature, the
1321         standard input of "gpg -bsau $key" is fed with the contents to be
1322         signed, and the program is expected to send the result to its
1323         standard output.
1325 gui.commitmsgwidth::
1326         Defines how wide the commit message window is in the
1327         linkgit:git-gui[1]. "75" is the default.
1329 gui.diffcontext::
1330         Specifies how many context lines should be used in calls to diff
1331         made by the linkgit:git-gui[1]. The default is "5".
1333 gui.encoding::
1334         Specifies the default encoding to use for displaying of
1335         file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1336         It can be overridden by setting the 'encoding' attribute
1337         for relevant files (see linkgit:gitattributes[5]).
1338         If this option is not set, the tools default to the
1339         locale encoding.
1341 gui.matchtrackingbranch::
1342         Determines if new branches created with linkgit:git-gui[1] should
1343         default to tracking remote branches with matching names or
1344         not. Default: "false".
1346 gui.newbranchtemplate::
1347         Is used as suggested name when creating new branches using the
1348         linkgit:git-gui[1].
1350 gui.pruneduringfetch::
1351         "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1352         performing a fetch. The default value is "false".
1354 gui.trustmtime::
1355         Determines if linkgit:git-gui[1] should trust the file modification
1356         timestamp or not. By default the timestamps are not trusted.
1358 gui.spellingdictionary::
1359         Specifies the dictionary used for spell checking commit messages in
1360         the linkgit:git-gui[1]. When set to "none" spell checking is turned
1361         off.
1363 gui.fastcopyblame::
1364         If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1365         location detection. It makes blame significantly faster on huge
1366         repositories at the expense of less thorough copy detection.
1368 gui.copyblamethreshold::
1369         Specifies the threshold to use in 'git gui blame' original location
1370         detection, measured in alphanumeric characters. See the
1371         linkgit:git-blame[1] manual for more information on copy detection.
1373 gui.blamehistoryctx::
1374         Specifies the radius of history context in days to show in
1375         linkgit:gitk[1] for the selected commit, when the `Show History
1376         Context` menu item is invoked from 'git gui blame'. If this
1377         variable is set to zero, the whole history is shown.
1379 guitool.<name>.cmd::
1380         Specifies the shell command line to execute when the corresponding item
1381         of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1382         mandatory for every tool. The command is executed from the root of
1383         the working directory, and in the environment it receives the name of
1384         the tool as 'GIT_GUITOOL', the name of the currently selected file as
1385         'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1386         the head is detached, 'CUR_BRANCH' is empty).
1388 guitool.<name>.needsfile::
1389         Run the tool only if a diff is selected in the GUI. It guarantees
1390         that 'FILENAME' is not empty.
1392 guitool.<name>.noconsole::
1393         Run the command silently, without creating a window to display its
1394         output.
1396 guitool.<name>.norescan::
1397         Don't rescan the working directory for changes after the tool
1398         finishes execution.
1400 guitool.<name>.confirm::
1401         Show a confirmation dialog before actually running the tool.
1403 guitool.<name>.argprompt::
1404         Request a string argument from the user, and pass it to the tool
1405         through the 'ARGS' environment variable. Since requesting an
1406         argument implies confirmation, the 'confirm' option has no effect
1407         if this is enabled. If the option is set to 'true', 'yes', or '1',
1408         the dialog uses a built-in generic prompt; otherwise the exact
1409         value of the variable is used.
1411 guitool.<name>.revprompt::
1412         Request a single valid revision from the user, and set the
1413         'REVISION' environment variable. In other aspects this option
1414         is similar to 'argprompt', and can be used together with it.
1416 guitool.<name>.revunmerged::
1417         Show only unmerged branches in the 'revprompt' subdialog.
1418         This is useful for tools similar to merge or rebase, but not
1419         for things like checkout or reset.
1421 guitool.<name>.title::
1422         Specifies the title to use for the prompt dialog. The default
1423         is the tool name.
1425 guitool.<name>.prompt::
1426         Specifies the general prompt string to display at the top of
1427         the dialog, before subsections for 'argprompt' and 'revprompt'.
1428         The default value includes the actual command.
1430 help.browser::
1431         Specify the browser that will be used to display help in the
1432         'web' format. See linkgit:git-help[1].
1434 help.format::
1435         Override the default help format used by linkgit:git-help[1].
1436         Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1437         the default. 'web' and 'html' are the same.
1439 help.autocorrect::
1440         Automatically correct and execute mistyped commands after
1441         waiting for the given number of deciseconds (0.1 sec). If more
1442         than one command can be deduced from the entered text, nothing
1443         will be executed.  If the value of this option is negative,
1444         the corrected command will be executed immediately. If the
1445         value is 0 - the command will be just shown but not executed.
1446         This is the default.
1448 help.htmlpath::
1449         Specify the path where the HTML documentation resides. File system paths
1450         and URLs are supported. HTML pages will be prefixed with this path when
1451         help is displayed in the 'web' format. This defaults to the documentation
1452         path of your Git installation.
1454 http.proxy::
1455         Override the HTTP proxy, normally configured using the 'http_proxy',
1456         'https_proxy', and 'all_proxy' environment variables (see
1457         `curl(1)`).  This can be overridden on a per-remote basis; see
1458         remote.<name>.proxy
1460 http.cookiefile::
1461         File containing previously stored cookie lines which should be used
1462         in the Git http session, if they match the server. The file format
1463         of the file to read cookies from should be plain HTTP headers or
1464         the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
1465         NOTE that the file specified with http.cookiefile is only used as
1466         input unless http.saveCookies is set.
1468 http.savecookies::
1469         If set, store cookies received during requests to the file specified by
1470         http.cookiefile. Has no effect if http.cookiefile is unset.
1472 http.sslVerify::
1473         Whether to verify the SSL certificate when fetching or pushing
1474         over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1475         variable.
1477 http.sslCert::
1478         File containing the SSL certificate when fetching or pushing
1479         over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1480         variable.
1482 http.sslKey::
1483         File containing the SSL private key when fetching or pushing
1484         over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1485         variable.
1487 http.sslCertPasswordProtected::
1488         Enable Git's password prompt for the SSL certificate.  Otherwise
1489         OpenSSL will prompt the user, possibly many times, if the
1490         certificate or private key is encrypted.  Can be overridden by the
1491         'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1493 http.sslCAInfo::
1494         File containing the certificates to verify the peer with when
1495         fetching or pushing over HTTPS. Can be overridden by the
1496         'GIT_SSL_CAINFO' environment variable.
1498 http.sslCAPath::
1499         Path containing files with the CA certificates to verify the peer
1500         with when fetching or pushing over HTTPS. Can be overridden
1501         by the 'GIT_SSL_CAPATH' environment variable.
1503 http.sslTry::
1504         Attempt to use AUTH SSL/TLS and encrypted data transfers
1505         when connecting via regular FTP protocol. This might be needed
1506         if the FTP server requires it for security reasons or you wish
1507         to connect securely whenever remote FTP server supports it.
1508         Default is false since it might trigger certificate verification
1509         errors on misconfigured servers.
1511 http.maxRequests::
1512         How many HTTP requests to launch in parallel. Can be overridden
1513         by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1515 http.minSessions::
1516         The number of curl sessions (counted across slots) to be kept across
1517         requests. They will not be ended with curl_easy_cleanup() until
1518         http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1519         value will be capped at 1. Defaults to 1.
1521 http.postBuffer::
1522         Maximum size in bytes of the buffer used by smart HTTP
1523         transports when POSTing data to the remote system.
1524         For requests larger than this buffer size, HTTP/1.1 and
1525         Transfer-Encoding: chunked is used to avoid creating a
1526         massive pack file locally.  Default is 1 MiB, which is
1527         sufficient for most requests.
1529 http.lowSpeedLimit, http.lowSpeedTime::
1530         If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1531         for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1532         Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1533         'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1535 http.noEPSV::
1536         A boolean which disables using of EPSV ftp command by curl.
1537         This can helpful with some "poor" ftp servers which don't
1538         support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1539         environment variable. Default is false (curl will use EPSV).
1541 http.useragent::
1542         The HTTP USER_AGENT string presented to an HTTP server.  The default
1543         value represents the version of the client Git such as git/1.7.1.
1544         This option allows you to override this value to a more common value
1545         such as Mozilla/4.0.  This may be necessary, for instance, if
1546         connecting through a firewall that restricts HTTP connections to a set
1547         of common USER_AGENT strings (but not including those like git/1.7.1).
1548         Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1550 http.<url>.*::
1551         Any of the http.* options above can be applied selectively to some urls.
1552         For a config key to match a URL, each element of the config key is
1553         compared to that of the URL, in the following order:
1556 . Scheme (e.g., `https` in `https://example.com/`). This field
1557   must match exactly between the config key and the URL.
1559 . Host/domain name (e.g., `example.com` in `https://example.com/`).
1560   This field must match exactly between the config key and the URL.
1562 . Port number (e.g., `8080` in `http://example.com:8080/`).
1563   This field must match exactly between the config key and the URL.
1564   Omitted port numbers are automatically converted to the correct
1565   default for the scheme before matching.
1567 . Path (e.g., `repo.git` in `https://example.com/repo.git`). The
1568   path field of the config key must match the path field of the URL
1569   either exactly or as a prefix of slash-delimited path elements.  This means
1570   a config key with path `foo/` matches URL path `foo/bar`.  A prefix can only
1571   match on a slash (`/`) boundary.  Longer matches take precedence (so a config
1572   key with path `foo/bar` is a better match to URL path `foo/bar` than a config
1573   key with just path `foo/`).
1575 . User name (e.g., `user` in `https://user@example.com/repo.git`). If
1576   the config key has a user name it must match the user name in the
1577   URL exactly. If the config key does not have a user name, that
1578   config key will match a URL with any user name (including none),
1579   but at a lower precedence than a config key with a user name.
1582 The list above is ordered by decreasing precedence; a URL that matches
1583 a config key's path is preferred to one that matches its user name. For example,
1584 if the URL is `https://user@example.com/foo/bar` a config key match of
1585 `https://example.com/foo` will be preferred over a config key match of
1586 `https://user@example.com`.
1588 All URLs are normalized before attempting any matching (the password part,
1589 if embedded in the URL, is always ignored for matching purposes) so that
1590 equivalent urls that are simply spelled differently will match properly.
1591 Environment variable settings always override any matches.  The urls that are
1592 matched against are those given directly to Git commands.  This means any URLs
1593 visited as a result of a redirection do not participate in matching.
1595 i18n.commitEncoding::
1596         Character encoding the commit messages are stored in; Git itself
1597         does not care per se, but this information is necessary e.g. when
1598         importing commits from emails or in the gitk graphical history
1599         browser (and possibly at other places in the future or in other
1600         porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1602 i18n.logOutputEncoding::
1603         Character encoding the commit messages are converted to when
1604         running 'git log' and friends.
1606 imap::
1607         The configuration variables in the 'imap' section are described
1608         in linkgit:git-imap-send[1].
1610 init.templatedir::
1611         Specify the directory from which templates will be copied.
1612         (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1614 instaweb.browser::
1615         Specify the program that will be used to browse your working
1616         repository in gitweb. See linkgit:git-instaweb[1].
1618 instaweb.httpd::
1619         The HTTP daemon command-line to start gitweb on your working
1620         repository. See linkgit:git-instaweb[1].
1622 instaweb.local::
1623         If true the web server started by linkgit:git-instaweb[1] will
1624         be bound to the local IP (127.0.0.1).
1626 instaweb.modulepath::
1627         The default module path for linkgit:git-instaweb[1] to use
1628         instead of /usr/lib/apache2/modules.  Only used if httpd
1629         is Apache.
1631 instaweb.port::
1632         The port number to bind the gitweb httpd to. See
1633         linkgit:git-instaweb[1].
1635 interactive.singlekey::
1636         In interactive commands, allow the user to provide one-letter
1637         input with a single key (i.e., without hitting enter).
1638         Currently this is used by the `--patch` mode of
1639         linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1640         linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1641         setting is silently ignored if portable keystroke input
1642         is not available.
1644 log.abbrevCommit::
1645         If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1646         linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
1647         override this option with `--no-abbrev-commit`.
1649 log.date::
1650         Set the default date-time mode for the 'log' command.
1651         Setting a value for log.date is similar to using 'git log''s
1652         `--date` option.  Possible values are `relative`, `local`,
1653         `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1654         for details.
1656 log.decorate::
1657         Print out the ref names of any commits that are shown by the log
1658         command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1659         'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1660         specified, the full ref name (including prefix) will be printed.
1661         This is the same as the log commands '--decorate' option.
1663 log.showroot::
1664         If true, the initial commit will be shown as a big creation event.
1665         This is equivalent to a diff against an empty tree.
1666         Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1667         normally hide the root commit will now show it. True by default.
1669 log.mailmap::
1670         If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1671         linkgit:git-whatchanged[1] assume `--use-mailmap`.
1673 mailmap.file::
1674         The location of an augmenting mailmap file. The default
1675         mailmap, located in the root of the repository, is loaded
1676         first, then the mailmap file pointed to by this variable.
1677         The location of the mailmap file may be in a repository
1678         subdirectory, or somewhere outside of the repository itself.
1679         See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1681 mailmap.blob::
1682         Like `mailmap.file`, but consider the value as a reference to a
1683         blob in the repository. If both `mailmap.file` and
1684         `mailmap.blob` are given, both are parsed, with entries from
1685         `mailmap.file` taking precedence. In a bare repository, this
1686         defaults to `HEAD:.mailmap`. In a non-bare repository, it
1687         defaults to empty.
1689 man.viewer::
1690         Specify the programs that may be used to display help in the
1691         'man' format. See linkgit:git-help[1].
1693 man.<tool>.cmd::
1694         Specify the command to invoke the specified man viewer. The
1695         specified command is evaluated in shell with the man page
1696         passed as argument. (See linkgit:git-help[1].)
1698 man.<tool>.path::
1699         Override the path for the given tool that may be used to
1700         display help in the 'man' format. See linkgit:git-help[1].
1702 include::merge-config.txt[]
1704 mergetool.<tool>.path::
1705         Override the path for the given tool.  This is useful in case
1706         your tool is not in the PATH.
1708 mergetool.<tool>.cmd::
1709         Specify the command to invoke the specified merge tool.  The
1710         specified command is evaluated in shell with the following
1711         variables available: 'BASE' is the name of a temporary file
1712         containing the common base of the files to be merged, if available;
1713         'LOCAL' is the name of a temporary file containing the contents of
1714         the file on the current branch; 'REMOTE' is the name of a temporary
1715         file containing the contents of the file from the branch being
1716         merged; 'MERGED' contains the name of the file to which the merge
1717         tool should write the results of a successful merge.
1719 mergetool.<tool>.trustExitCode::
1720         For a custom merge command, specify whether the exit code of
1721         the merge command can be used to determine whether the merge was
1722         successful.  If this is not set to true then the merge target file
1723         timestamp is checked and the merge assumed to have been successful
1724         if the file has been updated, otherwise the user is prompted to
1725         indicate the success of the merge.
1727 mergetool.keepBackup::
1728         After performing a merge, the original file with conflict markers
1729         can be saved as a file with a `.orig` extension.  If this variable
1730         is set to `false` then this file is not preserved.  Defaults to
1731         `true` (i.e. keep the backup files).
1733 mergetool.keepTemporaries::
1734         When invoking a custom merge tool, Git uses a set of temporary
1735         files to pass to the tool. If the tool returns an error and this
1736         variable is set to `true`, then these temporary files will be
1737         preserved, otherwise they will be removed after the tool has
1738         exited. Defaults to `false`.
1740 mergetool.prompt::
1741         Prompt before each invocation of the merge resolution program.
1743 notes.displayRef::
1744         The (fully qualified) refname from which to show notes when
1745         showing commit messages.  The value of this variable can be set
1746         to a glob, in which case notes from all matching refs will be
1747         shown.  You may also specify this configuration variable
1748         several times.  A warning will be issued for refs that do not
1749         exist, but a glob that does not match any refs is silently
1750         ignored.
1752 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1753 environment variable, which must be a colon separated list of refs or
1754 globs.
1756 The effective value of "core.notesRef" (possibly overridden by
1757 GIT_NOTES_REF) is also implicitly added to the list of refs to be
1758 displayed.
1760 notes.rewrite.<command>::
1761         When rewriting commits with <command> (currently `amend` or
1762         `rebase`) and this variable is set to `true`, Git
1763         automatically copies your notes from the original to the
1764         rewritten commit.  Defaults to `true`, but see
1765         "notes.rewriteRef" below.
1767 notes.rewriteMode::
1768         When copying notes during a rewrite (see the
1769         "notes.rewrite.<command>" option), determines what to do if
1770         the target commit already has a note.  Must be one of
1771         `overwrite`, `concatenate`, or `ignore`.  Defaults to
1772         `concatenate`.
1774 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1775 environment variable.
1777 notes.rewriteRef::
1778         When copying notes during a rewrite, specifies the (fully
1779         qualified) ref whose notes should be copied.  The ref may be a
1780         glob, in which case notes in all matching refs will be copied.
1781         You may also specify this configuration several times.
1783 Does not have a default value; you must configure this variable to
1784 enable note rewriting.  Set it to `refs/notes/commits` to enable
1785 rewriting for the default commit notes.
1787 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1788 environment variable, which must be a colon separated list of refs or
1789 globs.
1791 pack.window::
1792         The size of the window used by linkgit:git-pack-objects[1] when no
1793         window size is given on the command line. Defaults to 10.
1795 pack.depth::
1796         The maximum delta depth used by linkgit:git-pack-objects[1] when no
1797         maximum depth is given on the command line. Defaults to 50.
1799 pack.windowMemory::
1800         The window memory size limit used by linkgit:git-pack-objects[1]
1801         when no limit is given on the command line.  The value can be
1802         suffixed with "k", "m", or "g".  Defaults to 0, meaning no
1803         limit.
1805 pack.compression::
1806         An integer -1..9, indicating the compression level for objects
1807         in a pack file. -1 is the zlib default. 0 means no
1808         compression, and 1..9 are various speed/size tradeoffs, 9 being
1809         slowest.  If not set,  defaults to core.compression.  If that is
1810         not set,  defaults to -1, the zlib default, which is "a default
1811         compromise between speed and compression (currently equivalent
1812         to level 6)."
1814 Note that changing the compression level will not automatically recompress
1815 all existing objects. You can force recompression by passing the -F option
1816 to linkgit:git-repack[1].
1818 pack.deltaCacheSize::
1819         The maximum memory in bytes used for caching deltas in
1820         linkgit:git-pack-objects[1] before writing them out to a pack.
1821         This cache is used to speed up the writing object phase by not
1822         having to recompute the final delta result once the best match
1823         for all objects is found.  Repacking large repositories on machines
1824         which are tight with memory might be badly impacted by this though,
1825         especially if this cache pushes the system into swapping.
1826         A value of 0 means no limit. The smallest size of 1 byte may be
1827         used to virtually disable this cache. Defaults to 256 MiB.
1829 pack.deltaCacheLimit::
1830         The maximum size of a delta, that is cached in
1831         linkgit:git-pack-objects[1]. This cache is used to speed up the
1832         writing object phase by not having to recompute the final delta
1833         result once the best match for all objects is found. Defaults to 1000.
1835 pack.threads::
1836         Specifies the number of threads to spawn when searching for best
1837         delta matches.  This requires that linkgit:git-pack-objects[1]
1838         be compiled with pthreads otherwise this option is ignored with a
1839         warning. This is meant to reduce packing time on multiprocessor
1840         machines. The required amount of memory for the delta search window
1841         is however multiplied by the number of threads.
1842         Specifying 0 will cause Git to auto-detect the number of CPU's
1843         and set the number of threads accordingly.
1845 pack.indexVersion::
1846         Specify the default pack index version.  Valid values are 1 for
1847         legacy pack index used by Git versions prior to 1.5.2, and 2 for
1848         the new pack index with capabilities for packs larger than 4 GB
1849         as well as proper protection against the repacking of corrupted
1850         packs.  Version 2 is the default.  Note that version 2 is enforced
1851         and this config option ignored whenever the corresponding pack is
1852         larger than 2 GB.
1854 If you have an old Git that does not understand the version 2 `*.idx` file,
1855 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1856 that will copy both `*.pack` file and corresponding `*.idx` file from the
1857 other side may give you a repository that cannot be accessed with your
1858 older version of Git. If the `*.pack` file is smaller than 2 GB, however,
1859 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1860 the `*.idx` file.
1862 pack.packSizeLimit::
1863         The maximum size of a pack.  This setting only affects
1864         packing to a file when repacking, i.e. the git:// protocol
1865         is unaffected.  It can be overridden by the `--max-pack-size`
1866         option of linkgit:git-repack[1]. The minimum size allowed is
1867         limited to 1 MiB. The default is unlimited.
1868         Common unit suffixes of 'k', 'm', or 'g' are
1869         supported.
1871 pager.<cmd>::
1872         If the value is boolean, turns on or off pagination of the
1873         output of a particular Git subcommand when writing to a tty.
1874         Otherwise, turns on pagination for the subcommand using the
1875         pager specified by the value of `pager.<cmd>`.  If `--paginate`
1876         or `--no-pager` is specified on the command line, it takes
1877         precedence over this option.  To disable pagination for all
1878         commands, set `core.pager` or `GIT_PAGER` to `cat`.
1880 pretty.<name>::
1881         Alias for a --pretty= format string, as specified in
1882         linkgit:git-log[1]. Any aliases defined here can be used just
1883         as the built-in pretty formats could. For example,
1884         running `git config pretty.changelog "format:* %H %s"`
1885         would cause the invocation `git log --pretty=changelog`
1886         to be equivalent to running `git log "--pretty=format:* %H %s"`.
1887         Note that an alias with the same name as a built-in format
1888         will be silently ignored.
1890 pull.rebase::
1891         When true, rebase branches on top of the fetched branch, instead
1892         of merging the default branch from the default remote when "git
1893         pull" is run. See "branch.<name>.rebase" for setting this on a
1894         per-branch basis.
1896         When preserve, also pass `--preserve-merges` along to 'git rebase'
1897         so that locally committed merge commits will not be flattened
1898         by running 'git pull'.
1900 *NOTE*: this is a possibly dangerous operation; do *not* use
1901 it unless you understand the implications (see linkgit:git-rebase[1]
1902 for details).
1904 pull.octopus::
1905         The default merge strategy to use when pulling multiple branches
1906         at once.
1908 pull.twohead::
1909         The default merge strategy to use when pulling a single branch.
1911 push.default::
1912         Defines the action `git push` should take if no refspec is
1913         explicitly given.  Different values are well-suited for
1914         specific workflows; for instance, in a purely central workflow
1915         (i.e. the fetch source is equal to the push destination),
1916         `upstream` is probably what you want.  Possible values are:
1920 * `nothing` - do not push anything (error out) unless a refspec is
1921   explicitly given. This is primarily meant for people who want to
1922   avoid mistakes by always being explicit.
1924 * `current` - push the current branch to update a branch with the same
1925   name on the receiving end.  Works in both central and non-central
1926   workflows.
1928 * `upstream` - push the current branch back to the branch whose
1929   changes are usually integrated into the current branch (which is
1930   called `@{upstream}`).  This mode only makes sense if you are
1931   pushing to the same repository you would normally pull from
1932   (i.e. central workflow).
1934 * `simple` - in centralized workflow, work like `upstream` with an
1935   added safety to refuse to push if the upstream branch's name is
1936   different from the local one.
1938 When pushing to a remote that is different from the remote you normally
1939 pull from, work as `current`.  This is the safest option and is suited
1940 for beginners.
1942 This mode will become the default in Git 2.0.
1944 * `matching` - push all branches having the same name on both ends.
1945   This makes the repository you are pushing to remember the set of
1946   branches that will be pushed out (e.g. if you always push 'maint'
1947   and 'master' there and no other branches, the repository you push
1948   to will have these two branches, and your local 'maint' and
1949   'master' will be pushed there).
1951 To use this mode effectively, you have to make sure _all_ the
1952 branches you would push out are ready to be pushed out before
1953 running 'git push', as the whole point of this mode is to allow you
1954 to push all of the branches in one go.  If you usually finish work
1955 on only one branch and push out the result, while other branches are
1956 unfinished, this mode is not for you.  Also this mode is not
1957 suitable for pushing into a shared central repository, as other
1958 people may add new branches there, or update the tip of existing
1959 branches outside your control.
1961 This is currently the default, but Git 2.0 will change the default
1962 to `simple`.
1966 rebase.stat::
1967         Whether to show a diffstat of what changed upstream since the last
1968         rebase. False by default.
1970 rebase.autosquash::
1971         If set to true enable '--autosquash' option by default.
1973 rebase.autostash::
1974         When set to true, automatically create a temporary stash
1975         before the operation begins, and apply it after the operation
1976         ends.  This means that you can run rebase on a dirty worktree.
1977         However, use with care: the final stash application after a
1978         successful rebase might result in non-trivial conflicts.
1979         Defaults to false.
1981 receive.autogc::
1982         By default, git-receive-pack will run "git-gc --auto" after
1983         receiving data from git-push and updating refs.  You can stop
1984         it by setting this variable to false.
1986 receive.fsckObjects::
1987         If it is set to true, git-receive-pack will check all received
1988         objects. It will abort in the case of a malformed object or a
1989         broken link. The result of an abort are only dangling objects.
1990         Defaults to false. If not set, the value of `transfer.fsckObjects`
1991         is used instead.
1993 receive.unpackLimit::
1994         If the number of objects received in a push is below this
1995         limit then the objects will be unpacked into loose object
1996         files. However if the number of received objects equals or
1997         exceeds this limit then the received pack will be stored as
1998         a pack, after adding any missing delta bases.  Storing the
1999         pack from a push can make the push operation complete faster,
2000         especially on slow filesystems.  If not set, the value of
2001         `transfer.unpackLimit` is used instead.
2003 receive.denyDeletes::
2004         If set to true, git-receive-pack will deny a ref update that deletes
2005         the ref. Use this to prevent such a ref deletion via a push.
2007 receive.denyDeleteCurrent::
2008         If set to true, git-receive-pack will deny a ref update that
2009         deletes the currently checked out branch of a non-bare repository.
2011 receive.denyCurrentBranch::
2012         If set to true or "refuse", git-receive-pack will deny a ref update
2013         to the currently checked out branch of a non-bare repository.
2014         Such a push is potentially dangerous because it brings the HEAD
2015         out of sync with the index and working tree. If set to "warn",
2016         print a warning of such a push to stderr, but allow the push to
2017         proceed. If set to false or "ignore", allow such pushes with no
2018         message. Defaults to "refuse".
2020 receive.denyNonFastForwards::
2021         If set to true, git-receive-pack will deny a ref update which is
2022         not a fast-forward. Use this to prevent such an update via a push,
2023         even if that push is forced. This configuration variable is
2024         set when initializing a shared repository.
2026 receive.hiderefs::
2027         String(s) `receive-pack` uses to decide which refs to omit
2028         from its initial advertisement.  Use more than one
2029         definitions to specify multiple prefix strings. A ref that
2030         are under the hierarchies listed on the value of this
2031         variable is excluded, and is hidden when responding to `git
2032         push`, and an attempt to update or delete a hidden ref by
2033         `git push` is rejected.
2035 receive.updateserverinfo::
2036         If set to true, git-receive-pack will run git-update-server-info
2037         after receiving data from git-push and updating refs.
2039 receive.shallowupdate::
2040         If set to true, .git/shallow can be updated when new refs
2041         require new shallow roots. Otherwise those refs are rejected.
2043 remote.pushdefault::
2044         The remote to push to by default.  Overrides
2045         `branch.<name>.remote` for all branches, and is overridden by
2046         `branch.<name>.pushremote` for specific branches.
2048 remote.<name>.url::
2049         The URL of a remote repository.  See linkgit:git-fetch[1] or
2050         linkgit:git-push[1].
2052 remote.<name>.pushurl::
2053         The push URL of a remote repository.  See linkgit:git-push[1].
2055 remote.<name>.proxy::
2056         For remotes that require curl (http, https and ftp), the URL to
2057         the proxy to use for that remote.  Set to the empty string to
2058         disable proxying for that remote.
2060 remote.<name>.fetch::
2061         The default set of "refspec" for linkgit:git-fetch[1]. See
2062         linkgit:git-fetch[1].
2064 remote.<name>.push::
2065         The default set of "refspec" for linkgit:git-push[1]. See
2066         linkgit:git-push[1].
2068 remote.<name>.mirror::
2069         If true, pushing to this remote will automatically behave
2070         as if the `--mirror` option was given on the command line.
2072 remote.<name>.skipDefaultUpdate::
2073         If true, this remote will be skipped by default when updating
2074         using linkgit:git-fetch[1] or the `update` subcommand of
2075         linkgit:git-remote[1].
2077 remote.<name>.skipFetchAll::
2078         If true, this remote will be skipped by default when updating
2079         using linkgit:git-fetch[1] or the `update` subcommand of
2080         linkgit:git-remote[1].
2082 remote.<name>.receivepack::
2083         The default program to execute on the remote side when pushing.  See
2084         option \--receive-pack of linkgit:git-push[1].
2086 remote.<name>.uploadpack::
2087         The default program to execute on the remote side when fetching.  See
2088         option \--upload-pack of linkgit:git-fetch-pack[1].
2090 remote.<name>.tagopt::
2091         Setting this value to \--no-tags disables automatic tag following when
2092         fetching from remote <name>. Setting it to \--tags will fetch every
2093         tag from remote <name>, even if they are not reachable from remote
2094         branch heads. Passing these flags directly to linkgit:git-fetch[1] can
2095         override this setting. See options \--tags and \--no-tags of
2096         linkgit:git-fetch[1].
2098 remote.<name>.vcs::
2099         Setting this to a value <vcs> will cause Git to interact with
2100         the remote with the git-remote-<vcs> helper.
2102 remote.<name>.prune::
2103         When set to true, fetching from this remote by default will also
2104         remove any remote-tracking references that no longer exist on the
2105         remote (as if the `--prune` option was given on the command line).
2106         Overrides `fetch.prune` settings, if any.
2108 remotes.<group>::
2109         The list of remotes which are fetched by "git remote update
2110         <group>".  See linkgit:git-remote[1].
2112 repack.usedeltabaseoffset::
2113         By default, linkgit:git-repack[1] creates packs that use
2114         delta-base offset. If you need to share your repository with
2115         Git older than version 1.4.4, either directly or via a dumb
2116         protocol such as http, then you need to set this option to
2117         "false" and repack. Access from old Git versions over the
2118         native protocol are unaffected by this option.
2120 rerere.autoupdate::
2121         When set to true, `git-rerere` updates the index with the
2122         resulting contents after it cleanly resolves conflicts using
2123         previously recorded resolution.  Defaults to false.
2125 rerere.enabled::
2126         Activate recording of resolved conflicts, so that identical
2127         conflict hunks can be resolved automatically, should they be
2128         encountered again.  By default, linkgit:git-rerere[1] is
2129         enabled if there is an `rr-cache` directory under the
2130         `$GIT_DIR`, e.g. if "rerere" was previously used in the
2131         repository.
2133 sendemail.identity::
2134         A configuration identity. When given, causes values in the
2135         'sendemail.<identity>' subsection to take precedence over
2136         values in the 'sendemail' section. The default identity is
2137         the value of 'sendemail.identity'.
2139 sendemail.smtpencryption::
2140         See linkgit:git-send-email[1] for description.  Note that this
2141         setting is not subject to the 'identity' mechanism.
2143 sendemail.smtpssl::
2144         Deprecated alias for 'sendemail.smtpencryption = ssl'.
2146 sendemail.smtpsslcertpath::
2147         Path to ca-certificates (either a directory or a single file).
2148         Set it to an empty string to disable certificate verification.
2150 sendemail.<identity>.*::
2151         Identity-specific versions of the 'sendemail.*' parameters
2152         found below, taking precedence over those when the this
2153         identity is selected, through command-line or
2154         'sendemail.identity'.
2156 sendemail.aliasesfile::
2157 sendemail.aliasfiletype::
2158 sendemail.annotate::
2159 sendemail.bcc::
2160 sendemail.cc::
2161 sendemail.cccmd::
2162 sendemail.chainreplyto::
2163 sendemail.confirm::
2164 sendemail.envelopesender::
2165 sendemail.from::
2166 sendemail.multiedit::
2167 sendemail.signedoffbycc::
2168 sendemail.smtppass::
2169 sendemail.suppresscc::
2170 sendemail.suppressfrom::
2171 sendemail.to::
2172 sendemail.smtpdomain::
2173 sendemail.smtpserver::
2174 sendemail.smtpserverport::
2175 sendemail.smtpserveroption::
2176 sendemail.smtpuser::
2177 sendemail.thread::
2178 sendemail.validate::
2179         See linkgit:git-send-email[1] for description.
2181 sendemail.signedoffcc::
2182         Deprecated alias for 'sendemail.signedoffbycc'.
2184 showbranch.default::
2185         The default set of branches for linkgit:git-show-branch[1].
2186         See linkgit:git-show-branch[1].
2188 status.relativePaths::
2189         By default, linkgit:git-status[1] shows paths relative to the
2190         current directory. Setting this variable to `false` shows paths
2191         relative to the repository root (this was the default for Git
2192         prior to v1.5.4).
2194 status.short::
2195         Set to true to enable --short by default in linkgit:git-status[1].
2196         The option --no-short takes precedence over this variable.
2198 status.branch::
2199         Set to true to enable --branch by default in linkgit:git-status[1].
2200         The option --no-branch takes precedence over this variable.
2202 status.displayCommentPrefix::
2203         If set to true, linkgit:git-status[1] will insert a comment
2204         prefix before each output line (starting with
2205         `core.commentChar`, i.e. `#` by default). This was the
2206         behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
2207         Defaults to false.
2209 status.showUntrackedFiles::
2210         By default, linkgit:git-status[1] and linkgit:git-commit[1] show
2211         files which are not currently tracked by Git. Directories which
2212         contain only untracked files, are shown with the directory name
2213         only. Showing untracked files means that Git needs to lstat() all
2214         all the files in the whole repository, which might be slow on some
2215         systems. So, this variable controls how the commands displays
2216         the untracked files. Possible values are:
2219 * `no` - Show no untracked files.
2220 * `normal` - Show untracked files and directories.
2221 * `all` - Show also individual files in untracked directories.
2224 If this variable is not specified, it defaults to 'normal'.
2225 This variable can be overridden with the -u|--untracked-files option
2226 of linkgit:git-status[1] and linkgit:git-commit[1].
2228 status.submodulesummary::
2229         Defaults to false.
2230         If this is set to a non zero number or true (identical to -1 or an
2231         unlimited number), the submodule summary will be enabled and a
2232         summary of commits for modified submodules will be shown (see
2233         --summary-limit option of linkgit:git-submodule[1]). Please note
2234         that the summary output command will be suppressed for all
2235         submodules when `diff.ignoreSubmodules` is set to 'all' or only
2236         for those submodules where `submodule.<name>.ignore=all`. To
2237         also view the summary for ignored submodules you can either use
2238         the --ignore-submodules=dirty command line option or the 'git
2239         submodule summary' command, which shows a similar output but does
2240         not honor these settings.
2242 submodule.<name>.path::
2243 submodule.<name>.url::
2244 submodule.<name>.update::
2245         The path within this project, URL, and the updating strategy
2246         for a submodule.  These variables are initially populated
2247         by 'git submodule init'; edit them to override the
2248         URL and other values found in the `.gitmodules` file.  See
2249         linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
2251 submodule.<name>.branch::
2252         The remote branch name for a submodule, used by `git submodule
2253         update --remote`.  Set this option to override the value found in
2254         the `.gitmodules` file.  See linkgit:git-submodule[1] and
2255         linkgit:gitmodules[5] for details.
2257 submodule.<name>.fetchRecurseSubmodules::
2258         This option can be used to control recursive fetching of this
2259         submodule. It can be overridden by using the --[no-]recurse-submodules
2260         command line option to "git fetch" and "git pull".
2261         This setting will override that from in the linkgit:gitmodules[5]
2262         file.
2264 submodule.<name>.ignore::
2265         Defines under what circumstances "git status" and the diff family show
2266         a submodule as modified. When set to "all", it will never be considered
2267         modified, "dirty" will ignore all changes to the submodules work tree and
2268         takes only differences between the HEAD of the submodule and the commit
2269         recorded in the superproject into account. "untracked" will additionally
2270         let submodules with modified tracked files in their work tree show up.
2271         Using "none" (the default when this option is not set) also shows
2272         submodules that have untracked files in their work tree as changed.
2273         This setting overrides any setting made in .gitmodules for this submodule,
2274         both settings can be overridden on the command line by using the
2275         "--ignore-submodules" option. The 'git submodule' commands are not
2276         affected by this setting.
2278 tar.umask::
2279         This variable can be used to restrict the permission bits of
2280         tar archive entries.  The default is 0002, which turns off the
2281         world write bit.  The special value "user" indicates that the
2282         archiving user's umask will be used instead.  See umask(2) and
2283         linkgit:git-archive[1].
2285 transfer.fsckObjects::
2286         When `fetch.fsckObjects` or `receive.fsckObjects` are
2287         not set, the value of this variable is used instead.
2288         Defaults to false.
2290 transfer.hiderefs::
2291         This variable can be used to set both `receive.hiderefs`
2292         and `uploadpack.hiderefs` at the same time to the same
2293         values.  See entries for these other variables.
2295 transfer.unpackLimit::
2296         When `fetch.unpackLimit` or `receive.unpackLimit` are
2297         not set, the value of this variable is used instead.
2298         The default value is 100.
2300 uploadpack.hiderefs::
2301         String(s) `upload-pack` uses to decide which refs to omit
2302         from its initial advertisement.  Use more than one
2303         definitions to specify multiple prefix strings. A ref that
2304         are under the hierarchies listed on the value of this
2305         variable is excluded, and is hidden from `git ls-remote`,
2306         `git fetch`, etc.  An attempt to fetch a hidden ref by `git
2307         fetch` will fail.  See also `uploadpack.allowtipsha1inwant`.
2309 uploadpack.allowtipsha1inwant::
2310         When `uploadpack.hiderefs` is in effect, allow `upload-pack`
2311         to accept a fetch request that asks for an object at the tip
2312         of a hidden ref (by default, such a request is rejected).
2313         see also `uploadpack.hiderefs`.
2315 uploadpack.keepalive::
2316         When `upload-pack` has started `pack-objects`, there may be a
2317         quiet period while `pack-objects` prepares the pack. Normally
2318         it would output progress information, but if `--quiet` was used
2319         for the fetch, `pack-objects` will output nothing at all until
2320         the pack data begins. Some clients and networks may consider
2321         the server to be hung and give up. Setting this option instructs
2322         `upload-pack` to send an empty keepalive packet every
2323         `uploadpack.keepalive` seconds. Setting this option to 0
2324         disables keepalive packets entirely. The default is 5 seconds.
2326 url.<base>.insteadOf::
2327         Any URL that starts with this value will be rewritten to
2328         start, instead, with <base>. In cases where some site serves a
2329         large number of repositories, and serves them with multiple
2330         access methods, and some users need to use different access
2331         methods, this feature allows people to specify any of the
2332         equivalent URLs and have Git automatically rewrite the URL to
2333         the best alternative for the particular user, even for a
2334         never-before-seen repository on the site.  When more than one
2335         insteadOf strings match a given URL, the longest match is used.
2337 url.<base>.pushInsteadOf::
2338         Any URL that starts with this value will not be pushed to;
2339         instead, it will be rewritten to start with <base>, and the
2340         resulting URL will be pushed to. In cases where some site serves
2341         a large number of repositories, and serves them with multiple
2342         access methods, some of which do not allow push, this feature
2343         allows people to specify a pull-only URL and have Git
2344         automatically use an appropriate URL to push, even for a
2345         never-before-seen repository on the site.  When more than one
2346         pushInsteadOf strings match a given URL, the longest match is
2347         used.  If a remote has an explicit pushurl, Git will ignore this
2348         setting for that remote.
2350 user.email::
2351         Your email address to be recorded in any newly created commits.
2352         Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
2353         'EMAIL' environment variables.  See linkgit:git-commit-tree[1].
2355 user.name::
2356         Your full name to be recorded in any newly created commits.
2357         Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
2358         environment variables.  See linkgit:git-commit-tree[1].
2360 user.signingkey::
2361         If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
2362         key you want it to automatically when creating a signed tag or
2363         commit, you can override the default selection with this variable.
2364         This option is passed unchanged to gpg's --local-user parameter,
2365         so you may specify a key using any method that gpg supports.
2367 web.browser::
2368         Specify a web browser that may be used by some commands.
2369         Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
2370         may use it.