Merge branch 'mm/config-pathname-tilde-expand'
[alt-git.git] / Documentation / config.txt
blobd8b842bd0ea6208b426f5c8545d4dd3f79833168
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.
131 core.fileMode::
132         If false, the executable bit differences between the index and
133         the working copy are ignored; useful on broken filesystems like FAT.
134         See linkgit:git-update-index[1]. True by default.
136 core.ignoreCygwinFSTricks::
137         This option is only used by Cygwin implementation of Git. If false,
138         the Cygwin stat() and lstat() functions are used. This may be useful
139         if your repository consists of a few separate directories joined in
140         one hierarchy using Cygwin mount. If true, Git uses native Win32 API
141         whenever it is possible and falls back to Cygwin functions only to
142         handle symbol links. The native mode is more than twice faster than
143         normal Cygwin l/stat() functions. True by default, unless core.filemode
144         is true, in which case ignoreCygwinFSTricks is ignored as Cygwin's
145         POSIX emulation is required to support core.filemode.
147 core.trustctime::
148         If false, the ctime differences between the index and the
149         working copy are ignored; useful when the inode change time
150         is regularly modified by something outside Git (file system
151         crawlers and some backup systems).
152         See linkgit:git-update-index[1]. True by default.
154 core.quotepath::
155         The commands that output paths (e.g. 'ls-files',
156         'diff'), when not given the `-z` option, will quote
157         "unusual" characters in the pathname by enclosing the
158         pathname in a double-quote pair and with backslashes the
159         same way strings in C source code are quoted.  If this
160         variable is set to false, the bytes higher than 0x80 are
161         not quoted but output as verbatim.  Note that double
162         quote, backslash and control characters are always
163         quoted without `-z` regardless of the setting of this
164         variable.
166 core.autocrlf::
167         If true, makes git convert `CRLF` at the end of lines in text files to
168         `LF` when reading from the filesystem, and convert in reverse when
169         writing to the filesystem.  The variable can be set to
170         'input', in which case the conversion happens only while
171         reading from the filesystem but files are written out with
172         `LF` at the end of lines.  Currently, which paths to consider
173         "text" (i.e. be subjected to the autocrlf mechanism) is
174         decided purely based on the contents.
176 core.safecrlf::
177         If true, makes git check if converting `CRLF` as controlled by
178         `core.autocrlf` is reversible.  Git will verify if a command
179         modifies a file in the work tree either directly or indirectly.
180         For example, committing a file followed by checking out the
181         same file should yield the original file in the work tree.  If
182         this is not the case for the current setting of
183         `core.autocrlf`, git will reject the file.  The variable can
184         be set to "warn", in which case git will only warn about an
185         irreversible conversion but continue the operation.
187 CRLF conversion bears a slight chance of corrupting data.
188 autocrlf=true will convert CRLF to LF during commit and LF to
189 CRLF during checkout.  A file that contains a mixture of LF and
190 CRLF before the commit cannot be recreated by git.  For text
191 files this is the right thing to do: it corrects line endings
192 such that we have only LF line endings in the repository.
193 But for binary files that are accidentally classified as text the
194 conversion can corrupt data.
196 If you recognize such corruption early you can easily fix it by
197 setting the conversion type explicitly in .gitattributes.  Right
198 after committing you still have the original file in your work
199 tree and this file is not yet corrupted.  You can explicitly tell
200 git that this file is binary and git will handle the file
201 appropriately.
203 Unfortunately, the desired effect of cleaning up text files with
204 mixed line endings and the undesired effect of corrupting binary
205 files cannot be distinguished.  In both cases CRLFs are removed
206 in an irreversible way.  For text files this is the right thing
207 to do because CRLFs are line endings, while for binary files
208 converting CRLFs corrupts data.
210 Note, this safety check does not mean that a checkout will generate a
211 file identical to the original file for a different setting of
212 `core.autocrlf`, but only for the current one.  For example, a text
213 file with `LF` would be accepted with `core.autocrlf=input` and could
214 later be checked out with `core.autocrlf=true`, in which case the
215 resulting file would contain `CRLF`, although the original file
216 contained `LF`.  However, in both work trees the line endings would be
217 consistent, that is either all `LF` or all `CRLF`, but never mixed.  A
218 file with mixed line endings would be reported by the `core.safecrlf`
219 mechanism.
221 core.symlinks::
222         If false, symbolic links are checked out as small plain files that
223         contain the link text. linkgit:git-update-index[1] and
224         linkgit:git-add[1] will not change the recorded type to regular
225         file. Useful on filesystems like FAT that do not support
226         symbolic links. True by default.
228 core.gitProxy::
229         A "proxy command" to execute (as 'command host port') instead
230         of establishing direct connection to the remote server when
231         using the git protocol for fetching. If the variable value is
232         in the "COMMAND for DOMAIN" format, the command is applied only
233         on hostnames ending with the specified domain string. This variable
234         may be set multiple times and is matched in the given order;
235         the first match wins.
237 Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
238 (which always applies universally, without the special "for"
239 handling).
241 The special string `none` can be used as the proxy command to
242 specify that no proxy be used for a given domain pattern.
243 This is useful for excluding servers inside a firewall from
244 proxy use, while defaulting to a common proxy for external domains.
246 core.ignoreStat::
247         If true, commands which modify both the working tree and the index
248         will mark the updated paths with the "assume unchanged" bit in the
249         index. These marked files are then assumed to stay unchanged in the
250         working copy, until you mark them otherwise manually - Git will not
251         detect the file changes by lstat() calls. This is useful on systems
252         where those are very slow, such as Microsoft Windows.
253         See linkgit:git-update-index[1].
254         False by default.
256 core.preferSymlinkRefs::
257         Instead of the default "symref" format for HEAD
258         and other symbolic reference files, use symbolic links.
259         This is sometimes needed to work with old scripts that
260         expect HEAD to be a symbolic link.
262 core.bare::
263         If true this repository is assumed to be 'bare' and has no
264         working directory associated with it.  If this is the case a
265         number of commands that require a working directory will be
266         disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
268 This setting is automatically guessed by linkgit:git-clone[1] or
269 linkgit:git-init[1] when the repository was created.  By default a
270 repository that ends in "/.git" is assumed to be not bare (bare =
271 false), while all other repositories are assumed to be bare (bare
272 = true).
274 core.worktree::
275         Set the path to the working tree.  The value will not be
276         used in combination with repositories found automatically in
277         a .git directory (i.e. $GIT_DIR is not set).
278         This can be overridden by the GIT_WORK_TREE environment
279         variable and the '--work-tree' command line option. It can be
280         a absolute path or relative path to the directory specified by
281         --git-dir or GIT_DIR.
282         Note: If --git-dir or GIT_DIR are specified but none of
283         --work-tree, GIT_WORK_TREE and core.worktree is specified,
284         the current working directory is regarded as the top directory
285         of your working tree.
287 core.logAllRefUpdates::
288         Enable the reflog. Updates to a ref <ref> is logged to the file
289         "$GIT_DIR/logs/<ref>", by appending the new and old
290         SHA1, the date/time and the reason of the update, but
291         only when the file exists.  If this configuration
292         variable is set to true, missing "$GIT_DIR/logs/<ref>"
293         file is automatically created for branch heads.
295 This information can be used to determine what commit
296 was the tip of a branch "2 days ago".
298 This value is true by default in a repository that has
299 a working directory associated with it, and false by
300 default in a bare repository.
302 core.repositoryFormatVersion::
303         Internal variable identifying the repository format and layout
304         version.
306 core.sharedRepository::
307         When 'group' (or 'true'), the repository is made shareable between
308         several users in a group (making sure all the files and objects are
309         group-writable). When 'all' (or 'world' or 'everybody'), the
310         repository will be readable by all users, additionally to being
311         group-shareable. When 'umask' (or 'false'), git will use permissions
312         reported by umask(2). When '0xxx', where '0xxx' is an octal number,
313         files in the repository will have this mode value. '0xxx' will override
314         user's umask value (whereas the other options will only override
315         requested parts of the user's umask value). Examples: '0660' will make
316         the repo read/write-able for the owner and group, but inaccessible to
317         others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
318         repository that is group-readable but not group-writable.
319         See linkgit:git-init[1]. False by default.
321 core.warnAmbiguousRefs::
322         If true, git will warn you if the ref name you passed it is ambiguous
323         and might match multiple refs in the .git/refs/ tree. True by default.
325 core.compression::
326         An integer -1..9, indicating a default compression level.
327         -1 is the zlib default. 0 means no compression,
328         and 1..9 are various speed/size tradeoffs, 9 being slowest.
329         If set, this provides a default to other compression variables,
330         such as 'core.loosecompression' and 'pack.compression'.
332 core.loosecompression::
333         An integer -1..9, indicating the compression level for objects that
334         are not in a pack file. -1 is the zlib default. 0 means no
335         compression, and 1..9 are various speed/size tradeoffs, 9 being
336         slowest.  If not set,  defaults to core.compression.  If that is
337         not set,  defaults to 1 (best speed).
339 core.packedGitWindowSize::
340         Number of bytes of a pack file to map into memory in a
341         single mapping operation.  Larger window sizes may allow
342         your system to process a smaller number of large pack files
343         more quickly.  Smaller window sizes will negatively affect
344         performance due to increased calls to the operating system's
345         memory manager, but may improve performance when accessing
346         a large number of large pack files.
348 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
349 MiB on 32 bit platforms and 1 GiB on 64 bit platforms.  This should
350 be reasonable for all users/operating systems.  You probably do
351 not need to adjust this value.
353 Common unit suffixes of 'k', 'm', or 'g' are supported.
355 core.packedGitLimit::
356         Maximum number of bytes to map simultaneously into memory
357         from pack files.  If Git needs to access more than this many
358         bytes at once to complete an operation it will unmap existing
359         regions to reclaim virtual address space within the process.
361 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
362 This should be reasonable for all users/operating systems, except on
363 the largest projects.  You probably do not need to adjust this value.
365 Common unit suffixes of 'k', 'm', or 'g' are supported.
367 core.deltaBaseCacheLimit::
368         Maximum number of bytes to reserve for caching base objects
369         that multiple deltafied objects reference.  By storing the
370         entire decompressed base objects in a cache Git is able
371         to avoid unpacking and decompressing frequently used base
372         objects multiple times.
374 Default is 16 MiB on all platforms.  This should be reasonable
375 for all users/operating systems, except on the largest projects.
376 You probably do not need to adjust this value.
378 Common unit suffixes of 'k', 'm', or 'g' are supported.
380 core.excludesfile::
381         In addition to '.gitignore' (per-directory) and
382         '.git/info/exclude', git looks into this file for patterns
383         of files which are not meant to be tracked.  "{tilde}/" is expanded
384         to the value of `$HOME` and "{tilde}user/" to the specified user's
385         home directory.  See linkgit:gitignore[5].
387 core.editor::
388         Commands such as `commit` and `tag` that lets you edit
389         messages by launching an editor uses the value of this
390         variable when it is set, and the environment variable
391         `GIT_EDITOR` is not set.  See linkgit:git-var[1].
393 core.pager::
394         The command that git will use to paginate output.  Can
395         be overridden with the `GIT_PAGER` environment
396         variable.  Note that git sets the `LESS` environment
397         variable to `FRSX` if it is unset when it runs the
398         pager.  One can change these settings by setting the
399         `LESS` variable to some other value.  Alternately,
400         these settings can be overridden on a project or
401         global basis by setting the `core.pager` option.
402         Setting `core.pager` has no affect on the `LESS`
403         environment variable behaviour above, so if you want
404         to override git's default settings this way, you need
405         to be explicit.  For example, to disable the S option
406         in a backward compatible manner, set `core.pager`
407         to `less -+$LESS -FRX`.  This will be passed to the
408         shell by git, which will translate the final command to
409         `LESS=FRSX less -+FRSX -FRX`.
411 core.whitespace::
412         A comma separated list of common whitespace problems to
413         notice.  'git-diff' will use `color.diff.whitespace` to
414         highlight them, and 'git-apply --whitespace=error' will
415         consider them as errors.  You can prefix `-` to disable
416         any of them (e.g. `-trailing-space`):
418 * `blank-at-eol` treats trailing whitespaces at the end of the line
419   as an error (enabled by default).
420 * `space-before-tab` treats a space character that appears immediately
421   before a tab character in the initial indent part of the line as an
422   error (enabled by default).
423 * `indent-with-non-tab` treats a line that is indented with 8 or more
424   space characters as an error (not enabled by default).
425 * `blank-at-eof` treats blank lines added at the end of file as an error
426   (enabled by default).
427 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
428   `blank-at-eof`.
429 * `cr-at-eol` treats a carriage-return at the end of line as
430   part of the line terminator, i.e. with it, `trailing-space`
431   does not trigger if the character before such a carriage-return
432   is not a whitespace (not enabled by default).
434 core.fsyncobjectfiles::
435         This boolean will enable 'fsync()' when writing object files.
437 This is a total waste of time and effort on a filesystem that orders
438 data writes properly, but can be useful for filesystems that do not use
439 journalling (traditional UNIX filesystems) or that only journal metadata
440 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
442 core.preloadindex::
443         Enable parallel index preload for operations like 'git diff'
445 This can speed up operations like 'git diff' and 'git status' especially
446 on filesystems like NFS that have weak caching semantics and thus
447 relatively high IO latencies.  With this set to 'true', git will do the
448 index comparison to the filesystem data in parallel, allowing
449 overlapping IO's.
451 core.createObject::
452         You can set this to 'link', in which case a hardlink followed by
453         a delete of the source are used to make sure that object creation
454         will not overwrite existing objects.
456 On some file system/operating system combinations, this is unreliable.
457 Set this config setting to 'rename' there; However, This will remove the
458 check that makes sure that existing object files will not get overwritten.
460 core.notesRef::
461         When showing commit messages, also show notes which are stored in
462         the given ref.  This ref is expected to contain files named
463         after the full SHA-1 of the commit they annotate.
465 If such a file exists in the given ref, the referenced blob is read, and
466 appended to the commit message, separated by a "Notes:" line.  If the
467 given ref itself does not exist, it is not an error, but means that no
468 notes should be printed.
470 This setting defaults to "refs/notes/commits", and can be overridden by
471 the `GIT_NOTES_REF` environment variable.
473 add.ignore-errors::
474         Tells 'git-add' to continue adding files when some files cannot be
475         added due to indexing errors. Equivalent to the '--ignore-errors'
476         option of linkgit:git-add[1].
478 alias.*::
479         Command aliases for the linkgit:git[1] command wrapper - e.g.
480         after defining "alias.last = cat-file commit HEAD", the invocation
481         "git last" is equivalent to "git cat-file commit HEAD". To avoid
482         confusion and troubles with script usage, aliases that
483         hide existing git commands are ignored. Arguments are split by
484         spaces, the usual shell quoting and escaping is supported.
485         quote pair and a backslash can be used to quote them.
487 If the alias expansion is prefixed with an exclamation point,
488 it will be treated as a shell command.  For example, defining
489 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
490 "git new" is equivalent to running the shell command
491 "gitk --all --not ORIG_HEAD".  Note that shell commands will be
492 executed from the top-level directory of a repository, which may
493 not necessarily be the current directory.
495 apply.ignorewhitespace::
496         When set to 'change', tells 'git-apply' to ignore changes in
497         whitespace, in the same way as the '--ignore-space-change'
498         option.
499         When set to one of: no, none, never, false tells 'git-apply' to
500         respect all whitespace differences.
501         See linkgit:git-apply[1].
503 apply.whitespace::
504         Tells 'git-apply' how to handle whitespaces, in the same way
505         as the '--whitespace' option. See linkgit:git-apply[1].
507 branch.autosetupmerge::
508         Tells 'git-branch' and 'git-checkout' to setup new branches
509         so that linkgit:git-pull[1] will appropriately merge from the
510         starting point branch. Note that even if this option is not set,
511         this behavior can be chosen per-branch using the `--track`
512         and `--no-track` options. The valid settings are: `false` -- no
513         automatic setup is done; `true` -- automatic setup is done when the
514         starting point is a remote branch; `always` -- automatic setup is
515         done when the starting point is either a local branch or remote
516         branch. This option defaults to true.
518 branch.autosetuprebase::
519         When a new branch is created with 'git-branch' or 'git-checkout'
520         that tracks another branch, this variable tells git to set
521         up pull to rebase instead of merge (see "branch.<name>.rebase").
522         When `never`, rebase is never automatically set to true.
523         When `local`, rebase is set to true for tracked branches of
524         other local branches.
525         When `remote`, rebase is set to true for tracked branches of
526         remote branches.
527         When `always`, rebase will be set to true for all tracking
528         branches.
529         See "branch.autosetupmerge" for details on how to set up a
530         branch to track another branch.
531         This option defaults to never.
533 branch.<name>.remote::
534         When in branch <name>, it tells 'git-fetch' and 'git-push' which
535         remote to fetch from/push to.  It defaults to `origin` if no remote is
536         configured. `origin` is also used if you are not on any branch.
538 branch.<name>.merge::
539         Defines, together with branch.<name>.remote, the upstream branch
540         for the given branch. It tells 'git-fetch'/'git-pull' which
541         branch to merge and can also affect 'git-push' (see push.default).
542         When in branch <name>, it tells 'git-fetch' the default
543         refspec to be marked for merging in FETCH_HEAD. The value is
544         handled like the remote part of a refspec, and must match a
545         ref which is fetched from the remote given by
546         "branch.<name>.remote".
547         The merge information is used by 'git-pull' (which at first calls
548         'git-fetch') to lookup the default branch for merging. Without
549         this option, 'git-pull' defaults to merge the first refspec fetched.
550         Specify multiple values to get an octopus merge.
551         If you wish to setup 'git-pull' so that it merges into <name> from
552         another branch in the local repository, you can point
553         branch.<name>.merge to the desired branch, and use the special setting
554         `.` (a period) for branch.<name>.remote.
556 branch.<name>.mergeoptions::
557         Sets default options for merging into branch <name>. The syntax and
558         supported options are the same as those of linkgit:git-merge[1], but
559         option values containing whitespace characters are currently not
560         supported.
562 branch.<name>.rebase::
563         When true, rebase the branch <name> on top of the fetched branch,
564         instead of merging the default branch from the default remote when
565         "git pull" is run.
566         *NOTE*: this is a possibly dangerous operation; do *not* use
567         it unless you understand the implications (see linkgit:git-rebase[1]
568         for details).
570 browser.<tool>.cmd::
571         Specify the command to invoke the specified browser. The
572         specified command is evaluated in shell with the URLs passed
573         as arguments. (See linkgit:git-web--browse[1].)
575 browser.<tool>.path::
576         Override the path for the given tool that may be used to
577         browse HTML help (see '-w' option in linkgit:git-help[1]) or a
578         working repository in gitweb (see linkgit:git-instaweb[1]).
580 clean.requireForce::
581         A boolean to make git-clean do nothing unless given -f
582         or -n.   Defaults to true.
584 color.branch::
585         A boolean to enable/disable color in the output of
586         linkgit:git-branch[1]. May be set to `always`,
587         `false` (or `never`) or `auto` (or `true`), in which case colors are used
588         only when the output is to a terminal. Defaults to false.
590 color.branch.<slot>::
591         Use customized color for branch coloration. `<slot>` is one of
592         `current` (the current branch), `local` (a local branch),
593         `remote` (a tracking branch in refs/remotes/), `plain` (other
594         refs).
596 The value for these configuration variables is a list of colors (at most
597 two) and attributes (at most one), separated by spaces.  The colors
598 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
599 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
600 `blink` and `reverse`.  The first color given is the foreground; the
601 second is the background.  The position of the attribute, if any,
602 doesn't matter.
604 color.diff::
605         When set to `always`, always use colors in patch.
606         When false (or `never`), never.  When set to `true` or `auto`, use
607         colors only when the output is to the terminal. Defaults to false.
609 color.diff.<slot>::
610         Use customized color for diff colorization.  `<slot>` specifies
611         which part of the patch to use the specified color, and is one
612         of `plain` (context text), `meta` (metainformation), `frag`
613         (hunk header), `old` (removed lines), `new` (added lines),
614         `commit` (commit headers), or `whitespace` (highlighting
615         whitespace errors). The values of these variables may be specified as
616         in color.branch.<slot>.
618 color.grep::
619         When set to `always`, always highlight matches.  When `false` (or
620         `never`), never.  When set to `true` or `auto`, use color only
621         when the output is written to the terminal.  Defaults to `false`.
623 color.grep.external::
624         The string value of this variable is passed to an external 'grep'
625         command as a command line option if match highlighting is turned
626         on.  If set to an empty string, no option is passed at all,
627         turning off coloring for external 'grep' calls; this is the default.
628         For GNU grep, set it to `--color=always` to highlight matches even
629         when a pager is used.
631 color.grep.match::
632         Use customized color for matches.  The value of this variable
633         may be specified as in color.branch.<slot>.  It is passed using
634         the environment variables 'GREP_COLOR' and 'GREP_COLORS' when
635         calling an external 'grep'.
637 color.interactive::
638         When set to `always`, always use colors for interactive prompts
639         and displays (such as those used by "git-add --interactive").
640         When false (or `never`), never.  When set to `true` or `auto`, use
641         colors only when the output is to the terminal. Defaults to false.
643 color.interactive.<slot>::
644         Use customized color for 'git-add --interactive'
645         output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
646         four distinct types of normal output from interactive
647         commands.  The values of these variables may be specified as
648         in color.branch.<slot>.
650 color.pager::
651         A boolean to enable/disable colored output when the pager is in
652         use (default is true).
654 color.showbranch::
655         A boolean to enable/disable color in the output of
656         linkgit:git-show-branch[1]. May be set to `always`,
657         `false` (or `never`) or `auto` (or `true`), in which case colors are used
658         only when the output is to a terminal. Defaults to false.
660 color.status::
661         A boolean to enable/disable color in the output of
662         linkgit:git-status[1]. May be set to `always`,
663         `false` (or `never`) or `auto` (or `true`), in which case colors are used
664         only when the output is to a terminal. Defaults to false.
666 color.status.<slot>::
667         Use customized color for status colorization. `<slot>` is
668         one of `header` (the header text of the status message),
669         `added` or `updated` (files which are added but not committed),
670         `changed` (files which are changed but not added in the index),
671         `untracked` (files which are not tracked by git), or
672         `nobranch` (the color the 'no branch' warning is shown in, defaulting
673         to red). The values of these variables may be specified as in
674         color.branch.<slot>.
676 color.ui::
677         When set to `always`, always use colors in all git commands which
678         are capable of colored output. When false (or `never`), never. When
679         set to `true` or `auto`, use colors only when the output is to the
680         terminal. When more specific variables of color.* are set, they always
681         take precedence over this setting. Defaults to false.
683 commit.template::
684         Specify a file to use as the template for new commit messages.
685         "{tilde}/" is expanded to the value of `$HOME` and "{tilde}user/" to the
686         specified user's home directory.
688 diff.autorefreshindex::
689         When using 'git-diff' to compare with work tree
690         files, do not consider stat-only change as changed.
691         Instead, silently run `git update-index --refresh` to
692         update the cached stat information for paths whose
693         contents in the work tree match the contents in the
694         index.  This option defaults to true.  Note that this
695         affects only 'git-diff' Porcelain, and not lower level
696         'diff' commands, such as 'git-diff-files'.
698 diff.external::
699         If this config variable is set, diff generation is not
700         performed using the internal diff machinery, but using the
701         given command.  Can be overridden with the `GIT_EXTERNAL_DIFF'
702         environment variable.  The command is called with parameters
703         as described under "git Diffs" in linkgit:git[1].  Note: if
704         you want to use an external diff program only on a subset of
705         your files, you might want to use linkgit:gitattributes[5] instead.
707 diff.mnemonicprefix::
708         If set, 'git-diff' uses a prefix pair that is different from the
709         standard "a/" and "b/" depending on what is being compared.  When
710         this configuration is in effect, reverse diff output also swaps
711         the order of the prefixes:
712 'git-diff';;
713         compares the (i)ndex and the (w)ork tree;
714 'git-diff HEAD';;
715          compares a (c)ommit and the (w)ork tree;
716 'git diff --cached';;
717         compares a (c)ommit and the (i)ndex;
718 'git-diff HEAD:file1 file2';;
719         compares an (o)bject and a (w)ork tree entity;
720 'git diff --no-index a b';;
721         compares two non-git things (1) and (2).
723 diff.renameLimit::
724         The number of files to consider when performing the copy/rename
725         detection; equivalent to the 'git-diff' option '-l'.
727 diff.renames::
728         Tells git to detect renames.  If set to any boolean value, it
729         will enable basic rename detection.  If set to "copies" or
730         "copy", it will detect copies, as well.
732 diff.suppressBlankEmpty::
733         A boolean to inhibit the standard behavior of printing a space
734         before each empty output line. Defaults to false.
736 diff.tool::
737         Controls which diff tool is used.  `diff.tool` overrides
738         `merge.tool` when used by linkgit:git-difftool[1] and has
739         the same valid values as `merge.tool` minus "tortoisemerge"
740         and plus "kompare".
742 difftool.<tool>.path::
743         Override the path for the given tool.  This is useful in case
744         your tool is not in the PATH.
746 difftool.<tool>.cmd::
747         Specify the command to invoke the specified diff tool.
748         The specified command is evaluated in shell with the following
749         variables available:  'LOCAL' is set to the name of the temporary
750         file containing the contents of the diff pre-image and 'REMOTE'
751         is set to the name of the temporary file containing the contents
752         of the diff post-image.
754 difftool.prompt::
755         Prompt before each invocation of the diff tool.
757 diff.wordRegex::
758         A POSIX Extended Regular Expression used to determine what is a "word"
759         when performing word-by-word difference calculations.  Character
760         sequences that match the regular expression are "words", all other
761         characters are *ignorable* whitespace.
763 fetch.unpackLimit::
764         If the number of objects fetched over the git native
765         transfer is below this
766         limit, then the objects will be unpacked into loose object
767         files. However if the number of received objects equals or
768         exceeds this limit then the received pack will be stored as
769         a pack, after adding any missing delta bases.  Storing the
770         pack from a push can make the push operation complete faster,
771         especially on slow filesystems.  If not set, the value of
772         `transfer.unpackLimit` is used instead.
774 format.attach::
775         Enable multipart/mixed attachments as the default for
776         'format-patch'.  The value can also be a double quoted string
777         which will enable attachments as the default and set the
778         value as the boundary.  See the --attach option in
779         linkgit:git-format-patch[1].
781 format.numbered::
782         A boolean which can enable or disable sequence numbers in patch
783         subjects.  It defaults to "auto" which enables it only if there
784         is more than one patch.  It can be enabled or disabled for all
785         messages by setting it to "true" or "false".  See --numbered
786         option in linkgit:git-format-patch[1].
788 format.headers::
789         Additional email headers to include in a patch to be submitted
790         by mail.  See linkgit:git-format-patch[1].
792 format.cc::
793         Additional "Cc:" headers to include in a patch to be submitted
794         by mail.  See the --cc option in linkgit:git-format-patch[1].
796 format.subjectprefix::
797         The default for format-patch is to output files with the '[PATCH]'
798         subject prefix. Use this variable to change that prefix.
800 format.suffix::
801         The default for format-patch is to output files with the suffix
802         `.patch`. Use this variable to change that suffix (make sure to
803         include the dot if you want it).
805 format.pretty::
806         The default pretty format for log/show/whatchanged command,
807         See linkgit:git-log[1], linkgit:git-show[1],
808         linkgit:git-whatchanged[1].
810 format.thread::
811         The default threading style for 'git-format-patch'.  Can be
812         either a boolean value, `shallow` or `deep`.  `shallow`
813         threading makes every mail a reply to the head of the series,
814         where the head is chosen from the cover letter, the
815         `\--in-reply-to`, and the first patch mail, in this order.
816         `deep` threading makes every mail a reply to the previous one.
817         A true boolean value is the same as `shallow`, and a false
818         value disables threading.
820 format.signoff::
821     A boolean value which lets you enable the `-s/--signoff` option of
822     format-patch by default. *Note:* Adding the Signed-off-by: line to a
823     patch should be a conscious act and means that you certify you have
824     the rights to submit this work under the same open source license.
825     Please see the 'SubmittingPatches' document for further discussion.
827 gc.aggressiveWindow::
828         The window size parameter used in the delta compression
829         algorithm used by 'git-gc --aggressive'.  This defaults
830         to 10.
832 gc.auto::
833         When there are approximately more than this many loose
834         objects in the repository, `git gc --auto` will pack them.
835         Some Porcelain commands use this command to perform a
836         light-weight garbage collection from time to time.  The
837         default value is 6700.  Setting this to 0 disables it.
839 gc.autopacklimit::
840         When there are more than this many packs that are not
841         marked with `*.keep` file in the repository, `git gc
842         --auto` consolidates them into one larger pack.  The
843         default value is 50.  Setting this to 0 disables it.
845 gc.packrefs::
846         'git-gc' does not run `git pack-refs` in a bare repository by
847         default so that older dumb-transport clients can still fetch
848         from the repository.  Setting this to `true` lets 'git-gc'
849         to run `git pack-refs`.  Setting this to `false` tells
850         'git-gc' never to run `git pack-refs`. The default setting is
851         `notbare`. Enable it only when you know you do not have to
852         support such clients.  The default setting will change to `true`
853         at some stage, and setting this to `false` will continue to
854         prevent `git pack-refs` from being run from 'git-gc'.
856 gc.pruneexpire::
857         When 'git-gc' is run, it will call 'prune --expire 2.weeks.ago'.
858         Override the grace period with this config variable.  The value
859         "now" may be used to disable this  grace period and always prune
860         unreachable objects immediately.
862 gc.reflogexpire::
863         'git-reflog expire' removes reflog entries older than
864         this time; defaults to 90 days.
866 gc.reflogexpireunreachable::
867         'git-reflog expire' removes reflog entries older than
868         this time and are not reachable from the current tip;
869         defaults to 30 days.
871 gc.rerereresolved::
872         Records of conflicted merge you resolved earlier are
873         kept for this many days when 'git-rerere gc' is run.
874         The default is 60 days.  See linkgit:git-rerere[1].
876 gc.rerereunresolved::
877         Records of conflicted merge you have not resolved are
878         kept for this many days when 'git-rerere gc' is run.
879         The default is 15 days.  See linkgit:git-rerere[1].
881 gitcvs.commitmsgannotation::
882         Append this string to each commit message. Set to empty string
883         to disable this feature. Defaults to "via git-CVS emulator".
885 gitcvs.enabled::
886         Whether the CVS server interface is enabled for this repository.
887         See linkgit:git-cvsserver[1].
889 gitcvs.logfile::
890         Path to a log file where the CVS server interface well... logs
891         various stuff. See linkgit:git-cvsserver[1].
893 gitcvs.usecrlfattr::
894         If true, the server will look up the `crlf` attribute for
895         files to determine the '-k' modes to use. If `crlf` is set,
896         the '-k' mode will be left blank, so cvs clients will
897         treat it as text. If `crlf` is explicitly unset, the file
898         will be set with '-kb' mode, which suppresses any newline munging
899         the client might otherwise do. If `crlf` is not specified,
900         then 'gitcvs.allbinary' is used. See linkgit:gitattributes[5].
902 gitcvs.allbinary::
903         This is used if 'gitcvs.usecrlfattr' does not resolve
904         the correct '-kb' mode to use. If true, all
905         unresolved files are sent to the client in
906         mode '-kb'. This causes the client to treat them
907         as binary files, which suppresses any newline munging it
908         otherwise might do. Alternatively, if it is set to "guess",
909         then the contents of the file are examined to decide if
910         it is binary, similar to 'core.autocrlf'.
912 gitcvs.dbname::
913         Database used by git-cvsserver to cache revision information
914         derived from the git repository. The exact meaning depends on the
915         used database driver, for SQLite (which is the default driver) this
916         is a filename. Supports variable substitution (see
917         linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
918         Default: '%Ggitcvs.%m.sqlite'
920 gitcvs.dbdriver::
921         Used Perl DBI driver. You can specify any available driver
922         for this here, but it might not work. git-cvsserver is tested
923         with 'DBD::SQLite', reported to work with 'DBD::Pg', and
924         reported *not* to work with 'DBD::mysql'. Experimental feature.
925         May not contain double colons (`:`). Default: 'SQLite'.
926         See linkgit:git-cvsserver[1].
928 gitcvs.dbuser, gitcvs.dbpass::
929         Database user and password. Only useful if setting 'gitcvs.dbdriver',
930         since SQLite has no concept of database users and/or passwords.
931         'gitcvs.dbuser' supports variable substitution (see
932         linkgit:git-cvsserver[1] for details).
934 gitcvs.dbTableNamePrefix::
935         Database table name prefix.  Prepended to the names of any
936         database tables used, allowing a single database to be used
937         for several repositories.  Supports variable substitution (see
938         linkgit:git-cvsserver[1] for details).  Any non-alphabetic
939         characters will be replaced with underscores.
941 All gitcvs variables except for 'gitcvs.usecrlfattr' and
942 'gitcvs.allbinary' can also be specified as
943 'gitcvs.<access_method>.<varname>' (where 'access_method'
944 is one of "ext" and "pserver") to make them apply only for the given
945 access method.
947 gui.commitmsgwidth::
948         Defines how wide the commit message window is in the
949         linkgit:git-gui[1]. "75" is the default.
951 gui.diffcontext::
952         Specifies how many context lines should be used in calls to diff
953         made by the linkgit:git-gui[1]. The default is "5".
955 gui.encoding::
956         Specifies the default encoding to use for displaying of
957         file contents in linkgit:git-gui[1] and linkgit:gitk[1].
958         It can be overridden by setting the 'encoding' attribute
959         for relevant files (see linkgit:gitattributes[5]).
960         If this option is not set, the tools default to the
961         locale encoding.
963 gui.matchtrackingbranch::
964         Determines if new branches created with linkgit:git-gui[1] should
965         default to tracking remote branches with matching names or
966         not. Default: "false".
968 gui.newbranchtemplate::
969         Is used as suggested name when creating new branches using the
970         linkgit:git-gui[1].
972 gui.pruneduringfetch::
973         "true" if linkgit:git-gui[1] should prune tracking branches when
974         performing a fetch. The default value is "false".
976 gui.trustmtime::
977         Determines if linkgit:git-gui[1] should trust the file modification
978         timestamp or not. By default the timestamps are not trusted.
980 gui.spellingdictionary::
981         Specifies the dictionary used for spell checking commit messages in
982         the linkgit:git-gui[1]. When set to "none" spell checking is turned
983         off.
985 gui.fastcopyblame::
986         If true, 'git gui blame' uses '-C' instead of '-C -C' for original
987         location detection. It makes blame significantly faster on huge
988         repositories at the expense of less thorough copy detection.
990 gui.copyblamethreshold::
991         Specifies the threshold to use in 'git gui blame' original location
992         detection, measured in alphanumeric characters. See the
993         linkgit:git-blame[1] manual for more information on copy detection.
995 gui.blamehistoryctx::
996         Specifies the radius of history context in days to show in
997         linkgit:gitk[1] for the selected commit, when the `Show History
998         Context` menu item is invoked from 'git gui blame'. If this
999         variable is set to zero, the whole history is shown.
1001 guitool.<name>.cmd::
1002         Specifies the shell command line to execute when the corresponding item
1003         of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1004         mandatory for every tool. The command is executed from the root of
1005         the working directory, and in the environment it receives the name of
1006         the tool as 'GIT_GUITOOL', the name of the currently selected file as
1007         'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1008         the head is detached, 'CUR_BRANCH' is empty).
1010 guitool.<name>.needsfile::
1011         Run the tool only if a diff is selected in the GUI. It guarantees
1012         that 'FILENAME' is not empty.
1014 guitool.<name>.noconsole::
1015         Run the command silently, without creating a window to display its
1016         output.
1018 guitool.<name>.norescan::
1019         Don't rescan the working directory for changes after the tool
1020         finishes execution.
1022 guitool.<name>.confirm::
1023         Show a confirmation dialog before actually running the tool.
1025 guitool.<name>.argprompt::
1026         Request a string argument from the user, and pass it to the tool
1027         through the 'ARGS' environment variable. Since requesting an
1028         argument implies confirmation, the 'confirm' option has no effect
1029         if this is enabled. If the option is set to 'true', 'yes', or '1',
1030         the dialog uses a built-in generic prompt; otherwise the exact
1031         value of the variable is used.
1033 guitool.<name>.revprompt::
1034         Request a single valid revision from the user, and set the
1035         'REVISION' environment variable. In other aspects this option
1036         is similar to 'argprompt', and can be used together with it.
1038 guitool.<name>.revunmerged::
1039         Show only unmerged branches in the 'revprompt' subdialog.
1040         This is useful for tools similar to merge or rebase, but not
1041         for things like checkout or reset.
1043 guitool.<name>.title::
1044         Specifies the title to use for the prompt dialog. The default
1045         is the tool name.
1047 guitool.<name>.prompt::
1048         Specifies the general prompt string to display at the top of
1049         the dialog, before subsections for 'argprompt' and 'revprompt'.
1050         The default value includes the actual command.
1052 help.browser::
1053         Specify the browser that will be used to display help in the
1054         'web' format. See linkgit:git-help[1].
1056 help.format::
1057         Override the default help format used by linkgit:git-help[1].
1058         Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1059         the default. 'web' and 'html' are the same.
1061 help.autocorrect::
1062         Automatically correct and execute mistyped commands after
1063         waiting for the given number of deciseconds (0.1 sec). If more
1064         than one command can be deduced from the entered text, nothing
1065         will be executed.  If the value of this option is negative,
1066         the corrected command will be executed immediately. If the
1067         value is 0 - the command will be just shown but not executed.
1068         This is the default.
1070 http.proxy::
1071         Override the HTTP proxy, normally configured using the 'http_proxy'
1072         environment variable (see linkgit:curl[1]).  This can be overridden
1073         on a per-remote basis; see remote.<name>.proxy
1075 http.sslVerify::
1076         Whether to verify the SSL certificate when fetching or pushing
1077         over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1078         variable.
1080 http.sslCert::
1081         File containing the SSL certificate when fetching or pushing
1082         over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1083         variable.
1085 http.sslKey::
1086         File containing the SSL private key when fetching or pushing
1087         over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1088         variable.
1090 http.sslCertPasswordProtected::
1091         Enable git's password prompt for the SSL certificate.  Otherwise
1092         OpenSSL will prompt the user, possibly many times, if the
1093         certificate or private key is encrypted.  Can be overridden by the
1094         'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1096 http.sslCAInfo::
1097         File containing the certificates to verify the peer with when
1098         fetching or pushing over HTTPS. Can be overridden by the
1099         'GIT_SSL_CAINFO' environment variable.
1101 http.sslCAPath::
1102         Path containing files with the CA certificates to verify the peer
1103         with when fetching or pushing over HTTPS. Can be overridden
1104         by the 'GIT_SSL_CAPATH' environment variable.
1106 http.maxRequests::
1107         How many HTTP requests to launch in parallel. Can be overridden
1108         by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1110 http.postBuffer::
1111         Maximum size in bytes of the buffer used by smart HTTP
1112         transports when POSTing data to the remote system.
1113         For requests larger than this buffer size, HTTP/1.1 and
1114         Transfer-Encoding: chunked is used to avoid creating a
1115         massive pack file locally.  Default is 1 MiB, which is
1116         sufficient for most requests.
1118 http.lowSpeedLimit, http.lowSpeedTime::
1119         If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1120         for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1121         Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1122         'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1124 http.noEPSV::
1125         A boolean which disables using of EPSV ftp command by curl.
1126         This can helpful with some "poor" ftp servers which don't
1127         support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1128         environment variable. Default is false (curl will use EPSV).
1130 i18n.commitEncoding::
1131         Character encoding the commit messages are stored in; git itself
1132         does not care per se, but this information is necessary e.g. when
1133         importing commits from emails or in the gitk graphical history
1134         browser (and possibly at other places in the future or in other
1135         porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1137 i18n.logOutputEncoding::
1138         Character encoding the commit messages are converted to when
1139         running 'git-log' and friends.
1141 imap::
1142         The configuration variables in the 'imap' section are described
1143         in linkgit:git-imap-send[1].
1145 instaweb.browser::
1146         Specify the program that will be used to browse your working
1147         repository in gitweb. See linkgit:git-instaweb[1].
1149 instaweb.httpd::
1150         The HTTP daemon command-line to start gitweb on your working
1151         repository. See linkgit:git-instaweb[1].
1153 instaweb.local::
1154         If true the web server started by linkgit:git-instaweb[1] will
1155         be bound to the local IP (127.0.0.1).
1157 instaweb.modulepath::
1158         The module path for an apache httpd used by linkgit:git-instaweb[1].
1160 instaweb.port::
1161         The port number to bind the gitweb httpd to. See
1162         linkgit:git-instaweb[1].
1164 interactive.singlekey::
1165         In interactive commands, allow the user to provide one-letter
1166         input with a single key (i.e., without hitting enter).
1167         Currently this is used only by the `\--patch` mode of
1168         linkgit:git-add[1].  Note that this setting is silently
1169         ignored if portable keystroke input is not available.
1171 log.date::
1172         Set default date-time mode for the log command. Setting log.date
1173         value is similar to using 'git-log'\'s --date option. The value is one of the
1174         following alternatives: {relative,local,default,iso,rfc,short}.
1175         See linkgit:git-log[1].
1177 log.showroot::
1178         If true, the initial commit will be shown as a big creation event.
1179         This is equivalent to a diff against an empty tree.
1180         Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1181         normally hide the root commit will now show it. True by default.
1183 mailmap.file::
1184         The location of an augmenting mailmap file. The default
1185         mailmap, located in the root of the repository, is loaded
1186         first, then the mailmap file pointed to by this variable.
1187         The location of the mailmap file may be in a repository
1188         subdirectory, or somewhere outside of the repository itself.
1189         See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1191 man.viewer::
1192         Specify the programs that may be used to display help in the
1193         'man' format. See linkgit:git-help[1].
1195 man.<tool>.cmd::
1196         Specify the command to invoke the specified man viewer. The
1197         specified command is evaluated in shell with the man page
1198         passed as argument. (See linkgit:git-help[1].)
1200 man.<tool>.path::
1201         Override the path for the given tool that may be used to
1202         display help in the 'man' format. See linkgit:git-help[1].
1204 include::merge-config.txt[]
1206 mergetool.<tool>.path::
1207         Override the path for the given tool.  This is useful in case
1208         your tool is not in the PATH.
1210 mergetool.<tool>.cmd::
1211         Specify the command to invoke the specified merge tool.  The
1212         specified command is evaluated in shell with the following
1213         variables available: 'BASE' is the name of a temporary file
1214         containing the common base of the files to be merged, if available;
1215         'LOCAL' is the name of a temporary file containing the contents of
1216         the file on the current branch; 'REMOTE' is the name of a temporary
1217         file containing the contents of the file from the branch being
1218         merged; 'MERGED' contains the name of the file to which the merge
1219         tool should write the results of a successful merge.
1221 mergetool.<tool>.trustExitCode::
1222         For a custom merge command, specify whether the exit code of
1223         the merge command can be used to determine whether the merge was
1224         successful.  If this is not set to true then the merge target file
1225         timestamp is checked and the merge assumed to have been successful
1226         if the file has been updated, otherwise the user is prompted to
1227         indicate the success of the merge.
1229 mergetool.keepBackup::
1230         After performing a merge, the original file with conflict markers
1231         can be saved as a file with a `.orig` extension.  If this variable
1232         is set to `false` then this file is not preserved.  Defaults to
1233         `true` (i.e. keep the backup files).
1235 mergetool.keepTemporaries::
1236         When invoking a custom merge tool, git uses a set of temporary
1237         files to pass to the tool. If the tool returns an error and this
1238         variable is set to `true`, then these temporary files will be
1239         preserved, otherwise they will be removed after the tool has
1240         exited. Defaults to `false`.
1242 mergetool.prompt::
1243         Prompt before each invocation of the merge resolution program.
1245 pack.window::
1246         The size of the window used by linkgit:git-pack-objects[1] when no
1247         window size is given on the command line. Defaults to 10.
1249 pack.depth::
1250         The maximum delta depth used by linkgit:git-pack-objects[1] when no
1251         maximum depth is given on the command line. Defaults to 50.
1253 pack.windowMemory::
1254         The window memory size limit used by linkgit:git-pack-objects[1]
1255         when no limit is given on the command line.  The value can be
1256         suffixed with "k", "m", or "g".  Defaults to 0, meaning no
1257         limit.
1259 pack.compression::
1260         An integer -1..9, indicating the compression level for objects
1261         in a pack file. -1 is the zlib default. 0 means no
1262         compression, and 1..9 are various speed/size tradeoffs, 9 being
1263         slowest.  If not set,  defaults to core.compression.  If that is
1264         not set,  defaults to -1, the zlib default, which is "a default
1265         compromise between speed and compression (currently equivalent
1266         to level 6)."
1268 pack.deltaCacheSize::
1269         The maximum memory in bytes used for caching deltas in
1270         linkgit:git-pack-objects[1] before writing them out to a pack.
1271         This cache is used to speed up the writing object phase by not
1272         having to recompute the final delta result once the best match
1273         for all objects is found.  Repacking large repositories on machines
1274         which are tight with memory might be badly impacted by this though,
1275         especially if this cache pushes the system into swapping.
1276         A value of 0 means no limit. The smallest size of 1 byte may be
1277         used to virtually disable this cache. Defaults to 256 MiB.
1279 pack.deltaCacheLimit::
1280         The maximum size of a delta, that is cached in
1281         linkgit:git-pack-objects[1]. This cache is used to speed up the
1282         writing object phase by not having to recompute the final delta
1283         result once the best match for all objects is found. Defaults to 1000.
1285 pack.threads::
1286         Specifies the number of threads to spawn when searching for best
1287         delta matches.  This requires that linkgit:git-pack-objects[1]
1288         be compiled with pthreads otherwise this option is ignored with a
1289         warning. This is meant to reduce packing time on multiprocessor
1290         machines. The required amount of memory for the delta search window
1291         is however multiplied by the number of threads.
1292         Specifying 0 will cause git to auto-detect the number of CPU's
1293         and set the number of threads accordingly.
1295 pack.indexVersion::
1296         Specify the default pack index version.  Valid values are 1 for
1297         legacy pack index used by Git versions prior to 1.5.2, and 2 for
1298         the new pack index with capabilities for packs larger than 4 GB
1299         as well as proper protection against the repacking of corrupted
1300         packs.  Version 2 is the default.  Note that version 2 is enforced
1301         and this config option ignored whenever the corresponding pack is
1302         larger than 2 GB.
1304 If you have an old git that does not understand the version 2 `{asterisk}.idx` file,
1305 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1306 that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the
1307 other side may give you a repository that cannot be accessed with your
1308 older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,
1309 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1310 the `{asterisk}.idx` file.
1312 pack.packSizeLimit::
1313         The default maximum size of a pack.  This setting only affects
1314         packing to a file, i.e. the git:// protocol is unaffected.  It
1315         can be overridden by the `\--max-pack-size` option of
1316         linkgit:git-repack[1].
1318 pager.<cmd>::
1319         Allows turning on or off pagination of the output of a
1320         particular git subcommand when writing to a tty.  If
1321         `\--paginate` or `\--no-pager` is specified on the command line,
1322         it takes precedence over this option.  To disable pagination for
1323         all commands, set `core.pager` or `GIT_PAGER` to `cat`.
1325 pull.octopus::
1326         The default merge strategy to use when pulling multiple branches
1327         at once.
1329 pull.twohead::
1330         The default merge strategy to use when pulling a single branch.
1332 push.default::
1333         Defines the action git push should take if no refspec is given
1334         on the command line, no refspec is configured in the remote, and
1335         no refspec is implied by any of the options given on the command
1336         line. Possible values are:
1338 * `nothing` do not push anything.
1339 * `matching` push all matching branches.
1340   All branches having the same name in both ends are considered to be
1341   matching. This is the default.
1342 * `tracking` push the current branch to its upstream branch.
1343 * `current` push the current branch to a branch of the same name.
1345 rebase.stat::
1346         Whether to show a diffstat of what changed upstream since the last
1347         rebase. False by default.
1349 receive.autogc::
1350         By default, git-receive-pack will run "git-gc --auto" after
1351         receiving data from git-push and updating refs.  You can stop
1352         it by setting this variable to false.
1354 receive.fsckObjects::
1355         If it is set to true, git-receive-pack will check all received
1356         objects. It will abort in the case of a malformed object or a
1357         broken link. The result of an abort are only dangling objects.
1358         Defaults to false.
1360 receive.unpackLimit::
1361         If the number of objects received in a push is below this
1362         limit then the objects will be unpacked into loose object
1363         files. However if the number of received objects equals or
1364         exceeds this limit then the received pack will be stored as
1365         a pack, after adding any missing delta bases.  Storing the
1366         pack from a push can make the push operation complete faster,
1367         especially on slow filesystems.  If not set, the value of
1368         `transfer.unpackLimit` is used instead.
1370 receive.denyDeletes::
1371         If set to true, git-receive-pack will deny a ref update that deletes
1372         the ref. Use this to prevent such a ref deletion via a push.
1374 receive.denyCurrentBranch::
1375         If set to true or "refuse", receive-pack will deny a ref update
1376         to the currently checked out branch of a non-bare repository.
1377         Such a push is potentially dangerous because it brings the HEAD
1378         out of sync with the index and working tree. If set to "warn",
1379         print a warning of such a push to stderr, but allow the push to
1380         proceed. If set to false or "ignore", allow such pushes with no
1381         message. Defaults to "warn".
1383 receive.denyNonFastForwards::
1384         If set to true, git-receive-pack will deny a ref update which is
1385         not a fast-forward. Use this to prevent such an update via a push,
1386         even if that push is forced. This configuration variable is
1387         set when initializing a shared repository.
1389 receive.updateserverinfo::
1390         If set to true, git-receive-pack will run git-update-server-info
1391         after receiving data from git-push and updating refs.
1393 remote.<name>.url::
1394         The URL of a remote repository.  See linkgit:git-fetch[1] or
1395         linkgit:git-push[1].
1397 remote.<name>.pushurl::
1398         The push URL of a remote repository.  See linkgit:git-push[1].
1400 remote.<name>.proxy::
1401         For remotes that require curl (http, https and ftp), the URL to
1402         the proxy to use for that remote.  Set to the empty string to
1403         disable proxying for that remote.
1405 remote.<name>.fetch::
1406         The default set of "refspec" for linkgit:git-fetch[1]. See
1407         linkgit:git-fetch[1].
1409 remote.<name>.push::
1410         The default set of "refspec" for linkgit:git-push[1]. See
1411         linkgit:git-push[1].
1413 remote.<name>.mirror::
1414         If true, pushing to this remote will automatically behave
1415         as if the `\--mirror` option was given on the command line.
1417 remote.<name>.skipDefaultUpdate::
1418         If true, this remote will be skipped by default when updating
1419         using the update subcommand of linkgit:git-remote[1].
1421 remote.<name>.receivepack::
1422         The default program to execute on the remote side when pushing.  See
1423         option \--receive-pack of linkgit:git-push[1].
1425 remote.<name>.uploadpack::
1426         The default program to execute on the remote side when fetching.  See
1427         option \--upload-pack of linkgit:git-fetch-pack[1].
1429 remote.<name>.tagopt::
1430         Setting this value to \--no-tags disables automatic tag following when
1431         fetching from remote <name>
1433 remotes.<group>::
1434         The list of remotes which are fetched by "git remote update
1435         <group>".  See linkgit:git-remote[1].
1437 repack.usedeltabaseoffset::
1438         By default, linkgit:git-repack[1] creates packs that use
1439         delta-base offset. If you need to share your repository with
1440         git older than version 1.4.4, either directly or via a dumb
1441         protocol such as http, then you need to set this option to
1442         "false" and repack. Access from old git versions over the
1443         native protocol are unaffected by this option.
1445 rerere.autoupdate::
1446         When set to true, `git-rerere` updates the index with the
1447         resulting contents after it cleanly resolves conflicts using
1448         previously recorded resolution.  Defaults to false.
1450 rerere.enabled::
1451         Activate recording of resolved conflicts, so that identical
1452         conflict hunks can be resolved automatically, should they
1453         be encountered again.  linkgit:git-rerere[1] command is by
1454         default enabled if you create `rr-cache` directory under
1455         `$GIT_DIR`, but can be disabled by setting this option to false.
1457 sendemail.identity::
1458         A configuration identity. When given, causes values in the
1459         'sendemail.<identity>' subsection to take precedence over
1460         values in the 'sendemail' section. The default identity is
1461         the value of 'sendemail.identity'.
1463 sendemail.smtpencryption::
1464         See linkgit:git-send-email[1] for description.  Note that this
1465         setting is not subject to the 'identity' mechanism.
1467 sendemail.smtpssl::
1468         Deprecated alias for 'sendemail.smtpencryption = ssl'.
1470 sendemail.<identity>.*::
1471         Identity-specific versions of the 'sendemail.*' parameters
1472         found below, taking precedence over those when the this
1473         identity is selected, through command-line or
1474         'sendemail.identity'.
1476 sendemail.aliasesfile::
1477 sendemail.aliasfiletype::
1478 sendemail.bcc::
1479 sendemail.cc::
1480 sendemail.cccmd::
1481 sendemail.chainreplyto::
1482 sendemail.confirm::
1483 sendemail.envelopesender::
1484 sendemail.from::
1485 sendemail.multiedit::
1486 sendemail.signedoffbycc::
1487 sendemail.smtppass::
1488 sendemail.suppresscc::
1489 sendemail.suppressfrom::
1490 sendemail.to::
1491 sendemail.smtpserver::
1492 sendemail.smtpserverport::
1493 sendemail.smtpuser::
1494 sendemail.thread::
1495 sendemail.validate::
1496         See linkgit:git-send-email[1] for description.
1498 sendemail.signedoffcc::
1499         Deprecated alias for 'sendemail.signedoffbycc'.
1501 showbranch.default::
1502         The default set of branches for linkgit:git-show-branch[1].
1503         See linkgit:git-show-branch[1].
1505 status.relativePaths::
1506         By default, linkgit:git-status[1] shows paths relative to the
1507         current directory. Setting this variable to `false` shows paths
1508         relative to the repository root (this was the default for git
1509         prior to v1.5.4).
1511 status.showUntrackedFiles::
1512         By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1513         files which are not currently tracked by Git. Directories which
1514         contain only untracked files, are shown with the directory name
1515         only. Showing untracked files means that Git needs to lstat() all
1516         all the files in the whole repository, which might be slow on some
1517         systems. So, this variable controls how the commands displays
1518         the untracked files. Possible values are:
1521         - 'no'     - Show no untracked files
1522         - 'normal' - Shows untracked files and directories
1523         - 'all'    - Shows also individual files in untracked directories.
1526 If this variable is not specified, it defaults to 'normal'.
1527 This variable can be overridden with the -u|--untracked-files option
1528 of linkgit:git-status[1] and linkgit:git-commit[1].
1530 tar.umask::
1531         This variable can be used to restrict the permission bits of
1532         tar archive entries.  The default is 0002, which turns off the
1533         world write bit.  The special value "user" indicates that the
1534         archiving user's umask will be used instead.  See umask(2) and
1535         linkgit:git-archive[1].
1537 transfer.unpackLimit::
1538         When `fetch.unpackLimit` or `receive.unpackLimit` are
1539         not set, the value of this variable is used instead.
1540         The default value is 100.
1542 url.<base>.insteadOf::
1543         Any URL that starts with this value will be rewritten to
1544         start, instead, with <base>. In cases where some site serves a
1545         large number of repositories, and serves them with multiple
1546         access methods, and some users need to use different access
1547         methods, this feature allows people to specify any of the
1548         equivalent URLs and have git automatically rewrite the URL to
1549         the best alternative for the particular user, even for a
1550         never-before-seen repository on the site.  When more than one
1551         insteadOf strings match a given URL, the longest match is used.
1553 url.<base>.pushInsteadOf::
1554         Any URL that starts with this value will not be pushed to;
1555         instead, it will be rewritten to start with <base>, and the
1556         resulting URL will be pushed to. In cases where some site serves
1557         a large number of repositories, and serves them with multiple
1558         access methods, some of which do not allow push, this feature
1559         allows people to specify a pull-only URL and have git
1560         automatically use an appropriate URL to push, even for a
1561         never-before-seen repository on the site.  When more than one
1562         pushInsteadOf strings match a given URL, the longest match is
1563         used.  If a remote has an explicit pushurl, git will ignore this
1564         setting for that remote.
1566 user.email::
1567         Your email address to be recorded in any newly created commits.
1568         Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
1569         'EMAIL' environment variables.  See linkgit:git-commit-tree[1].
1571 user.name::
1572         Your full name to be recorded in any newly created commits.
1573         Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
1574         environment variables.  See linkgit:git-commit-tree[1].
1576 user.signingkey::
1577         If linkgit:git-tag[1] is not selecting the key you want it to
1578         automatically when creating a signed tag, you can override the
1579         default selection with this variable.  This option is passed
1580         unchanged to gpg's --local-user parameter, so you may specify a key
1581         using any method that gpg supports.
1583 web.browser::
1584         Specify a web browser that may be used by some commands.
1585         Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
1586         may use it.