format-patch: document the format.to configuration setting
[git.git] / Documentation / config.txt
blob1029bc46ca82ca8da70c131d6e688430d6450871
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 and only alphanumeric
16 characters are allowed. Some variables may appear multiple times.
18 Syntax
19 ~~~~~~
21 The syntax is fairly flexible and permissive; whitespaces are mostly
22 ignored.  The '#' and ';' characters begin comments to the end of line,
23 blank lines are ignored.
25 The file consists of sections and variables.  A section begins with
26 the name of the section in square brackets and continues until the next
27 section begins.  Section names are not case sensitive.  Only alphanumeric
28 characters, `-` and `.` are allowed in section names.  Each variable
29 must belong to some section, which means that there must be a section
30 header before the first setting of a variable.
32 Sections can be further divided into subsections.  To begin a subsection
33 put its name in double quotes, separated by space from the section name,
34 in the section header, like in the example below:
36 --------
37         [section "subsection"]
39 --------
41 Subsection names are case sensitive and can contain any characters except
42 newline (doublequote `"` and backslash have to be escaped as `\"` and `\\`,
43 respectively).  Section headers cannot span multiple
44 lines.  Variables may belong directly to a section or to a given subsection.
45 You can have `[section]` if you have `[section "subsection"]`, but you
46 don't need to.
48 There is also a case insensitive alternative `[section.subsection]` syntax.
49 In this syntax, subsection names follow the same restrictions as for section
50 names.
52 All the other lines (and the remainder of the line after the section
53 header) are recognized as setting variables, in the form
54 'name = value'.  If there is no equal sign on the line, the entire line
55 is taken as 'name' and the variable is recognized as boolean "true".
56 The variable names are case-insensitive and only alphanumeric
57 characters and `-` are allowed.  There can be more than one value
58 for a given variable; we say then that variable is multivalued.
60 Leading and trailing whitespace in a variable value is discarded.
61 Internal whitespace within a variable value is retained verbatim.
63 The values following the equals sign in variable assign are all either
64 a string, an integer, or a boolean.  Boolean values may be given as yes/no,
65 0/1, true/false or on/off.  Case is not significant in boolean values, when
66 converting value to the canonical form using '--bool' type specifier;
67 'git config' will ensure that the output is "true" or "false".
69 String values may be entirely or partially enclosed in double quotes.
70 You need to enclose variable values in double quotes if you want to
71 preserve leading or trailing whitespace, or if the variable value contains
72 comment characters (i.e. it contains '#' or ';').
73 Double quote `"` and backslash `\` characters in variable values must
74 be escaped: use `\"` for `"` and `\\` for `\`.
76 The following escape sequences (beside `\"` and `\\`) are recognized:
77 `\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
78 and `\b` for backspace (BS).  No other char escape sequence, nor octal
79 char sequences are valid.
81 Variable values ending in a `\` are continued on the next line in the
82 customary UNIX fashion.
84 Some variables may require a special value format.
86 Example
87 ~~~~~~~
89         # Core variables
90         [core]
91                 ; Don't trust file modes
92                 filemode = false
94         # Our diff algorithm
95         [diff]
96                 external = /usr/local/bin/diff-wrapper
97                 renames = true
99         [branch "devel"]
100                 remote = origin
101                 merge = refs/heads/devel
103         # Proxy settings
104         [core]
105                 gitProxy="ssh" for "kernel.org"
106                 gitProxy=default-proxy ; for the rest
108 Variables
109 ~~~~~~~~~
111 Note that this list is non-comprehensive and not necessarily complete.
112 For command-specific variables, you will find a more detailed description
113 in the appropriate manual page. You will find a description of non-core
114 porcelain configuration variables in the respective porcelain documentation.
116 advice.*::
117         When set to 'true', display the given optional help message.
118         When set to 'false', do not display. The configuration variables
119         are:
122         pushNonFastForward::
123                 Advice shown when linkgit:git-push[1] refuses
124                 non-fast-forward refs. Default: true.
125         statusHints::
126                 Directions on how to stage/unstage/add shown in the
127                 output of linkgit:git-status[1] and the template shown
128                 when writing commit messages. Default: true.
129         commitBeforeMerge::
130                 Advice shown when linkgit:git-merge[1] refuses to
131                 merge to avoid overwritting local changes.
132                 Default: true.
133         resolveConflict::
134                 Advices shown by various commands when conflicts
135                 prevent the operation from being performed.
136                 Default: true.
137         implicitIdentity::
138                 Advice on how to set your identity configuration when
139                 your information is guessed from the system username and
140                 domain name. Default: true.
142         detachedHead::
143                 Advice shown when you used linkgit::git-checkout[1] to
144                 move to the detach HEAD state, to instruct how to create
145                 a local branch after the fact.  Default: true.
148 core.fileMode::
149         If false, the executable bit differences between the index and
150         the working copy are ignored; useful on broken filesystems like FAT.
151         See linkgit:git-update-index[1].
153 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
154 will probe and set core.fileMode false if appropriate when the
155 repository is created.
157 core.ignoreCygwinFSTricks::
158         This option is only used by Cygwin implementation of Git. If false,
159         the Cygwin stat() and lstat() functions are used. This may be useful
160         if your repository consists of a few separate directories joined in
161         one hierarchy using Cygwin mount. If true, Git uses native Win32 API
162         whenever it is possible and falls back to Cygwin functions only to
163         handle symbol links. The native mode is more than twice faster than
164         normal Cygwin l/stat() functions. True by default, unless core.filemode
165         is true, in which case ignoreCygwinFSTricks is ignored as Cygwin's
166         POSIX emulation is required to support core.filemode.
168 core.ignorecase::
169         If true, this option enables various workarounds to enable
170         git to work better on filesystems that are not case sensitive,
171         like FAT. For example, if a directory listing finds
172         "makefile" when git expects "Makefile", git will assume
173         it is really the same file, and continue to remember it as
174         "Makefile".
176 The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
177 will probe and set core.ignorecase true if appropriate when the repository
178 is created.
180 core.trustctime::
181         If false, the ctime differences between the index and the
182         working copy are ignored; useful when the inode change time
183         is regularly modified by something outside Git (file system
184         crawlers and some backup systems).
185         See linkgit:git-update-index[1]. True by default.
187 core.quotepath::
188         The commands that output paths (e.g. 'ls-files',
189         'diff'), when not given the `-z` option, will quote
190         "unusual" characters in the pathname by enclosing the
191         pathname in a double-quote pair and with backslashes the
192         same way strings in C source code are quoted.  If this
193         variable is set to false, the bytes higher than 0x80 are
194         not quoted but output as verbatim.  Note that double
195         quote, backslash and control characters are always
196         quoted without `-z` regardless of the setting of this
197         variable.
199 core.autocrlf::
200         If true, makes git convert `CRLF` at the end of lines in text files to
201         `LF` when reading from the work tree, and convert in reverse when
202         writing to the work tree.  The variable can be set to
203         'input', in which case the conversion happens only while
204         reading from the work tree but files are written out to the work
205         tree with `LF` at the end of lines.  A file is considered
206         "text" (i.e. be subjected to the autocrlf mechanism) based on
207         the file's `crlf` attribute, or if `crlf` is unspecified,
208         based on the file's contents.  See linkgit:gitattributes[5].
210 core.safecrlf::
211         If true, makes git check if converting `CRLF` as controlled by
212         `core.autocrlf` is reversible.  Git will verify if a command
213         modifies a file in the work tree either directly or indirectly.
214         For example, committing a file followed by checking out the
215         same file should yield the original file in the work tree.  If
216         this is not the case for the current setting of
217         `core.autocrlf`, git will reject the file.  The variable can
218         be set to "warn", in which case git will only warn about an
219         irreversible conversion but continue the operation.
221 CRLF conversion bears a slight chance of corrupting data.
222 autocrlf=true will convert CRLF to LF during commit and LF to
223 CRLF during checkout.  A file that contains a mixture of LF and
224 CRLF before the commit cannot be recreated by git.  For text
225 files this is the right thing to do: it corrects line endings
226 such that we have only LF line endings in the repository.
227 But for binary files that are accidentally classified as text the
228 conversion can corrupt data.
230 If you recognize such corruption early you can easily fix it by
231 setting the conversion type explicitly in .gitattributes.  Right
232 after committing you still have the original file in your work
233 tree and this file is not yet corrupted.  You can explicitly tell
234 git that this file is binary and git will handle the file
235 appropriately.
237 Unfortunately, the desired effect of cleaning up text files with
238 mixed line endings and the undesired effect of corrupting binary
239 files cannot be distinguished.  In both cases CRLFs are removed
240 in an irreversible way.  For text files this is the right thing
241 to do because CRLFs are line endings, while for binary files
242 converting CRLFs corrupts data.
244 Note, this safety check does not mean that a checkout will generate a
245 file identical to the original file for a different setting of
246 `core.autocrlf`, but only for the current one.  For example, a text
247 file with `LF` would be accepted with `core.autocrlf=input` and could
248 later be checked out with `core.autocrlf=true`, in which case the
249 resulting file would contain `CRLF`, although the original file
250 contained `LF`.  However, in both work trees the line endings would be
251 consistent, that is either all `LF` or all `CRLF`, but never mixed.  A
252 file with mixed line endings would be reported by the `core.safecrlf`
253 mechanism.
255 core.symlinks::
256         If false, symbolic links are checked out as small plain files that
257         contain the link text. linkgit:git-update-index[1] and
258         linkgit:git-add[1] will not change the recorded type to regular
259         file. Useful on filesystems like FAT that do not support
260         symbolic links.
262 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
263 will probe and set core.symlinks false if appropriate when the repository
264 is created.
266 core.gitProxy::
267         A "proxy command" to execute (as 'command host port') instead
268         of establishing direct connection to the remote server when
269         using the git protocol for fetching. If the variable value is
270         in the "COMMAND for DOMAIN" format, the command is applied only
271         on hostnames ending with the specified domain string. This variable
272         may be set multiple times and is matched in the given order;
273         the first match wins.
275 Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
276 (which always applies universally, without the special "for"
277 handling).
279 The special string `none` can be used as the proxy command to
280 specify that no proxy be used for a given domain pattern.
281 This is useful for excluding servers inside a firewall from
282 proxy use, while defaulting to a common proxy for external domains.
284 core.ignoreStat::
285         If true, commands which modify both the working tree and the index
286         will mark the updated paths with the "assume unchanged" bit in the
287         index. These marked files are then assumed to stay unchanged in the
288         working copy, until you mark them otherwise manually - Git will not
289         detect the file changes by lstat() calls. This is useful on systems
290         where those are very slow, such as Microsoft Windows.
291         See linkgit:git-update-index[1].
292         False by default.
294 core.preferSymlinkRefs::
295         Instead of the default "symref" format for HEAD
296         and other symbolic reference files, use symbolic links.
297         This is sometimes needed to work with old scripts that
298         expect HEAD to be a symbolic link.
300 core.bare::
301         If true this repository is assumed to be 'bare' and has no
302         working directory associated with it.  If this is the case a
303         number of commands that require a working directory will be
304         disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
306 This setting is automatically guessed by linkgit:git-clone[1] or
307 linkgit:git-init[1] when the repository was created.  By default a
308 repository that ends in "/.git" is assumed to be not bare (bare =
309 false), while all other repositories are assumed to be bare (bare
310 = true).
312 core.worktree::
313         Set the path to the root of the work tree.
314         This can be overridden by the GIT_WORK_TREE environment
315         variable and the '--work-tree' command line option. It can be
316         an absolute path or a relative path to the .git directory,
317         either specified by --git-dir or GIT_DIR, or automatically
318         discovered.
319         If --git-dir or GIT_DIR are specified but none of
320         --work-tree, GIT_WORK_TREE and core.worktree is specified,
321         the current working directory is regarded as the root of the
322         work tree.
324 Note that this variable is honored even when set in a configuration
325 file in a ".git" subdirectory of a directory, and its value differs
326 from the latter directory (e.g. "/path/to/.git/config" has
327 core.worktree set to "/different/path"), which is most likely a
328 misconfiguration.  Running git commands in "/path/to" directory will
329 still use "/different/path" as the root of the work tree and can cause
330 great confusion to the users.
332 core.logAllRefUpdates::
333         Enable the reflog. Updates to a ref <ref> is logged to the file
334         "$GIT_DIR/logs/<ref>", by appending the new and old
335         SHA1, the date/time and the reason of the update, but
336         only when the file exists.  If this configuration
337         variable is set to true, missing "$GIT_DIR/logs/<ref>"
338         file is automatically created for branch heads.
340 This information can be used to determine what commit
341 was the tip of a branch "2 days ago".
343 This value is true by default in a repository that has
344 a working directory associated with it, and false by
345 default in a bare repository.
347 core.repositoryFormatVersion::
348         Internal variable identifying the repository format and layout
349         version.
351 core.sharedRepository::
352         When 'group' (or 'true'), the repository is made shareable between
353         several users in a group (making sure all the files and objects are
354         group-writable). When 'all' (or 'world' or 'everybody'), the
355         repository will be readable by all users, additionally to being
356         group-shareable. When 'umask' (or 'false'), git will use permissions
357         reported by umask(2). When '0xxx', where '0xxx' is an octal number,
358         files in the repository will have this mode value. '0xxx' will override
359         user's umask value (whereas the other options will only override
360         requested parts of the user's umask value). Examples: '0660' will make
361         the repo read/write-able for the owner and group, but inaccessible to
362         others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
363         repository that is group-readable but not group-writable.
364         See linkgit:git-init[1]. False by default.
366 core.warnAmbiguousRefs::
367         If true, git will warn you if the ref name you passed it is ambiguous
368         and might match multiple refs in the .git/refs/ tree. True by default.
370 core.compression::
371         An integer -1..9, indicating a default compression level.
372         -1 is the zlib default. 0 means no compression,
373         and 1..9 are various speed/size tradeoffs, 9 being slowest.
374         If set, this provides a default to other compression variables,
375         such as 'core.loosecompression' and 'pack.compression'.
377 core.loosecompression::
378         An integer -1..9, indicating the compression level for objects that
379         are not in a pack file. -1 is the zlib default. 0 means no
380         compression, and 1..9 are various speed/size tradeoffs, 9 being
381         slowest.  If not set,  defaults to core.compression.  If that is
382         not set,  defaults to 1 (best speed).
384 core.packedGitWindowSize::
385         Number of bytes of a pack file to map into memory in a
386         single mapping operation.  Larger window sizes may allow
387         your system to process a smaller number of large pack files
388         more quickly.  Smaller window sizes will negatively affect
389         performance due to increased calls to the operating system's
390         memory manager, but may improve performance when accessing
391         a large number of large pack files.
393 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
394 MiB on 32 bit platforms and 1 GiB on 64 bit platforms.  This should
395 be reasonable for all users/operating systems.  You probably do
396 not need to adjust this value.
398 Common unit suffixes of 'k', 'm', or 'g' are supported.
400 core.packedGitLimit::
401         Maximum number of bytes to map simultaneously into memory
402         from pack files.  If Git needs to access more than this many
403         bytes at once to complete an operation it will unmap existing
404         regions to reclaim virtual address space within the process.
406 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
407 This should be reasonable for all users/operating systems, except on
408 the largest projects.  You probably do not need to adjust this value.
410 Common unit suffixes of 'k', 'm', or 'g' are supported.
412 core.deltaBaseCacheLimit::
413         Maximum number of bytes to reserve for caching base objects
414         that multiple deltafied objects reference.  By storing the
415         entire decompressed base objects in a cache Git is able
416         to avoid unpacking and decompressing frequently used base
417         objects multiple times.
419 Default is 16 MiB on all platforms.  This should be reasonable
420 for all users/operating systems, except on the largest projects.
421 You probably do not need to adjust this value.
423 Common unit suffixes of 'k', 'm', or 'g' are supported.
425 core.bigFileThreshold::
426         Files larger than this size are stored deflated, without
427         attempting delta compression.  Storing large files without
428         delta compression avoids excessive memory usage, at the
429         slight expense of increased disk usage.
431 Default is 512 MiB on all platforms.  This should be reasonable
432 for most projects as source code and other text files can still
433 be delta compressed, but larger binary media files won't be.
435 Common unit suffixes of 'k', 'm', or 'g' are supported.
437 Currently only linkgit:git-fast-import[1] honors this setting.
439 core.excludesfile::
440         In addition to '.gitignore' (per-directory) and
441         '.git/info/exclude', git looks into this file for patterns
442         of files which are not meant to be tracked.  "{tilde}/" is expanded
443         to the value of `$HOME` and "{tilde}user/" to the specified user's
444         home directory.  See linkgit:gitignore[5].
446 core.editor::
447         Commands such as `commit` and `tag` that lets you edit
448         messages by launching an editor uses the value of this
449         variable when it is set, and the environment variable
450         `GIT_EDITOR` is not set.  See linkgit:git-var[1].
452 core.pager::
453         The command that git will use to paginate output.  Can
454         be overridden with the `GIT_PAGER` environment
455         variable.  Note that git sets the `LESS` environment
456         variable to `FRSX` if it is unset when it runs the
457         pager.  One can change these settings by setting the
458         `LESS` variable to some other value.  Alternately,
459         these settings can be overridden on a project or
460         global basis by setting the `core.pager` option.
461         Setting `core.pager` has no affect on the `LESS`
462         environment variable behaviour above, so if you want
463         to override git's default settings this way, you need
464         to be explicit.  For example, to disable the S option
465         in a backward compatible manner, set `core.pager`
466         to `less -+$LESS -FRX`.  This will be passed to the
467         shell by git, which will translate the final command to
468         `LESS=FRSX less -+FRSX -FRX`.
470 core.whitespace::
471         A comma separated list of common whitespace problems to
472         notice.  'git diff' will use `color.diff.whitespace` to
473         highlight them, and 'git apply --whitespace=error' will
474         consider them as errors.  You can prefix `-` to disable
475         any of them (e.g. `-trailing-space`):
477 * `blank-at-eol` treats trailing whitespaces at the end of the line
478   as an error (enabled by default).
479 * `space-before-tab` treats a space character that appears immediately
480   before a tab character in the initial indent part of the line as an
481   error (enabled by default).
482 * `indent-with-non-tab` treats a line that is indented with 8 or more
483   space characters as an error (not enabled by default).
484 * `blank-at-eof` treats blank lines added at the end of file as an error
485   (enabled by default).
486 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
487   `blank-at-eof`.
488 * `cr-at-eol` treats a carriage-return at the end of line as
489   part of the line terminator, i.e. with it, `trailing-space`
490   does not trigger if the character before such a carriage-return
491   is not a whitespace (not enabled by default).
493 core.fsyncobjectfiles::
494         This boolean will enable 'fsync()' when writing object files.
496 This is a total waste of time and effort on a filesystem that orders
497 data writes properly, but can be useful for filesystems that do not use
498 journalling (traditional UNIX filesystems) or that only journal metadata
499 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
501 core.preloadindex::
502         Enable parallel index preload for operations like 'git diff'
504 This can speed up operations like 'git diff' and 'git status' especially
505 on filesystems like NFS that have weak caching semantics and thus
506 relatively high IO latencies.  With this set to 'true', git will do the
507 index comparison to the filesystem data in parallel, allowing
508 overlapping IO's.
510 core.createObject::
511         You can set this to 'link', in which case a hardlink followed by
512         a delete of the source are used to make sure that object creation
513         will not overwrite existing objects.
515 On some file system/operating system combinations, this is unreliable.
516 Set this config setting to 'rename' there; However, This will remove the
517 check that makes sure that existing object files will not get overwritten.
519 core.notesRef::
520         When showing commit messages, also show notes which are stored in
521         the given ref.  The ref must be fully qualified.  If the given
522         ref does not exist, it is not an error but means that no
523         notes should be printed.
525 This setting defaults to "refs/notes/commits", and it can be overridden by
526 the 'GIT_NOTES_REF' environment variable.  See linkgit:git-notes[1].
528 core.sparseCheckout::
529         Enable "sparse checkout" feature. See section "Sparse checkout" in
530         linkgit:git-read-tree[1] for more information.
532 add.ignore-errors::
533         Tells 'git add' to continue adding files when some files cannot be
534         added due to indexing errors. Equivalent to the '--ignore-errors'
535         option of linkgit:git-add[1].
537 alias.*::
538         Command aliases for the linkgit:git[1] command wrapper - e.g.
539         after defining "alias.last = cat-file commit HEAD", the invocation
540         "git last" is equivalent to "git cat-file commit HEAD". To avoid
541         confusion and troubles with script usage, aliases that
542         hide existing git commands are ignored. Arguments are split by
543         spaces, the usual shell quoting and escaping is supported.
544         quote pair and a backslash can be used to quote them.
546 If the alias expansion is prefixed with an exclamation point,
547 it will be treated as a shell command.  For example, defining
548 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
549 "git new" is equivalent to running the shell command
550 "gitk --all --not ORIG_HEAD".  Note that shell commands will be
551 executed from the top-level directory of a repository, which may
552 not necessarily be the current directory.
554 am.keepcr::
555         If true, git-am will call git-mailsplit for patches in mbox format
556         with parameter '--keep-cr'. In this case git-mailsplit will
557         not remove `\r` from lines ending with `\r\n`. Can be overrriden
558         by giving '--no-keep-cr' from the command line.
559         See linkgit:git-am[1], linkgit:git-mailsplit[1].
561 apply.ignorewhitespace::
562         When set to 'change', tells 'git apply' to ignore changes in
563         whitespace, in the same way as the '--ignore-space-change'
564         option.
565         When set to one of: no, none, never, false tells 'git apply' to
566         respect all whitespace differences.
567         See linkgit:git-apply[1].
569 apply.whitespace::
570         Tells 'git apply' how to handle whitespaces, in the same way
571         as the '--whitespace' option. See linkgit:git-apply[1].
573 branch.autosetupmerge::
574         Tells 'git branch' and 'git checkout' to set up new branches
575         so that linkgit:git-pull[1] will appropriately merge from the
576         starting point branch. Note that even if this option is not set,
577         this behavior can be chosen per-branch using the `--track`
578         and `--no-track` options. The valid settings are: `false` -- no
579         automatic setup is done; `true` -- automatic setup is done when the
580         starting point is a remote branch; `always` -- automatic setup is
581         done when the starting point is either a local branch or remote
582         branch. This option defaults to true.
584 branch.autosetuprebase::
585         When a new branch is created with 'git branch' or 'git checkout'
586         that tracks another branch, this variable tells git to set
587         up pull to rebase instead of merge (see "branch.<name>.rebase").
588         When `never`, rebase is never automatically set to true.
589         When `local`, rebase is set to true for tracked branches of
590         other local branches.
591         When `remote`, rebase is set to true for tracked branches of
592         remote branches.
593         When `always`, rebase will be set to true for all tracking
594         branches.
595         See "branch.autosetupmerge" for details on how to set up a
596         branch to track another branch.
597         This option defaults to never.
599 branch.<name>.remote::
600         When in branch <name>, it tells 'git fetch' and 'git push' which
601         remote to fetch from/push to.  It defaults to `origin` if no remote is
602         configured. `origin` is also used if you are not on any branch.
604 branch.<name>.merge::
605         Defines, together with branch.<name>.remote, the upstream branch
606         for the given branch. It tells 'git fetch'/'git pull' which
607         branch to merge and can also affect 'git push' (see push.default).
608         When in branch <name>, it tells 'git fetch' the default
609         refspec to be marked for merging in FETCH_HEAD. The value is
610         handled like the remote part of a refspec, and must match a
611         ref which is fetched from the remote given by
612         "branch.<name>.remote".
613         The merge information is used by 'git pull' (which at first calls
614         'git fetch') to lookup the default branch for merging. Without
615         this option, 'git pull' defaults to merge the first refspec fetched.
616         Specify multiple values to get an octopus merge.
617         If you wish to setup 'git pull' so that it merges into <name> from
618         another branch in the local repository, you can point
619         branch.<name>.merge to the desired branch, and use the special setting
620         `.` (a period) for branch.<name>.remote.
622 branch.<name>.mergeoptions::
623         Sets default options for merging into branch <name>. The syntax and
624         supported options are the same as those of linkgit:git-merge[1], but
625         option values containing whitespace characters are currently not
626         supported.
628 branch.<name>.rebase::
629         When true, rebase the branch <name> on top of the fetched branch,
630         instead of merging the default branch from the default remote when
631         "git pull" is run.
632         *NOTE*: this is a possibly dangerous operation; do *not* use
633         it unless you understand the implications (see linkgit:git-rebase[1]
634         for details).
636 browser.<tool>.cmd::
637         Specify the command to invoke the specified browser. The
638         specified command is evaluated in shell with the URLs passed
639         as arguments. (See linkgit:git-web--browse[1].)
641 browser.<tool>.path::
642         Override the path for the given tool that may be used to
643         browse HTML help (see '-w' option in linkgit:git-help[1]) or a
644         working repository in gitweb (see linkgit:git-instaweb[1]).
646 clean.requireForce::
647         A boolean to make git-clean do nothing unless given -f
648         or -n.   Defaults to true.
650 color.branch::
651         A boolean to enable/disable color in the output of
652         linkgit:git-branch[1]. May be set to `always`,
653         `false` (or `never`) or `auto` (or `true`), in which case colors are used
654         only when the output is to a terminal. Defaults to false.
656 color.branch.<slot>::
657         Use customized color for branch coloration. `<slot>` is one of
658         `current` (the current branch), `local` (a local branch),
659         `remote` (a tracking branch in refs/remotes/), `plain` (other
660         refs).
662 The value for these configuration variables is a list of colors (at most
663 two) and attributes (at most one), separated by spaces.  The colors
664 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
665 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
666 `blink` and `reverse`.  The first color given is the foreground; the
667 second is the background.  The position of the attribute, if any,
668 doesn't matter.
670 color.diff::
671         When set to `always`, always use colors in patch.
672         When false (or `never`), never.  When set to `true` or `auto`, use
673         colors only when the output is to the terminal. Defaults to false.
675 color.diff.<slot>::
676         Use customized color for diff colorization.  `<slot>` specifies
677         which part of the patch to use the specified color, and is one
678         of `plain` (context text), `meta` (metainformation), `frag`
679         (hunk header), 'func' (function in hunk header), `old` (removed lines),
680         `new` (added lines), `commit` (commit headers), or `whitespace`
681         (highlighting whitespace errors). The values of these variables may be
682         specified as in color.branch.<slot>.
684 color.grep::
685         When set to `always`, always highlight matches.  When `false` (or
686         `never`), never.  When set to `true` or `auto`, use color only
687         when the output is written to the terminal.  Defaults to `false`.
689 color.grep.<slot>::
690         Use customized color for grep colorization.  `<slot>` specifies which
691         part of the line to use the specified color, and is one of
694 `context`;;
695         non-matching text in context lines (when using `-A`, `-B`, or `-C`)
696 `filename`;;
697         filename prefix (when not using `-h`)
698 `function`;;
699         function name lines (when using `-p`)
700 `linenumber`;;
701         line number prefix (when using `-n`)
702 `match`;;
703         matching text
704 `selected`;;
705         non-matching text in selected lines
706 `separator`;;
707         separators between fields on a line (`:`, `-`, and `=`)
708         and between hunks (`--`)
711 The values of these variables may be specified as in color.branch.<slot>.
713 color.interactive::
714         When set to `always`, always use colors for interactive prompts
715         and displays (such as those used by "git-add --interactive").
716         When false (or `never`), never.  When set to `true` or `auto`, use
717         colors only when the output is to the terminal. Defaults to false.
719 color.interactive.<slot>::
720         Use customized color for 'git add --interactive'
721         output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
722         four distinct types of normal output from interactive
723         commands.  The values of these variables may be specified as
724         in color.branch.<slot>.
726 color.pager::
727         A boolean to enable/disable colored output when the pager is in
728         use (default is true).
730 color.showbranch::
731         A boolean to enable/disable color in the output of
732         linkgit:git-show-branch[1]. May be set to `always`,
733         `false` (or `never`) or `auto` (or `true`), in which case colors are used
734         only when the output is to a terminal. Defaults to false.
736 color.status::
737         A boolean to enable/disable color in the output of
738         linkgit:git-status[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.status.<slot>::
743         Use customized color for status colorization. `<slot>` is
744         one of `header` (the header text of the status message),
745         `added` or `updated` (files which are added but not committed),
746         `changed` (files which are changed but not added in the index),
747         `untracked` (files which are not tracked by git), or
748         `nobranch` (the color the 'no branch' warning is shown in, defaulting
749         to red). The values of these variables may be specified as in
750         color.branch.<slot>.
752 color.ui::
753         When set to `always`, always use colors in all git commands which
754         are capable of colored output. When false (or `never`), never. When
755         set to `true` or `auto`, use colors only when the output is to the
756         terminal. When more specific variables of color.* are set, they always
757         take precedence over this setting. Defaults to false.
759 commit.status::
760         A boolean to enable/disable inclusion of status information in the
761         commit message template when using an editor to prepare the commit
762         message.  Defaults to true.
764 commit.template::
765         Specify a file to use as the template for new commit messages.
766         "{tilde}/" is expanded to the value of `$HOME` and "{tilde}user/" to the
767         specified user's home directory.
769 diff.autorefreshindex::
770         When using 'git diff' to compare with work tree
771         files, do not consider stat-only change as changed.
772         Instead, silently run `git update-index --refresh` to
773         update the cached stat information for paths whose
774         contents in the work tree match the contents in the
775         index.  This option defaults to true.  Note that this
776         affects only 'git diff' Porcelain, and not lower level
777         'diff' commands such as 'git diff-files'.
779 diff.external::
780         If this config variable is set, diff generation is not
781         performed using the internal diff machinery, but using the
782         given command.  Can be overridden with the `GIT_EXTERNAL_DIFF'
783         environment variable.  The command is called with parameters
784         as described under "git Diffs" in linkgit:git[1].  Note: if
785         you want to use an external diff program only on a subset of
786         your files, you might want to use linkgit:gitattributes[5] instead.
788 diff.mnemonicprefix::
789         If set, 'git diff' uses a prefix pair that is different from the
790         standard "a/" and "b/" depending on what is being compared.  When
791         this configuration is in effect, reverse diff output also swaps
792         the order of the prefixes:
793 `git diff`;;
794         compares the (i)ndex and the (w)ork tree;
795 `git diff HEAD`;;
796          compares a (c)ommit and the (w)ork tree;
797 `git diff --cached`;;
798         compares a (c)ommit and the (i)ndex;
799 `git diff HEAD:file1 file2`;;
800         compares an (o)bject and a (w)ork tree entity;
801 `git diff --no-index a b`;;
802         compares two non-git things (1) and (2).
804 diff.renameLimit::
805         The number of files to consider when performing the copy/rename
806         detection; equivalent to the 'git diff' option '-l'.
808 diff.renames::
809         Tells git to detect renames.  If set to any boolean value, it
810         will enable basic rename detection.  If set to "copies" or
811         "copy", it will detect copies, as well.
813 diff.suppressBlankEmpty::
814         A boolean to inhibit the standard behavior of printing a space
815         before each empty output line. Defaults to false.
817 diff.tool::
818         Controls which diff tool is used.  `diff.tool` overrides
819         `merge.tool` when used by linkgit:git-difftool[1] and has
820         the same valid values as `merge.tool` minus "tortoisemerge"
821         and plus "kompare".
823 difftool.<tool>.path::
824         Override the path for the given tool.  This is useful in case
825         your tool is not in the PATH.
827 difftool.<tool>.cmd::
828         Specify the command to invoke the specified diff tool.
829         The specified command is evaluated in shell with the following
830         variables available:  'LOCAL' is set to the name of the temporary
831         file containing the contents of the diff pre-image and 'REMOTE'
832         is set to the name of the temporary file containing the contents
833         of the diff post-image.
835 difftool.prompt::
836         Prompt before each invocation of the diff tool.
838 diff.wordRegex::
839         A POSIX Extended Regular Expression used to determine what is a "word"
840         when performing word-by-word difference calculations.  Character
841         sequences that match the regular expression are "words", all other
842         characters are *ignorable* whitespace.
844 fetch.unpackLimit::
845         If the number of objects fetched over the git native
846         transfer is below this
847         limit, then the objects will be unpacked into loose object
848         files. However if the number of received objects equals or
849         exceeds this limit then the received pack will be stored as
850         a pack, after adding any missing delta bases.  Storing the
851         pack from a push can make the push operation complete faster,
852         especially on slow filesystems.  If not set, the value of
853         `transfer.unpackLimit` is used instead.
855 format.attach::
856         Enable multipart/mixed attachments as the default for
857         'format-patch'.  The value can also be a double quoted string
858         which will enable attachments as the default and set the
859         value as the boundary.  See the --attach option in
860         linkgit:git-format-patch[1].
862 format.numbered::
863         A boolean which can enable or disable sequence numbers in patch
864         subjects.  It defaults to "auto" which enables it only if there
865         is more than one patch.  It can be enabled or disabled for all
866         messages by setting it to "true" or "false".  See --numbered
867         option in linkgit:git-format-patch[1].
869 format.headers::
870         Additional email headers to include in a patch to be submitted
871         by mail.  See linkgit:git-format-patch[1].
873 format.to::
874 format.cc::
875         Additional recipients to include in a patch to be submitted
876         by mail.  See the --to and --cc options in
877         linkgit:git-format-patch[1].
879 format.subjectprefix::
880         The default for format-patch is to output files with the '[PATCH]'
881         subject prefix. Use this variable to change that prefix.
883 format.suffix::
884         The default for format-patch is to output files with the suffix
885         `.patch`. Use this variable to change that suffix (make sure to
886         include the dot if you want it).
888 format.pretty::
889         The default pretty format for log/show/whatchanged command,
890         See linkgit:git-log[1], linkgit:git-show[1],
891         linkgit:git-whatchanged[1].
893 format.thread::
894         The default threading style for 'git format-patch'.  Can be
895         a boolean value, or `shallow` or `deep`.  `shallow` threading
896         makes every mail a reply to the head of the series,
897         where the head is chosen from the cover letter, the
898         `\--in-reply-to`, and the first patch mail, in this order.
899         `deep` threading makes every mail a reply to the previous one.
900         A true boolean value is the same as `shallow`, and a false
901         value disables threading.
903 format.signoff::
904     A boolean value which lets you enable the `-s/--signoff` option of
905     format-patch by default. *Note:* Adding the Signed-off-by: line to a
906     patch should be a conscious act and means that you certify you have
907     the rights to submit this work under the same open source license.
908     Please see the 'SubmittingPatches' document for further discussion.
910 gc.aggressiveWindow::
911         The window size parameter used in the delta compression
912         algorithm used by 'git gc --aggressive'.  This defaults
913         to 250.
915 gc.auto::
916         When there are approximately more than this many loose
917         objects in the repository, `git gc --auto` will pack them.
918         Some Porcelain commands use this command to perform a
919         light-weight garbage collection from time to time.  The
920         default value is 6700.  Setting this to 0 disables it.
922 gc.autopacklimit::
923         When there are more than this many packs that are not
924         marked with `*.keep` file in the repository, `git gc
925         --auto` consolidates them into one larger pack.  The
926         default value is 50.  Setting this to 0 disables it.
928 gc.packrefs::
929         Running `git pack-refs` in a repository renders it
930         unclonable by Git versions prior to 1.5.1.2 over dumb
931         transports such as HTTP.  This variable determines whether
932         'git gc' runs `git pack-refs`. This can be set to `nobare`
933         to enable it within all non-bare repos or it can be set to a
934         boolean value.  The default is `true`.
936 gc.pruneexpire::
937         When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
938         Override the grace period with this config variable.  The value
939         "now" may be used to disable this  grace period and always prune
940         unreachable objects immediately.
942 gc.reflogexpire::
943         'git reflog expire' removes reflog entries older than
944         this time; defaults to 90 days.
946 gc.reflogexpireunreachable::
947         'git reflog expire' removes reflog entries older than
948         this time and are not reachable from the current tip;
949         defaults to 30 days.
951 gc.rerereresolved::
952         Records of conflicted merge you resolved earlier are
953         kept for this many days when 'git rerere gc' is run.
954         The default is 60 days.  See linkgit:git-rerere[1].
956 gc.rerereunresolved::
957         Records of conflicted merge you have not resolved are
958         kept for this many days when 'git rerere gc' is run.
959         The default is 15 days.  See linkgit:git-rerere[1].
961 gitcvs.commitmsgannotation::
962         Append this string to each commit message. Set to empty string
963         to disable this feature. Defaults to "via git-CVS emulator".
965 gitcvs.enabled::
966         Whether the CVS server interface is enabled for this repository.
967         See linkgit:git-cvsserver[1].
969 gitcvs.logfile::
970         Path to a log file where the CVS server interface well... logs
971         various stuff. See linkgit:git-cvsserver[1].
973 gitcvs.usecrlfattr::
974         If true, the server will look up the `crlf` attribute for
975         files to determine the '-k' modes to use. If `crlf` is set,
976         the '-k' mode will be left blank, so cvs clients will
977         treat it as text. If `crlf` is explicitly unset, the file
978         will be set with '-kb' mode, which suppresses any newline munging
979         the client might otherwise do. If `crlf` is not specified,
980         then 'gitcvs.allbinary' is used. See linkgit:gitattributes[5].
982 gitcvs.allbinary::
983         This is used if 'gitcvs.usecrlfattr' does not resolve
984         the correct '-kb' mode to use. If true, all
985         unresolved files are sent to the client in
986         mode '-kb'. This causes the client to treat them
987         as binary files, which suppresses any newline munging it
988         otherwise might do. Alternatively, if it is set to "guess",
989         then the contents of the file are examined to decide if
990         it is binary, similar to 'core.autocrlf'.
992 gitcvs.dbname::
993         Database used by git-cvsserver to cache revision information
994         derived from the git repository. The exact meaning depends on the
995         used database driver, for SQLite (which is the default driver) this
996         is a filename. Supports variable substitution (see
997         linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
998         Default: '%Ggitcvs.%m.sqlite'
1000 gitcvs.dbdriver::
1001         Used Perl DBI driver. You can specify any available driver
1002         for this here, but it might not work. git-cvsserver is tested
1003         with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1004         reported *not* to work with 'DBD::mysql'. Experimental feature.
1005         May not contain double colons (`:`). Default: 'SQLite'.
1006         See linkgit:git-cvsserver[1].
1008 gitcvs.dbuser, gitcvs.dbpass::
1009         Database user and password. Only useful if setting 'gitcvs.dbdriver',
1010         since SQLite has no concept of database users and/or passwords.
1011         'gitcvs.dbuser' supports variable substitution (see
1012         linkgit:git-cvsserver[1] for details).
1014 gitcvs.dbTableNamePrefix::
1015         Database table name prefix.  Prepended to the names of any
1016         database tables used, allowing a single database to be used
1017         for several repositories.  Supports variable substitution (see
1018         linkgit:git-cvsserver[1] for details).  Any non-alphabetic
1019         characters will be replaced with underscores.
1021 All gitcvs variables except for 'gitcvs.usecrlfattr' and
1022 'gitcvs.allbinary' can also be specified as
1023 'gitcvs.<access_method>.<varname>' (where 'access_method'
1024 is one of "ext" and "pserver") to make them apply only for the given
1025 access method.
1027 gui.commitmsgwidth::
1028         Defines how wide the commit message window is in the
1029         linkgit:git-gui[1]. "75" is the default.
1031 gui.diffcontext::
1032         Specifies how many context lines should be used in calls to diff
1033         made by the linkgit:git-gui[1]. The default is "5".
1035 gui.encoding::
1036         Specifies the default encoding to use for displaying of
1037         file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1038         It can be overridden by setting the 'encoding' attribute
1039         for relevant files (see linkgit:gitattributes[5]).
1040         If this option is not set, the tools default to the
1041         locale encoding.
1043 gui.matchtrackingbranch::
1044         Determines if new branches created with linkgit:git-gui[1] should
1045         default to tracking remote branches with matching names or
1046         not. Default: "false".
1048 gui.newbranchtemplate::
1049         Is used as suggested name when creating new branches using the
1050         linkgit:git-gui[1].
1052 gui.pruneduringfetch::
1053         "true" if linkgit:git-gui[1] should prune tracking branches when
1054         performing a fetch. The default value is "false".
1056 gui.trustmtime::
1057         Determines if linkgit:git-gui[1] should trust the file modification
1058         timestamp or not. By default the timestamps are not trusted.
1060 gui.spellingdictionary::
1061         Specifies the dictionary used for spell checking commit messages in
1062         the linkgit:git-gui[1]. When set to "none" spell checking is turned
1063         off.
1065 gui.fastcopyblame::
1066         If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1067         location detection. It makes blame significantly faster on huge
1068         repositories at the expense of less thorough copy detection.
1070 gui.copyblamethreshold::
1071         Specifies the threshold to use in 'git gui blame' original location
1072         detection, measured in alphanumeric characters. See the
1073         linkgit:git-blame[1] manual for more information on copy detection.
1075 gui.blamehistoryctx::
1076         Specifies the radius of history context in days to show in
1077         linkgit:gitk[1] for the selected commit, when the `Show History
1078         Context` menu item is invoked from 'git gui blame'. If this
1079         variable is set to zero, the whole history is shown.
1081 guitool.<name>.cmd::
1082         Specifies the shell command line to execute when the corresponding item
1083         of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1084         mandatory for every tool. The command is executed from the root of
1085         the working directory, and in the environment it receives the name of
1086         the tool as 'GIT_GUITOOL', the name of the currently selected file as
1087         'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1088         the head is detached, 'CUR_BRANCH' is empty).
1090 guitool.<name>.needsfile::
1091         Run the tool only if a diff is selected in the GUI. It guarantees
1092         that 'FILENAME' is not empty.
1094 guitool.<name>.noconsole::
1095         Run the command silently, without creating a window to display its
1096         output.
1098 guitool.<name>.norescan::
1099         Don't rescan the working directory for changes after the tool
1100         finishes execution.
1102 guitool.<name>.confirm::
1103         Show a confirmation dialog before actually running the tool.
1105 guitool.<name>.argprompt::
1106         Request a string argument from the user, and pass it to the tool
1107         through the 'ARGS' environment variable. Since requesting an
1108         argument implies confirmation, the 'confirm' option has no effect
1109         if this is enabled. If the option is set to 'true', 'yes', or '1',
1110         the dialog uses a built-in generic prompt; otherwise the exact
1111         value of the variable is used.
1113 guitool.<name>.revprompt::
1114         Request a single valid revision from the user, and set the
1115         'REVISION' environment variable. In other aspects this option
1116         is similar to 'argprompt', and can be used together with it.
1118 guitool.<name>.revunmerged::
1119         Show only unmerged branches in the 'revprompt' subdialog.
1120         This is useful for tools similar to merge or rebase, but not
1121         for things like checkout or reset.
1123 guitool.<name>.title::
1124         Specifies the title to use for the prompt dialog. The default
1125         is the tool name.
1127 guitool.<name>.prompt::
1128         Specifies the general prompt string to display at the top of
1129         the dialog, before subsections for 'argprompt' and 'revprompt'.
1130         The default value includes the actual command.
1132 help.browser::
1133         Specify the browser that will be used to display help in the
1134         'web' format. See linkgit:git-help[1].
1136 help.format::
1137         Override the default help format used by linkgit:git-help[1].
1138         Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1139         the default. 'web' and 'html' are the same.
1141 help.autocorrect::
1142         Automatically correct and execute mistyped commands after
1143         waiting for the given number of deciseconds (0.1 sec). If more
1144         than one command can be deduced from the entered text, nothing
1145         will be executed.  If the value of this option is negative,
1146         the corrected command will be executed immediately. If the
1147         value is 0 - the command will be just shown but not executed.
1148         This is the default.
1150 http.proxy::
1151         Override the HTTP proxy, normally configured using the 'http_proxy'
1152         environment variable (see linkgit:curl[1]).  This can be overridden
1153         on a per-remote basis; see remote.<name>.proxy
1155 http.sslVerify::
1156         Whether to verify the SSL certificate when fetching or pushing
1157         over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1158         variable.
1160 http.sslCert::
1161         File containing the SSL certificate when fetching or pushing
1162         over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1163         variable.
1165 http.sslKey::
1166         File containing the SSL private key when fetching or pushing
1167         over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1168         variable.
1170 http.sslCertPasswordProtected::
1171         Enable git's password prompt for the SSL certificate.  Otherwise
1172         OpenSSL will prompt the user, possibly many times, if the
1173         certificate or private key is encrypted.  Can be overridden by the
1174         'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1176 http.sslCAInfo::
1177         File containing the certificates to verify the peer with when
1178         fetching or pushing over HTTPS. Can be overridden by the
1179         'GIT_SSL_CAINFO' environment variable.
1181 http.sslCAPath::
1182         Path containing files with the CA certificates to verify the peer
1183         with when fetching or pushing over HTTPS. Can be overridden
1184         by the 'GIT_SSL_CAPATH' environment variable.
1186 http.maxRequests::
1187         How many HTTP requests to launch in parallel. Can be overridden
1188         by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1190 http.minSessions::
1191         The number of curl sessions (counted across slots) to be kept across
1192         requests. They will not be ended with curl_easy_cleanup() until
1193         http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1194         value will be capped at 1. Defaults to 1.
1196 http.postBuffer::
1197         Maximum size in bytes of the buffer used by smart HTTP
1198         transports when POSTing data to the remote system.
1199         For requests larger than this buffer size, HTTP/1.1 and
1200         Transfer-Encoding: chunked is used to avoid creating a
1201         massive pack file locally.  Default is 1 MiB, which is
1202         sufficient for most requests.
1204 http.lowSpeedLimit, http.lowSpeedTime::
1205         If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1206         for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1207         Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1208         'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1210 http.noEPSV::
1211         A boolean which disables using of EPSV ftp command by curl.
1212         This can helpful with some "poor" ftp servers which don't
1213         support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1214         environment variable. Default is false (curl will use EPSV).
1216 i18n.commitEncoding::
1217         Character encoding the commit messages are stored in; git itself
1218         does not care per se, but this information is necessary e.g. when
1219         importing commits from emails or in the gitk graphical history
1220         browser (and possibly at other places in the future or in other
1221         porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1223 i18n.logOutputEncoding::
1224         Character encoding the commit messages are converted to when
1225         running 'git log' and friends.
1227 imap::
1228         The configuration variables in the 'imap' section are described
1229         in linkgit:git-imap-send[1].
1231 init.templatedir::
1232         Specify the directory from which templates will be copied.
1233         (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1235 instaweb.browser::
1236         Specify the program that will be used to browse your working
1237         repository in gitweb. See linkgit:git-instaweb[1].
1239 instaweb.httpd::
1240         The HTTP daemon command-line to start gitweb on your working
1241         repository. See linkgit:git-instaweb[1].
1243 instaweb.local::
1244         If true the web server started by linkgit:git-instaweb[1] will
1245         be bound to the local IP (127.0.0.1).
1247 instaweb.modulepath::
1248         The module path for an apache httpd used by linkgit:git-instaweb[1].
1250 instaweb.port::
1251         The port number to bind the gitweb httpd to. See
1252         linkgit:git-instaweb[1].
1254 interactive.singlekey::
1255         In interactive commands, allow the user to provide one-letter
1256         input with a single key (i.e., without hitting enter).
1257         Currently this is used only by the `\--patch` mode of
1258         linkgit:git-add[1].  Note that this setting is silently
1259         ignored if portable keystroke input is not available.
1261 log.date::
1262         Set default date-time mode for the log command. Setting log.date
1263         value is similar to using 'git log'\'s --date option. The value is one of the
1264         following alternatives: {relative,local,default,iso,rfc,short}.
1265         See linkgit:git-log[1].
1267 log.showroot::
1268         If true, the initial commit will be shown as a big creation event.
1269         This is equivalent to a diff against an empty tree.
1270         Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1271         normally hide the root commit will now show it. True by default.
1273 mailmap.file::
1274         The location of an augmenting mailmap file. The default
1275         mailmap, located in the root of the repository, is loaded
1276         first, then the mailmap file pointed to by this variable.
1277         The location of the mailmap file may be in a repository
1278         subdirectory, or somewhere outside of the repository itself.
1279         See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1281 man.viewer::
1282         Specify the programs that may be used to display help in the
1283         'man' format. See linkgit:git-help[1].
1285 man.<tool>.cmd::
1286         Specify the command to invoke the specified man viewer. The
1287         specified command is evaluated in shell with the man page
1288         passed as argument. (See linkgit:git-help[1].)
1290 man.<tool>.path::
1291         Override the path for the given tool that may be used to
1292         display help in the 'man' format. See linkgit:git-help[1].
1294 include::merge-config.txt[]
1296 mergetool.<tool>.path::
1297         Override the path for the given tool.  This is useful in case
1298         your tool is not in the PATH.
1300 mergetool.<tool>.cmd::
1301         Specify the command to invoke the specified merge tool.  The
1302         specified command is evaluated in shell with the following
1303         variables available: 'BASE' is the name of a temporary file
1304         containing the common base of the files to be merged, if available;
1305         'LOCAL' is the name of a temporary file containing the contents of
1306         the file on the current branch; 'REMOTE' is the name of a temporary
1307         file containing the contents of the file from the branch being
1308         merged; 'MERGED' contains the name of the file to which the merge
1309         tool should write the results of a successful merge.
1311 mergetool.<tool>.trustExitCode::
1312         For a custom merge command, specify whether the exit code of
1313         the merge command can be used to determine whether the merge was
1314         successful.  If this is not set to true then the merge target file
1315         timestamp is checked and the merge assumed to have been successful
1316         if the file has been updated, otherwise the user is prompted to
1317         indicate the success of the merge.
1319 mergetool.keepBackup::
1320         After performing a merge, the original file with conflict markers
1321         can be saved as a file with a `.orig` extension.  If this variable
1322         is set to `false` then this file is not preserved.  Defaults to
1323         `true` (i.e. keep the backup files).
1325 mergetool.keepTemporaries::
1326         When invoking a custom merge tool, git uses a set of temporary
1327         files to pass to the tool. If the tool returns an error and this
1328         variable is set to `true`, then these temporary files will be
1329         preserved, otherwise they will be removed after the tool has
1330         exited. Defaults to `false`.
1332 mergetool.prompt::
1333         Prompt before each invocation of the merge resolution program.
1335 notes.displayRef::
1336         The (fully qualified) refname from which to show notes when
1337         showing commit messages.  The value of this variable can be set
1338         to a glob, in which case notes from all matching refs will be
1339         shown.  You may also specify this configuration variable
1340         several times.  A warning will be issued for refs that do not
1341         exist, but a glob that does not match any refs is silently
1342         ignored.
1344 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1345 environment variable, which must be a colon separated list of refs or
1346 globs.
1348 The effective value of "core.notesRef" (possibly overridden by
1349 GIT_NOTES_REF) is also implicitly added to the list of refs to be
1350 displayed.
1352 notes.rewrite.<command>::
1353         When rewriting commits with <command> (currently `amend` or
1354         `rebase`) and this variable is set to `true`, git
1355         automatically copies your notes from the original to the
1356         rewritten commit.  Defaults to `true`, but see
1357         "notes.rewriteRef" below.
1359 notes.rewriteMode::
1360         When copying notes during a rewrite (see the
1361         "notes.rewrite.<command>" option), determines what to do if
1362         the target commit already has a note.  Must be one of
1363         `overwrite`, `concatenate`, or `ignore`.  Defaults to
1364         `concatenate`.
1366 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1367 environment variable.
1369 notes.rewriteRef::
1370         When copying notes during a rewrite, specifies the (fully
1371         qualified) ref whose notes should be copied.  The ref may be a
1372         glob, in which case notes in all matching refs will be copied.
1373         You may also specify this configuration several times.
1375 Does not have a default value; you must configure this variable to
1376 enable note rewriting.
1378 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1379 environment variable, which must be a colon separated list of refs or
1380 globs.
1382 pack.window::
1383         The size of the window used by linkgit:git-pack-objects[1] when no
1384         window size is given on the command line. Defaults to 10.
1386 pack.depth::
1387         The maximum delta depth used by linkgit:git-pack-objects[1] when no
1388         maximum depth is given on the command line. Defaults to 50.
1390 pack.windowMemory::
1391         The window memory size limit used by linkgit:git-pack-objects[1]
1392         when no limit is given on the command line.  The value can be
1393         suffixed with "k", "m", or "g".  Defaults to 0, meaning no
1394         limit.
1396 pack.compression::
1397         An integer -1..9, indicating the compression level for objects
1398         in a pack file. -1 is the zlib default. 0 means no
1399         compression, and 1..9 are various speed/size tradeoffs, 9 being
1400         slowest.  If not set,  defaults to core.compression.  If that is
1401         not set,  defaults to -1, the zlib default, which is "a default
1402         compromise between speed and compression (currently equivalent
1403         to level 6)."
1405 pack.deltaCacheSize::
1406         The maximum memory in bytes used for caching deltas in
1407         linkgit:git-pack-objects[1] before writing them out to a pack.
1408         This cache is used to speed up the writing object phase by not
1409         having to recompute the final delta result once the best match
1410         for all objects is found.  Repacking large repositories on machines
1411         which are tight with memory might be badly impacted by this though,
1412         especially if this cache pushes the system into swapping.
1413         A value of 0 means no limit. The smallest size of 1 byte may be
1414         used to virtually disable this cache. Defaults to 256 MiB.
1416 pack.deltaCacheLimit::
1417         The maximum size of a delta, that is cached in
1418         linkgit:git-pack-objects[1]. This cache is used to speed up the
1419         writing object phase by not having to recompute the final delta
1420         result once the best match for all objects is found. Defaults to 1000.
1422 pack.threads::
1423         Specifies the number of threads to spawn when searching for best
1424         delta matches.  This requires that linkgit:git-pack-objects[1]
1425         be compiled with pthreads otherwise this option is ignored with a
1426         warning. This is meant to reduce packing time on multiprocessor
1427         machines. The required amount of memory for the delta search window
1428         is however multiplied by the number of threads.
1429         Specifying 0 will cause git to auto-detect the number of CPU's
1430         and set the number of threads accordingly.
1432 pack.indexVersion::
1433         Specify the default pack index version.  Valid values are 1 for
1434         legacy pack index used by Git versions prior to 1.5.2, and 2 for
1435         the new pack index with capabilities for packs larger than 4 GB
1436         as well as proper protection against the repacking of corrupted
1437         packs.  Version 2 is the default.  Note that version 2 is enforced
1438         and this config option ignored whenever the corresponding pack is
1439         larger than 2 GB.
1441 If you have an old git that does not understand the version 2 `{asterisk}.idx` file,
1442 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1443 that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the
1444 other side may give you a repository that cannot be accessed with your
1445 older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,
1446 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1447 the `{asterisk}.idx` file.
1449 pack.packSizeLimit::
1450         The maximum size of a pack.  This setting only affects
1451         packing to a file when repacking, i.e. the git:// protocol
1452         is unaffected.  It can be overridden by the `\--max-pack-size`
1453         option of linkgit:git-repack[1]. The minimum size allowed is
1454         limited to 1 MiB. The default is unlimited.
1455         Common unit suffixes of 'k', 'm', or 'g' are
1456         supported.
1458 pager.<cmd>::
1459         Allows turning on or off pagination of the output of a
1460         particular git subcommand when writing to a tty.  If
1461         `\--paginate` or `\--no-pager` is specified on the command line,
1462         it takes precedence over this option.  To disable pagination for
1463         all commands, set `core.pager` or `GIT_PAGER` to `cat`.
1465 pull.octopus::
1466         The default merge strategy to use when pulling multiple branches
1467         at once.
1469 pull.twohead::
1470         The default merge strategy to use when pulling a single branch.
1472 push.default::
1473         Defines the action git push should take if no refspec is given
1474         on the command line, no refspec is configured in the remote, and
1475         no refspec is implied by any of the options given on the command
1476         line. Possible values are:
1478 * `nothing` do not push anything.
1479 * `matching` push all matching branches.
1480   All branches having the same name in both ends are considered to be
1481   matching. This is the default.
1482 * `tracking` push the current branch to its upstream branch.
1483 * `current` push the current branch to a branch of the same name.
1485 rebase.stat::
1486         Whether to show a diffstat of what changed upstream since the last
1487         rebase. False by default.
1489 receive.autogc::
1490         By default, git-receive-pack will run "git-gc --auto" after
1491         receiving data from git-push and updating refs.  You can stop
1492         it by setting this variable to false.
1494 receive.fsckObjects::
1495         If it is set to true, git-receive-pack will check all received
1496         objects. It will abort in the case of a malformed object or a
1497         broken link. The result of an abort are only dangling objects.
1498         Defaults to false.
1500 receive.unpackLimit::
1501         If the number of objects received in a push is below this
1502         limit then the objects will be unpacked into loose object
1503         files. However if the number of received objects equals or
1504         exceeds this limit then the received pack will be stored as
1505         a pack, after adding any missing delta bases.  Storing the
1506         pack from a push can make the push operation complete faster,
1507         especially on slow filesystems.  If not set, the value of
1508         `transfer.unpackLimit` is used instead.
1510 receive.denyDeletes::
1511         If set to true, git-receive-pack will deny a ref update that deletes
1512         the ref. Use this to prevent such a ref deletion via a push.
1514 receive.denyCurrentBranch::
1515         If set to true or "refuse", git-receive-pack will deny a ref update
1516         to the currently checked out branch of a non-bare repository.
1517         Such a push is potentially dangerous because it brings the HEAD
1518         out of sync with the index and working tree. If set to "warn",
1519         print a warning of such a push to stderr, but allow the push to
1520         proceed. If set to false or "ignore", allow such pushes with no
1521         message. Defaults to "refuse".
1523 receive.denyNonFastForwards::
1524         If set to true, git-receive-pack will deny a ref update which is
1525         not a fast-forward. Use this to prevent such an update via a push,
1526         even if that push is forced. This configuration variable is
1527         set when initializing a shared repository.
1529 receive.updateserverinfo::
1530         If set to true, git-receive-pack will run git-update-server-info
1531         after receiving data from git-push and updating refs.
1533 remote.<name>.url::
1534         The URL of a remote repository.  See linkgit:git-fetch[1] or
1535         linkgit:git-push[1].
1537 remote.<name>.pushurl::
1538         The push URL of a remote repository.  See linkgit:git-push[1].
1540 remote.<name>.proxy::
1541         For remotes that require curl (http, https and ftp), the URL to
1542         the proxy to use for that remote.  Set to the empty string to
1543         disable proxying for that remote.
1545 remote.<name>.fetch::
1546         The default set of "refspec" for linkgit:git-fetch[1]. See
1547         linkgit:git-fetch[1].
1549 remote.<name>.push::
1550         The default set of "refspec" for linkgit:git-push[1]. See
1551         linkgit:git-push[1].
1553 remote.<name>.mirror::
1554         If true, pushing to this remote will automatically behave
1555         as if the `\--mirror` option was given on the command line.
1557 remote.<name>.skipDefaultUpdate::
1558         If true, this remote will be skipped by default when updating
1559         using linkgit:git-fetch[1] or the `update` subcommand of
1560         linkgit:git-remote[1].
1562 remote.<name>.skipFetchAll::
1563         If true, this remote will be skipped by default when updating
1564         using linkgit:git-fetch[1] or the `update` subcommand of
1565         linkgit:git-remote[1].
1567 remote.<name>.receivepack::
1568         The default program to execute on the remote side when pushing.  See
1569         option \--receive-pack of linkgit:git-push[1].
1571 remote.<name>.uploadpack::
1572         The default program to execute on the remote side when fetching.  See
1573         option \--upload-pack of linkgit:git-fetch-pack[1].
1575 remote.<name>.tagopt::
1576         Setting this value to \--no-tags disables automatic tag following when
1577         fetching from remote <name>
1579 remote.<name>.vcs::
1580         Setting this to a value <vcs> will cause git to interact with
1581         the remote with the git-remote-<vcs> helper.
1583 remotes.<group>::
1584         The list of remotes which are fetched by "git remote update
1585         <group>".  See linkgit:git-remote[1].
1587 repack.usedeltabaseoffset::
1588         By default, linkgit:git-repack[1] creates packs that use
1589         delta-base offset. If you need to share your repository with
1590         git older than version 1.4.4, either directly or via a dumb
1591         protocol such as http, then you need to set this option to
1592         "false" and repack. Access from old git versions over the
1593         native protocol are unaffected by this option.
1595 rerere.autoupdate::
1596         When set to true, `git-rerere` updates the index with the
1597         resulting contents after it cleanly resolves conflicts using
1598         previously recorded resolution.  Defaults to false.
1600 rerere.enabled::
1601         Activate recording of resolved conflicts, so that identical
1602         conflict hunks can be resolved automatically, should they
1603         be encountered again.  linkgit:git-rerere[1] command is by
1604         default enabled if you create `rr-cache` directory under
1605         `$GIT_DIR`, but can be disabled by setting this option to false.
1607 sendemail.identity::
1608         A configuration identity. When given, causes values in the
1609         'sendemail.<identity>' subsection to take precedence over
1610         values in the 'sendemail' section. The default identity is
1611         the value of 'sendemail.identity'.
1613 sendemail.smtpencryption::
1614         See linkgit:git-send-email[1] for description.  Note that this
1615         setting is not subject to the 'identity' mechanism.
1617 sendemail.smtpssl::
1618         Deprecated alias for 'sendemail.smtpencryption = ssl'.
1620 sendemail.<identity>.*::
1621         Identity-specific versions of the 'sendemail.*' parameters
1622         found below, taking precedence over those when the this
1623         identity is selected, through command-line or
1624         'sendemail.identity'.
1626 sendemail.aliasesfile::
1627 sendemail.aliasfiletype::
1628 sendemail.bcc::
1629 sendemail.cc::
1630 sendemail.cccmd::
1631 sendemail.chainreplyto::
1632 sendemail.confirm::
1633 sendemail.envelopesender::
1634 sendemail.from::
1635 sendemail.multiedit::
1636 sendemail.signedoffbycc::
1637 sendemail.smtppass::
1638 sendemail.suppresscc::
1639 sendemail.suppressfrom::
1640 sendemail.to::
1641 sendemail.smtpdomain::
1642 sendemail.smtpserver::
1643 sendemail.smtpserverport::
1644 sendemail.smtpuser::
1645 sendemail.thread::
1646 sendemail.validate::
1647         See linkgit:git-send-email[1] for description.
1649 sendemail.signedoffcc::
1650         Deprecated alias for 'sendemail.signedoffbycc'.
1652 showbranch.default::
1653         The default set of branches for linkgit:git-show-branch[1].
1654         See linkgit:git-show-branch[1].
1656 status.relativePaths::
1657         By default, linkgit:git-status[1] shows paths relative to the
1658         current directory. Setting this variable to `false` shows paths
1659         relative to the repository root (this was the default for git
1660         prior to v1.5.4).
1662 status.showUntrackedFiles::
1663         By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1664         files which are not currently tracked by Git. Directories which
1665         contain only untracked files, are shown with the directory name
1666         only. Showing untracked files means that Git needs to lstat() all
1667         all the files in the whole repository, which might be slow on some
1668         systems. So, this variable controls how the commands displays
1669         the untracked files. Possible values are:
1672         - 'no'     - Show no untracked files
1673         - 'normal' - Shows untracked files and directories
1674         - 'all'    - Shows also individual files in untracked directories.
1677 If this variable is not specified, it defaults to 'normal'.
1678 This variable can be overridden with the -u|--untracked-files option
1679 of linkgit:git-status[1] and linkgit:git-commit[1].
1681 status.submodulesummary::
1682         Defaults to false.
1683         If this is set to a non zero number or true (identical to -1 or an
1684         unlimited number), the submodule summary will be enabled and a
1685         summary of commits for modified submodules will be shown (see
1686         --summary-limit option of linkgit:git-submodule[1]).
1688 tar.umask::
1689         This variable can be used to restrict the permission bits of
1690         tar archive entries.  The default is 0002, which turns off the
1691         world write bit.  The special value "user" indicates that the
1692         archiving user's umask will be used instead.  See umask(2) and
1693         linkgit:git-archive[1].
1695 transfer.unpackLimit::
1696         When `fetch.unpackLimit` or `receive.unpackLimit` are
1697         not set, the value of this variable is used instead.
1698         The default value is 100.
1700 url.<base>.insteadOf::
1701         Any URL that starts with this value will be rewritten to
1702         start, instead, with <base>. In cases where some site serves a
1703         large number of repositories, and serves them with multiple
1704         access methods, and some users need to use different access
1705         methods, this feature allows people to specify any of the
1706         equivalent URLs and have git automatically rewrite the URL to
1707         the best alternative for the particular user, even for a
1708         never-before-seen repository on the site.  When more than one
1709         insteadOf strings match a given URL, the longest match is used.
1711 url.<base>.pushInsteadOf::
1712         Any URL that starts with this value will not be pushed to;
1713         instead, it will be rewritten to start with <base>, and the
1714         resulting URL will be pushed to. In cases where some site serves
1715         a large number of repositories, and serves them with multiple
1716         access methods, some of which do not allow push, this feature
1717         allows people to specify a pull-only URL and have git
1718         automatically use an appropriate URL to push, even for a
1719         never-before-seen repository on the site.  When more than one
1720         pushInsteadOf strings match a given URL, the longest match is
1721         used.  If a remote has an explicit pushurl, git will ignore this
1722         setting for that remote.
1724 user.email::
1725         Your email address to be recorded in any newly created commits.
1726         Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
1727         'EMAIL' environment variables.  See linkgit:git-commit-tree[1].
1729 user.name::
1730         Your full name to be recorded in any newly created commits.
1731         Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
1732         environment variables.  See linkgit:git-commit-tree[1].
1734 user.signingkey::
1735         If linkgit:git-tag[1] is not selecting the key you want it to
1736         automatically when creating a signed tag, you can override the
1737         default selection with this variable.  This option is passed
1738         unchanged to gpg's --local-user parameter, so you may specify a key
1739         using any method that gpg supports.
1741 web.browser::
1742         Specify a web browser that may be used by some commands.
1743         Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
1744         may use it.