use 'commit-ish' instead of 'committish'
[git.git] / Documentation / config.txt
blob1ccec22e2207d335abae1b050402f47e87eb8f22
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).  No other char escape sequence, nor octal
82 char sequences are valid.
84 Variable values ending in a `\` are continued on the next line in the
85 customary UNIX fashion.
87 Some variables may require a special value format.
89 Includes
90 ~~~~~~~~
92 You can include one config file from another by setting the special
93 `include.path` variable to the name of the file to be included. The
94 included file is expanded immediately, as if its contents had been
95 found at the location of the include directive. If the value of the
96 `include.path` variable is a relative path, the path is considered to be
97 relative to the configuration file in which the include directive was
98 found. The value of `include.path` is subject to tilde expansion: `~/`
99 is expanded to the value of `$HOME`, and `~user/` to the specified
100 user's home directory. See below for examples.
102 Example
103 ~~~~~~~
105         # Core variables
106         [core]
107                 ; Don't trust file modes
108                 filemode = false
110         # Our diff algorithm
111         [diff]
112                 external = /usr/local/bin/diff-wrapper
113                 renames = true
115         [branch "devel"]
116                 remote = origin
117                 merge = refs/heads/devel
119         # Proxy settings
120         [core]
121                 gitProxy="ssh" for "kernel.org"
122                 gitProxy=default-proxy ; for the rest
124         [include]
125                 path = /path/to/foo.inc ; include by absolute path
126                 path = foo ; expand "foo" relative to the current file
127                 path = ~/foo ; expand "foo" in your $HOME directory
129 Variables
130 ~~~~~~~~~
132 Note that this list is non-comprehensive and not necessarily complete.
133 For command-specific variables, you will find a more detailed description
134 in the appropriate manual page. You will find a description of non-core
135 porcelain configuration variables in the respective porcelain documentation.
137 advice.*::
138         These variables control various optional help messages designed to
139         aid new users. All 'advice.*' variables default to 'true', and you
140         can tell Git that you do not need help by setting these to 'false':
143         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.ignorecase::
217         If true, this option enables various workarounds to enable
218         Git to work better on filesystems that are not case sensitive,
219         like FAT. For example, if a directory listing finds
220         "makefile" when Git expects "Makefile", Git will assume
221         it is really the same file, and continue to remember it as
222         "Makefile".
224 The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
225 will probe and set core.ignorecase true if appropriate when the repository
226 is created.
228 core.precomposeunicode::
229         This option is only used by Mac OS implementation of Git.
230         When core.precomposeunicode=true, Git reverts the unicode decomposition
231         of filenames done by Mac OS. This is useful when sharing a repository
232         between Mac OS and Linux or Windows.
233         (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
234         When false, file names are handled fully transparent by Git,
235         which is backward compatible with older versions of Git.
237 core.trustctime::
238         If false, the ctime differences between the index and the
239         working tree are ignored; useful when the inode change time
240         is regularly modified by something outside Git (file system
241         crawlers and some backup systems).
242         See linkgit:git-update-index[1]. True by default.
244 core.checkstat::
245         Determines which stat fields to match between the index
246         and work tree. The user can set this to 'default' or
247         'minimal'. Default (or explicitly 'default'), is to check
248         all fields, including the sub-second part of mtime and ctime.
250 core.quotepath::
251         The commands that output paths (e.g. 'ls-files',
252         'diff'), when not given the `-z` option, will quote
253         "unusual" characters in the pathname by enclosing the
254         pathname in a double-quote pair and with backslashes the
255         same way strings in C source code are quoted.  If this
256         variable is set to false, the bytes higher than 0x80 are
257         not quoted but output as verbatim.  Note that double
258         quote, backslash and control characters are always
259         quoted without `-z` regardless of the setting of this
260         variable.
262 core.eol::
263         Sets the line ending type to use in the working directory for
264         files that have the `text` property set.  Alternatives are
265         'lf', 'crlf' and 'native', which uses the platform's native
266         line ending.  The default value is `native`.  See
267         linkgit:gitattributes[5] for more information on end-of-line
268         conversion.
270 core.safecrlf::
271         If true, makes Git check if converting `CRLF` is reversible when
272         end-of-line conversion is active.  Git will verify if a command
273         modifies a file in the work tree either directly or indirectly.
274         For example, committing a file followed by checking out the
275         same file should yield the original file in the work tree.  If
276         this is not the case for the current setting of
277         `core.autocrlf`, Git will reject the file.  The variable can
278         be set to "warn", in which case Git will only warn about an
279         irreversible conversion but continue the operation.
281 CRLF conversion bears a slight chance of corrupting data.
282 When it is enabled, Git will convert CRLF to LF during commit and LF to
283 CRLF during checkout.  A file that contains a mixture of LF and
284 CRLF before the commit cannot be recreated by Git.  For text
285 files this is the right thing to do: it corrects line endings
286 such that we have only LF line endings in the repository.
287 But for binary files that are accidentally classified as text the
288 conversion can corrupt data.
290 If you recognize such corruption early you can easily fix it by
291 setting the conversion type explicitly in .gitattributes.  Right
292 after committing you still have the original file in your work
293 tree and this file is not yet corrupted.  You can explicitly tell
294 Git that this file is binary and Git will handle the file
295 appropriately.
297 Unfortunately, the desired effect of cleaning up text files with
298 mixed line endings and the undesired effect of corrupting binary
299 files cannot be distinguished.  In both cases CRLFs are removed
300 in an irreversible way.  For text files this is the right thing
301 to do because CRLFs are line endings, while for binary files
302 converting CRLFs corrupts data.
304 Note, this safety check does not mean that a checkout will generate a
305 file identical to the original file for a different setting of
306 `core.eol` and `core.autocrlf`, but only for the current one.  For
307 example, a text file with `LF` would be accepted with `core.eol=lf`
308 and could later be checked out with `core.eol=crlf`, in which case the
309 resulting file would contain `CRLF`, although the original file
310 contained `LF`.  However, in both work trees the line endings would be
311 consistent, that is either all `LF` or all `CRLF`, but never mixed.  A
312 file with mixed line endings would be reported by the `core.safecrlf`
313 mechanism.
315 core.autocrlf::
316         Setting this variable to "true" is almost the same as setting
317         the `text` attribute to "auto" on all files except that text
318         files are not guaranteed to be normalized: files that contain
319         `CRLF` in the repository will not be touched.  Use this
320         setting if you want to have `CRLF` line endings in your
321         working directory even though the repository does not have
322         normalized line endings.  This variable can be set to 'input',
323         in which case no output conversion is performed.
325 core.symlinks::
326         If false, symbolic links are checked out as small plain files that
327         contain the link text. linkgit:git-update-index[1] and
328         linkgit:git-add[1] will not change the recorded type to regular
329         file. Useful on filesystems like FAT that do not support
330         symbolic links.
332 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
333 will probe and set core.symlinks false if appropriate when the repository
334 is created.
336 core.gitProxy::
337         A "proxy command" to execute (as 'command host port') instead
338         of establishing direct connection to the remote server when
339         using the Git protocol for fetching. If the variable value is
340         in the "COMMAND for DOMAIN" format, the command is applied only
341         on hostnames ending with the specified domain string. This variable
342         may be set multiple times and is matched in the given order;
343         the first match wins.
345 Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
346 (which always applies universally, without the special "for"
347 handling).
349 The special string `none` can be used as the proxy command to
350 specify that no proxy be used for a given domain pattern.
351 This is useful for excluding servers inside a firewall from
352 proxy use, while defaulting to a common proxy for external domains.
354 core.ignoreStat::
355         If true, commands which modify both the working tree and the index
356         will mark the updated paths with the "assume unchanged" bit in the
357         index. These marked files are then assumed to stay unchanged in the
358         working tree, until you mark them otherwise manually - Git will not
359         detect the file changes by lstat() calls. This is useful on systems
360         where those are very slow, such as Microsoft Windows.
361         See linkgit:git-update-index[1].
362         False by default.
364 core.preferSymlinkRefs::
365         Instead of the default "symref" format for HEAD
366         and other symbolic reference files, use symbolic links.
367         This is sometimes needed to work with old scripts that
368         expect HEAD to be a symbolic link.
370 core.bare::
371         If true this repository is assumed to be 'bare' and has no
372         working directory associated with it.  If this is the case a
373         number of commands that require a working directory will be
374         disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
376 This setting is automatically guessed by linkgit:git-clone[1] or
377 linkgit:git-init[1] when the repository was created.  By default a
378 repository that ends in "/.git" is assumed to be not bare (bare =
379 false), while all other repositories are assumed to be bare (bare
380 = true).
382 core.worktree::
383         Set the path to the root of the working tree.
384         This can be overridden by the GIT_WORK_TREE environment
385         variable and the '--work-tree' command line option.
386         The value can be an absolute path or relative to the path to
387         the .git directory, which is either specified by --git-dir
388         or GIT_DIR, or automatically discovered.
389         If --git-dir or GIT_DIR is specified but none of
390         --work-tree, GIT_WORK_TREE and core.worktree is specified,
391         the current working directory is regarded as the top level
392         of your working tree.
394 Note that this variable is honored even when set in a configuration
395 file in a ".git" subdirectory of a directory and its value differs
396 from the latter directory (e.g. "/path/to/.git/config" has
397 core.worktree set to "/different/path"), which is most likely a
398 misconfiguration.  Running Git commands in the "/path/to" directory will
399 still use "/different/path" as the root of the work tree and can cause
400 confusion unless you know what you are doing (e.g. you are creating a
401 read-only snapshot of the same index to a location different from the
402 repository's usual working tree).
404 core.logAllRefUpdates::
405         Enable the reflog. Updates to a ref <ref> is logged to the file
406         "$GIT_DIR/logs/<ref>", by appending the new and old
407         SHA-1, the date/time and the reason of the update, but
408         only when the file exists.  If this configuration
409         variable is set to true, missing "$GIT_DIR/logs/<ref>"
410         file is automatically created for branch heads (i.e. under
411         refs/heads/), remote refs (i.e. under refs/remotes/),
412         note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
414 This information can be used to determine what commit
415 was the tip of a branch "2 days ago".
417 This value is true by default in a repository that has
418 a working directory associated with it, and false by
419 default in a bare repository.
421 core.repositoryFormatVersion::
422         Internal variable identifying the repository format and layout
423         version.
425 core.sharedRepository::
426         When 'group' (or 'true'), the repository is made shareable between
427         several users in a group (making sure all the files and objects are
428         group-writable). When 'all' (or 'world' or 'everybody'), the
429         repository will be readable by all users, additionally to being
430         group-shareable. When 'umask' (or 'false'), Git will use permissions
431         reported by umask(2). When '0xxx', where '0xxx' is an octal number,
432         files in the repository will have this mode value. '0xxx' will override
433         user's umask value (whereas the other options will only override
434         requested parts of the user's umask value). Examples: '0660' will make
435         the repo read/write-able for the owner and group, but inaccessible to
436         others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
437         repository that is group-readable but not group-writable.
438         See linkgit:git-init[1]. False by default.
440 core.warnAmbiguousRefs::
441         If true, Git will warn you if the ref name you passed it is ambiguous
442         and might match multiple refs in the repository. True by default.
444 core.compression::
445         An integer -1..9, indicating a default compression level.
446         -1 is the zlib default. 0 means no compression,
447         and 1..9 are various speed/size tradeoffs, 9 being slowest.
448         If set, this provides a default to other compression variables,
449         such as 'core.loosecompression' and 'pack.compression'.
451 core.loosecompression::
452         An integer -1..9, indicating the compression level for objects that
453         are not in a pack file. -1 is the zlib default. 0 means no
454         compression, and 1..9 are various speed/size tradeoffs, 9 being
455         slowest.  If not set,  defaults to core.compression.  If that is
456         not set,  defaults to 1 (best speed).
458 core.packedGitWindowSize::
459         Number of bytes of a pack file to map into memory in a
460         single mapping operation.  Larger window sizes may allow
461         your system to process a smaller number of large pack files
462         more quickly.  Smaller window sizes will negatively affect
463         performance due to increased calls to the operating system's
464         memory manager, but may improve performance when accessing
465         a large number of large pack files.
467 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
468 MiB on 32 bit platforms and 1 GiB on 64 bit platforms.  This should
469 be reasonable for all users/operating systems.  You probably do
470 not need to adjust this value.
472 Common unit suffixes of 'k', 'm', or 'g' are supported.
474 core.packedGitLimit::
475         Maximum number of bytes to map simultaneously into memory
476         from pack files.  If Git needs to access more than this many
477         bytes at once to complete an operation it will unmap existing
478         regions to reclaim virtual address space within the process.
480 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
481 This should be reasonable for all users/operating systems, except on
482 the largest projects.  You probably do not need to adjust this value.
484 Common unit suffixes of 'k', 'm', or 'g' are supported.
486 core.deltaBaseCacheLimit::
487         Maximum number of bytes to reserve for caching base objects
488         that may be referenced by multiple deltified objects.  By storing the
489         entire decompressed base objects in a cache Git is able
490         to avoid unpacking and decompressing frequently used base
491         objects multiple times.
493 Default is 16 MiB on all platforms.  This should be reasonable
494 for all users/operating systems, except on the largest projects.
495 You probably do not need to adjust this value.
497 Common unit suffixes of 'k', 'm', or 'g' are supported.
499 core.bigFileThreshold::
500         Files larger than this size are stored deflated, without
501         attempting delta compression.  Storing large files without
502         delta compression avoids excessive memory usage, at the
503         slight expense of increased disk usage.
505 Default is 512 MiB on all platforms.  This should be reasonable
506 for most projects as source code and other text files can still
507 be delta compressed, but larger binary media files won't be.
509 Common unit suffixes of 'k', 'm', or 'g' are supported.
511 core.excludesfile::
512         In addition to '.gitignore' (per-directory) and
513         '.git/info/exclude', Git looks into this file for patterns
514         of files which are not meant to be tracked.  "`~/`" is expanded
515         to the value of `$HOME` and "`~user/`" to the specified user's
516         home directory. Its default value is $XDG_CONFIG_HOME/git/ignore.
517         If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore
518         is used instead. See linkgit:gitignore[5].
520 core.askpass::
521         Some commands (e.g. svn and http interfaces) that interactively
522         ask for a password can be told to use an external program given
523         via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
524         environment variable. If not set, fall back to the value of the
525         'SSH_ASKPASS' environment variable or, failing that, a simple password
526         prompt. The external program shall be given a suitable prompt as
527         command line argument and write the password on its STDOUT.
529 core.attributesfile::
530         In addition to '.gitattributes' (per-directory) and
531         '.git/info/attributes', Git looks into this file for attributes
532         (see linkgit:gitattributes[5]). Path expansions are made the same
533         way as for `core.excludesfile`. Its default value is
534         $XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not
535         set or empty, $HOME/.config/git/attributes is used instead.
537 core.editor::
538         Commands such as `commit` and `tag` that lets you edit
539         messages by launching an editor uses the value of this
540         variable when it is set, and the environment variable
541         `GIT_EDITOR` is not set.  See linkgit:git-var[1].
543 core.commentchar::
544         Commands such as `commit` and `tag` that lets you edit
545         messages consider a line that begins with this character
546         commented, and removes them after the editor returns
547         (default '#').
549 sequence.editor::
550         Text editor used by `git rebase -i` for editing the rebase instruction file.
551         The value is meant to be interpreted by the shell when it is used.
552         It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
553         When not configured the default commit message editor is used instead.
555 core.pager::
556         The command that Git will use to paginate output.  Can
557         be overridden with the `GIT_PAGER` environment
558         variable.  Note that Git sets the `LESS` environment
559         variable to `FRSX` if it is unset when it runs the
560         pager.  One can change these settings by setting the
561         `LESS` variable to some other value.  Alternately,
562         these settings can be overridden on a project or
563         global basis by setting the `core.pager` option.
564         Setting `core.pager` has no effect on the `LESS`
565         environment variable behaviour above, so if you want
566         to override Git's default settings this way, you need
567         to be explicit.  For example, to disable the S option
568         in a backward compatible manner, set `core.pager`
569         to `less -+S`.  This will be passed to the shell by
570         Git, which will translate the final command to
571         `LESS=FRSX less -+S`.
573 core.whitespace::
574         A comma separated list of common whitespace problems to
575         notice.  'git diff' will use `color.diff.whitespace` to
576         highlight them, and 'git apply --whitespace=error' will
577         consider them as errors.  You can prefix `-` to disable
578         any of them (e.g. `-trailing-space`):
580 * `blank-at-eol` treats trailing whitespaces at the end of the line
581   as an error (enabled by default).
582 * `space-before-tab` treats a space character that appears immediately
583   before a tab character in the initial indent part of the line as an
584   error (enabled by default).
585 * `indent-with-non-tab` treats a line that is indented with space
586   characters instead of the equivalent tabs as an error (not enabled by
587   default).
588 * `tab-in-indent` treats a tab character in the initial indent part of
589   the line as an error (not enabled by default).
590 * `blank-at-eof` treats blank lines added at the end of file as an error
591   (enabled by default).
592 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
593   `blank-at-eof`.
594 * `cr-at-eol` treats a carriage-return at the end of line as
595   part of the line terminator, i.e. with it, `trailing-space`
596   does not trigger if the character before such a carriage-return
597   is not a whitespace (not enabled by default).
598 * `tabwidth=<n>` tells how many character positions a tab occupies; this
599   is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
600   errors. The default tab width is 8. Allowed values are 1 to 63.
602 core.fsyncobjectfiles::
603         This boolean will enable 'fsync()' when writing object files.
605 This is a total waste of time and effort on a filesystem that orders
606 data writes properly, but can be useful for filesystems that do not use
607 journalling (traditional UNIX filesystems) or that only journal metadata
608 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
610 core.preloadindex::
611         Enable parallel index preload for operations like 'git diff'
613 This can speed up operations like 'git diff' and 'git status' especially
614 on filesystems like NFS that have weak caching semantics and thus
615 relatively high IO latencies.  With this set to 'true', Git will do the
616 index comparison to the filesystem data in parallel, allowing
617 overlapping IO's.
619 core.createObject::
620         You can set this to 'link', in which case a hardlink followed by
621         a delete of the source are used to make sure that object creation
622         will not overwrite existing objects.
624 On some file system/operating system combinations, this is unreliable.
625 Set this config setting to 'rename' there; However, This will remove the
626 check that makes sure that existing object files will not get overwritten.
628 core.notesRef::
629         When showing commit messages, also show notes which are stored in
630         the given ref.  The ref must be fully qualified.  If the given
631         ref does not exist, it is not an error but means that no
632         notes should be printed.
634 This setting defaults to "refs/notes/commits", and it can be overridden by
635 the 'GIT_NOTES_REF' environment variable.  See linkgit:git-notes[1].
637 core.sparseCheckout::
638         Enable "sparse checkout" feature. See section "Sparse checkout" in
639         linkgit:git-read-tree[1] for more information.
641 core.abbrev::
642         Set the length object names are abbreviated to.  If unspecified,
643         many commands abbreviate to 7 hexdigits, which may not be enough
644         for abbreviated object names to stay unique for sufficiently long
645         time.
647 add.ignore-errors::
648 add.ignoreErrors::
649         Tells 'git add' to continue adding files when some files cannot be
650         added due to indexing errors. Equivalent to the '--ignore-errors'
651         option of linkgit:git-add[1].  Older versions of Git accept only
652         `add.ignore-errors`, which does not follow the usual naming
653         convention for configuration variables.  Newer versions of Git
654         honor `add.ignoreErrors` as well.
656 alias.*::
657         Command aliases for the linkgit:git[1] command wrapper - e.g.
658         after defining "alias.last = cat-file commit HEAD", the invocation
659         "git last" is equivalent to "git cat-file commit HEAD". To avoid
660         confusion and troubles with script usage, aliases that
661         hide existing Git commands are ignored. Arguments are split by
662         spaces, the usual shell quoting and escaping is supported.
663         quote pair and a backslash can be used to quote them.
665 If the alias expansion is prefixed with an exclamation point,
666 it will be treated as a shell command.  For example, defining
667 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
668 "git new" is equivalent to running the shell command
669 "gitk --all --not ORIG_HEAD".  Note that shell commands will be
670 executed from the top-level directory of a repository, which may
671 not necessarily be the current directory.
672 'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
673 from the original current directory. See linkgit:git-rev-parse[1].
675 am.keepcr::
676         If true, git-am will call git-mailsplit for patches in mbox format
677         with parameter '--keep-cr'. In this case git-mailsplit will
678         not remove `\r` from lines ending with `\r\n`. Can be overridden
679         by giving '--no-keep-cr' from the command line.
680         See linkgit:git-am[1], linkgit:git-mailsplit[1].
682 apply.ignorewhitespace::
683         When set to 'change', tells 'git apply' to ignore changes in
684         whitespace, in the same way as the '--ignore-space-change'
685         option.
686         When set to one of: no, none, never, false tells 'git apply' to
687         respect all whitespace differences.
688         See linkgit:git-apply[1].
690 apply.whitespace::
691         Tells 'git apply' how to handle whitespaces, in the same way
692         as the '--whitespace' option. See linkgit:git-apply[1].
694 branch.autosetupmerge::
695         Tells 'git branch' and 'git checkout' to set up new branches
696         so that linkgit:git-pull[1] will appropriately merge from the
697         starting point branch. Note that even if this option is not set,
698         this behavior can be chosen per-branch using the `--track`
699         and `--no-track` options. The valid settings are: `false` -- no
700         automatic setup is done; `true` -- automatic setup is done when the
701         starting point is a remote-tracking branch; `always` --
702         automatic setup is done when the starting point is either a
703         local branch or remote-tracking
704         branch. This option defaults to true.
706 branch.autosetuprebase::
707         When a new branch is created with 'git branch' or 'git checkout'
708         that tracks another branch, this variable tells Git to set
709         up pull to rebase instead of merge (see "branch.<name>.rebase").
710         When `never`, rebase is never automatically set to true.
711         When `local`, rebase is set to true for tracked branches of
712         other local branches.
713         When `remote`, rebase is set to true for tracked branches of
714         remote-tracking branches.
715         When `always`, rebase will be set to true for all tracking
716         branches.
717         See "branch.autosetupmerge" for details on how to set up a
718         branch to track another branch.
719         This option defaults to never.
721 branch.<name>.remote::
722         When on branch <name>, it tells 'git fetch' and 'git push'
723         which remote to fetch from/push to.  The remote to push to
724         may be overridden with `remote.pushdefault` (for all branches).
725         The remote to push to, for the current branch, may be further
726         overridden by `branch.<name>.pushremote`.  If no remote is
727         configured, or if you are not on any branch, it defaults to
728         `origin` for fetching and `remote.pushdefault` for pushing.
730 branch.<name>.pushremote::
731         When on branch <name>, it overrides `branch.<name>.remote` for
732         pushing.  It also overrides `remote.pushdefault` for pushing
733         from branch <name>.  When you pull from one place (e.g. your
734         upstream) and push to another place (e.g. your own publishing
735         repository), you would want to set `remote.pushdefault` to
736         specify the remote to push to for all branches, and use this
737         option to override it for a specific branch.
739 branch.<name>.merge::
740         Defines, together with branch.<name>.remote, the upstream branch
741         for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
742         branch to merge and can also affect 'git push' (see push.default).
743         When in branch <name>, it tells 'git fetch' the default
744         refspec to be marked for merging in FETCH_HEAD. The value is
745         handled like the remote part of a refspec, and must match a
746         ref which is fetched from the remote given by
747         "branch.<name>.remote".
748         The merge information is used by 'git pull' (which at first calls
749         'git fetch') to lookup the default branch for merging. Without
750         this option, 'git pull' defaults to merge the first refspec fetched.
751         Specify multiple values to get an octopus merge.
752         If you wish to setup 'git pull' so that it merges into <name> from
753         another branch in the local repository, you can point
754         branch.<name>.merge to the desired branch, and use the special setting
755         `.` (a period) for branch.<name>.remote.
757 branch.<name>.mergeoptions::
758         Sets default options for merging into branch <name>. The syntax and
759         supported options are the same as those of linkgit:git-merge[1], but
760         option values containing whitespace characters are currently not
761         supported.
763 branch.<name>.rebase::
764         When true, rebase the branch <name> on top of the fetched branch,
765         instead of merging the default branch from the default remote when
766         "git pull" is run. See "pull.rebase" for doing this in a non
767         branch-specific manner.
769 *NOTE*: this is a possibly dangerous operation; do *not* use
770 it unless you understand the implications (see linkgit:git-rebase[1]
771 for details).
773 branch.<name>.description::
774         Branch description, can be edited with
775         `git branch --edit-description`. Branch description is
776         automatically added in the format-patch cover letter or
777         request-pull summary.
779 browser.<tool>.cmd::
780         Specify the command to invoke the specified browser. The
781         specified command is evaluated in shell with the URLs passed
782         as arguments. (See linkgit:git-web{litdd}browse[1].)
784 browser.<tool>.path::
785         Override the path for the given tool that may be used to
786         browse HTML help (see '-w' option in linkgit:git-help[1]) or a
787         working repository in gitweb (see linkgit:git-instaweb[1]).
789 clean.requireForce::
790         A boolean to make git-clean do nothing unless given -f
791         or -n.   Defaults to true.
793 color.branch::
794         A boolean to enable/disable color in the output of
795         linkgit:git-branch[1]. May be set to `always`,
796         `false` (or `never`) or `auto` (or `true`), in which case colors are used
797         only when the output is to a terminal. Defaults to false.
799 color.branch.<slot>::
800         Use customized color for branch coloration. `<slot>` is one of
801         `current` (the current branch), `local` (a local branch),
802         `remote` (a remote-tracking branch in refs/remotes/),
803         `upstream` (upstream tracking branch), `plain` (other
804         refs).
806 The value for these configuration variables is a list of colors (at most
807 two) and attributes (at most one), separated by spaces.  The colors
808 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
809 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
810 `blink` and `reverse`.  The first color given is the foreground; the
811 second is the background.  The position of the attribute, if any,
812 doesn't matter.
814 color.diff::
815         Whether to use ANSI escape sequences to add color to patches.
816         If this is set to `always`, linkgit:git-diff[1],
817         linkgit:git-log[1], and linkgit:git-show[1] will use color
818         for all patches.  If it is set to `true` or `auto`, those
819         commands will only use color when output is to the terminal.
820         Defaults to false.
822 This does not affect linkgit:git-format-patch[1] nor the
823 'git-diff-{asterisk}' plumbing commands.  Can be overridden on the
824 command line with the `--color[=<when>]` option.
826 color.diff.<slot>::
827         Use customized color for diff colorization.  `<slot>` specifies
828         which part of the patch to use the specified color, and is one
829         of `plain` (context text), `meta` (metainformation), `frag`
830         (hunk header), 'func' (function in hunk header), `old` (removed lines),
831         `new` (added lines), `commit` (commit headers), or `whitespace`
832         (highlighting whitespace errors). The values of these variables may be
833         specified as in color.branch.<slot>.
835 color.decorate.<slot>::
836         Use customized color for 'git log --decorate' output.  `<slot>` is one
837         of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
838         branches, remote-tracking branches, tags, stash and HEAD, respectively.
840 color.grep::
841         When set to `always`, always highlight matches.  When `false` (or
842         `never`), never.  When set to `true` or `auto`, use color only
843         when the output is written to the terminal.  Defaults to `false`.
845 color.grep.<slot>::
846         Use customized color for grep colorization.  `<slot>` specifies which
847         part of the line to use the specified color, and is one of
850 `context`;;
851         non-matching text in context lines (when using `-A`, `-B`, or `-C`)
852 `filename`;;
853         filename prefix (when not using `-h`)
854 `function`;;
855         function name lines (when using `-p`)
856 `linenumber`;;
857         line number prefix (when using `-n`)
858 `match`;;
859         matching text
860 `selected`;;
861         non-matching text in selected lines
862 `separator`;;
863         separators between fields on a line (`:`, `-`, and `=`)
864         and between hunks (`--`)
867 The values of these variables may be specified as in color.branch.<slot>.
869 color.interactive::
870         When set to `always`, always use colors for interactive prompts
871         and displays (such as those used by "git-add --interactive" and
872         "git-clean --interactive"). When false (or `never`), never.
873         When set to `true` or `auto`, use colors only when the output is
874         to the terminal. Defaults to false.
876 color.interactive.<slot>::
877         Use customized color for 'git add --interactive' and 'git clean
878         --interactive' output. `<slot>` may be `prompt`, `header`, `help`
879         or `error`, for four distinct types of normal output from
880         interactive commands.  The values of these variables may be
881         specified as in color.branch.<slot>.
883 color.pager::
884         A boolean to enable/disable colored output when the pager is in
885         use (default is true).
887 color.showbranch::
888         A boolean to enable/disable color in the output of
889         linkgit:git-show-branch[1]. May be set to `always`,
890         `false` (or `never`) or `auto` (or `true`), in which case colors are used
891         only when the output is to a terminal. Defaults to false.
893 color.status::
894         A boolean to enable/disable color in the output of
895         linkgit:git-status[1]. May be set to `always`,
896         `false` (or `never`) or `auto` (or `true`), in which case colors are used
897         only when the output is to a terminal. Defaults to false.
899 color.status.<slot>::
900         Use customized color for status colorization. `<slot>` is
901         one of `header` (the header text of the status message),
902         `added` or `updated` (files which are added but not committed),
903         `changed` (files which are changed but not added in the index),
904         `untracked` (files which are not tracked by Git),
905         `branch` (the current branch), or
906         `nobranch` (the color the 'no branch' warning is shown in, defaulting
907         to red). The values of these variables may be specified as in
908         color.branch.<slot>.
910 color.ui::
911         This variable determines the default value for variables such
912         as `color.diff` and `color.grep` that control the use of color
913         per command family. Its scope will expand as more commands learn
914         configuration to set a default for the `--color` option.  Set it
915         to `false` or `never` if you prefer Git commands not to use
916         color unless enabled explicitly with some other configuration
917         or the `--color` option. Set it to `always` if you want all
918         output not intended for machine consumption to use color, to
919         `true` or `auto` (this is the default since Git 1.8.4) if you
920         want such output to use color when written to the terminal.
922 column.ui::
923         Specify whether supported commands should output in columns.
924         This variable consists of a list of tokens separated by spaces
925         or commas:
927 These options control when the feature should be enabled
928 (defaults to 'never'):
931 `always`;;
932         always show in columns
933 `never`;;
934         never show in columns
935 `auto`;;
936         show in columns if the output is to the terminal
939 These options control layout (defaults to 'column').  Setting any
940 of these implies 'always' if none of 'always', 'never', or 'auto' are
941 specified.
944 `column`;;
945         fill columns before rows
946 `row`;;
947         fill rows before columns
948 `plain`;;
949         show in one column
952 Finally, these options can be combined with a layout option (defaults
953 to 'nodense'):
956 `dense`;;
957         make unequal size columns to utilize more space
958 `nodense`;;
959         make equal size columns
962 column.branch::
963         Specify whether to output branch listing in `git branch` in columns.
964         See `column.ui` for details.
966 column.clean::
967         Specify the layout when list items in `git clean -i`, which always
968         shows files and directories in columns. See `column.ui` for details.
970 column.status::
971         Specify whether to output untracked files in `git status` in columns.
972         See `column.ui` for details.
974 column.tag::
975         Specify whether to output tag listing in `git tag` in columns.
976         See `column.ui` for details.
978 commit.cleanup::
979         This setting overrides the default of the `--cleanup` option in
980         `git commit`. See linkgit:git-commit[1] for details. Changing the
981         default can be useful when you always want to keep lines that begin
982         with comment character `#` in your log message, in which case you
983         would do `git config commit.cleanup whitespace` (note that you will
984         have to remove the help lines that begin with `#` in the commit log
985         template yourself, if you do this).
987 commit.status::
988         A boolean to enable/disable inclusion of status information in the
989         commit message template when using an editor to prepare the commit
990         message.  Defaults to true.
992 commit.template::
993         Specify a file to use as the template for new commit messages.
994         "`~/`" is expanded to the value of `$HOME` and "`~user/`" to the
995         specified user's home directory.
997 credential.helper::
998         Specify an external helper to be called when a username or
999         password credential is needed; the helper may consult external
1000         storage to avoid prompting the user for the credentials. See
1001         linkgit:gitcredentials[7] for details.
1003 credential.useHttpPath::
1004         When acquiring credentials, consider the "path" component of an http
1005         or https URL to be important. Defaults to false. See
1006         linkgit:gitcredentials[7] for more information.
1008 credential.username::
1009         If no username is set for a network authentication, use this username
1010         by default. See credential.<context>.* below, and
1011         linkgit:gitcredentials[7].
1013 credential.<url>.*::
1014         Any of the credential.* options above can be applied selectively to
1015         some credentials. For example "credential.https://example.com.username"
1016         would set the default username only for https connections to
1017         example.com. See linkgit:gitcredentials[7] for details on how URLs are
1018         matched.
1020 include::diff-config.txt[]
1022 difftool.<tool>.path::
1023         Override the path for the given tool.  This is useful in case
1024         your tool is not in the PATH.
1026 difftool.<tool>.cmd::
1027         Specify the command to invoke the specified diff tool.
1028         The specified command is evaluated in shell with the following
1029         variables available:  'LOCAL' is set to the name of the temporary
1030         file containing the contents of the diff pre-image and 'REMOTE'
1031         is set to the name of the temporary file containing the contents
1032         of the diff post-image.
1034 difftool.prompt::
1035         Prompt before each invocation of the diff tool.
1037 fetch.recurseSubmodules::
1038         This option can be either set to a boolean value or to 'on-demand'.
1039         Setting it to a boolean changes the behavior of fetch and pull to
1040         unconditionally recurse into submodules when set to true or to not
1041         recurse at all when set to false. When set to 'on-demand' (the default
1042         value), fetch and pull will only recurse into a populated submodule
1043         when its superproject retrieves a commit that updates the submodule's
1044         reference.
1046 fetch.fsckObjects::
1047         If it is set to true, git-fetch-pack will check all fetched
1048         objects. It will abort in the case of a malformed object or a
1049         broken link. The result of an abort are only dangling objects.
1050         Defaults to false. If not set, the value of `transfer.fsckObjects`
1051         is used instead.
1053 fetch.unpackLimit::
1054         If the number of objects fetched over the Git native
1055         transfer is below this
1056         limit, then the objects will be unpacked into loose object
1057         files. However if the number of received objects equals or
1058         exceeds this limit then the received pack will be stored as
1059         a pack, after adding any missing delta bases.  Storing the
1060         pack from a push can make the push operation complete faster,
1061         especially on slow filesystems.  If not set, the value of
1062         `transfer.unpackLimit` is used instead.
1064 format.attach::
1065         Enable multipart/mixed attachments as the default for
1066         'format-patch'.  The value can also be a double quoted string
1067         which will enable attachments as the default and set the
1068         value as the boundary.  See the --attach option in
1069         linkgit:git-format-patch[1].
1071 format.numbered::
1072         A boolean which can enable or disable sequence numbers in patch
1073         subjects.  It defaults to "auto" which enables it only if there
1074         is more than one patch.  It can be enabled or disabled for all
1075         messages by setting it to "true" or "false".  See --numbered
1076         option in linkgit:git-format-patch[1].
1078 format.headers::
1079         Additional email headers to include in a patch to be submitted
1080         by mail.  See linkgit:git-format-patch[1].
1082 format.to::
1083 format.cc::
1084         Additional recipients to include in a patch to be submitted
1085         by mail.  See the --to and --cc options in
1086         linkgit:git-format-patch[1].
1088 format.subjectprefix::
1089         The default for format-patch is to output files with the '[PATCH]'
1090         subject prefix. Use this variable to change that prefix.
1092 format.signature::
1093         The default for format-patch is to output a signature containing
1094         the Git version number. Use this variable to change that default.
1095         Set this variable to the empty string ("") to suppress
1096         signature generation.
1098 format.suffix::
1099         The default for format-patch is to output files with the suffix
1100         `.patch`. Use this variable to change that suffix (make sure to
1101         include the dot if you want it).
1103 format.pretty::
1104         The default pretty format for log/show/whatchanged command,
1105         See linkgit:git-log[1], linkgit:git-show[1],
1106         linkgit:git-whatchanged[1].
1108 format.thread::
1109         The default threading style for 'git format-patch'.  Can be
1110         a boolean value, or `shallow` or `deep`.  `shallow` threading
1111         makes every mail a reply to the head of the series,
1112         where the head is chosen from the cover letter, the
1113         `--in-reply-to`, and the first patch mail, in this order.
1114         `deep` threading makes every mail a reply to the previous one.
1115         A true boolean value is the same as `shallow`, and a false
1116         value disables threading.
1118 format.signoff::
1119         A boolean value which lets you enable the `-s/--signoff` option of
1120         format-patch by default. *Note:* Adding the Signed-off-by: line to a
1121         patch should be a conscious act and means that you certify you have
1122         the rights to submit this work under the same open source license.
1123         Please see the 'SubmittingPatches' document for further discussion.
1125 format.coverLetter::
1126         A boolean that controls whether to generate a cover-letter when
1127         format-patch is invoked, but in addition can be set to "auto", to
1128         generate a cover-letter only when there's more than one patch.
1130 filter.<driver>.clean::
1131         The command which is used to convert the content of a worktree
1132         file to a blob upon checkin.  See linkgit:gitattributes[5] for
1133         details.
1135 filter.<driver>.smudge::
1136         The command which is used to convert the content of a blob
1137         object to a worktree file upon checkout.  See
1138         linkgit:gitattributes[5] for details.
1140 gc.aggressiveWindow::
1141         The window size parameter used in the delta compression
1142         algorithm used by 'git gc --aggressive'.  This defaults
1143         to 250.
1145 gc.auto::
1146         When there are approximately more than this many loose
1147         objects in the repository, `git gc --auto` will pack them.
1148         Some Porcelain commands use this command to perform a
1149         light-weight garbage collection from time to time.  The
1150         default value is 6700.  Setting this to 0 disables it.
1152 gc.autopacklimit::
1153         When there are more than this many packs that are not
1154         marked with `*.keep` file in the repository, `git gc
1155         --auto` consolidates them into one larger pack.  The
1156         default value is 50.  Setting this to 0 disables it.
1158 gc.packrefs::
1159         Running `git pack-refs` in a repository renders it
1160         unclonable by Git versions prior to 1.5.1.2 over dumb
1161         transports such as HTTP.  This variable determines whether
1162         'git gc' runs `git pack-refs`. This can be set to `notbare`
1163         to enable it within all non-bare repos or it can be set to a
1164         boolean value.  The default is `true`.
1166 gc.pruneexpire::
1167         When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1168         Override the grace period with this config variable.  The value
1169         "now" may be used to disable this  grace period and always prune
1170         unreachable objects immediately.
1172 gc.reflogexpire::
1173 gc.<pattern>.reflogexpire::
1174         'git reflog expire' removes reflog entries older than
1175         this time; defaults to 90 days.  With "<pattern>" (e.g.
1176         "refs/stash") in the middle the setting applies only to
1177         the refs that match the <pattern>.
1179 gc.reflogexpireunreachable::
1180 gc.<ref>.reflogexpireunreachable::
1181         'git reflog expire' removes reflog entries older than
1182         this time and are not reachable from the current tip;
1183         defaults to 30 days.  With "<pattern>" (e.g. "refs/stash")
1184         in the middle, the setting applies only to the refs that
1185         match the <pattern>.
1187 gc.rerereresolved::
1188         Records of conflicted merge you resolved earlier are
1189         kept for this many days when 'git rerere gc' is run.
1190         The default is 60 days.  See linkgit:git-rerere[1].
1192 gc.rerereunresolved::
1193         Records of conflicted merge you have not resolved are
1194         kept for this many days when 'git rerere gc' is run.
1195         The default is 15 days.  See linkgit:git-rerere[1].
1197 gitcvs.commitmsgannotation::
1198         Append this string to each commit message. Set to empty string
1199         to disable this feature. Defaults to "via git-CVS emulator".
1201 gitcvs.enabled::
1202         Whether the CVS server interface is enabled for this repository.
1203         See linkgit:git-cvsserver[1].
1205 gitcvs.logfile::
1206         Path to a log file where the CVS server interface well... logs
1207         various stuff. See linkgit:git-cvsserver[1].
1209 gitcvs.usecrlfattr::
1210         If true, the server will look up the end-of-line conversion
1211         attributes for files to determine the '-k' modes to use. If
1212         the attributes force Git to treat a file as text,
1213         the '-k' mode will be left blank so CVS clients will
1214         treat it as text. If they suppress text conversion, the file
1215         will be set with '-kb' mode, which suppresses any newline munging
1216         the client might otherwise do. If the attributes do not allow
1217         the file type to be determined, then 'gitcvs.allbinary' is
1218         used. See linkgit:gitattributes[5].
1220 gitcvs.allbinary::
1221         This is used if 'gitcvs.usecrlfattr' does not resolve
1222         the correct '-kb' mode to use. If true, all
1223         unresolved files are sent to the client in
1224         mode '-kb'. This causes the client to treat them
1225         as binary files, which suppresses any newline munging it
1226         otherwise might do. Alternatively, if it is set to "guess",
1227         then the contents of the file are examined to decide if
1228         it is binary, similar to 'core.autocrlf'.
1230 gitcvs.dbname::
1231         Database used by git-cvsserver to cache revision information
1232         derived from the Git repository. The exact meaning depends on the
1233         used database driver, for SQLite (which is the default driver) this
1234         is a filename. Supports variable substitution (see
1235         linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1236         Default: '%Ggitcvs.%m.sqlite'
1238 gitcvs.dbdriver::
1239         Used Perl DBI driver. You can specify any available driver
1240         for this here, but it might not work. git-cvsserver is tested
1241         with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1242         reported *not* to work with 'DBD::mysql'. Experimental feature.
1243         May not contain double colons (`:`). Default: 'SQLite'.
1244         See linkgit:git-cvsserver[1].
1246 gitcvs.dbuser, gitcvs.dbpass::
1247         Database user and password. Only useful if setting 'gitcvs.dbdriver',
1248         since SQLite has no concept of database users and/or passwords.
1249         'gitcvs.dbuser' supports variable substitution (see
1250         linkgit:git-cvsserver[1] for details).
1252 gitcvs.dbTableNamePrefix::
1253         Database table name prefix.  Prepended to the names of any
1254         database tables used, allowing a single database to be used
1255         for several repositories.  Supports variable substitution (see
1256         linkgit:git-cvsserver[1] for details).  Any non-alphabetic
1257         characters will be replaced with underscores.
1259 All gitcvs variables except for 'gitcvs.usecrlfattr' and
1260 'gitcvs.allbinary' can also be specified as
1261 'gitcvs.<access_method>.<varname>' (where 'access_method'
1262 is one of "ext" and "pserver") to make them apply only for the given
1263 access method.
1265 gitweb.category::
1266 gitweb.description::
1267 gitweb.owner::
1268 gitweb.url::
1269         See linkgit:gitweb[1] for description.
1271 gitweb.avatar::
1272 gitweb.blame::
1273 gitweb.grep::
1274 gitweb.highlight::
1275 gitweb.patches::
1276 gitweb.pickaxe::
1277 gitweb.remote_heads::
1278 gitweb.showsizes::
1279 gitweb.snapshot::
1280         See linkgit:gitweb.conf[5] for description.
1282 grep.lineNumber::
1283         If set to true, enable '-n' option by default.
1285 grep.patternType::
1286         Set the default matching behavior. Using a value of 'basic', 'extended',
1287         'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',
1288         '--fixed-strings', or '--perl-regexp' option accordingly, while the
1289         value 'default' will return to the default matching behavior.
1291 grep.extendedRegexp::
1292         If set to true, enable '--extended-regexp' option by default. This
1293         option is ignored when the 'grep.patternType' option is set to a value
1294         other than 'default'.
1296 gpg.program::
1297         Use this custom program instead of "gpg" found on $PATH when
1298         making or verifying a PGP signature. The program must support the
1299         same command line interface as GPG, namely, to verify a detached
1300         signature, "gpg --verify $file - <$signature" is run, and the
1301         program is expected to signal a good signature by exiting with
1302         code 0, and to generate an ascii-armored detached signature, the
1303         standard input of "gpg -bsau $key" is fed with the contents to be
1304         signed, and the program is expected to send the result to its
1305         standard output.
1307 gui.commitmsgwidth::
1308         Defines how wide the commit message window is in the
1309         linkgit:git-gui[1]. "75" is the default.
1311 gui.diffcontext::
1312         Specifies how many context lines should be used in calls to diff
1313         made by the linkgit:git-gui[1]. The default is "5".
1315 gui.encoding::
1316         Specifies the default encoding to use for displaying of
1317         file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1318         It can be overridden by setting the 'encoding' attribute
1319         for relevant files (see linkgit:gitattributes[5]).
1320         If this option is not set, the tools default to the
1321         locale encoding.
1323 gui.matchtrackingbranch::
1324         Determines if new branches created with linkgit:git-gui[1] should
1325         default to tracking remote branches with matching names or
1326         not. Default: "false".
1328 gui.newbranchtemplate::
1329         Is used as suggested name when creating new branches using the
1330         linkgit:git-gui[1].
1332 gui.pruneduringfetch::
1333         "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1334         performing a fetch. The default value is "false".
1336 gui.trustmtime::
1337         Determines if linkgit:git-gui[1] should trust the file modification
1338         timestamp or not. By default the timestamps are not trusted.
1340 gui.spellingdictionary::
1341         Specifies the dictionary used for spell checking commit messages in
1342         the linkgit:git-gui[1]. When set to "none" spell checking is turned
1343         off.
1345 gui.fastcopyblame::
1346         If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1347         location detection. It makes blame significantly faster on huge
1348         repositories at the expense of less thorough copy detection.
1350 gui.copyblamethreshold::
1351         Specifies the threshold to use in 'git gui blame' original location
1352         detection, measured in alphanumeric characters. See the
1353         linkgit:git-blame[1] manual for more information on copy detection.
1355 gui.blamehistoryctx::
1356         Specifies the radius of history context in days to show in
1357         linkgit:gitk[1] for the selected commit, when the `Show History
1358         Context` menu item is invoked from 'git gui blame'. If this
1359         variable is set to zero, the whole history is shown.
1361 guitool.<name>.cmd::
1362         Specifies the shell command line to execute when the corresponding item
1363         of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1364         mandatory for every tool. The command is executed from the root of
1365         the working directory, and in the environment it receives the name of
1366         the tool as 'GIT_GUITOOL', the name of the currently selected file as
1367         'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1368         the head is detached, 'CUR_BRANCH' is empty).
1370 guitool.<name>.needsfile::
1371         Run the tool only if a diff is selected in the GUI. It guarantees
1372         that 'FILENAME' is not empty.
1374 guitool.<name>.noconsole::
1375         Run the command silently, without creating a window to display its
1376         output.
1378 guitool.<name>.norescan::
1379         Don't rescan the working directory for changes after the tool
1380         finishes execution.
1382 guitool.<name>.confirm::
1383         Show a confirmation dialog before actually running the tool.
1385 guitool.<name>.argprompt::
1386         Request a string argument from the user, and pass it to the tool
1387         through the 'ARGS' environment variable. Since requesting an
1388         argument implies confirmation, the 'confirm' option has no effect
1389         if this is enabled. If the option is set to 'true', 'yes', or '1',
1390         the dialog uses a built-in generic prompt; otherwise the exact
1391         value of the variable is used.
1393 guitool.<name>.revprompt::
1394         Request a single valid revision from the user, and set the
1395         'REVISION' environment variable. In other aspects this option
1396         is similar to 'argprompt', and can be used together with it.
1398 guitool.<name>.revunmerged::
1399         Show only unmerged branches in the 'revprompt' subdialog.
1400         This is useful for tools similar to merge or rebase, but not
1401         for things like checkout or reset.
1403 guitool.<name>.title::
1404         Specifies the title to use for the prompt dialog. The default
1405         is the tool name.
1407 guitool.<name>.prompt::
1408         Specifies the general prompt string to display at the top of
1409         the dialog, before subsections for 'argprompt' and 'revprompt'.
1410         The default value includes the actual command.
1412 help.browser::
1413         Specify the browser that will be used to display help in the
1414         'web' format. See linkgit:git-help[1].
1416 help.format::
1417         Override the default help format used by linkgit:git-help[1].
1418         Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1419         the default. 'web' and 'html' are the same.
1421 help.autocorrect::
1422         Automatically correct and execute mistyped commands after
1423         waiting for the given number of deciseconds (0.1 sec). If more
1424         than one command can be deduced from the entered text, nothing
1425         will be executed.  If the value of this option is negative,
1426         the corrected command will be executed immediately. If the
1427         value is 0 - the command will be just shown but not executed.
1428         This is the default.
1430 help.htmlpath::
1431         Specify the path where the HTML documentation resides. File system paths
1432         and URLs are supported. HTML pages will be prefixed with this path when
1433         help is displayed in the 'web' format. This defaults to the documentation
1434         path of your Git installation.
1436 http.proxy::
1437         Override the HTTP proxy, normally configured using the 'http_proxy',
1438         'https_proxy', and 'all_proxy' environment variables (see
1439         `curl(1)`).  This can be overridden on a per-remote basis; see
1440         remote.<name>.proxy
1442 http.cookiefile::
1443         File containing previously stored cookie lines which should be used
1444         in the Git http session, if they match the server. The file format
1445         of the file to read cookies from should be plain HTTP headers or
1446         the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
1447         NOTE that the file specified with http.cookiefile is only used as
1448         input. No cookies will be stored in the file.
1450 http.sslVerify::
1451         Whether to verify the SSL certificate when fetching or pushing
1452         over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1453         variable.
1455 http.sslCert::
1456         File containing the SSL certificate when fetching or pushing
1457         over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1458         variable.
1460 http.sslKey::
1461         File containing the SSL private key when fetching or pushing
1462         over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1463         variable.
1465 http.sslCertPasswordProtected::
1466         Enable Git's password prompt for the SSL certificate.  Otherwise
1467         OpenSSL will prompt the user, possibly many times, if the
1468         certificate or private key is encrypted.  Can be overridden by the
1469         'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1471 http.sslCAInfo::
1472         File containing the certificates to verify the peer with when
1473         fetching or pushing over HTTPS. Can be overridden by the
1474         'GIT_SSL_CAINFO' environment variable.
1476 http.sslCAPath::
1477         Path containing files with the CA certificates to verify the peer
1478         with when fetching or pushing over HTTPS. Can be overridden
1479         by the 'GIT_SSL_CAPATH' environment variable.
1481 http.sslTry::
1482         Attempt to use AUTH SSL/TLS and encrypted data transfers
1483         when connecting via regular FTP protocol. This might be needed
1484         if the FTP server requires it for security reasons or you wish
1485         to connect securely whenever remote FTP server supports it.
1486         Default is false since it might trigger certificate verification
1487         errors on misconfigured servers.
1489 http.maxRequests::
1490         How many HTTP requests to launch in parallel. Can be overridden
1491         by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1493 http.minSessions::
1494         The number of curl sessions (counted across slots) to be kept across
1495         requests. They will not be ended with curl_easy_cleanup() until
1496         http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1497         value will be capped at 1. Defaults to 1.
1499 http.postBuffer::
1500         Maximum size in bytes of the buffer used by smart HTTP
1501         transports when POSTing data to the remote system.
1502         For requests larger than this buffer size, HTTP/1.1 and
1503         Transfer-Encoding: chunked is used to avoid creating a
1504         massive pack file locally.  Default is 1 MiB, which is
1505         sufficient for most requests.
1507 http.lowSpeedLimit, http.lowSpeedTime::
1508         If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1509         for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1510         Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1511         'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1513 http.noEPSV::
1514         A boolean which disables using of EPSV ftp command by curl.
1515         This can helpful with some "poor" ftp servers which don't
1516         support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1517         environment variable. Default is false (curl will use EPSV).
1519 http.useragent::
1520         The HTTP USER_AGENT string presented to an HTTP server.  The default
1521         value represents the version of the client Git such as git/1.7.1.
1522         This option allows you to override this value to a more common value
1523         such as Mozilla/4.0.  This may be necessary, for instance, if
1524         connecting through a firewall that restricts HTTP connections to a set
1525         of common USER_AGENT strings (but not including those like git/1.7.1).
1526         Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1528 i18n.commitEncoding::
1529         Character encoding the commit messages are stored in; Git itself
1530         does not care per se, but this information is necessary e.g. when
1531         importing commits from emails or in the gitk graphical history
1532         browser (and possibly at other places in the future or in other
1533         porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1535 i18n.logOutputEncoding::
1536         Character encoding the commit messages are converted to when
1537         running 'git log' and friends.
1539 imap::
1540         The configuration variables in the 'imap' section are described
1541         in linkgit:git-imap-send[1].
1543 init.templatedir::
1544         Specify the directory from which templates will be copied.
1545         (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1547 instaweb.browser::
1548         Specify the program that will be used to browse your working
1549         repository in gitweb. See linkgit:git-instaweb[1].
1551 instaweb.httpd::
1552         The HTTP daemon command-line to start gitweb on your working
1553         repository. See linkgit:git-instaweb[1].
1555 instaweb.local::
1556         If true the web server started by linkgit:git-instaweb[1] will
1557         be bound to the local IP (127.0.0.1).
1559 instaweb.modulepath::
1560         The default module path for linkgit:git-instaweb[1] to use
1561         instead of /usr/lib/apache2/modules.  Only used if httpd
1562         is Apache.
1564 instaweb.port::
1565         The port number to bind the gitweb httpd to. See
1566         linkgit:git-instaweb[1].
1568 interactive.singlekey::
1569         In interactive commands, allow the user to provide one-letter
1570         input with a single key (i.e., without hitting enter).
1571         Currently this is used by the `--patch` mode of
1572         linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1573         linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1574         setting is silently ignored if portable keystroke input
1575         is not available.
1577 log.abbrevCommit::
1578         If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1579         linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
1580         override this option with `--no-abbrev-commit`.
1582 log.date::
1583         Set the default date-time mode for the 'log' command.
1584         Setting a value for log.date is similar to using 'git log''s
1585         `--date` option.  Possible values are `relative`, `local`,
1586         `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1587         for details.
1589 log.decorate::
1590         Print out the ref names of any commits that are shown by the log
1591         command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1592         'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1593         specified, the full ref name (including prefix) will be printed.
1594         This is the same as the log commands '--decorate' option.
1596 log.showroot::
1597         If true, the initial commit will be shown as a big creation event.
1598         This is equivalent to a diff against an empty tree.
1599         Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1600         normally hide the root commit will now show it. True by default.
1602 log.mailmap::
1603         If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1604         linkgit:git-whatchanged[1] assume `--use-mailmap`.
1606 mailmap.file::
1607         The location of an augmenting mailmap file. The default
1608         mailmap, located in the root of the repository, is loaded
1609         first, then the mailmap file pointed to by this variable.
1610         The location of the mailmap file may be in a repository
1611         subdirectory, or somewhere outside of the repository itself.
1612         See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1614 mailmap.blob::
1615         Like `mailmap.file`, but consider the value as a reference to a
1616         blob in the repository. If both `mailmap.file` and
1617         `mailmap.blob` are given, both are parsed, with entries from
1618         `mailmap.file` taking precedence. In a bare repository, this
1619         defaults to `HEAD:.mailmap`. In a non-bare repository, it
1620         defaults to empty.
1622 man.viewer::
1623         Specify the programs that may be used to display help in the
1624         'man' format. See linkgit:git-help[1].
1626 man.<tool>.cmd::
1627         Specify the command to invoke the specified man viewer. The
1628         specified command is evaluated in shell with the man page
1629         passed as argument. (See linkgit:git-help[1].)
1631 man.<tool>.path::
1632         Override the path for the given tool that may be used to
1633         display help in the 'man' format. See linkgit:git-help[1].
1635 include::merge-config.txt[]
1637 mergetool.<tool>.path::
1638         Override the path for the given tool.  This is useful in case
1639         your tool is not in the PATH.
1641 mergetool.<tool>.cmd::
1642         Specify the command to invoke the specified merge tool.  The
1643         specified command is evaluated in shell with the following
1644         variables available: 'BASE' is the name of a temporary file
1645         containing the common base of the files to be merged, if available;
1646         'LOCAL' is the name of a temporary file containing the contents of
1647         the file on the current branch; 'REMOTE' is the name of a temporary
1648         file containing the contents of the file from the branch being
1649         merged; 'MERGED' contains the name of the file to which the merge
1650         tool should write the results of a successful merge.
1652 mergetool.<tool>.trustExitCode::
1653         For a custom merge command, specify whether the exit code of
1654         the merge command can be used to determine whether the merge was
1655         successful.  If this is not set to true then the merge target file
1656         timestamp is checked and the merge assumed to have been successful
1657         if the file has been updated, otherwise the user is prompted to
1658         indicate the success of the merge.
1660 mergetool.keepBackup::
1661         After performing a merge, the original file with conflict markers
1662         can be saved as a file with a `.orig` extension.  If this variable
1663         is set to `false` then this file is not preserved.  Defaults to
1664         `true` (i.e. keep the backup files).
1666 mergetool.keepTemporaries::
1667         When invoking a custom merge tool, Git uses a set of temporary
1668         files to pass to the tool. If the tool returns an error and this
1669         variable is set to `true`, then these temporary files will be
1670         preserved, otherwise they will be removed after the tool has
1671         exited. Defaults to `false`.
1673 mergetool.prompt::
1674         Prompt before each invocation of the merge resolution program.
1676 notes.displayRef::
1677         The (fully qualified) refname from which to show notes when
1678         showing commit messages.  The value of this variable can be set
1679         to a glob, in which case notes from all matching refs will be
1680         shown.  You may also specify this configuration variable
1681         several times.  A warning will be issued for refs that do not
1682         exist, but a glob that does not match any refs is silently
1683         ignored.
1685 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1686 environment variable, which must be a colon separated list of refs or
1687 globs.
1689 The effective value of "core.notesRef" (possibly overridden by
1690 GIT_NOTES_REF) is also implicitly added to the list of refs to be
1691 displayed.
1693 notes.rewrite.<command>::
1694         When rewriting commits with <command> (currently `amend` or
1695         `rebase`) and this variable is set to `true`, Git
1696         automatically copies your notes from the original to the
1697         rewritten commit.  Defaults to `true`, but see
1698         "notes.rewriteRef" below.
1700 notes.rewriteMode::
1701         When copying notes during a rewrite (see the
1702         "notes.rewrite.<command>" option), determines what to do if
1703         the target commit already has a note.  Must be one of
1704         `overwrite`, `concatenate`, or `ignore`.  Defaults to
1705         `concatenate`.
1707 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1708 environment variable.
1710 notes.rewriteRef::
1711         When copying notes during a rewrite, specifies the (fully
1712         qualified) ref whose notes should be copied.  The ref may be a
1713         glob, in which case notes in all matching refs will be copied.
1714         You may also specify this configuration several times.
1716 Does not have a default value; you must configure this variable to
1717 enable note rewriting.  Set it to `refs/notes/commits` to enable
1718 rewriting for the default commit notes.
1720 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1721 environment variable, which must be a colon separated list of refs or
1722 globs.
1724 pack.window::
1725         The size of the window used by linkgit:git-pack-objects[1] when no
1726         window size is given on the command line. Defaults to 10.
1728 pack.depth::
1729         The maximum delta depth used by linkgit:git-pack-objects[1] when no
1730         maximum depth is given on the command line. Defaults to 50.
1732 pack.windowMemory::
1733         The window memory size limit used by linkgit:git-pack-objects[1]
1734         when no limit is given on the command line.  The value can be
1735         suffixed with "k", "m", or "g".  Defaults to 0, meaning no
1736         limit.
1738 pack.compression::
1739         An integer -1..9, indicating the compression level for objects
1740         in a pack file. -1 is the zlib default. 0 means no
1741         compression, and 1..9 are various speed/size tradeoffs, 9 being
1742         slowest.  If not set,  defaults to core.compression.  If that is
1743         not set,  defaults to -1, the zlib default, which is "a default
1744         compromise between speed and compression (currently equivalent
1745         to level 6)."
1747 Note that changing the compression level will not automatically recompress
1748 all existing objects. You can force recompression by passing the -F option
1749 to linkgit:git-repack[1].
1751 pack.deltaCacheSize::
1752         The maximum memory in bytes used for caching deltas in
1753         linkgit:git-pack-objects[1] before writing them out to a pack.
1754         This cache is used to speed up the writing object phase by not
1755         having to recompute the final delta result once the best match
1756         for all objects is found.  Repacking large repositories on machines
1757         which are tight with memory might be badly impacted by this though,
1758         especially if this cache pushes the system into swapping.
1759         A value of 0 means no limit. The smallest size of 1 byte may be
1760         used to virtually disable this cache. Defaults to 256 MiB.
1762 pack.deltaCacheLimit::
1763         The maximum size of a delta, that is cached in
1764         linkgit:git-pack-objects[1]. This cache is used to speed up the
1765         writing object phase by not having to recompute the final delta
1766         result once the best match for all objects is found. Defaults to 1000.
1768 pack.threads::
1769         Specifies the number of threads to spawn when searching for best
1770         delta matches.  This requires that linkgit:git-pack-objects[1]
1771         be compiled with pthreads otherwise this option is ignored with a
1772         warning. This is meant to reduce packing time on multiprocessor
1773         machines. The required amount of memory for the delta search window
1774         is however multiplied by the number of threads.
1775         Specifying 0 will cause Git to auto-detect the number of CPU's
1776         and set the number of threads accordingly.
1778 pack.indexVersion::
1779         Specify the default pack index version.  Valid values are 1 for
1780         legacy pack index used by Git versions prior to 1.5.2, and 2 for
1781         the new pack index with capabilities for packs larger than 4 GB
1782         as well as proper protection against the repacking of corrupted
1783         packs.  Version 2 is the default.  Note that version 2 is enforced
1784         and this config option ignored whenever the corresponding pack is
1785         larger than 2 GB.
1787 If you have an old Git that does not understand the version 2 `*.idx` file,
1788 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1789 that will copy both `*.pack` file and corresponding `*.idx` file from the
1790 other side may give you a repository that cannot be accessed with your
1791 older version of Git. If the `*.pack` file is smaller than 2 GB, however,
1792 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1793 the `*.idx` file.
1795 pack.packSizeLimit::
1796         The maximum size of a pack.  This setting only affects
1797         packing to a file when repacking, i.e. the git:// protocol
1798         is unaffected.  It can be overridden by the `--max-pack-size`
1799         option of linkgit:git-repack[1]. The minimum size allowed is
1800         limited to 1 MiB. The default is unlimited.
1801         Common unit suffixes of 'k', 'm', or 'g' are
1802         supported.
1804 pager.<cmd>::
1805         If the value is boolean, turns on or off pagination of the
1806         output of a particular Git subcommand when writing to a tty.
1807         Otherwise, turns on pagination for the subcommand using the
1808         pager specified by the value of `pager.<cmd>`.  If `--paginate`
1809         or `--no-pager` is specified on the command line, it takes
1810         precedence over this option.  To disable pagination for all
1811         commands, set `core.pager` or `GIT_PAGER` to `cat`.
1813 pretty.<name>::
1814         Alias for a --pretty= format string, as specified in
1815         linkgit:git-log[1]. Any aliases defined here can be used just
1816         as the built-in pretty formats could. For example,
1817         running `git config pretty.changelog "format:* %H %s"`
1818         would cause the invocation `git log --pretty=changelog`
1819         to be equivalent to running `git log "--pretty=format:* %H %s"`.
1820         Note that an alias with the same name as a built-in format
1821         will be silently ignored.
1823 pull.rebase::
1824         When true, rebase branches on top of the fetched branch, instead
1825         of merging the default branch from the default remote when "git
1826         pull" is run. See "branch.<name>.rebase" for setting this on a
1827         per-branch basis.
1829 *NOTE*: this is a possibly dangerous operation; do *not* use
1830 it unless you understand the implications (see linkgit:git-rebase[1]
1831 for details).
1833 pull.octopus::
1834         The default merge strategy to use when pulling multiple branches
1835         at once.
1837 pull.twohead::
1838         The default merge strategy to use when pulling a single branch.
1840 push.default::
1841         Defines the action `git push` should take if no refspec is
1842         explicitly given.  Different values are well-suited for
1843         specific workflows; for instance, in a purely central workflow
1844         (i.e. the fetch source is equal to the push destination),
1845         `upstream` is probably what you want.  Possible values are:
1849 * `nothing` - do not push anything (error out) unless a refspec is
1850   explicitly given. This is primarily meant for people who want to
1851   avoid mistakes by always being explicit.
1853 * `current` - push the current branch to update a branch with the same
1854   name on the receiving end.  Works in both central and non-central
1855   workflows.
1857 * `upstream` - push the current branch back to the branch whose
1858   changes are usually integrated into the current branch (which is
1859   called `@{upstream}`).  This mode only makes sense if you are
1860   pushing to the same repository you would normally pull from
1861   (i.e. central workflow).
1863 * `simple` - in centralized workflow, work like `upstream` with an
1864   added safety to refuse to push if the upstream branch's name is
1865   different from the local one.
1867 When pushing to a remote that is different from the remote you normally
1868 pull from, work as `current`.  This is the safest option and is suited
1869 for beginners.
1871 This mode will become the default in Git 2.0.
1873 * `matching` - push all branches having the same name on both ends.
1874   This makes the repository you are pushing to remember the set of
1875   branches that will be pushed out (e.g. if you always push 'maint'
1876   and 'master' there and no other branches, the repository you push
1877   to will have these two branches, and your local 'maint' and
1878   'master' will be pushed there).
1880 To use this mode effectively, you have to make sure _all_ the
1881 branches you would push out are ready to be pushed out before
1882 running 'git push', as the whole point of this mode is to allow you
1883 to push all of the branches in one go.  If you usually finish work
1884 on only one branch and push out the result, while other branches are
1885 unfinished, this mode is not for you.  Also this mode is not
1886 suitable for pushing into a shared central repository, as other
1887 people may add new branches there, or update the tip of existing
1888 branches outside your control.
1890 This is currently the default, but Git 2.0 will change the default
1891 to `simple`.
1895 rebase.stat::
1896         Whether to show a diffstat of what changed upstream since the last
1897         rebase. False by default.
1899 rebase.autosquash::
1900         If set to true enable '--autosquash' option by default.
1902 rebase.autostash::
1903         When set to true, automatically create a temporary stash
1904         before the operation begins, and apply it after the operation
1905         ends.  This means that you can run rebase on a dirty worktree.
1906         However, use with care: the final stash application after a
1907         successful rebase might result in non-trivial conflicts.
1908         Defaults to false.
1910 receive.autogc::
1911         By default, git-receive-pack will run "git-gc --auto" after
1912         receiving data from git-push and updating refs.  You can stop
1913         it by setting this variable to false.
1915 receive.fsckObjects::
1916         If it is set to true, git-receive-pack will check all received
1917         objects. It will abort in the case of a malformed object or a
1918         broken link. The result of an abort are only dangling objects.
1919         Defaults to false. If not set, the value of `transfer.fsckObjects`
1920         is used instead.
1922 receive.unpackLimit::
1923         If the number of objects received in a push is below this
1924         limit then the objects will be unpacked into loose object
1925         files. However if the number of received objects equals or
1926         exceeds this limit then the received pack will be stored as
1927         a pack, after adding any missing delta bases.  Storing the
1928         pack from a push can make the push operation complete faster,
1929         especially on slow filesystems.  If not set, the value of
1930         `transfer.unpackLimit` is used instead.
1932 receive.denyDeletes::
1933         If set to true, git-receive-pack will deny a ref update that deletes
1934         the ref. Use this to prevent such a ref deletion via a push.
1936 receive.denyDeleteCurrent::
1937         If set to true, git-receive-pack will deny a ref update that
1938         deletes the currently checked out branch of a non-bare repository.
1940 receive.denyCurrentBranch::
1941         If set to true or "refuse", git-receive-pack will deny a ref update
1942         to the currently checked out branch of a non-bare repository.
1943         Such a push is potentially dangerous because it brings the HEAD
1944         out of sync with the index and working tree. If set to "warn",
1945         print a warning of such a push to stderr, but allow the push to
1946         proceed. If set to false or "ignore", allow such pushes with no
1947         message. Defaults to "refuse".
1949 receive.denyNonFastForwards::
1950         If set to true, git-receive-pack will deny a ref update which is
1951         not a fast-forward. Use this to prevent such an update via a push,
1952         even if that push is forced. This configuration variable is
1953         set when initializing a shared repository.
1955 receive.hiderefs::
1956         String(s) `receive-pack` uses to decide which refs to omit
1957         from its initial advertisement.  Use more than one
1958         definitions to specify multiple prefix strings. A ref that
1959         are under the hierarchies listed on the value of this
1960         variable is excluded, and is hidden when responding to `git
1961         push`, and an attempt to update or delete a hidden ref by
1962         `git push` is rejected.
1964 receive.updateserverinfo::
1965         If set to true, git-receive-pack will run git-update-server-info
1966         after receiving data from git-push and updating refs.
1968 remote.pushdefault::
1969         The remote to push to by default.  Overrides
1970         `branch.<name>.remote` for all branches, and is overridden by
1971         `branch.<name>.pushremote` for specific branches.
1973 remote.<name>.url::
1974         The URL of a remote repository.  See linkgit:git-fetch[1] or
1975         linkgit:git-push[1].
1977 remote.<name>.pushurl::
1978         The push URL of a remote repository.  See linkgit:git-push[1].
1980 remote.<name>.proxy::
1981         For remotes that require curl (http, https and ftp), the URL to
1982         the proxy to use for that remote.  Set to the empty string to
1983         disable proxying for that remote.
1985 remote.<name>.fetch::
1986         The default set of "refspec" for linkgit:git-fetch[1]. See
1987         linkgit:git-fetch[1].
1989 remote.<name>.push::
1990         The default set of "refspec" for linkgit:git-push[1]. See
1991         linkgit:git-push[1].
1993 remote.<name>.mirror::
1994         If true, pushing to this remote will automatically behave
1995         as if the `--mirror` option was given on the command line.
1997 remote.<name>.skipDefaultUpdate::
1998         If true, this remote will be skipped by default when updating
1999         using linkgit:git-fetch[1] or the `update` subcommand of
2000         linkgit:git-remote[1].
2002 remote.<name>.skipFetchAll::
2003         If true, this remote will be skipped by default when updating
2004         using linkgit:git-fetch[1] or the `update` subcommand of
2005         linkgit:git-remote[1].
2007 remote.<name>.receivepack::
2008         The default program to execute on the remote side when pushing.  See
2009         option \--receive-pack of linkgit:git-push[1].
2011 remote.<name>.uploadpack::
2012         The default program to execute on the remote side when fetching.  See
2013         option \--upload-pack of linkgit:git-fetch-pack[1].
2015 remote.<name>.tagopt::
2016         Setting this value to \--no-tags disables automatic tag following when
2017         fetching from remote <name>. Setting it to \--tags will fetch every
2018         tag from remote <name>, even if they are not reachable from remote
2019         branch heads. Passing these flags directly to linkgit:git-fetch[1] can
2020         override this setting. See options \--tags and \--no-tags of
2021         linkgit:git-fetch[1].
2023 remote.<name>.vcs::
2024         Setting this to a value <vcs> will cause Git to interact with
2025         the remote with the git-remote-<vcs> helper.
2027 remotes.<group>::
2028         The list of remotes which are fetched by "git remote update
2029         <group>".  See linkgit:git-remote[1].
2031 repack.usedeltabaseoffset::
2032         By default, linkgit:git-repack[1] creates packs that use
2033         delta-base offset. If you need to share your repository with
2034         Git older than version 1.4.4, either directly or via a dumb
2035         protocol such as http, then you need to set this option to
2036         "false" and repack. Access from old Git versions over the
2037         native protocol are unaffected by this option.
2039 rerere.autoupdate::
2040         When set to true, `git-rerere` updates the index with the
2041         resulting contents after it cleanly resolves conflicts using
2042         previously recorded resolution.  Defaults to false.
2044 rerere.enabled::
2045         Activate recording of resolved conflicts, so that identical
2046         conflict hunks can be resolved automatically, should they be
2047         encountered again.  By default, linkgit:git-rerere[1] is
2048         enabled if there is an `rr-cache` directory under the
2049         `$GIT_DIR`, e.g. if "rerere" was previously used in the
2050         repository.
2052 sendemail.identity::
2053         A configuration identity. When given, causes values in the
2054         'sendemail.<identity>' subsection to take precedence over
2055         values in the 'sendemail' section. The default identity is
2056         the value of 'sendemail.identity'.
2058 sendemail.smtpencryption::
2059         See linkgit:git-send-email[1] for description.  Note that this
2060         setting is not subject to the 'identity' mechanism.
2062 sendemail.smtpssl::
2063         Deprecated alias for 'sendemail.smtpencryption = ssl'.
2065 sendemail.smtpsslcertpath::
2066         Path to ca-certificates (either a directory or a single file).
2067         Set it to an empty string to disable certificate verification.
2069 sendemail.<identity>.*::
2070         Identity-specific versions of the 'sendemail.*' parameters
2071         found below, taking precedence over those when the this
2072         identity is selected, through command-line or
2073         'sendemail.identity'.
2075 sendemail.aliasesfile::
2076 sendemail.aliasfiletype::
2077 sendemail.annotate::
2078 sendemail.bcc::
2079 sendemail.cc::
2080 sendemail.cccmd::
2081 sendemail.chainreplyto::
2082 sendemail.confirm::
2083 sendemail.envelopesender::
2084 sendemail.from::
2085 sendemail.multiedit::
2086 sendemail.signedoffbycc::
2087 sendemail.smtppass::
2088 sendemail.suppresscc::
2089 sendemail.suppressfrom::
2090 sendemail.to::
2091 sendemail.smtpdomain::
2092 sendemail.smtpserver::
2093 sendemail.smtpserverport::
2094 sendemail.smtpserveroption::
2095 sendemail.smtpuser::
2096 sendemail.thread::
2097 sendemail.validate::
2098         See linkgit:git-send-email[1] for description.
2100 sendemail.signedoffcc::
2101         Deprecated alias for 'sendemail.signedoffbycc'.
2103 showbranch.default::
2104         The default set of branches for linkgit:git-show-branch[1].
2105         See linkgit:git-show-branch[1].
2107 status.relativePaths::
2108         By default, linkgit:git-status[1] shows paths relative to the
2109         current directory. Setting this variable to `false` shows paths
2110         relative to the repository root (this was the default for Git
2111         prior to v1.5.4).
2113 status.short::
2114         Set to true to enable --short by default in linkgit:git-status[1].
2115         The option --no-short takes precedence over this variable.
2117 status.branch::
2118         Set to true to enable --branch by default in linkgit:git-status[1].
2119         The option --no-branch takes precedence over this variable.
2121 status.showUntrackedFiles::
2122         By default, linkgit:git-status[1] and linkgit:git-commit[1] show
2123         files which are not currently tracked by Git. Directories which
2124         contain only untracked files, are shown with the directory name
2125         only. Showing untracked files means that Git needs to lstat() all
2126         all the files in the whole repository, which might be slow on some
2127         systems. So, this variable controls how the commands displays
2128         the untracked files. Possible values are:
2131 * `no` - Show no untracked files.
2132 * `normal` - Show untracked files and directories.
2133 * `all` - Show also individual files in untracked directories.
2136 If this variable is not specified, it defaults to 'normal'.
2137 This variable can be overridden with the -u|--untracked-files option
2138 of linkgit:git-status[1] and linkgit:git-commit[1].
2140 status.submodulesummary::
2141         Defaults to false.
2142         If this is set to a non zero number or true (identical to -1 or an
2143         unlimited number), the submodule summary will be enabled and a
2144         summary of commits for modified submodules will be shown (see
2145         --summary-limit option of linkgit:git-submodule[1]).
2147 submodule.<name>.path::
2148 submodule.<name>.url::
2149 submodule.<name>.update::
2150         The path within this project, URL, and the updating strategy
2151         for a submodule.  These variables are initially populated
2152         by 'git submodule init'; edit them to override the
2153         URL and other values found in the `.gitmodules` file.  See
2154         linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
2156 submodule.<name>.branch::
2157         The remote branch name for a submodule, used by `git submodule
2158         update --remote`.  Set this option to override the value found in
2159         the `.gitmodules` file.  See linkgit:git-submodule[1] and
2160         linkgit:gitmodules[5] for details.
2162 submodule.<name>.fetchRecurseSubmodules::
2163         This option can be used to control recursive fetching of this
2164         submodule. It can be overridden by using the --[no-]recurse-submodules
2165         command line option to "git fetch" and "git pull".
2166         This setting will override that from in the linkgit:gitmodules[5]
2167         file.
2169 submodule.<name>.ignore::
2170         Defines under what circumstances "git status" and the diff family show
2171         a submodule as modified. When set to "all", it will never be considered
2172         modified, "dirty" will ignore all changes to the submodules work tree and
2173         takes only differences between the HEAD of the submodule and the commit
2174         recorded in the superproject into account. "untracked" will additionally
2175         let submodules with modified tracked files in their work tree show up.
2176         Using "none" (the default when this option is not set) also shows
2177         submodules that have untracked files in their work tree as changed.
2178         This setting overrides any setting made in .gitmodules for this submodule,
2179         both settings can be overridden on the command line by using the
2180         "--ignore-submodules" option.
2182 tar.umask::
2183         This variable can be used to restrict the permission bits of
2184         tar archive entries.  The default is 0002, which turns off the
2185         world write bit.  The special value "user" indicates that the
2186         archiving user's umask will be used instead.  See umask(2) and
2187         linkgit:git-archive[1].
2189 transfer.fsckObjects::
2190         When `fetch.fsckObjects` or `receive.fsckObjects` are
2191         not set, the value of this variable is used instead.
2192         Defaults to false.
2194 transfer.hiderefs::
2195         This variable can be used to set both `receive.hiderefs`
2196         and `uploadpack.hiderefs` at the same time to the same
2197         values.  See entries for these other variables.
2199 transfer.unpackLimit::
2200         When `fetch.unpackLimit` or `receive.unpackLimit` are
2201         not set, the value of this variable is used instead.
2202         The default value is 100.
2204 uploadpack.hiderefs::
2205         String(s) `upload-pack` uses to decide which refs to omit
2206         from its initial advertisement.  Use more than one
2207         definitions to specify multiple prefix strings. A ref that
2208         are under the hierarchies listed on the value of this
2209         variable is excluded, and is hidden from `git ls-remote`,
2210         `git fetch`, etc.  An attempt to fetch a hidden ref by `git
2211         fetch` will fail.  See also `uploadpack.allowtipsha1inwant`.
2213 uploadpack.allowtipsha1inwant::
2214         When `uploadpack.hiderefs` is in effect, allow `upload-pack`
2215         to accept a fetch request that asks for an object at the tip
2216         of a hidden ref (by default, such a request is rejected).
2217         see also `uploadpack.hiderefs`.
2219 url.<base>.insteadOf::
2220         Any URL that starts with this value will be rewritten to
2221         start, instead, with <base>. In cases where some site serves a
2222         large number of repositories, and serves them with multiple
2223         access methods, and some users need to use different access
2224         methods, this feature allows people to specify any of the
2225         equivalent URLs and have Git automatically rewrite the URL to
2226         the best alternative for the particular user, even for a
2227         never-before-seen repository on the site.  When more than one
2228         insteadOf strings match a given URL, the longest match is used.
2230 url.<base>.pushInsteadOf::
2231         Any URL that starts with this value will not be pushed to;
2232         instead, it will be rewritten to start with <base>, and the
2233         resulting URL will be pushed to. In cases where some site serves
2234         a large number of repositories, and serves them with multiple
2235         access methods, some of which do not allow push, this feature
2236         allows people to specify a pull-only URL and have Git
2237         automatically use an appropriate URL to push, even for a
2238         never-before-seen repository on the site.  When more than one
2239         pushInsteadOf strings match a given URL, the longest match is
2240         used.  If a remote has an explicit pushurl, Git will ignore this
2241         setting for that remote.
2243 user.email::
2244         Your email address to be recorded in any newly created commits.
2245         Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
2246         'EMAIL' environment variables.  See linkgit:git-commit-tree[1].
2248 user.name::
2249         Your full name to be recorded in any newly created commits.
2250         Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
2251         environment variables.  See linkgit:git-commit-tree[1].
2253 user.signingkey::
2254         If linkgit:git-tag[1] is not selecting the key you want it to
2255         automatically when creating a signed tag, you can override the
2256         default selection with this variable.  This option is passed
2257         unchanged to gpg's --local-user parameter, so you may specify a key
2258         using any method that gpg supports.
2260 web.browser::
2261         Specify a web browser that may be used by some commands.
2262         Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
2263         may use it.