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