Windows: define S_ISUID properly
[git/dscho.git] / Documentation / config.txt
blob49a24e5fb20e5bf33fbb98d5170d00577330691a
1 CONFIGURATION FILE
2 ------------------
4 The git configuration file contains a number of variables that affect
5 the git command's behavior. The `.git/config` file in each repository
6 is used to store the configuration for that repository, and
7 `$HOME/.gitconfig` is used to store a per-user configuration as
8 fallback values for the `.git/config` file. The file `/etc/gitconfig`
9 can be used to store a system-wide default configuration.
11 The configuration variables are used by both the git plumbing
12 and the porcelains. The variables are divided into sections, wherein
13 the fully qualified variable name of the variable itself is the last
14 dot-separated segment and the section name is everything before the last
15 dot. The variable names are case-insensitive, allow only alphanumeric
16 characters and `-`, and must start with an alphabetic character.  Some
17 variables may appear multiple times.
19 Syntax
20 ~~~~~~
22 The syntax is fairly flexible and permissive; whitespaces are mostly
23 ignored.  The '#' and ';' characters begin comments to the end of line,
24 blank lines are ignored.
26 The file consists of sections and variables.  A section begins with
27 the name of the section in square brackets and continues until the next
28 section begins.  Section names are not case sensitive.  Only alphanumeric
29 characters, `-` and `.` are allowed in section names.  Each variable
30 must belong to some section, which means that there must be a section
31 header before the first setting of a variable.
33 Sections can be further divided into subsections.  To begin a subsection
34 put its name in double quotes, separated by space from the section name,
35 in the section header, like in the example below:
37 --------
38         [section "subsection"]
40 --------
42 Subsection names are case sensitive and can contain any characters except
43 newline (doublequote `"` and backslash have to be escaped as `\"` and `\\`,
44 respectively).  Section headers cannot span multiple
45 lines.  Variables may belong directly to a section or to a given subsection.
46 You can have `[section]` if you have `[section "subsection"]`, but you
47 don't need to.
49 There is also a deprecated `[section.subsection]` syntax. With this
50 syntax, the subsection name is converted to lower-case and is also
51 compared case sensitively. These subsection names follow the same
52 restrictions as section names.
54 All the other lines (and the remainder of the line after the section
55 header) are recognized as setting variables, in the form
56 'name = value'.  If there is no equal sign on the line, the entire line
57 is taken as 'name' and the variable is recognized as boolean "true".
58 The variable names are case-insensitive, allow only alphanumeric characters
59 and `-`, and must start with an alphabetic character.  There can be more
60 than one value for a given variable; we say then that the variable is
61 multivalued.
63 Leading and trailing whitespace in a variable value is discarded.
64 Internal whitespace within a variable value is retained verbatim.
66 The values following the equals sign in variable assign are all either
67 a string, an integer, or a boolean.  Boolean values may be given as yes/no,
68 1/0, true/false or on/off.  Case is not significant in boolean values, when
69 converting value to the canonical form using '--bool' type specifier;
70 'git config' will ensure that the output is "true" or "false".
72 String values may be entirely or partially enclosed in double quotes.
73 You need to enclose variable values in double quotes if you want to
74 preserve leading or trailing whitespace, or if the variable value contains
75 comment characters (i.e. it contains '#' or ';').
76 Double quote `"` and backslash `\` characters in variable values must
77 be escaped: use `\"` for `"` and `\\` for `\`.
79 The following escape sequences (beside `\"` and `\\`) are recognized:
80 `\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
81 and `\b` for backspace (BS).  No other char escape sequence, nor octal
82 char sequences are valid.
84 Variable values ending in a `\` are continued on the next line in the
85 customary UNIX fashion.
87 Some variables may require a special value format.
89 Includes
90 ~~~~~~~~
92 You can include one config file from another by setting the special
93 `include.path` variable to the name of the file to be included. The
94 included file is expanded immediately, as if its contents had been
95 found at the location of the include directive. If the value of the
96 `include.path` variable is a relative path, the path is considered to be
97 relative to the configuration file in which the include directive was
98 found. See below for examples.
100 Example
101 ~~~~~~~
103         # Core variables
104         [core]
105                 ; Don't trust file modes
106                 filemode = false
108         # Our diff algorithm
109         [diff]
110                 external = /usr/local/bin/diff-wrapper
111                 renames = true
113         [branch "devel"]
114                 remote = origin
115                 merge = refs/heads/devel
117         # Proxy settings
118         [core]
119                 gitProxy="ssh" for "kernel.org"
120                 gitProxy=default-proxy ; for the rest
122         [include]
123                 path = /path/to/foo.inc ; include by absolute path
124                 path = foo ; expand "foo" relative to the current file
126 Variables
127 ~~~~~~~~~
129 Note that this list is non-comprehensive and not necessarily complete.
130 For command-specific variables, you will find a more detailed description
131 in the appropriate manual page. You will find a description of non-core
132 porcelain configuration variables in the respective porcelain documentation.
134 advice.*::
135         These variables control various optional help messages designed to
136         aid new users. All 'advice.*' variables default to 'true', and you
137         can tell Git that you do not need help by setting these to 'false':
140         pushNonFastForward::
141                 Set this variable to 'false' if you want to disable
142                 'pushNonFFCurrent', 'pushNonFFDefault', and
143                 'pushNonFFMatching' simultaneously.
144         pushNonFFCurrent::
145                 Advice shown when linkgit:git-push[1] fails due to a
146                 non-fast-forward update to the current branch.
147         pushNonFFDefault::
148                 Advice to set 'push.default' to 'upstream' or 'current'
149                 when you ran linkgit:git-push[1] and pushed 'matching
150                 refs' by default (i.e. you did not provide an explicit
151                 refspec, and no 'push.default' configuration was set)
152                 and it resulted in a non-fast-forward error.
153         pushNonFFMatching::
154                 Advice shown when you ran linkgit:git-push[1] and pushed
155                 'matching refs' explicitly (i.e. you used ':', or
156                 specified a refspec that isn't your current branch) and
157                 it resulted in a non-fast-forward error.
158         statusHints::
159                 Directions on how to stage/unstage/add shown in the
160                 output of linkgit:git-status[1] and the template shown
161                 when writing commit messages.
162         commitBeforeMerge::
163                 Advice shown when linkgit:git-merge[1] refuses to
164                 merge to avoid overwriting local changes.
165         resolveConflict::
166                 Advices shown by various commands when conflicts
167                 prevent the operation from being performed.
168         implicitIdentity::
169                 Advice on how to set your identity configuration when
170                 your information is guessed from the system username and
171                 domain name.
172         detachedHead::
173                 Advice shown when you used linkgit:git-checkout[1] to
174                 move to the detach HEAD state, to instruct how to create
175                 a local branch after the fact.
178 core.fileMode::
179         If false, the executable bit differences between the index and
180         the working tree are ignored; useful on broken filesystems like FAT.
181         See linkgit:git-update-index[1].
183 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
184 will probe and set core.fileMode false if appropriate when the
185 repository is created.
187 core.hideDotFiles::
188         (Windows-only) If true (which is the default), mark newly-created
189         directories and files whose name starts with a dot as hidden.
190         If 'dotGitOnly', only the .git/ directory is hidden, but no other
191         files starting with a dot.
193 core.ignoreCygwinFSTricks::
194         This option is only used by Cygwin implementation of Git. If false,
195         the Cygwin stat() and lstat() functions are used. This may be useful
196         if your repository consists of a few separate directories joined in
197         one hierarchy using Cygwin mount. If true, Git uses native Win32 API
198         whenever it is possible and falls back to Cygwin functions only to
199         handle symbol links. The native mode is more than twice faster than
200         normal Cygwin l/stat() functions. True by default, unless core.filemode
201         is true, in which case ignoreCygwinFSTricks is ignored as Cygwin's
202         POSIX emulation is required to support core.filemode.
204 core.ignorecase::
205         If true, this option enables various workarounds to enable
206         git to work better on filesystems that are not case sensitive,
207         like FAT. For example, if a directory listing finds
208         "makefile" when git expects "Makefile", git will assume
209         it is really the same file, and continue to remember it as
210         "Makefile".
212 The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
213 will probe and set core.ignorecase true if appropriate when the repository
214 is created.
216 core.trustctime::
217         If false, the ctime differences between the index and the
218         working tree are ignored; useful when the inode change time
219         is regularly modified by something outside Git (file system
220         crawlers and some backup systems).
221         See linkgit:git-update-index[1]. True by default.
223 core.quotepath::
224         The commands that output paths (e.g. 'ls-files',
225         'diff'), when not given the `-z` option, will quote
226         "unusual" characters in the pathname by enclosing the
227         pathname in a double-quote pair and with backslashes the
228         same way strings in C source code are quoted.  If this
229         variable is set to false, the bytes higher than 0x80 are
230         not quoted but output as verbatim.  Note that double
231         quote, backslash and control characters are always
232         quoted without `-z` regardless of the setting of this
233         variable.
235 core.eol::
236         Sets the line ending type to use in the working directory for
237         files that have the `text` property set.  Alternatives are
238         'lf', 'crlf' and 'native', which uses the platform's native
239         line ending.  The default value is `native`.  See
240         linkgit:gitattributes[5] for more information on end-of-line
241         conversion.
243 core.safecrlf::
244         If true, makes git check if converting `CRLF` is reversible when
245         end-of-line conversion is active.  Git will verify if a command
246         modifies a file in the work tree either directly or indirectly.
247         For example, committing a file followed by checking out the
248         same file should yield the original file in the work tree.  If
249         this is not the case for the current setting of
250         `core.autocrlf`, git will reject the file.  The variable can
251         be set to "warn", in which case git will only warn about an
252         irreversible conversion but continue the operation.
254 CRLF conversion bears a slight chance of corrupting data.
255 When it is enabled, git will convert CRLF to LF during commit and LF to
256 CRLF during checkout.  A file that contains a mixture of LF and
257 CRLF before the commit cannot be recreated by git.  For text
258 files this is the right thing to do: it corrects line endings
259 such that we have only LF line endings in the repository.
260 But for binary files that are accidentally classified as text the
261 conversion can corrupt data.
263 If you recognize such corruption early you can easily fix it by
264 setting the conversion type explicitly in .gitattributes.  Right
265 after committing you still have the original file in your work
266 tree and this file is not yet corrupted.  You can explicitly tell
267 git that this file is binary and git will handle the file
268 appropriately.
270 Unfortunately, the desired effect of cleaning up text files with
271 mixed line endings and the undesired effect of corrupting binary
272 files cannot be distinguished.  In both cases CRLFs are removed
273 in an irreversible way.  For text files this is the right thing
274 to do because CRLFs are line endings, while for binary files
275 converting CRLFs corrupts data.
277 Note, this safety check does not mean that a checkout will generate a
278 file identical to the original file for a different setting of
279 `core.eol` and `core.autocrlf`, but only for the current one.  For
280 example, a text file with `LF` would be accepted with `core.eol=lf`
281 and could later be checked out with `core.eol=crlf`, in which case the
282 resulting file would contain `CRLF`, although the original file
283 contained `LF`.  However, in both work trees the line endings would be
284 consistent, that is either all `LF` or all `CRLF`, but never mixed.  A
285 file with mixed line endings would be reported by the `core.safecrlf`
286 mechanism.
288 core.autocrlf::
289         Setting this variable to "true" is almost the same as setting
290         the `text` attribute to "auto" on all files except that text
291         files are not guaranteed to be normalized: files that contain
292         `CRLF` in the repository will not be touched.  Use this
293         setting if you want to have `CRLF` line endings in your
294         working directory even though the repository does not have
295         normalized line endings.  This variable can be set to 'input',
296         in which case no output conversion is performed.
298 core.symlinks::
299         If false, symbolic links are checked out as small plain files that
300         contain the link text. linkgit:git-update-index[1] and
301         linkgit:git-add[1] will not change the recorded type to regular
302         file. Useful on filesystems like FAT that do not support
303         symbolic links.
305 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
306 will probe and set core.symlinks false if appropriate when the repository
307 is created.
309 core.gitProxy::
310         A "proxy command" to execute (as 'command host port') instead
311         of establishing direct connection to the remote server when
312         using the git protocol for fetching. If the variable value is
313         in the "COMMAND for DOMAIN" format, the command is applied only
314         on hostnames ending with the specified domain string. This variable
315         may be set multiple times and is matched in the given order;
316         the first match wins.
318 Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
319 (which always applies universally, without the special "for"
320 handling).
322 The special string `none` can be used as the proxy command to
323 specify that no proxy be used for a given domain pattern.
324 This is useful for excluding servers inside a firewall from
325 proxy use, while defaulting to a common proxy for external domains.
327 core.ignoreStat::
328         If true, commands which modify both the working tree and the index
329         will mark the updated paths with the "assume unchanged" bit in the
330         index. These marked files are then assumed to stay unchanged in the
331         working tree, until you mark them otherwise manually - Git will not
332         detect the file changes by lstat() calls. This is useful on systems
333         where those are very slow, such as Microsoft Windows.
334         See linkgit:git-update-index[1].
335         False by default.
337 core.preferSymlinkRefs::
338         Instead of the default "symref" format for HEAD
339         and other symbolic reference files, use symbolic links.
340         This is sometimes needed to work with old scripts that
341         expect HEAD to be a symbolic link.
343 core.bare::
344         If true this repository is assumed to be 'bare' and has no
345         working directory associated with it.  If this is the case a
346         number of commands that require a working directory will be
347         disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
349 This setting is automatically guessed by linkgit:git-clone[1] or
350 linkgit:git-init[1] when the repository was created.  By default a
351 repository that ends in "/.git" is assumed to be not bare (bare =
352 false), while all other repositories are assumed to be bare (bare
353 = true).
355 core.worktree::
356         Set the path to the root of the working tree.
357         This can be overridden by the GIT_WORK_TREE environment
358         variable and the '--work-tree' command line option.
359         The value can be an absolute path or relative to the path to
360         the .git directory, which is either specified by --git-dir
361         or GIT_DIR, or automatically discovered.
362         If --git-dir or GIT_DIR is specified but none of
363         --work-tree, GIT_WORK_TREE and core.worktree is specified,
364         the current working directory is regarded as the top level
365         of your working tree.
367 Note that this variable is honored even when set in a configuration
368 file in a ".git" subdirectory of a directory and its value differs
369 from the latter directory (e.g. "/path/to/.git/config" has
370 core.worktree set to "/different/path"), which is most likely a
371 misconfiguration.  Running git commands in the "/path/to" directory will
372 still use "/different/path" as the root of the work tree and can cause
373 confusion unless you know what you are doing (e.g. you are creating a
374 read-only snapshot of the same index to a location different from the
375 repository's usual working tree).
377 core.logAllRefUpdates::
378         Enable the reflog. Updates to a ref <ref> is logged to the file
379         "$GIT_DIR/logs/<ref>", by appending the new and old
380         SHA1, the date/time and the reason of the update, but
381         only when the file exists.  If this configuration
382         variable is set to true, missing "$GIT_DIR/logs/<ref>"
383         file is automatically created for branch heads (i.e. under
384         refs/heads/), remote refs (i.e. under refs/remotes/),
385         note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
387 This information can be used to determine what commit
388 was the tip of a branch "2 days ago".
390 This value is true by default in a repository that has
391 a working directory associated with it, and false by
392 default in a bare repository.
394 core.repositoryFormatVersion::
395         Internal variable identifying the repository format and layout
396         version.
398 core.sharedRepository::
399         When 'group' (or 'true'), the repository is made shareable between
400         several users in a group (making sure all the files and objects are
401         group-writable). When 'all' (or 'world' or 'everybody'), the
402         repository will be readable by all users, additionally to being
403         group-shareable. When 'umask' (or 'false'), git will use permissions
404         reported by umask(2). When '0xxx', where '0xxx' is an octal number,
405         files in the repository will have this mode value. '0xxx' will override
406         user's umask value (whereas the other options will only override
407         requested parts of the user's umask value). Examples: '0660' will make
408         the repo read/write-able for the owner and group, but inaccessible to
409         others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
410         repository that is group-readable but not group-writable.
411         See linkgit:git-init[1]. False by default.
413 core.warnAmbiguousRefs::
414         If true, git will warn you if the ref name you passed it is ambiguous
415         and might match multiple refs in the .git/refs/ tree. True by default.
417 core.compression::
418         An integer -1..9, indicating a default compression level.
419         -1 is the zlib default. 0 means no compression,
420         and 1..9 are various speed/size tradeoffs, 9 being slowest.
421         If set, this provides a default to other compression variables,
422         such as 'core.loosecompression' and 'pack.compression'.
424 core.loosecompression::
425         An integer -1..9, indicating the compression level for objects that
426         are not in a pack file. -1 is the zlib default. 0 means no
427         compression, and 1..9 are various speed/size tradeoffs, 9 being
428         slowest.  If not set,  defaults to core.compression.  If that is
429         not set,  defaults to 1 (best speed).
431 core.packedGitWindowSize::
432         Number of bytes of a pack file to map into memory in a
433         single mapping operation.  Larger window sizes may allow
434         your system to process a smaller number of large pack files
435         more quickly.  Smaller window sizes will negatively affect
436         performance due to increased calls to the operating system's
437         memory manager, but may improve performance when accessing
438         a large number of large pack files.
440 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
441 MiB on 32 bit platforms and 1 GiB on 64 bit platforms.  This should
442 be reasonable for all users/operating systems.  You probably do
443 not need to adjust this value.
445 Common unit suffixes of 'k', 'm', or 'g' are supported.
447 core.packedGitLimit::
448         Maximum number of bytes to map simultaneously into memory
449         from pack files.  If Git needs to access more than this many
450         bytes at once to complete an operation it will unmap existing
451         regions to reclaim virtual address space within the process.
453 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
454 This should be reasonable for all users/operating systems, except on
455 the largest projects.  You probably do not need to adjust this value.
457 Common unit suffixes of 'k', 'm', or 'g' are supported.
459 core.deltaBaseCacheLimit::
460         Maximum number of bytes to reserve for caching base objects
461         that may be referenced by multiple deltified objects.  By storing the
462         entire decompressed base objects in a cache Git is able
463         to avoid unpacking and decompressing frequently used base
464         objects multiple times.
466 Default is 16 MiB on all platforms.  This should be reasonable
467 for all users/operating systems, except on the largest projects.
468 You probably do not need to adjust this value.
470 Common unit suffixes of 'k', 'm', or 'g' are supported.
472 core.bigFileThreshold::
473         Files larger than this size are stored deflated, without
474         attempting delta compression.  Storing large files without
475         delta compression avoids excessive memory usage, at the
476         slight expense of increased disk usage.
478 Default is 512 MiB on all platforms.  This should be reasonable
479 for most projects as source code and other text files can still
480 be delta compressed, but larger binary media files won't be.
482 Common unit suffixes of 'k', 'm', or 'g' are supported.
484 core.excludesfile::
485         In addition to '.gitignore' (per-directory) and
486         '.git/info/exclude', git looks into this file for patterns
487         of files which are not meant to be tracked.  "{tilde}/" is expanded
488         to the value of `$HOME` and "{tilde}user/" to the specified user's
489         home directory.  See linkgit:gitignore[5].
491 core.askpass::
492         Some commands (e.g. svn and http interfaces) that interactively
493         ask for a password can be told to use an external program given
494         via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
495         environment variable. If not set, fall back to the value of the
496         'SSH_ASKPASS' environment variable or, failing that, a simple password
497         prompt. The external program shall be given a suitable prompt as
498         command line argument and write the password on its STDOUT.
500 core.attributesfile::
501         In addition to '.gitattributes' (per-directory) and
502         '.git/info/attributes', git looks into this file for attributes
503         (see linkgit:gitattributes[5]). Path expansions are made the same
504         way as for `core.excludesfile`.
506 core.editor::
507         Commands such as `commit` and `tag` that lets you edit
508         messages by launching an editor uses the value of this
509         variable when it is set, and the environment variable
510         `GIT_EDITOR` is not set.  See linkgit:git-var[1].
512 sequence.editor::
513         Text editor used by `git rebase -i` for editing the rebase insn file.
514         The value is meant to be interpreted by the shell when it is used.
515         It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
516         When not configured the default commit message editor is used instead.
518 core.pager::
519         The command that git will use to paginate output.  Can
520         be overridden with the `GIT_PAGER` environment
521         variable.  Note that git sets the `LESS` environment
522         variable to `FRSX` if it is unset when it runs the
523         pager.  One can change these settings by setting the
524         `LESS` variable to some other value.  Alternately,
525         these settings can be overridden on a project or
526         global basis by setting the `core.pager` option.
527         Setting `core.pager` has no affect on the `LESS`
528         environment variable behaviour above, so if you want
529         to override git's default settings this way, you need
530         to be explicit.  For example, to disable the S option
531         in a backward compatible manner, set `core.pager`
532         to `less -+$LESS -FRX`.  This will be passed to the
533         shell by git, which will translate the final command to
534         `LESS=FRSX less -+FRSX -FRX`.
536 core.whitespace::
537         A comma separated list of common whitespace problems to
538         notice.  'git diff' will use `color.diff.whitespace` to
539         highlight them, and 'git apply --whitespace=error' will
540         consider them as errors.  You can prefix `-` to disable
541         any of them (e.g. `-trailing-space`):
543 * `blank-at-eol` treats trailing whitespaces at the end of the line
544   as an error (enabled by default).
545 * `space-before-tab` treats a space character that appears immediately
546   before a tab character in the initial indent part of the line as an
547   error (enabled by default).
548 * `indent-with-non-tab` treats a line that is indented with 8 or more
549   space characters as an error (not enabled by default).
550 * `tab-in-indent` treats a tab character in the initial indent part of
551   the line as an error (not enabled by default).
552 * `blank-at-eof` treats blank lines added at the end of file as an error
553   (enabled by default).
554 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
555   `blank-at-eof`.
556 * `cr-at-eol` treats a carriage-return at the end of line as
557   part of the line terminator, i.e. with it, `trailing-space`
558   does not trigger if the character before such a carriage-return
559   is not a whitespace (not enabled by default).
560 * `tabwidth=<n>` tells how many character positions a tab occupies; this
561   is relevant for `indent-with-non-tab` and when git fixes `tab-in-indent`
562   errors. The default tab width is 8. Allowed values are 1 to 63.
564 core.fsyncobjectfiles::
565         This boolean will enable 'fsync()' when writing object files.
567 This is a total waste of time and effort on a filesystem that orders
568 data writes properly, but can be useful for filesystems that do not use
569 journalling (traditional UNIX filesystems) or that only journal metadata
570 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
572 core.preloadindex::
573         Enable parallel index preload for operations like 'git diff'
575 This can speed up operations like 'git diff' and 'git status' especially
576 on filesystems like NFS that have weak caching semantics and thus
577 relatively high IO latencies.  With this set to 'true', git will do the
578 index comparison to the filesystem data in parallel, allowing
579 overlapping IO's.
581 core.createObject::
582         You can set this to 'link', in which case a hardlink followed by
583         a delete of the source are used to make sure that object creation
584         will not overwrite existing objects.
586 On some file system/operating system combinations, this is unreliable.
587 Set this config setting to 'rename' there; However, This will remove the
588 check that makes sure that existing object files will not get overwritten.
590 core.notesRef::
591         When showing commit messages, also show notes which are stored in
592         the given ref.  The ref must be fully qualified.  If the given
593         ref does not exist, it is not an error but means that no
594         notes should be printed.
596 This setting defaults to "refs/notes/commits", and it can be overridden by
597 the 'GIT_NOTES_REF' environment variable.  See linkgit:git-notes[1].
599 core.sparseCheckout::
600         Enable "sparse checkout" feature. See section "Sparse checkout" in
601         linkgit:git-read-tree[1] for more information.
603 core.abbrev::
604         Set the length object names are abbreviated to.  If unspecified,
605         many commands abbreviate to 7 hexdigits, which may not be enough
606         for abbreviated object names to stay unique for sufficiently long
607         time.
609 add.ignore-errors::
610 add.ignoreErrors::
611         Tells 'git add' to continue adding files when some files cannot be
612         added due to indexing errors. Equivalent to the '--ignore-errors'
613         option of linkgit:git-add[1].  Older versions of git accept only
614         `add.ignore-errors`, which does not follow the usual naming
615         convention for configuration variables.  Newer versions of git
616         honor `add.ignoreErrors` as well.
618 alias.*::
619         Command aliases for the linkgit:git[1] command wrapper - e.g.
620         after defining "alias.last = cat-file commit HEAD", the invocation
621         "git last" is equivalent to "git cat-file commit HEAD". To avoid
622         confusion and troubles with script usage, aliases that
623         hide existing git commands are ignored. Arguments are split by
624         spaces, the usual shell quoting and escaping is supported.
625         quote pair and a backslash can be used to quote them.
627 If the alias expansion is prefixed with an exclamation point,
628 it will be treated as a shell command.  For example, defining
629 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
630 "git new" is equivalent to running the shell command
631 "gitk --all --not ORIG_HEAD".  Note that shell commands will be
632 executed from the top-level directory of a repository, which may
633 not necessarily be the current directory.
634 'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
635 from the original current directory. See linkgit:git-rev-parse[1].
637 am.keepcr::
638         If true, git-am will call git-mailsplit for patches in mbox format
639         with parameter '--keep-cr'. In this case git-mailsplit will
640         not remove `\r` from lines ending with `\r\n`. Can be overridden
641         by giving '--no-keep-cr' from the command line.
642         See linkgit:git-am[1], linkgit:git-mailsplit[1].
644 apply.ignorewhitespace::
645         When set to 'change', tells 'git apply' to ignore changes in
646         whitespace, in the same way as the '--ignore-space-change'
647         option.
648         When set to one of: no, none, never, false tells 'git apply' to
649         respect all whitespace differences.
650         See linkgit:git-apply[1].
652 apply.whitespace::
653         Tells 'git apply' how to handle whitespaces, in the same way
654         as the '--whitespace' option. See linkgit:git-apply[1].
656 branch.autosetupmerge::
657         Tells 'git branch' and 'git checkout' to set up new branches
658         so that linkgit:git-pull[1] will appropriately merge from the
659         starting point branch. Note that even if this option is not set,
660         this behavior can be chosen per-branch using the `--track`
661         and `--no-track` options. The valid settings are: `false` -- no
662         automatic setup is done; `true` -- automatic setup is done when the
663         starting point is a remote-tracking branch; `always` --
664         automatic setup is done when the starting point is either a
665         local branch or remote-tracking
666         branch. This option defaults to true.
668 branch.autosetuprebase::
669         When a new branch is created with 'git branch' or 'git checkout'
670         that tracks another branch, this variable tells git to set
671         up pull to rebase instead of merge (see "branch.<name>.rebase").
672         When `never`, rebase is never automatically set to true.
673         When `local`, rebase is set to true for tracked branches of
674         other local branches.
675         When `remote`, rebase is set to true for tracked branches of
676         remote-tracking branches.
677         When `always`, rebase will be set to true for all tracking
678         branches.
679         See "branch.autosetupmerge" for details on how to set up a
680         branch to track another branch.
681         This option defaults to never.
683 branch.<name>.remote::
684         When in branch <name>, it tells 'git fetch' and 'git push' which
685         remote to fetch from/push to.  It defaults to `origin` if no remote is
686         configured. `origin` is also used if you are not on any branch.
688 branch.<name>.merge::
689         Defines, together with branch.<name>.remote, the upstream branch
690         for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
691         branch to merge and can also affect 'git push' (see push.default).
692         When in branch <name>, it tells 'git fetch' the default
693         refspec to be marked for merging in FETCH_HEAD. The value is
694         handled like the remote part of a refspec, and must match a
695         ref which is fetched from the remote given by
696         "branch.<name>.remote".
697         The merge information is used by 'git pull' (which at first calls
698         'git fetch') to lookup the default branch for merging. Without
699         this option, 'git pull' defaults to merge the first refspec fetched.
700         Specify multiple values to get an octopus merge.
701         If you wish to setup 'git pull' so that it merges into <name> from
702         another branch in the local repository, you can point
703         branch.<name>.merge to the desired branch, and use the special setting
704         `.` (a period) for branch.<name>.remote.
706 branch.<name>.mergeoptions::
707         Sets default options for merging into branch <name>. The syntax and
708         supported options are the same as those of linkgit:git-merge[1], but
709         option values containing whitespace characters are currently not
710         supported.
712 branch.<name>.rebase::
713         When true, rebase the branch <name> on top of the fetched branch,
714         instead of merging the default branch from the default remote when
715         "git pull" is run. See "pull.rebase" for doing this in a non
716         branch-specific manner.
718 *NOTE*: this is a possibly dangerous operation; do *not* use
719 it unless you understand the implications (see linkgit:git-rebase[1]
720 for details).
722 browser.<tool>.cmd::
723         Specify the command to invoke the specified browser. The
724         specified command is evaluated in shell with the URLs passed
725         as arguments. (See linkgit:git-web{litdd}browse[1].)
727 browser.<tool>.path::
728         Override the path for the given tool that may be used to
729         browse HTML help (see '-w' option in linkgit:git-help[1]) or a
730         working repository in gitweb (see linkgit:git-instaweb[1]).
732 clean.requireForce::
733         A boolean to make git-clean do nothing unless given -f
734         or -n.   Defaults to true.
736 color.branch::
737         A boolean to enable/disable color in the output of
738         linkgit:git-branch[1]. May be set to `always`,
739         `false` (or `never`) or `auto` (or `true`), in which case colors are used
740         only when the output is to a terminal. Defaults to false.
742 color.branch.<slot>::
743         Use customized color for branch coloration. `<slot>` is one of
744         `current` (the current branch), `local` (a local branch),
745         `remote` (a remote-tracking branch in refs/remotes/), `plain` (other
746         refs).
748 The value for these configuration variables is a list of colors (at most
749 two) and attributes (at most one), separated by spaces.  The colors
750 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
751 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
752 `blink` and `reverse`.  The first color given is the foreground; the
753 second is the background.  The position of the attribute, if any,
754 doesn't matter.
756 color.diff::
757         Whether to use ANSI escape sequences to add color to patches.
758         If this is set to `always`, linkgit:git-diff[1],
759         linkgit:git-log[1], and linkgit:git-show[1] will use color
760         for all patches.  If it is set to `true` or `auto`, those
761         commands will only use color when output is to the terminal.
762         Defaults to false.
764 This does not affect linkgit:git-format-patch[1] nor the
765 'git-diff-{asterisk}' plumbing commands.  Can be overridden on the
766 command line with the `--color[=<when>]` option.
768 color.diff.<slot>::
769         Use customized color for diff colorization.  `<slot>` specifies
770         which part of the patch to use the specified color, and is one
771         of `plain` (context text), `meta` (metainformation), `frag`
772         (hunk header), 'func' (function in hunk header), `old` (removed lines),
773         `new` (added lines), `commit` (commit headers), or `whitespace`
774         (highlighting whitespace errors). The values of these variables may be
775         specified as in color.branch.<slot>.
777 color.decorate.<slot>::
778         Use customized color for 'git log --decorate' output.  `<slot>` is one
779         of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
780         branches, remote-tracking branches, tags, stash and HEAD, respectively.
782 color.grep::
783         When set to `always`, always highlight matches.  When `false` (or
784         `never`), never.  When set to `true` or `auto`, use color only
785         when the output is written to the terminal.  Defaults to `false`.
787 color.grep.<slot>::
788         Use customized color for grep colorization.  `<slot>` specifies which
789         part of the line to use the specified color, and is one of
792 `context`;;
793         non-matching text in context lines (when using `-A`, `-B`, or `-C`)
794 `filename`;;
795         filename prefix (when not using `-h`)
796 `function`;;
797         function name lines (when using `-p`)
798 `linenumber`;;
799         line number prefix (when using `-n`)
800 `match`;;
801         matching text
802 `selected`;;
803         non-matching text in selected lines
804 `separator`;;
805         separators between fields on a line (`:`, `-`, and `=`)
806         and between hunks (`--`)
809 The values of these variables may be specified as in color.branch.<slot>.
811 color.interactive::
812         When set to `always`, always use colors for interactive prompts
813         and displays (such as those used by "git-add --interactive").
814         When false (or `never`), never.  When set to `true` or `auto`, use
815         colors only when the output is to the terminal. Defaults to false.
817 color.interactive.<slot>::
818         Use customized color for 'git add --interactive'
819         output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
820         four distinct types of normal output from interactive
821         commands.  The values of these variables may be specified as
822         in color.branch.<slot>.
824 color.pager::
825         A boolean to enable/disable colored output when the pager is in
826         use (default is true).
828 color.showbranch::
829         A boolean to enable/disable color in the output of
830         linkgit:git-show-branch[1]. May be set to `always`,
831         `false` (or `never`) or `auto` (or `true`), in which case colors are used
832         only when the output is to a terminal. Defaults to false.
834 color.status::
835         A boolean to enable/disable color in the output of
836         linkgit:git-status[1]. May be set to `always`,
837         `false` (or `never`) or `auto` (or `true`), in which case colors are used
838         only when the output is to a terminal. Defaults to false.
840 color.status.<slot>::
841         Use customized color for status colorization. `<slot>` is
842         one of `header` (the header text of the status message),
843         `added` or `updated` (files which are added but not committed),
844         `changed` (files which are changed but not added in the index),
845         `untracked` (files which are not tracked by git),
846         `branch` (the current branch), or
847         `nobranch` (the color the 'no branch' warning is shown in, defaulting
848         to red). The values of these variables may be specified as in
849         color.branch.<slot>.
851 color.ui::
852         This variable determines the default value for variables such
853         as `color.diff` and `color.grep` that control the use of color
854         per command family. Its scope will expand as more commands learn
855         configuration to set a default for the `--color` option.  Set it
856         to `always` if you want all output not intended for machine
857         consumption to use color, to `true` or `auto` if you want such
858         output to use color when written to the terminal, or to `false` or
859         `never` if you prefer git commands not to use color unless enabled
860         explicitly with some other configuration or the `--color` option.
862 commit.status::
863         A boolean to enable/disable inclusion of status information in the
864         commit message template when using an editor to prepare the commit
865         message.  Defaults to true.
867 commit.template::
868         Specify a file to use as the template for new commit messages.
869         "{tilde}/" is expanded to the value of `$HOME` and "{tilde}user/" to the
870         specified user's home directory.
872 credential.helper::
873         Specify an external helper to be called when a username or
874         password credential is needed; the helper may consult external
875         storage to avoid prompting the user for the credentials. See
876         linkgit:gitcredentials[7] for details.
878 credential.useHttpPath::
879         When acquiring credentials, consider the "path" component of an http
880         or https URL to be important. Defaults to false. See
881         linkgit:gitcredentials[7] for more information.
883 credential.username::
884         If no username is set for a network authentication, use this username
885         by default. See credential.<context>.* below, and
886         linkgit:gitcredentials[7].
888 credential.<url>.*::
889         Any of the credential.* options above can be applied selectively to
890         some credentials. For example "credential.https://example.com.username"
891         would set the default username only for https connections to
892         example.com. See linkgit:gitcredentials[7] for details on how URLs are
893         matched.
895 include::diff-config.txt[]
897 difftool.<tool>.path::
898         Override the path for the given tool.  This is useful in case
899         your tool is not in the PATH.
901 difftool.<tool>.cmd::
902         Specify the command to invoke the specified diff tool.
903         The specified command is evaluated in shell with the following
904         variables available:  'LOCAL' is set to the name of the temporary
905         file containing the contents of the diff pre-image and 'REMOTE'
906         is set to the name of the temporary file containing the contents
907         of the diff post-image.
909 difftool.prompt::
910         Prompt before each invocation of the diff tool.
912 diff.wordRegex::
913         A POSIX Extended Regular Expression used to determine what is a "word"
914         when performing word-by-word difference calculations.  Character
915         sequences that match the regular expression are "words", all other
916         characters are *ignorable* whitespace.
918 fetch.recurseSubmodules::
919         This option can be either set to a boolean value or to 'on-demand'.
920         Setting it to a boolean changes the behavior of fetch and pull to
921         unconditionally recurse into submodules when set to true or to not
922         recurse at all when set to false. When set to 'on-demand' (the default
923         value), fetch and pull will only recurse into a populated submodule
924         when its superproject retrieves a commit that updates the submodule's
925         reference.
927 fetch.fsckObjects::
928         If it is set to true, git-fetch-pack will check all fetched
929         objects. It will abort in the case of a malformed object or a
930         broken link. The result of an abort are only dangling objects.
931         Defaults to false. If not set, the value of `transfer.fsckObjects`
932         is used instead.
934 fetch.unpackLimit::
935         If the number of objects fetched over the git native
936         transfer is below this
937         limit, then the objects will be unpacked into loose object
938         files. However if the number of received objects equals or
939         exceeds this limit then the received pack will be stored as
940         a pack, after adding any missing delta bases.  Storing the
941         pack from a push can make the push operation complete faster,
942         especially on slow filesystems.  If not set, the value of
943         `transfer.unpackLimit` is used instead.
945 format.attach::
946         Enable multipart/mixed attachments as the default for
947         'format-patch'.  The value can also be a double quoted string
948         which will enable attachments as the default and set the
949         value as the boundary.  See the --attach option in
950         linkgit:git-format-patch[1].
952 format.numbered::
953         A boolean which can enable or disable sequence numbers in patch
954         subjects.  It defaults to "auto" which enables it only if there
955         is more than one patch.  It can be enabled or disabled for all
956         messages by setting it to "true" or "false".  See --numbered
957         option in linkgit:git-format-patch[1].
959 format.headers::
960         Additional email headers to include in a patch to be submitted
961         by mail.  See linkgit:git-format-patch[1].
963 format.to::
964 format.cc::
965         Additional recipients to include in a patch to be submitted
966         by mail.  See the --to and --cc options in
967         linkgit:git-format-patch[1].
969 format.subjectprefix::
970         The default for format-patch is to output files with the '[PATCH]'
971         subject prefix. Use this variable to change that prefix.
973 format.signature::
974         The default for format-patch is to output a signature containing
975         the git version number. Use this variable to change that default.
976         Set this variable to the empty string ("") to suppress
977         signature generation.
979 format.suffix::
980         The default for format-patch is to output files with the suffix
981         `.patch`. Use this variable to change that suffix (make sure to
982         include the dot if you want it).
984 format.pretty::
985         The default pretty format for log/show/whatchanged command,
986         See linkgit:git-log[1], linkgit:git-show[1],
987         linkgit:git-whatchanged[1].
989 format.thread::
990         The default threading style for 'git format-patch'.  Can be
991         a boolean value, or `shallow` or `deep`.  `shallow` threading
992         makes every mail a reply to the head of the series,
993         where the head is chosen from the cover letter, the
994         `\--in-reply-to`, and the first patch mail, in this order.
995         `deep` threading makes every mail a reply to the previous one.
996         A true boolean value is the same as `shallow`, and a false
997         value disables threading.
999 format.signoff::
1000     A boolean value which lets you enable the `-s/--signoff` option of
1001     format-patch by default. *Note:* Adding the Signed-off-by: line to a
1002     patch should be a conscious act and means that you certify you have
1003     the rights to submit this work under the same open source license.
1004     Please see the 'SubmittingPatches' document for further discussion.
1006 filter.<driver>.clean::
1007         The command which is used to convert the content of a worktree
1008         file to a blob upon checkin.  See linkgit:gitattributes[5] for
1009         details.
1011 filter.<driver>.smudge::
1012         The command which is used to convert the content of a blob
1013         object to a worktree file upon checkout.  See
1014         linkgit:gitattributes[5] for details.
1016 gc.aggressiveWindow::
1017         The window size parameter used in the delta compression
1018         algorithm used by 'git gc --aggressive'.  This defaults
1019         to 250.
1021 gc.auto::
1022         When there are approximately more than this many loose
1023         objects in the repository, `git gc --auto` will pack them.
1024         Some Porcelain commands use this command to perform a
1025         light-weight garbage collection from time to time.  The
1026         default value is 6700.  Setting this to 0 disables it.
1028 gc.autopacklimit::
1029         When there are more than this many packs that are not
1030         marked with `*.keep` file in the repository, `git gc
1031         --auto` consolidates them into one larger pack.  The
1032         default value is 50.  Setting this to 0 disables it.
1034 gc.packrefs::
1035         Running `git pack-refs` in a repository renders it
1036         unclonable by Git versions prior to 1.5.1.2 over dumb
1037         transports such as HTTP.  This variable determines whether
1038         'git gc' runs `git pack-refs`. This can be set to `notbare`
1039         to enable it within all non-bare repos or it can be set to a
1040         boolean value.  The default is `true`.
1042 gc.pruneexpire::
1043         When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1044         Override the grace period with this config variable.  The value
1045         "now" may be used to disable this  grace period and always prune
1046         unreachable objects immediately.
1048 gc.reflogexpire::
1049 gc.<pattern>.reflogexpire::
1050         'git reflog expire' removes reflog entries older than
1051         this time; defaults to 90 days.  With "<pattern>" (e.g.
1052         "refs/stash") in the middle the setting applies only to
1053         the refs that match the <pattern>.
1055 gc.reflogexpireunreachable::
1056 gc.<ref>.reflogexpireunreachable::
1057         'git reflog expire' removes reflog entries older than
1058         this time and are not reachable from the current tip;
1059         defaults to 30 days.  With "<pattern>" (e.g. "refs/stash")
1060         in the middle, the setting applies only to the refs that
1061         match the <pattern>.
1063 gc.rerereresolved::
1064         Records of conflicted merge you resolved earlier are
1065         kept for this many days when 'git rerere gc' is run.
1066         The default is 60 days.  See linkgit:git-rerere[1].
1068 gc.rerereunresolved::
1069         Records of conflicted merge you have not resolved are
1070         kept for this many days when 'git rerere gc' is run.
1071         The default is 15 days.  See linkgit:git-rerere[1].
1073 gitcvs.commitmsgannotation::
1074         Append this string to each commit message. Set to empty string
1075         to disable this feature. Defaults to "via git-CVS emulator".
1077 gitcvs.enabled::
1078         Whether the CVS server interface is enabled for this repository.
1079         See linkgit:git-cvsserver[1].
1081 gitcvs.logfile::
1082         Path to a log file where the CVS server interface well... logs
1083         various stuff. See linkgit:git-cvsserver[1].
1085 gitcvs.usecrlfattr::
1086         If true, the server will look up the end-of-line conversion
1087         attributes for files to determine the '-k' modes to use. If
1088         the attributes force git to treat a file as text,
1089         the '-k' mode will be left blank so CVS clients will
1090         treat it as text. If they suppress text conversion, the file
1091         will be set with '-kb' mode, which suppresses any newline munging
1092         the client might otherwise do. If the attributes do not allow
1093         the file type to be determined, then 'gitcvs.allbinary' is
1094         used. See linkgit:gitattributes[5].
1096 gitcvs.allbinary::
1097         This is used if 'gitcvs.usecrlfattr' does not resolve
1098         the correct '-kb' mode to use. If true, all
1099         unresolved files are sent to the client in
1100         mode '-kb'. This causes the client to treat them
1101         as binary files, which suppresses any newline munging it
1102         otherwise might do. Alternatively, if it is set to "guess",
1103         then the contents of the file are examined to decide if
1104         it is binary, similar to 'core.autocrlf'.
1106 gitcvs.dbname::
1107         Database used by git-cvsserver to cache revision information
1108         derived from the git repository. The exact meaning depends on the
1109         used database driver, for SQLite (which is the default driver) this
1110         is a filename. Supports variable substitution (see
1111         linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1112         Default: '%Ggitcvs.%m.sqlite'
1114 gitcvs.dbdriver::
1115         Used Perl DBI driver. You can specify any available driver
1116         for this here, but it might not work. git-cvsserver is tested
1117         with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1118         reported *not* to work with 'DBD::mysql'. Experimental feature.
1119         May not contain double colons (`:`). Default: 'SQLite'.
1120         See linkgit:git-cvsserver[1].
1122 gitcvs.dbuser, gitcvs.dbpass::
1123         Database user and password. Only useful if setting 'gitcvs.dbdriver',
1124         since SQLite has no concept of database users and/or passwords.
1125         'gitcvs.dbuser' supports variable substitution (see
1126         linkgit:git-cvsserver[1] for details).
1128 gitcvs.dbTableNamePrefix::
1129         Database table name prefix.  Prepended to the names of any
1130         database tables used, allowing a single database to be used
1131         for several repositories.  Supports variable substitution (see
1132         linkgit:git-cvsserver[1] for details).  Any non-alphabetic
1133         characters will be replaced with underscores.
1135 All gitcvs variables except for 'gitcvs.usecrlfattr' and
1136 'gitcvs.allbinary' can also be specified as
1137 'gitcvs.<access_method>.<varname>' (where 'access_method'
1138 is one of "ext" and "pserver") to make them apply only for the given
1139 access method.
1141 gitweb.category::
1142 gitweb.description::
1143 gitweb.owner::
1144 gitweb.url::
1145         See linkgit:gitweb[1] for description.
1147 gitweb.avatar::
1148 gitweb.blame::
1149 gitweb.grep::
1150 gitweb.highlight::
1151 gitweb.patches::
1152 gitweb.pickaxe::
1153 gitweb.remote_heads::
1154 gitweb.showsizes::
1155 gitweb.snapshot::
1156         See linkgit:gitweb.conf[5] for description.
1158 grep.lineNumber::
1159         If set to true, enable '-n' option by default.
1161 grep.extendedRegexp::
1162         If set to true, enable '--extended-regexp' option by default.
1164 gpg.program::
1165         Use this custom program instead of "gpg" found on $PATH when
1166         making or verifying a PGP signature. The program must support the
1167         same command line interface as GPG, namely, to verify a detached
1168         signature, "gpg --verify $file - <$signature" is run, and the
1169         program is expected to signal a good signature by exiting with
1170         code 0, and to generate an ascii-armored detached signature, the
1171         standard input of "gpg -bsau $key" is fed with the contents to be
1172         signed, and the program is expected to send the result to its
1173         standard output.
1175 gui.commitmsgwidth::
1176         Defines how wide the commit message window is in the
1177         linkgit:git-gui[1]. "75" is the default.
1179 gui.diffcontext::
1180         Specifies how many context lines should be used in calls to diff
1181         made by the linkgit:git-gui[1]. The default is "5".
1183 gui.encoding::
1184         Specifies the default encoding to use for displaying of
1185         file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1186         It can be overridden by setting the 'encoding' attribute
1187         for relevant files (see linkgit:gitattributes[5]).
1188         If this option is not set, the tools default to the
1189         locale encoding.
1191 gui.matchtrackingbranch::
1192         Determines if new branches created with linkgit:git-gui[1] should
1193         default to tracking remote branches with matching names or
1194         not. Default: "false".
1196 gui.newbranchtemplate::
1197         Is used as suggested name when creating new branches using the
1198         linkgit:git-gui[1].
1200 gui.pruneduringfetch::
1201         "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1202         performing a fetch. The default value is "false".
1204 gui.trustmtime::
1205         Determines if linkgit:git-gui[1] should trust the file modification
1206         timestamp or not. By default the timestamps are not trusted.
1208 gui.spellingdictionary::
1209         Specifies the dictionary used for spell checking commit messages in
1210         the linkgit:git-gui[1]. When set to "none" spell checking is turned
1211         off.
1213 gui.fastcopyblame::
1214         If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1215         location detection. It makes blame significantly faster on huge
1216         repositories at the expense of less thorough copy detection.
1218 gui.copyblamethreshold::
1219         Specifies the threshold to use in 'git gui blame' original location
1220         detection, measured in alphanumeric characters. See the
1221         linkgit:git-blame[1] manual for more information on copy detection.
1223 gui.blamehistoryctx::
1224         Specifies the radius of history context in days to show in
1225         linkgit:gitk[1] for the selected commit, when the `Show History
1226         Context` menu item is invoked from 'git gui blame'. If this
1227         variable is set to zero, the whole history is shown.
1229 guitool.<name>.cmd::
1230         Specifies the shell command line to execute when the corresponding item
1231         of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1232         mandatory for every tool. The command is executed from the root of
1233         the working directory, and in the environment it receives the name of
1234         the tool as 'GIT_GUITOOL', the name of the currently selected file as
1235         'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1236         the head is detached, 'CUR_BRANCH' is empty).
1238 guitool.<name>.needsfile::
1239         Run the tool only if a diff is selected in the GUI. It guarantees
1240         that 'FILENAME' is not empty.
1242 guitool.<name>.noconsole::
1243         Run the command silently, without creating a window to display its
1244         output.
1246 guitool.<name>.norescan::
1247         Don't rescan the working directory for changes after the tool
1248         finishes execution.
1250 guitool.<name>.confirm::
1251         Show a confirmation dialog before actually running the tool.
1253 guitool.<name>.argprompt::
1254         Request a string argument from the user, and pass it to the tool
1255         through the 'ARGS' environment variable. Since requesting an
1256         argument implies confirmation, the 'confirm' option has no effect
1257         if this is enabled. If the option is set to 'true', 'yes', or '1',
1258         the dialog uses a built-in generic prompt; otherwise the exact
1259         value of the variable is used.
1261 guitool.<name>.revprompt::
1262         Request a single valid revision from the user, and set the
1263         'REVISION' environment variable. In other aspects this option
1264         is similar to 'argprompt', and can be used together with it.
1266 guitool.<name>.revunmerged::
1267         Show only unmerged branches in the 'revprompt' subdialog.
1268         This is useful for tools similar to merge or rebase, but not
1269         for things like checkout or reset.
1271 guitool.<name>.title::
1272         Specifies the title to use for the prompt dialog. The default
1273         is the tool name.
1275 guitool.<name>.prompt::
1276         Specifies the general prompt string to display at the top of
1277         the dialog, before subsections for 'argprompt' and 'revprompt'.
1278         The default value includes the actual command.
1280 help.browser::
1281         Specify the browser that will be used to display help in the
1282         'web' format. See linkgit:git-help[1].
1284 help.format::
1285         Override the default help format used by linkgit:git-help[1].
1286         Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1287         the default. 'web' and 'html' are the same.
1289 help.autocorrect::
1290         Automatically correct and execute mistyped commands after
1291         waiting for the given number of deciseconds (0.1 sec). If more
1292         than one command can be deduced from the entered text, nothing
1293         will be executed.  If the value of this option is negative,
1294         the corrected command will be executed immediately. If the
1295         value is 0 - the command will be just shown but not executed.
1296         This is the default.
1298 http.proxy::
1299         Override the HTTP proxy, normally configured using the 'http_proxy',
1300         'https_proxy', and 'all_proxy' environment variables (see
1301         `curl(1)`).  This can be overridden on a per-remote basis; see
1302         remote.<name>.proxy
1304 http.cookiefile::
1305         File containing previously stored cookie lines which should be used
1306         in the git http session, if they match the server. The file format
1307         of the file to read cookies from should be plain HTTP headers or
1308         the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
1309         NOTE that the file specified with http.cookiefile is only used as
1310         input. No cookies will be stored in the file.
1312 http.sslVerify::
1313         Whether to verify the SSL certificate when fetching or pushing
1314         over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1315         variable.
1317 http.sslCert::
1318         File containing the SSL certificate when fetching or pushing
1319         over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1320         variable.
1322 http.sslKey::
1323         File containing the SSL private key when fetching or pushing
1324         over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1325         variable.
1327 http.sslCertPasswordProtected::
1328         Enable git's password prompt for the SSL certificate.  Otherwise
1329         OpenSSL will prompt the user, possibly many times, if the
1330         certificate or private key is encrypted.  Can be overridden by the
1331         'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1333 http.sslCAInfo::
1334         File containing the certificates to verify the peer with when
1335         fetching or pushing over HTTPS. Can be overridden by the
1336         'GIT_SSL_CAINFO' environment variable.
1338 http.sslCAPath::
1339         Path containing files with the CA certificates to verify the peer
1340         with when fetching or pushing over HTTPS. Can be overridden
1341         by the 'GIT_SSL_CAPATH' environment variable.
1343 http.maxRequests::
1344         How many HTTP requests to launch in parallel. Can be overridden
1345         by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1347 http.minSessions::
1348         The number of curl sessions (counted across slots) to be kept across
1349         requests. They will not be ended with curl_easy_cleanup() until
1350         http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1351         value will be capped at 1. Defaults to 1.
1353 http.postBuffer::
1354         Maximum size in bytes of the buffer used by smart HTTP
1355         transports when POSTing data to the remote system.
1356         For requests larger than this buffer size, HTTP/1.1 and
1357         Transfer-Encoding: chunked is used to avoid creating a
1358         massive pack file locally.  Default is 1 MiB, which is
1359         sufficient for most requests.
1361 http.lowSpeedLimit, http.lowSpeedTime::
1362         If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1363         for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1364         Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1365         'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1367 http.noEPSV::
1368         A boolean which disables using of EPSV ftp command by curl.
1369         This can helpful with some "poor" ftp servers which don't
1370         support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1371         environment variable. Default is false (curl will use EPSV).
1373 http.useragent::
1374         The HTTP USER_AGENT string presented to an HTTP server.  The default
1375         value represents the version of the client git such as git/1.7.1.
1376         This option allows you to override this value to a more common value
1377         such as Mozilla/4.0.  This may be necessary, for instance, if
1378         connecting through a firewall that restricts HTTP connections to a set
1379         of common USER_AGENT strings (but not including those like git/1.7.1).
1380         Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1382 i18n.commitEncoding::
1383         Character encoding the commit messages are stored in; git itself
1384         does not care per se, but this information is necessary e.g. when
1385         importing commits from emails or in the gitk graphical history
1386         browser (and possibly at other places in the future or in other
1387         porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1389 i18n.logOutputEncoding::
1390         Character encoding the commit messages are converted to when
1391         running 'git log' and friends.
1393 imap::
1394         The configuration variables in the 'imap' section are described
1395         in linkgit:git-imap-send[1].
1397 init.templatedir::
1398         Specify the directory from which templates will be copied.
1399         (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1401 instaweb.browser::
1402         Specify the program that will be used to browse your working
1403         repository in gitweb. See linkgit:git-instaweb[1].
1405 instaweb.httpd::
1406         The HTTP daemon command-line to start gitweb on your working
1407         repository. See linkgit:git-instaweb[1].
1409 instaweb.local::
1410         If true the web server started by linkgit:git-instaweb[1] will
1411         be bound to the local IP (127.0.0.1).
1413 instaweb.modulepath::
1414         The default module path for linkgit:git-instaweb[1] to use
1415         instead of /usr/lib/apache2/modules.  Only used if httpd
1416         is Apache.
1418 instaweb.port::
1419         The port number to bind the gitweb httpd to. See
1420         linkgit:git-instaweb[1].
1422 interactive.singlekey::
1423         In interactive commands, allow the user to provide one-letter
1424         input with a single key (i.e., without hitting enter).
1425         Currently this is used by the `\--patch` mode of
1426         linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1427         linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1428         setting is silently ignored if portable keystroke input
1429         is not available.
1431 log.abbrevCommit::
1432         If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1433         linkgit:git-whatchanged[1] assume `\--abbrev-commit`. You may
1434         override this option with `\--no-abbrev-commit`.
1436 log.date::
1437         Set the default date-time mode for the 'log' command.
1438         Setting a value for log.date is similar to using 'git log''s
1439         `\--date` option.  Possible values are `relative`, `local`,
1440         `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1441         for details.
1443 log.decorate::
1444         Print out the ref names of any commits that are shown by the log
1445         command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1446         'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1447         specified, the full ref name (including prefix) will be printed.
1448         This is the same as the log commands '--decorate' option.
1450 log.showroot::
1451         If true, the initial commit will be shown as a big creation event.
1452         This is equivalent to a diff against an empty tree.
1453         Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1454         normally hide the root commit will now show it. True by default.
1456 mailmap.file::
1457         The location of an augmenting mailmap file. The default
1458         mailmap, located in the root of the repository, is loaded
1459         first, then the mailmap file pointed to by this variable.
1460         The location of the mailmap file may be in a repository
1461         subdirectory, or somewhere outside of the repository itself.
1462         See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1464 man.viewer::
1465         Specify the programs that may be used to display help in the
1466         'man' format. See linkgit:git-help[1].
1468 man.<tool>.cmd::
1469         Specify the command to invoke the specified man viewer. The
1470         specified command is evaluated in shell with the man page
1471         passed as argument. (See linkgit:git-help[1].)
1473 man.<tool>.path::
1474         Override the path for the given tool that may be used to
1475         display help in the 'man' format. See linkgit:git-help[1].
1477 include::merge-config.txt[]
1479 mergetool.<tool>.path::
1480         Override the path for the given tool.  This is useful in case
1481         your tool is not in the PATH.
1483 mergetool.<tool>.cmd::
1484         Specify the command to invoke the specified merge tool.  The
1485         specified command is evaluated in shell with the following
1486         variables available: 'BASE' is the name of a temporary file
1487         containing the common base of the files to be merged, if available;
1488         'LOCAL' is the name of a temporary file containing the contents of
1489         the file on the current branch; 'REMOTE' is the name of a temporary
1490         file containing the contents of the file from the branch being
1491         merged; 'MERGED' contains the name of the file to which the merge
1492         tool should write the results of a successful merge.
1494 mergetool.<tool>.trustExitCode::
1495         For a custom merge command, specify whether the exit code of
1496         the merge command can be used to determine whether the merge was
1497         successful.  If this is not set to true then the merge target file
1498         timestamp is checked and the merge assumed to have been successful
1499         if the file has been updated, otherwise the user is prompted to
1500         indicate the success of the merge.
1502 mergetool.keepBackup::
1503         After performing a merge, the original file with conflict markers
1504         can be saved as a file with a `.orig` extension.  If this variable
1505         is set to `false` then this file is not preserved.  Defaults to
1506         `true` (i.e. keep the backup files).
1508 mergetool.keepTemporaries::
1509         When invoking a custom merge tool, git uses a set of temporary
1510         files to pass to the tool. If the tool returns an error and this
1511         variable is set to `true`, then these temporary files will be
1512         preserved, otherwise they will be removed after the tool has
1513         exited. Defaults to `false`.
1515 mergetool.prompt::
1516         Prompt before each invocation of the merge resolution program.
1518 notes.displayRef::
1519         The (fully qualified) refname from which to show notes when
1520         showing commit messages.  The value of this variable can be set
1521         to a glob, in which case notes from all matching refs will be
1522         shown.  You may also specify this configuration variable
1523         several times.  A warning will be issued for refs that do not
1524         exist, but a glob that does not match any refs is silently
1525         ignored.
1527 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1528 environment variable, which must be a colon separated list of refs or
1529 globs.
1531 The effective value of "core.notesRef" (possibly overridden by
1532 GIT_NOTES_REF) is also implicitly added to the list of refs to be
1533 displayed.
1535 notes.rewrite.<command>::
1536         When rewriting commits with <command> (currently `amend` or
1537         `rebase`) and this variable is set to `true`, git
1538         automatically copies your notes from the original to the
1539         rewritten commit.  Defaults to `true`, but see
1540         "notes.rewriteRef" below.
1542 notes.rewriteMode::
1543         When copying notes during a rewrite (see the
1544         "notes.rewrite.<command>" option), determines what to do if
1545         the target commit already has a note.  Must be one of
1546         `overwrite`, `concatenate`, or `ignore`.  Defaults to
1547         `concatenate`.
1549 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1550 environment variable.
1552 notes.rewriteRef::
1553         When copying notes during a rewrite, specifies the (fully
1554         qualified) ref whose notes should be copied.  The ref may be a
1555         glob, in which case notes in all matching refs will be copied.
1556         You may also specify this configuration several times.
1558 Does not have a default value; you must configure this variable to
1559 enable note rewriting.  Set it to `refs/notes/commits` to enable
1560 rewriting for the default commit notes.
1562 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1563 environment variable, which must be a colon separated list of refs or
1564 globs.
1566 pack.window::
1567         The size of the window used by linkgit:git-pack-objects[1] when no
1568         window size is given on the command line. Defaults to 10.
1570 pack.depth::
1571         The maximum delta depth used by linkgit:git-pack-objects[1] when no
1572         maximum depth is given on the command line. Defaults to 50.
1574 pack.windowMemory::
1575         The window memory size limit used by linkgit:git-pack-objects[1]
1576         when no limit is given on the command line.  The value can be
1577         suffixed with "k", "m", or "g".  Defaults to 0, meaning no
1578         limit.
1580 pack.compression::
1581         An integer -1..9, indicating the compression level for objects
1582         in a pack file. -1 is the zlib default. 0 means no
1583         compression, and 1..9 are various speed/size tradeoffs, 9 being
1584         slowest.  If not set,  defaults to core.compression.  If that is
1585         not set,  defaults to -1, the zlib default, which is "a default
1586         compromise between speed and compression (currently equivalent
1587         to level 6)."
1589 Note that changing the compression level will not automatically recompress
1590 all existing objects. You can force recompression by passing the -F option
1591 to linkgit:git-repack[1].
1593 pack.deltaCacheSize::
1594         The maximum memory in bytes used for caching deltas in
1595         linkgit:git-pack-objects[1] before writing them out to a pack.
1596         This cache is used to speed up the writing object phase by not
1597         having to recompute the final delta result once the best match
1598         for all objects is found.  Repacking large repositories on machines
1599         which are tight with memory might be badly impacted by this though,
1600         especially if this cache pushes the system into swapping.
1601         A value of 0 means no limit. The smallest size of 1 byte may be
1602         used to virtually disable this cache. Defaults to 256 MiB.
1604 pack.deltaCacheLimit::
1605         The maximum size of a delta, that is cached in
1606         linkgit:git-pack-objects[1]. This cache is used to speed up the
1607         writing object phase by not having to recompute the final delta
1608         result once the best match for all objects is found. Defaults to 1000.
1610 pack.threads::
1611         Specifies the number of threads to spawn when searching for best
1612         delta matches.  This requires that linkgit:git-pack-objects[1]
1613         be compiled with pthreads otherwise this option is ignored with a
1614         warning. This is meant to reduce packing time on multiprocessor
1615         machines. The required amount of memory for the delta search window
1616         is however multiplied by the number of threads.
1617         Specifying 0 will cause git to auto-detect the number of CPU's
1618         and set the number of threads accordingly.
1620 pack.indexVersion::
1621         Specify the default pack index version.  Valid values are 1 for
1622         legacy pack index used by Git versions prior to 1.5.2, and 2 for
1623         the new pack index with capabilities for packs larger than 4 GB
1624         as well as proper protection against the repacking of corrupted
1625         packs.  Version 2 is the default.  Note that version 2 is enforced
1626         and this config option ignored whenever the corresponding pack is
1627         larger than 2 GB.
1629 If you have an old git that does not understand the version 2 `{asterisk}.idx` file,
1630 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1631 that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the
1632 other side may give you a repository that cannot be accessed with your
1633 older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,
1634 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1635 the `{asterisk}.idx` file.
1637 pack.packSizeLimit::
1638         The maximum size of a pack.  This setting only affects
1639         packing to a file when repacking, i.e. the git:// protocol
1640         is unaffected.  It can be overridden by the `\--max-pack-size`
1641         option of linkgit:git-repack[1]. The minimum size allowed is
1642         limited to 1 MiB. The default is unlimited.
1643         Common unit suffixes of 'k', 'm', or 'g' are
1644         supported.
1646 pager.<cmd>::
1647         If the value is boolean, turns on or off pagination of the
1648         output of a particular git subcommand when writing to a tty.
1649         Otherwise, turns on pagination for the subcommand using the
1650         pager specified by the value of `pager.<cmd>`.  If `\--paginate`
1651         or `\--no-pager` is specified on the command line, it takes
1652         precedence over this option.  To disable pagination for all
1653         commands, set `core.pager` or `GIT_PAGER` to `cat`.
1655 pretty.<name>::
1656         Alias for a --pretty= format string, as specified in
1657         linkgit:git-log[1]. Any aliases defined here can be used just
1658         as the built-in pretty formats could. For example,
1659         running `git config pretty.changelog "format:{asterisk} %H %s"`
1660         would cause the invocation `git log --pretty=changelog`
1661         to be equivalent to running `git log "--pretty=format:{asterisk} %H %s"`.
1662         Note that an alias with the same name as a built-in format
1663         will be silently ignored.
1665 pull.rebase::
1666         When true, rebase branches on top of the fetched branch, instead
1667         of merging the default branch from the default remote when "git
1668         pull" is run. See "branch.<name>.rebase" for setting this on a
1669         per-branch basis.
1671 *NOTE*: this is a possibly dangerous operation; do *not* use
1672 it unless you understand the implications (see linkgit:git-rebase[1]
1673 for details).
1675 pull.octopus::
1676         The default merge strategy to use when pulling multiple branches
1677         at once.
1679 pull.twohead::
1680         The default merge strategy to use when pulling a single branch.
1682 push.default::
1683         Defines the action git push should take if no refspec is given
1684         on the command line, no refspec is configured in the remote, and
1685         no refspec is implied by any of the options given on the command
1686         line. Possible values are:
1688 * `nothing` - do not push anything.
1689 * `matching` - push all matching branches.
1690   All branches having the same name in both ends are considered to be
1691   matching. This is the default.
1692 * `upstream` - push the current branch to its upstream branch.
1693 * `tracking` - deprecated synonym for `upstream`.
1694 * `current` - push the current branch to a branch of the same name.
1696 rebase.stat::
1697         Whether to show a diffstat of what changed upstream since the last
1698         rebase. False by default.
1700 rebase.autosquash::
1701         If set to true enable '--autosquash' option by default.
1703 receive.autogc::
1704         By default, git-receive-pack will run "git-gc --auto" after
1705         receiving data from git-push and updating refs.  You can stop
1706         it by setting this variable to false.
1708 receive.fsckObjects::
1709         If it is set to true, git-receive-pack will check all received
1710         objects. It will abort in the case of a malformed object or a
1711         broken link. The result of an abort are only dangling objects.
1712         Defaults to false. If not set, the value of `transfer.fsckObjects`
1713         is used instead.
1715 receive.unpackLimit::
1716         If the number of objects received in a push is below this
1717         limit then the objects will be unpacked into loose object
1718         files. However if the number of received objects equals or
1719         exceeds this limit then the received pack will be stored as
1720         a pack, after adding any missing delta bases.  Storing the
1721         pack from a push can make the push operation complete faster,
1722         especially on slow filesystems.  If not set, the value of
1723         `transfer.unpackLimit` is used instead.
1725 receive.denyDeletes::
1726         If set to true, git-receive-pack will deny a ref update that deletes
1727         the ref. Use this to prevent such a ref deletion via a push.
1729 receive.denyDeleteCurrent::
1730         If set to true, git-receive-pack will deny a ref update that
1731         deletes the currently checked out branch of a non-bare repository.
1733 receive.denyCurrentBranch::
1734         If set to true or "refuse", git-receive-pack will deny a ref update
1735         to the currently checked out branch of a non-bare repository.
1736         Such a push is potentially dangerous because it brings the HEAD
1737         out of sync with the index and working tree. If set to "warn",
1738         print a warning of such a push to stderr, but allow the push to
1739         proceed. If set to false or "ignore", allow such pushes with no
1740         message. Defaults to "refuse".
1742 There are two more options that are meant for Git experts: "updateInstead"
1743 which will run `read-tree -u -m HEAD` and "detachInstead" which will detach
1744 the HEAD so it does not need to change.  Both options come with their own
1745 set of possible *complications*, but can be appropriate in rare workflows.
1747 receive.denyNonFastForwards::
1748         If set to true, git-receive-pack will deny a ref update which is
1749         not a fast-forward. Use this to prevent such an update via a push,
1750         even if that push is forced. This configuration variable is
1751         set when initializing a shared repository.
1753 receive.updateserverinfo::
1754         If set to true, git-receive-pack will run git-update-server-info
1755         after receiving data from git-push and updating refs.
1757 remote.<name>.url::
1758         The URL of a remote repository.  See linkgit:git-fetch[1] or
1759         linkgit:git-push[1].
1761 remote.<name>.pushurl::
1762         The push URL of a remote repository.  See linkgit:git-push[1].
1764 remote.<name>.proxy::
1765         For remotes that require curl (http, https and ftp), the URL to
1766         the proxy to use for that remote.  Set to the empty string to
1767         disable proxying for that remote.
1769 remote.<name>.fetch::
1770         The default set of "refspec" for linkgit:git-fetch[1]. See
1771         linkgit:git-fetch[1].
1773 remote.<name>.push::
1774         The default set of "refspec" for linkgit:git-push[1]. See
1775         linkgit:git-push[1].
1777 remote.<name>.mirror::
1778         If true, pushing to this remote will automatically behave
1779         as if the `\--mirror` option was given on the command line.
1781 remote.<name>.skipDefaultUpdate::
1782         If true, this remote will be skipped by default when updating
1783         using linkgit:git-fetch[1] or the `update` subcommand of
1784         linkgit:git-remote[1].
1786 remote.<name>.skipFetchAll::
1787         If true, this remote will be skipped by default when updating
1788         using linkgit:git-fetch[1] or the `update` subcommand of
1789         linkgit:git-remote[1].
1791 remote.<name>.receivepack::
1792         The default program to execute on the remote side when pushing.  See
1793         option \--receive-pack of linkgit:git-push[1].
1795 remote.<name>.uploadpack::
1796         The default program to execute on the remote side when fetching.  See
1797         option \--upload-pack of linkgit:git-fetch-pack[1].
1799 remote.<name>.tagopt::
1800         Setting this value to \--no-tags disables automatic tag following when
1801         fetching from remote <name>. Setting it to \--tags will fetch every
1802         tag from remote <name>, even if they are not reachable from remote
1803         branch heads. Passing these flags directly to linkgit:git-fetch[1] can
1804         override this setting. See options \--tags and \--no-tags of
1805         linkgit:git-fetch[1].
1807 remote.<name>.vcs::
1808         Setting this to a value <vcs> will cause git to interact with
1809         the remote with the git-remote-<vcs> helper.
1811 remotes.<group>::
1812         The list of remotes which are fetched by "git remote update
1813         <group>".  See linkgit:git-remote[1].
1815 repack.usedeltabaseoffset::
1816         By default, linkgit:git-repack[1] creates packs that use
1817         delta-base offset. If you need to share your repository with
1818         git older than version 1.4.4, either directly or via a dumb
1819         protocol such as http, then you need to set this option to
1820         "false" and repack. Access from old git versions over the
1821         native protocol are unaffected by this option.
1823 rerere.autoupdate::
1824         When set to true, `git-rerere` updates the index with the
1825         resulting contents after it cleanly resolves conflicts using
1826         previously recorded resolution.  Defaults to false.
1828 rerere.enabled::
1829         Activate recording of resolved conflicts, so that identical
1830         conflict hunks can be resolved automatically, should they be
1831         encountered again.  By default, linkgit:git-rerere[1] is
1832         enabled if there is an `rr-cache` directory under the
1833         `$GIT_DIR`, e.g. if "rerere" was previously used in the
1834         repository.
1836 sendemail.identity::
1837         A configuration identity. When given, causes values in the
1838         'sendemail.<identity>' subsection to take precedence over
1839         values in the 'sendemail' section. The default identity is
1840         the value of 'sendemail.identity'.
1842 sendemail.smtpencryption::
1843         See linkgit:git-send-email[1] for description.  Note that this
1844         setting is not subject to the 'identity' mechanism.
1846 sendemail.smtpssl::
1847         Deprecated alias for 'sendemail.smtpencryption = ssl'.
1849 sendemail.<identity>.*::
1850         Identity-specific versions of the 'sendemail.*' parameters
1851         found below, taking precedence over those when the this
1852         identity is selected, through command-line or
1853         'sendemail.identity'.
1855 sendemail.aliasesfile::
1856 sendemail.aliasfiletype::
1857 sendemail.bcc::
1858 sendemail.cc::
1859 sendemail.cccmd::
1860 sendemail.chainreplyto::
1861 sendemail.confirm::
1862 sendemail.envelopesender::
1863 sendemail.from::
1864 sendemail.multiedit::
1865 sendemail.signedoffbycc::
1866 sendemail.smtppass::
1867 sendemail.suppresscc::
1868 sendemail.suppressfrom::
1869 sendemail.to::
1870 sendemail.smtpdomain::
1871 sendemail.smtpserver::
1872 sendemail.smtpserverport::
1873 sendemail.smtpserveroption::
1874 sendemail.smtpuser::
1875 sendemail.thread::
1876 sendemail.validate::
1877         See linkgit:git-send-email[1] for description.
1879 sendemail.signedoffcc::
1880         Deprecated alias for 'sendemail.signedoffbycc'.
1882 showbranch.default::
1883         The default set of branches for linkgit:git-show-branch[1].
1884         See linkgit:git-show-branch[1].
1886 status.relativePaths::
1887         By default, linkgit:git-status[1] shows paths relative to the
1888         current directory. Setting this variable to `false` shows paths
1889         relative to the repository root (this was the default for git
1890         prior to v1.5.4).
1892 status.showUntrackedFiles::
1893         By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1894         files which are not currently tracked by Git. Directories which
1895         contain only untracked files, are shown with the directory name
1896         only. Showing untracked files means that Git needs to lstat() all
1897         all the files in the whole repository, which might be slow on some
1898         systems. So, this variable controls how the commands displays
1899         the untracked files. Possible values are:
1902 * `no` - Show no untracked files.
1903 * `normal` - Show untracked files and directories.
1904 * `all` - Show also individual files in untracked directories.
1907 If this variable is not specified, it defaults to 'normal'.
1908 This variable can be overridden with the -u|--untracked-files option
1909 of linkgit:git-status[1] and linkgit:git-commit[1].
1911 status.submodulesummary::
1912         Defaults to false.
1913         If this is set to a non zero number or true (identical to -1 or an
1914         unlimited number), the submodule summary will be enabled and a
1915         summary of commits for modified submodules will be shown (see
1916         --summary-limit option of linkgit:git-submodule[1]).
1918 submodule.<name>.path::
1919 submodule.<name>.url::
1920 submodule.<name>.update::
1921         The path within this project, URL, and the updating strategy
1922         for a submodule.  These variables are initially populated
1923         by 'git submodule init'; edit them to override the
1924         URL and other values found in the `.gitmodules` file.  See
1925         linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
1927 submodule.<name>.fetchRecurseSubmodules::
1928         This option can be used to control recursive fetching of this
1929         submodule. It can be overridden by using the --[no-]recurse-submodules
1930         command line option to "git fetch" and "git pull".
1931         This setting will override that from in the linkgit:gitmodules[5]
1932         file.
1934 submodule.<name>.ignore::
1935         Defines under what circumstances "git status" and the diff family show
1936         a submodule as modified. When set to "all", it will never be considered
1937         modified, "dirty" will ignore all changes to the submodules work tree and
1938         takes only differences between the HEAD of the submodule and the commit
1939         recorded in the superproject into account. "untracked" will additionally
1940         let submodules with modified tracked files in their work tree show up.
1941         Using "none" (the default when this option is not set) also shows
1942         submodules that have untracked files in their work tree as changed.
1943         This setting overrides any setting made in .gitmodules for this submodule,
1944         both settings can be overridden on the command line by using the
1945         "--ignore-submodules" option.
1947 tar.umask::
1948         This variable can be used to restrict the permission bits of
1949         tar archive entries.  The default is 0002, which turns off the
1950         world write bit.  The special value "user" indicates that the
1951         archiving user's umask will be used instead.  See umask(2) and
1952         linkgit:git-archive[1].
1954 transfer.fsckObjects::
1955         When `fetch.fsckObjects` or `receive.fsckObjects` are
1956         not set, the value of this variable is used instead.
1957         Defaults to false.
1959 transfer.unpackLimit::
1960         When `fetch.unpackLimit` or `receive.unpackLimit` are
1961         not set, the value of this variable is used instead.
1962         The default value is 100.
1964 url.<base>.insteadOf::
1965         Any URL that starts with this value will be rewritten to
1966         start, instead, with <base>. In cases where some site serves a
1967         large number of repositories, and serves them with multiple
1968         access methods, and some users need to use different access
1969         methods, this feature allows people to specify any of the
1970         equivalent URLs and have git automatically rewrite the URL to
1971         the best alternative for the particular user, even for a
1972         never-before-seen repository on the site.  When more than one
1973         insteadOf strings match a given URL, the longest match is used.
1975 url.<base>.pushInsteadOf::
1976         Any URL that starts with this value will not be pushed to;
1977         instead, it will be rewritten to start with <base>, and the
1978         resulting URL will be pushed to. In cases where some site serves
1979         a large number of repositories, and serves them with multiple
1980         access methods, some of which do not allow push, this feature
1981         allows people to specify a pull-only URL and have git
1982         automatically use an appropriate URL to push, even for a
1983         never-before-seen repository on the site.  When more than one
1984         pushInsteadOf strings match a given URL, the longest match is
1985         used.  If a remote has an explicit pushurl, git will ignore this
1986         setting for that remote.
1988 user.email::
1989         Your email address to be recorded in any newly created commits.
1990         Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
1991         'EMAIL' environment variables.  See linkgit:git-commit-tree[1].
1993 user.name::
1994         Your full name to be recorded in any newly created commits.
1995         Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
1996         environment variables.  See linkgit:git-commit-tree[1].
1998 user.signingkey::
1999         If linkgit:git-tag[1] is not selecting the key you want it to
2000         automatically when creating a signed tag, you can override the
2001         default selection with this variable.  This option is passed
2002         unchanged to gpg's --local-user parameter, so you may specify a key
2003         using any method that gpg supports.
2005 web.browser::
2006         Specify a web browser that may be used by some commands.
2007         Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
2008         may use it.