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