Merge branch 'sb/doc-upstream-branch'
[git/dscho.git] / Documentation / config.txt
blobf3ebd2f9a048371e7d519a93ea9c7eaf3bc75e2d
1 CONFIGURATION FILE
2 ------------------
4 The git configuration file contains a number of variables that affect
5 the git command's behavior. `.git/config` file for each repository
6 is used to store the information for that repository, and
7 `$HOME/.gitconfig` is used to store per user information to give
8 fallback values for `.git/config` file. The file `/etc/gitconfig`
9 can be used to store system-wide defaults.
11 They can be used by both the git plumbing
12 and the porcelains. The variables are divided into sections, where
13 in the fully qualified variable name 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 section
30 header before 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 example below:
36 --------
37         [section "subsection"]
39 --------
41 Subsection names can contain any characters except newline (doublequote
42 `"` and backslash have to be escaped as `\"` and `\\`,
43 respectively) and are case sensitive.  Section header 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 (case insensitive) alternative `[section.subsection]` syntax.
49 In this syntax subsection names follow the same restrictions as for section
50 name.
52 All the other lines are recognized as setting variables, in the form
53 'name = value'.  If there is no equal sign on the line, the entire line
54 is taken as 'name' and the variable is recognized as boolean "true".
55 The variable names are case-insensitive and only alphanumeric
56 characters and `-` are allowed.  There can be more than one value
57 for a given variable; we say then that variable is multivalued.
59 Leading and trailing whitespace in a variable value is discarded.
60 Internal whitespace within a variable value is retained verbatim.
62 The values following the equals sign in variable assign are all either
63 a string, an integer, or a boolean.  Boolean values may be given as yes/no,
64 0/1 or true/false.  Case is not significant in boolean values, when
65 converting value to the canonical form using '--bool' type specifier;
66 'git-config' will ensure that the output is "true" or "false".
68 String values may be entirely or partially enclosed in double quotes.
69 You need to enclose variable value in double quotes if you want to
70 preserve leading or trailing whitespace, or if variable value contains
71 beginning of comment characters (if it contains '#' or ';').
72 Double quote `"` and backslash `\` characters in variable value must
73 be escaped: use `\"` for `"` and `\\` for `\`.
75 The following escape sequences (beside `\"` and `\\`) are recognized:
76 `\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
77 and `\b` for backspace (BS).  No other char escape sequence, nor octal
78 char sequences are valid.
80 Variable value ending in a `\` is continued on the next line in the
81 customary UNIX fashion.
83 Some variables may require special value format.
85 Example
86 ~~~~~~~
88         # Core variables
89         [core]
90                 ; Don't trust file modes
91                 filemode = false
93         # Our diff algorithm
94         [diff]
95                 external = /usr/local/bin/diff-wrapper
96                 renames = true
98         [branch "devel"]
99                 remote = origin
100                 merge = refs/heads/devel
102         # Proxy settings
103         [core]
104                 gitProxy="ssh" for "kernel.org"
105                 gitProxy=default-proxy ; for the rest
107 Variables
108 ~~~~~~~~~
110 Note that this list is non-comprehensive and not necessarily complete.
111 For command-specific variables, you will find a more detailed description
112 in the appropriate manual page. You will find a description of non-core
113 porcelain configuration variables in the respective porcelain documentation.
115 core.fileMode::
116         If false, the executable bit differences between the index and
117         the working copy are ignored; useful on broken filesystems like FAT.
118         See linkgit:git-update-index[1]. True by default.
120 core.ignoreCygwinFSTricks::
121         This option is only used by Cygwin implementation of Git. If false,
122         the Cygwin stat() and lstat() functions are used. This may be useful
123         if your repository consists of a few separate directories joined in
124         one hierarchy using Cygwin mount. If true, Git uses native Win32 API
125         whenever it is possible and falls back to Cygwin functions only to
126         handle symbol links. The native mode is more than twice faster than
127         normal Cygwin l/stat() functions. True by default, unless core.filemode
128         is true, in which case ignoreCygwinFSTricks is ignored as Cygwin's
129         POSIX emulation is required to support core.filemode.
131 core.trustctime::
132         If false, the ctime differences between the index and the
133         working copy are ignored; useful when the inode change time
134         is regularly modified by something outside Git (file system
135         crawlers and some backup systems).
136         See linkgit:git-update-index[1]. True by default.
138 core.quotepath::
139         The commands that output paths (e.g. 'ls-files',
140         'diff'), when not given the `-z` option, will quote
141         "unusual" characters in the pathname by enclosing the
142         pathname in a double-quote pair and with backslashes the
143         same way strings in C source code are quoted.  If this
144         variable is set to false, the bytes higher than 0x80 are
145         not quoted but output as verbatim.  Note that double
146         quote, backslash and control characters are always
147         quoted without `-z` regardless of the setting of this
148         variable.
150 core.autocrlf::
151         If true, makes git convert `CRLF` at the end of lines in text files to
152         `LF` when reading from the filesystem, and convert in reverse when
153         writing to the filesystem.  The variable can be set to
154         'input', in which case the conversion happens only while
155         reading from the filesystem but files are written out with
156         `LF` at the end of lines.  Currently, which paths to consider
157         "text" (i.e. be subjected to the autocrlf mechanism) is
158         decided purely based on the contents.
160 core.safecrlf::
161         If true, makes git check if converting `CRLF` as controlled by
162         `core.autocrlf` is reversible.  Git will verify if a command
163         modifies a file in the work tree either directly or indirectly.
164         For example, committing a file followed by checking out the
165         same file should yield the original file in the work tree.  If
166         this is not the case for the current setting of
167         `core.autocrlf`, git will reject the file.  The variable can
168         be set to "warn", in which case git will only warn about an
169         irreversible conversion but continue the operation.
171 CRLF conversion bears a slight chance of corrupting data.
172 autocrlf=true will convert CRLF to LF during commit and LF to
173 CRLF during checkout.  A file that contains a mixture of LF and
174 CRLF before the commit cannot be recreated by git.  For text
175 files this is the right thing to do: it corrects line endings
176 such that we have only LF line endings in the repository.
177 But for binary files that are accidentally classified as text the
178 conversion can corrupt data.
180 If you recognize such corruption early you can easily fix it by
181 setting the conversion type explicitly in .gitattributes.  Right
182 after committing you still have the original file in your work
183 tree and this file is not yet corrupted.  You can explicitly tell
184 git that this file is binary and git will handle the file
185 appropriately.
187 Unfortunately, the desired effect of cleaning up text files with
188 mixed line endings and the undesired effect of corrupting binary
189 files cannot be distinguished.  In both cases CRLFs are removed
190 in an irreversible way.  For text files this is the right thing
191 to do because CRLFs are line endings, while for binary files
192 converting CRLFs corrupts data.
194 Note, this safety check does not mean that a checkout will generate a
195 file identical to the original file for a different setting of
196 `core.autocrlf`, but only for the current one.  For example, a text
197 file with `LF` would be accepted with `core.autocrlf=input` and could
198 later be checked out with `core.autocrlf=true`, in which case the
199 resulting file would contain `CRLF`, although the original file
200 contained `LF`.  However, in both work trees the line endings would be
201 consistent, that is either all `LF` or all `CRLF`, but never mixed.  A
202 file with mixed line endings would be reported by the `core.safecrlf`
203 mechanism.
205 core.symlinks::
206         If false, symbolic links are checked out as small plain files that
207         contain the link text. linkgit:git-update-index[1] and
208         linkgit:git-add[1] will not change the recorded type to regular
209         file. Useful on filesystems like FAT that do not support
210         symbolic links. True by default.
212 core.gitProxy::
213         A "proxy command" to execute (as 'command host port') instead
214         of establishing direct connection to the remote server when
215         using the git protocol for fetching. If the variable value is
216         in the "COMMAND for DOMAIN" format, the command is applied only
217         on hostnames ending with the specified domain string. This variable
218         may be set multiple times and is matched in the given order;
219         the first match wins.
221 Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
222 (which always applies universally, without the special "for"
223 handling).
225 The special string `none` can be used as the proxy command to
226 specify that no proxy be used for a given domain pattern.
227 This is useful for excluding servers inside a firewall from
228 proxy use, while defaulting to a common proxy for external domains.
230 core.ignoreStat::
231         If true, commands which modify both the working tree and the index
232         will mark the updated paths with the "assume unchanged" bit in the
233         index. These marked files are then assumed to stay unchanged in the
234         working copy, until you mark them otherwise manually - Git will not
235         detect the file changes by lstat() calls. This is useful on systems
236         where those are very slow, such as Microsoft Windows.
237         See linkgit:git-update-index[1].
238         False by default.
240 core.preferSymlinkRefs::
241         Instead of the default "symref" format for HEAD
242         and other symbolic reference files, use symbolic links.
243         This is sometimes needed to work with old scripts that
244         expect HEAD to be a symbolic link.
246 core.bare::
247         If true this repository is assumed to be 'bare' and has no
248         working directory associated with it.  If this is the case a
249         number of commands that require a working directory will be
250         disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
252 This setting is automatically guessed by linkgit:git-clone[1] or
253 linkgit:git-init[1] when the repository was created.  By default a
254 repository that ends in "/.git" is assumed to be not bare (bare =
255 false), while all other repositories are assumed to be bare (bare
256 = true).
258 core.worktree::
259         Set the path to the working tree.  The value will not be
260         used in combination with repositories found automatically in
261         a .git directory (i.e. $GIT_DIR is not set).
262         This can be overridden by the GIT_WORK_TREE environment
263         variable and the '--work-tree' command line option. It can be
264         a absolute path or relative path to the directory specified by
265         --git-dir or GIT_DIR.
266         Note: If --git-dir or GIT_DIR are specified but none of
267         --work-tree, GIT_WORK_TREE and core.worktree is specified,
268         the current working directory is regarded as the top directory
269         of your working tree.
271 core.logAllRefUpdates::
272         Enable the reflog. Updates to a ref <ref> is logged to the file
273         "$GIT_DIR/logs/<ref>", by appending the new and old
274         SHA1, the date/time and the reason of the update, but
275         only when the file exists.  If this configuration
276         variable is set to true, missing "$GIT_DIR/logs/<ref>"
277         file is automatically created for branch heads.
279 This information can be used to determine what commit
280 was the tip of a branch "2 days ago".
282 This value is true by default in a repository that has
283 a working directory associated with it, and false by
284 default in a bare repository.
286 core.repositoryFormatVersion::
287         Internal variable identifying the repository format and layout
288         version.
290 core.sharedRepository::
291         When 'group' (or 'true'), the repository is made shareable between
292         several users in a group (making sure all the files and objects are
293         group-writable). When 'all' (or 'world' or 'everybody'), the
294         repository will be readable by all users, additionally to being
295         group-shareable. When 'umask' (or 'false'), git will use permissions
296         reported by umask(2). When '0xxx', where '0xxx' is an octal number,
297         files in the repository will have this mode value. '0xxx' will override
298         user's umask value, and thus, users with a safe umask (0077) can use
299         this option. Examples: '0660' is equivalent to 'group'. '0640' is a
300         repository that is group-readable but not group-writable.
301         See linkgit:git-init[1]. False by default.
303 core.warnAmbiguousRefs::
304         If true, git will warn you if the ref name you passed it is ambiguous
305         and might match multiple refs in the .git/refs/ tree. True by default.
307 core.compression::
308         An integer -1..9, indicating a default compression level.
309         -1 is the zlib default. 0 means no compression,
310         and 1..9 are various speed/size tradeoffs, 9 being slowest.
311         If set, this provides a default to other compression variables,
312         such as 'core.loosecompression' and 'pack.compression'.
314 core.loosecompression::
315         An integer -1..9, indicating the compression level for objects that
316         are not in a pack file. -1 is the zlib default. 0 means no
317         compression, and 1..9 are various speed/size tradeoffs, 9 being
318         slowest.  If not set,  defaults to core.compression.  If that is
319         not set,  defaults to 1 (best speed).
321 core.packedGitWindowSize::
322         Number of bytes of a pack file to map into memory in a
323         single mapping operation.  Larger window sizes may allow
324         your system to process a smaller number of large pack files
325         more quickly.  Smaller window sizes will negatively affect
326         performance due to increased calls to the operating system's
327         memory manager, but may improve performance when accessing
328         a large number of large pack files.
330 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
331 MiB on 32 bit platforms and 1 GiB on 64 bit platforms.  This should
332 be reasonable for all users/operating systems.  You probably do
333 not need to adjust this value.
335 Common unit suffixes of 'k', 'm', or 'g' are supported.
337 core.packedGitLimit::
338         Maximum number of bytes to map simultaneously into memory
339         from pack files.  If Git needs to access more than this many
340         bytes at once to complete an operation it will unmap existing
341         regions to reclaim virtual address space within the process.
343 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
344 This should be reasonable for all users/operating systems, except on
345 the largest projects.  You probably do not need to adjust this value.
347 Common unit suffixes of 'k', 'm', or 'g' are supported.
349 core.deltaBaseCacheLimit::
350         Maximum number of bytes to reserve for caching base objects
351         that multiple deltafied objects reference.  By storing the
352         entire decompressed base objects in a cache Git is able
353         to avoid unpacking and decompressing frequently used base
354         objects multiple times.
356 Default is 16 MiB on all platforms.  This should be reasonable
357 for all users/operating systems, except on the largest projects.
358 You probably do not need to adjust this value.
360 Common unit suffixes of 'k', 'm', or 'g' are supported.
362 core.excludesfile::
363         In addition to '.gitignore' (per-directory) and
364         '.git/info/exclude', git looks into this file for patterns
365         of files which are not meant to be tracked.  See
366         linkgit:gitignore[5].
368 core.editor::
369         Commands such as `commit` and `tag` that lets you edit
370         messages by launching an editor uses the value of this
371         variable when it is set, and the environment variable
372         `GIT_EDITOR` is not set.  The order of preference is
373         `GIT_EDITOR` environment, `core.editor`, `VISUAL` and
374         `EDITOR` environment variables and then finally `vi`.
376 core.pager::
377         The command that git will use to paginate output.  Can
378         be overridden with the `GIT_PAGER` environment
379         variable.  Note that git sets the `LESS` environment
380         variable to `FRSX` if it is unset when it runs the
381         pager.  One can change these settings by setting the
382         `LESS` variable to some other value.  Alternately,
383         these settings can be overridden on a project or
384         global basis by setting the `core.pager` option.
385         Setting `core.pager` has no affect on the `LESS`
386         environment variable behaviour above, so if you want
387         to override git's default settings this way, you need
388         to be explicit.  For example, to disable the S option
389         in a backward compatible manner, set `core.pager`
390         to `less -+$LESS -FRX`.  This will be passed to the
391         shell by git, which will translate the final command to
392         `LESS=FRSX less -+FRSX -FRX`.
394 core.whitespace::
395         A comma separated list of common whitespace problems to
396         notice.  'git-diff' will use `color.diff.whitespace` to
397         highlight them, and 'git-apply --whitespace=error' will
398         consider them as errors.  You can prefix `-` to disable
399         any of them (e.g. `-trailing-space`):
401 * `trailing-space` treats trailing whitespaces at the end of the line
402   as an error (enabled by default).
403 * `space-before-tab` treats a space character that appears immediately
404   before a tab character in the initial indent part of the line as an
405   error (enabled by default).
406 * `indent-with-non-tab` treats a line that is indented with 8 or more
407   space characters as an error (not enabled by default).
408 * `cr-at-eol` treats a carriage-return at the end of line as
409   part of the line terminator, i.e. with it, `trailing-space`
410   does not trigger if the character before such a carriage-return
411   is not a whitespace (not enabled by default).
413 core.fsyncobjectfiles::
414         This boolean will enable 'fsync()' when writing object files.
416 This is a total waste of time and effort on a filesystem that orders
417 data writes properly, but can be useful for filesystems that do not use
418 journalling (traditional UNIX filesystems) or that only journal metadata
419 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
421 core.preloadindex::
422         Enable parallel index preload for operations like 'git diff'
424 This can speed up operations like 'git diff' and 'git status' especially
425 on filesystems like NFS that have weak caching semantics and thus
426 relatively high IO latencies.  With this set to 'true', git will do the
427 index comparison to the filesystem data in parallel, allowing
428 overlapping IO's.
430 alias.*::
431         Command aliases for the linkgit:git[1] command wrapper - e.g.
432         after defining "alias.last = cat-file commit HEAD", the invocation
433         "git last" is equivalent to "git cat-file commit HEAD". To avoid
434         confusion and troubles with script usage, aliases that
435         hide existing git commands are ignored. Arguments are split by
436         spaces, the usual shell quoting and escaping is supported.
437         quote pair and a backslash can be used to quote them.
439 If the alias expansion is prefixed with an exclamation point,
440 it will be treated as a shell command.  For example, defining
441 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
442 "git new" is equivalent to running the shell command
443 "gitk --all --not ORIG_HEAD".
445 apply.whitespace::
446         Tells 'git-apply' how to handle whitespaces, in the same way
447         as the '--whitespace' option. See linkgit:git-apply[1].
449 branch.autosetupmerge::
450         Tells 'git-branch' and 'git-checkout' to setup new branches
451         so that linkgit:git-pull[1] will appropriately merge from the
452         starting point branch. Note that even if this option is not set,
453         this behavior can be chosen per-branch using the `--track`
454         and `--no-track` options. The valid settings are: `false` -- no
455         automatic setup is done; `true` -- automatic setup is done when the
456         starting point is a remote branch; `always` -- automatic setup is
457         done when the starting point is either a local branch or remote
458         branch. This option defaults to true.
460 branch.autosetuprebase::
461         When a new branch is created with 'git-branch' or 'git-checkout'
462         that tracks another branch, this variable tells git to set
463         up pull to rebase instead of merge (see "branch.<name>.rebase").
464         When `never`, rebase is never automatically set to true.
465         When `local`, rebase is set to true for tracked branches of
466         other local branches.
467         When `remote`, rebase is set to true for tracked branches of
468         remote branches.
469         When `always`, rebase will be set to true for all tracking
470         branches.
471         See "branch.autosetupmerge" for details on how to set up a
472         branch to track another branch.
473         This option defaults to never.
475 branch.<name>.remote::
476         When in branch <name>, it tells 'git-fetch' and 'git-push' which
477         remote to fetch from/push to.  It defaults to `origin` if no remote is
478         configured. `origin` is also used if you are not on any branch.
480 branch.<name>.merge::
481         Defines, together with branch.<name>.remote, the upstream branch
482         for the given branch. It tells 'git-fetch'/'git-pull' which
483         branch to merge and can also affect 'git-push' (see push.default).
484         When in branch <name>, it tells 'git-fetch' the default
485         refspec to be marked for merging in FETCH_HEAD. The value is
486         handled like the remote part of a refspec, and must match a
487         ref which is fetched from the remote given by
488         "branch.<name>.remote".
489         The merge information is used by 'git-pull' (which at first calls
490         'git-fetch') to lookup the default branch for merging. Without
491         this option, 'git-pull' defaults to merge the first refspec fetched.
492         Specify multiple values to get an octopus merge.
493         If you wish to setup 'git-pull' so that it merges into <name> from
494         another branch in the local repository, you can point
495         branch.<name>.merge to the desired branch, and use the special setting
496         `.` (a period) for branch.<name>.remote.
498 branch.<name>.mergeoptions::
499         Sets default options for merging into branch <name>. The syntax and
500         supported options are equal to that of linkgit:git-merge[1], but
501         option values containing whitespace characters are currently not
502         supported.
504 branch.<name>.rebase::
505         When true, rebase the branch <name> on top of the fetched branch,
506         instead of merging the default branch from the default remote when
507         "git pull" is run.
508         *NOTE*: this is a possibly dangerous operation; do *not* use
509         it unless you understand the implications (see linkgit:git-rebase[1]
510         for details).
512 browser.<tool>.cmd::
513         Specify the command to invoke the specified browser. The
514         specified command is evaluated in shell with the URLs passed
515         as arguments. (See linkgit:git-web--browse[1].)
517 browser.<tool>.path::
518         Override the path for the given tool that may be used to
519         browse HTML help (see '-w' option in linkgit:git-help[1]) or a
520         working repository in gitweb (see linkgit:git-instaweb[1]).
522 clean.requireForce::
523         A boolean to make git-clean do nothing unless given -f
524         or -n.   Defaults to true.
526 color.branch::
527         A boolean to enable/disable color in the output of
528         linkgit:git-branch[1]. May be set to `always`,
529         `false` (or `never`) or `auto` (or `true`), in which case colors are used
530         only when the output is to a terminal. Defaults to false.
532 color.branch.<slot>::
533         Use customized color for branch coloration. `<slot>` is one of
534         `current` (the current branch), `local` (a local branch),
535         `remote` (a tracking branch in refs/remotes/), `plain` (other
536         refs).
538 The value for these configuration variables is a list of colors (at most
539 two) and attributes (at most one), separated by spaces.  The colors
540 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
541 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
542 `blink` and `reverse`.  The first color given is the foreground; the
543 second is the background.  The position of the attribute, if any,
544 doesn't matter.
546 color.diff::
547         When set to `always`, always use colors in patch.
548         When false (or `never`), never.  When set to `true` or `auto`, use
549         colors only when the output is to the terminal. Defaults to false.
551 color.diff.<slot>::
552         Use customized color for diff colorization.  `<slot>` specifies
553         which part of the patch to use the specified color, and is one
554         of `plain` (context text), `meta` (metainformation), `frag`
555         (hunk header), `old` (removed lines), `new` (added lines),
556         `commit` (commit headers), or `whitespace` (highlighting
557         whitespace errors). The values of these variables may be specified as
558         in color.branch.<slot>.
560 color.grep::
561         When set to `always`, always highlight matches.  When `false` (or
562         `never`), never.  When set to `true` or `auto`, use color only
563         when the output is written to the terminal.  Defaults to `false`.
565 color.grep.external::
566         The string value of this variable is passed to an external 'grep'
567         command as a command line option if match highlighting is turned
568         on.  If set to an empty string, no option is passed at all,
569         turning off coloring for external 'grep' calls; this is the default.
570         For GNU grep, set it to `--color=always` to highlight matches even
571         when a pager is used.
573 color.grep.match::
574         Use customized color for matches.  The value of this variable
575         may be specified as in color.branch.<slot>.  It is passed using
576         the environment variables 'GREP_COLOR' and 'GREP_COLORS' when
577         calling an external 'grep'.
579 color.interactive::
580         When set to `always`, always use colors for interactive prompts
581         and displays (such as those used by "git-add --interactive").
582         When false (or `never`), never.  When set to `true` or `auto`, use
583         colors only when the output is to the terminal. Defaults to false.
585 color.interactive.<slot>::
586         Use customized color for 'git-add --interactive'
587         output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
588         four distinct types of normal output from interactive
589         programs.  The values of these variables may be specified as
590         in color.branch.<slot>.
592 color.pager::
593         A boolean to enable/disable colored output when the pager is in
594         use (default is true).
596 color.status::
597         A boolean to enable/disable color in the output of
598         linkgit:git-status[1]. May be set to `always`,
599         `false` (or `never`) or `auto` (or `true`), in which case colors are used
600         only when the output is to a terminal. Defaults to false.
602 color.status.<slot>::
603         Use customized color for status colorization. `<slot>` is
604         one of `header` (the header text of the status message),
605         `added` or `updated` (files which are added but not committed),
606         `changed` (files which are changed but not added in the index),
607         `untracked` (files which are not tracked by git), or
608         `nobranch` (the color the 'no branch' warning is shown in, defaulting
609         to red). The values of these variables may be specified as in
610         color.branch.<slot>.
612 color.ui::
613         When set to `always`, always use colors in all git commands which
614         are capable of colored output. When false (or `never`), never. When
615         set to `true` or `auto`, use colors only when the output is to the
616         terminal. When more specific variables of color.* are set, they always
617         take precedence over this setting. Defaults to false.
619 commit.template::
620         Specify a file to use as the template for new commit messages.
622 diff.autorefreshindex::
623         When using 'git-diff' to compare with work tree
624         files, do not consider stat-only change as changed.
625         Instead, silently run `git update-index --refresh` to
626         update the cached stat information for paths whose
627         contents in the work tree match the contents in the
628         index.  This option defaults to true.  Note that this
629         affects only 'git-diff' Porcelain, and not lower level
630         'diff' commands, such as 'git-diff-files'.
632 diff.external::
633         If this config variable is set, diff generation is not
634         performed using the internal diff machinery, but using the
635         given command.  Can be overridden with the `GIT_EXTERNAL_DIFF'
636         environment variable.  The command is called with parameters
637         as described under "git Diffs" in linkgit:git[1].  Note: if
638         you want to use an external diff program only on a subset of
639         your files, you might want to use linkgit:gitattributes[5] instead.
641 diff.mnemonicprefix::
642         If set, 'git-diff' uses a prefix pair that is different from the
643         standard "a/" and "b/" depending on what is being compared.  When
644         this configuration is in effect, reverse diff output also swaps
645         the order of the prefixes:
646 'git-diff';;
647         compares the (i)ndex and the (w)ork tree;
648 'git-diff HEAD';;
649          compares a (c)ommit and the (w)ork tree;
650 'git diff --cached';;
651         compares a (c)ommit and the (i)ndex;
652 'git-diff HEAD:file1 file2';;
653         compares an (o)bject and a (w)ork tree entity;
654 'git diff --no-index a b';;
655         compares two non-git things (1) and (2).
657 diff.renameLimit::
658         The number of files to consider when performing the copy/rename
659         detection; equivalent to the 'git-diff' option '-l'.
661 diff.renames::
662         Tells git to detect renames.  If set to any boolean value, it
663         will enable basic rename detection.  If set to "copies" or
664         "copy", it will detect copies, as well.
666 diff.suppressBlankEmpty::
667         A boolean to inhibit the standard behavior of printing a space
668         before each empty output line. Defaults to false.
670 diff.wordRegex::
671         A POSIX Extended Regular Expression used to determine what is a "word"
672         when performing word-by-word difference calculations.  Character
673         sequences that match the regular expression are "words", all other
674         characters are *ignorable* whitespace.
676 fetch.unpackLimit::
677         If the number of objects fetched over the git native
678         transfer is below this
679         limit, then the objects will be unpacked into loose object
680         files. However if the number of received objects equals or
681         exceeds this limit then the received pack will be stored as
682         a pack, after adding any missing delta bases.  Storing the
683         pack from a push can make the push operation complete faster,
684         especially on slow filesystems.  If not set, the value of
685         `transfer.unpackLimit` is used instead.
687 format.numbered::
688         A boolean which can enable or disable sequence numbers in patch
689         subjects.  It defaults to "auto" which enables it only if there
690         is more than one patch.  It can be enabled or disabled for all
691         messages by setting it to "true" or "false".  See --numbered
692         option in linkgit:git-format-patch[1].
694 format.headers::
695         Additional email headers to include in a patch to be submitted
696         by mail.  See linkgit:git-format-patch[1].
698 format.suffix::
699         The default for format-patch is to output files with the suffix
700         `.patch`. Use this variable to change that suffix (make sure to
701         include the dot if you want it).
703 format.pretty::
704         The default pretty format for log/show/whatchanged command,
705         See linkgit:git-log[1], linkgit:git-show[1],
706         linkgit:git-whatchanged[1].
708 format.thread::
709         The default threading style for 'git-format-patch'.  Can be
710         either a boolean value, `shallow` or `deep`.  'Shallow'
711         threading makes every mail a reply to the head of the series,
712         where the head is chosen from the cover letter, the
713         `\--in-reply-to`, and the first patch mail, in this order.
714         'Deep' threading makes every mail a reply to the previous one.
715         A true boolean value is the same as `shallow`, and a false
716         value disables threading.
718 format.signoff::
719     A boolean value which lets you enable the `-s/--signoff` option of
720     format-patch by default. *Note:* Adding the Signed-off-by: line to a
721     patch should be a conscious act and means that you certify you have
722     the rights to submit this work under the same open source license.
723     Please see the 'SubmittingPatches' document for further discussion.
725 gc.aggressiveWindow::
726         The window size parameter used in the delta compression
727         algorithm used by 'git-gc --aggressive'.  This defaults
728         to 10.
730 gc.auto::
731         When there are approximately more than this many loose
732         objects in the repository, `git gc --auto` will pack them.
733         Some Porcelain commands use this command to perform a
734         light-weight garbage collection from time to time.  The
735         default value is 6700.  Setting this to 0 disables it.
737 gc.autopacklimit::
738         When there are more than this many packs that are not
739         marked with `*.keep` file in the repository, `git gc
740         --auto` consolidates them into one larger pack.  The
741         default value is 50.  Setting this to 0 disables it.
743 gc.packrefs::
744         'git-gc' does not run `git pack-refs` in a bare repository by
745         default so that older dumb-transport clients can still fetch
746         from the repository.  Setting this to `true` lets 'git-gc'
747         to run `git pack-refs`.  Setting this to `false` tells
748         'git-gc' never to run `git pack-refs`. The default setting is
749         `notbare`. Enable it only when you know you do not have to
750         support such clients.  The default setting will change to `true`
751         at some stage, and setting this to `false` will continue to
752         prevent `git pack-refs` from being run from 'git-gc'.
754 gc.pruneexpire::
755         When 'git-gc' is run, it will call 'prune --expire 2.weeks.ago'.
756         Override the grace period with this config variable.  The value
757         "now" may be used to disable this  grace period and always prune
758         unreachable objects immediately.
760 gc.reflogexpire::
761         'git-reflog expire' removes reflog entries older than
762         this time; defaults to 90 days.
764 gc.reflogexpireunreachable::
765         'git-reflog expire' removes reflog entries older than
766         this time and are not reachable from the current tip;
767         defaults to 30 days.
769 gc.rerereresolved::
770         Records of conflicted merge you resolved earlier are
771         kept for this many days when 'git-rerere gc' is run.
772         The default is 60 days.  See linkgit:git-rerere[1].
774 gc.rerereunresolved::
775         Records of conflicted merge you have not resolved are
776         kept for this many days when 'git-rerere gc' is run.
777         The default is 15 days.  See linkgit:git-rerere[1].
779 gitcvs.commitmsgannotation::
780         Append this string to each commit message. Set to empty string
781         to disable this feature. Defaults to "via git-CVS emulator".
783 gitcvs.enabled::
784         Whether the CVS server interface is enabled for this repository.
785         See linkgit:git-cvsserver[1].
787 gitcvs.logfile::
788         Path to a log file where the CVS server interface well... logs
789         various stuff. See linkgit:git-cvsserver[1].
791 gitcvs.usecrlfattr::
792         If true, the server will look up the `crlf` attribute for
793         files to determine the '-k' modes to use. If `crlf` is set,
794         the '-k' mode will be left blank, so cvs clients will
795         treat it as text. If `crlf` is explicitly unset, the file
796         will be set with '-kb' mode, which suppresses any newline munging
797         the client might otherwise do. If `crlf` is not specified,
798         then 'gitcvs.allbinary' is used. See linkgit:gitattributes[5].
800 gitcvs.allbinary::
801         This is used if 'gitcvs.usecrlfattr' does not resolve
802         the correct '-kb' mode to use. If true, all
803         unresolved files are sent to the client in
804         mode '-kb'. This causes the client to treat them
805         as binary files, which suppresses any newline munging it
806         otherwise might do. Alternatively, if it is set to "guess",
807         then the contents of the file are examined to decide if
808         it is binary, similar to 'core.autocrlf'.
810 gitcvs.dbname::
811         Database used by git-cvsserver to cache revision information
812         derived from the git repository. The exact meaning depends on the
813         used database driver, for SQLite (which is the default driver) this
814         is a filename. Supports variable substitution (see
815         linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
816         Default: '%Ggitcvs.%m.sqlite'
818 gitcvs.dbdriver::
819         Used Perl DBI driver. You can specify any available driver
820         for this here, but it might not work. git-cvsserver is tested
821         with 'DBD::SQLite', reported to work with 'DBD::Pg', and
822         reported *not* to work with 'DBD::mysql'. Experimental feature.
823         May not contain double colons (`:`). Default: 'SQLite'.
824         See linkgit:git-cvsserver[1].
826 gitcvs.dbuser, gitcvs.dbpass::
827         Database user and password. Only useful if setting 'gitcvs.dbdriver',
828         since SQLite has no concept of database users and/or passwords.
829         'gitcvs.dbuser' supports variable substitution (see
830         linkgit:git-cvsserver[1] for details).
832 gitcvs.dbTableNamePrefix::
833         Database table name prefix.  Prepended to the names of any
834         database tables used, allowing a single database to be used
835         for several repositories.  Supports variable substitution (see
836         linkgit:git-cvsserver[1] for details).  Any non-alphabetic
837         characters will be replaced with underscores.
839 All gitcvs variables except for 'gitcvs.usecrlfattr' and
840 'gitcvs.allbinary' can also be specified as
841 'gitcvs.<access_method>.<varname>' (where 'access_method'
842 is one of "ext" and "pserver") to make them apply only for the given
843 access method.
845 gui.commitmsgwidth::
846         Defines how wide the commit message window is in the
847         linkgit:git-gui[1]. "75" is the default.
849 gui.diffcontext::
850         Specifies how many context lines should be used in calls to diff
851         made by the linkgit:git-gui[1]. The default is "5".
853 gui.encoding::
854         Specifies the default encoding to use for displaying of
855         file contents in linkgit:git-gui[1] and linkgit:gitk[1].
856         It can be overridden by setting the 'encoding' attribute
857         for relevant files (see linkgit:gitattributes[5]).
858         If this option is not set, the tools default to the
859         locale encoding.
861 gui.matchtrackingbranch::
862         Determines if new branches created with linkgit:git-gui[1] should
863         default to tracking remote branches with matching names or
864         not. Default: "false".
866 gui.newbranchtemplate::
867         Is used as suggested name when creating new branches using the
868         linkgit:git-gui[1].
870 gui.pruneduringfetch::
871         "true" if linkgit:git-gui[1] should prune tracking branches when
872         performing a fetch. The default value is "false".
874 gui.trustmtime::
875         Determines if linkgit:git-gui[1] should trust the file modification
876         timestamp or not. By default the timestamps are not trusted.
878 gui.spellingdictionary::
879         Specifies the dictionary used for spell checking commit messages in
880         the linkgit:git-gui[1]. When set to "none" spell checking is turned
881         off.
883 gui.fastcopyblame::
884         If true, 'git gui blame' uses '-C' instead of '-C -C' for original
885         location detection. It makes blame significantly faster on huge
886         repositories at the expense of less thorough copy detection.
888 gui.copyblamethreshold::
889         Specifies the threshold to use in 'git gui blame' original location
890         detection, measured in alphanumeric characters. See the
891         linkgit:git-blame[1] manual for more information on copy detection.
893 gui.blamehistoryctx::
894         Specifies the radius of history context in days to show in
895         linkgit:gitk[1] for the selected commit, when the `Show History
896         Context` menu item is invoked from 'git gui blame'. If this
897         variable is set to zero, the whole history is shown.
899 guitool.<name>.cmd::
900         Specifies the shell command line to execute when the corresponding item
901         of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
902         mandatory for every tool. The command is executed from the root of
903         the working directory, and in the environment it receives the name of
904         the tool as 'GIT_GUITOOL', the name of the currently selected file as
905         'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
906         the head is detached, 'CUR_BRANCH' is empty).
908 guitool.<name>.needsfile::
909         Run the tool only if a diff is selected in the GUI. It guarantees
910         that 'FILENAME' is not empty.
912 guitool.<name>.noconsole::
913         Run the command silently, without creating a window to display its
914         output.
916 guitool.<name>.norescan::
917         Don't rescan the working directory for changes after the tool
918         finishes execution.
920 guitool.<name>.confirm::
921         Show a confirmation dialog before actually running the tool.
923 guitool.<name>.argprompt::
924         Request a string argument from the user, and pass it to the tool
925         through the 'ARGS' environment variable. Since requesting an
926         argument implies confirmation, the 'confirm' option has no effect
927         if this is enabled. If the option is set to 'true', 'yes', or '1',
928         the dialog uses a built-in generic prompt; otherwise the exact
929         value of the variable is used.
931 guitool.<name>.revprompt::
932         Request a single valid revision from the user, and set the
933         'REVISION' environment variable. In other aspects this option
934         is similar to 'argprompt', and can be used together with it.
936 guitool.<name>.revunmerged::
937         Show only unmerged branches in the 'revprompt' subdialog.
938         This is useful for tools similar to merge or rebase, but not
939         for things like checkout or reset.
941 guitool.<name>.title::
942         Specifies the title to use for the prompt dialog. The default
943         is the tool name.
945 guitool.<name>.prompt::
946         Specifies the general prompt string to display at the top of
947         the dialog, before subsections for 'argprompt' and 'revprompt'.
948         The default value includes the actual command.
950 help.browser::
951         Specify the browser that will be used to display help in the
952         'web' format. See linkgit:git-help[1].
954 help.format::
955         Override the default help format used by linkgit:git-help[1].
956         Values 'man', 'info', 'web' and 'html' are supported. 'man' is
957         the default. 'web' and 'html' are the same.
959 help.autocorrect::
960         Automatically correct and execute mistyped commands after
961         waiting for the given number of deciseconds (0.1 sec). If more
962         than one command can be deduced from the entered text, nothing
963         will be executed.  If the value of this option is negative,
964         the corrected command will be executed immediately. If the
965         value is 0 - the command will be just shown but not executed.
966         This is the default.
968 http.proxy::
969         Override the HTTP proxy, normally configured using the 'http_proxy'
970         environment variable (see linkgit:curl[1]).  This can be overridden
971         on a per-remote basis; see remote.<name>.proxy
973 http.sslVerify::
974         Whether to verify the SSL certificate when fetching or pushing
975         over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
976         variable.
978 http.sslCert::
979         File containing the SSL certificate when fetching or pushing
980         over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
981         variable.
983 http.sslKey::
984         File containing the SSL private key when fetching or pushing
985         over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
986         variable.
988 http.sslCAInfo::
989         File containing the certificates to verify the peer with when
990         fetching or pushing over HTTPS. Can be overridden by the
991         'GIT_SSL_CAINFO' environment variable.
993 http.sslCAPath::
994         Path containing files with the CA certificates to verify the peer
995         with when fetching or pushing over HTTPS. Can be overridden
996         by the 'GIT_SSL_CAPATH' environment variable.
998 http.maxRequests::
999         How many HTTP requests to launch in parallel. Can be overridden
1000         by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1002 http.lowSpeedLimit, http.lowSpeedTime::
1003         If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1004         for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1005         Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1006         'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1008 http.noEPSV::
1009         A boolean which disables using of EPSV ftp command by curl.
1010         This can helpful with some "poor" ftp servers which don't
1011         support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1012         environment variable. Default is false (curl will use EPSV).
1014 i18n.commitEncoding::
1015         Character encoding the commit messages are stored in; git itself
1016         does not care per se, but this information is necessary e.g. when
1017         importing commits from emails or in the gitk graphical history
1018         browser (and possibly at other places in the future or in other
1019         porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1021 i18n.logOutputEncoding::
1022         Character encoding the commit messages are converted to when
1023         running 'git-log' and friends.
1025 imap::
1026         The configuration variables in the 'imap' section are described
1027         in linkgit:git-imap-send[1].
1029 instaweb.browser::
1030         Specify the program that will be used to browse your working
1031         repository in gitweb. See linkgit:git-instaweb[1].
1033 instaweb.httpd::
1034         The HTTP daemon command-line to start gitweb on your working
1035         repository. See linkgit:git-instaweb[1].
1037 instaweb.local::
1038         If true the web server started by linkgit:git-instaweb[1] will
1039         be bound to the local IP (127.0.0.1).
1041 instaweb.modulepath::
1042         The module path for an apache httpd used by linkgit:git-instaweb[1].
1044 instaweb.port::
1045         The port number to bind the gitweb httpd to. See
1046         linkgit:git-instaweb[1].
1048 interactive.singlekey::
1049         In interactive programs, allow the user to provide one-letter
1050         input with a single key (i.e., without hitting enter).
1051         Currently this is used only by the `\--patch` mode of
1052         linkgit:git-add[1].  Note that this setting is silently
1053         ignored if portable keystroke input is not available.
1055 log.date::
1056         Set default date-time mode for the log command. Setting log.date
1057         value is similar to using 'git-log'\'s --date option. The value is one of the
1058         following alternatives: {relative,local,default,iso,rfc,short}.
1059         See linkgit:git-log[1].
1061 log.showroot::
1062         If true, the initial commit will be shown as a big creation event.
1063         This is equivalent to a diff against an empty tree.
1064         Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1065         normally hide the root commit will now show it. True by default.
1067 mailmap.file::
1068         The location of an augmenting mailmap file. The default
1069         mailmap, located in the root of the repository, is loaded
1070         first, then the mailmap file pointed to by this variable.
1071         The location of the mailmap file may be in a repository
1072         subdirectory, or somewhere outside of the repository itself.
1073         See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1075 man.viewer::
1076         Specify the programs that may be used to display help in the
1077         'man' format. See linkgit:git-help[1].
1079 man.<tool>.cmd::
1080         Specify the command to invoke the specified man viewer. The
1081         specified command is evaluated in shell with the man page
1082         passed as argument. (See linkgit:git-help[1].)
1084 man.<tool>.path::
1085         Override the path for the given tool that may be used to
1086         display help in the 'man' format. See linkgit:git-help[1].
1088 include::merge-config.txt[]
1090 mergetool.<tool>.path::
1091         Override the path for the given tool.  This is useful in case
1092         your tool is not in the PATH.
1094 mergetool.<tool>.cmd::
1095         Specify the command to invoke the specified merge tool.  The
1096         specified command is evaluated in shell with the following
1097         variables available: 'BASE' is the name of a temporary file
1098         containing the common base of the files to be merged, if available;
1099         'LOCAL' is the name of a temporary file containing the contents of
1100         the file on the current branch; 'REMOTE' is the name of a temporary
1101         file containing the contents of the file from the branch being
1102         merged; 'MERGED' contains the name of the file to which the merge
1103         tool should write the results of a successful merge.
1105 mergetool.<tool>.trustExitCode::
1106         For a custom merge command, specify whether the exit code of
1107         the merge command can be used to determine whether the merge was
1108         successful.  If this is not set to true then the merge target file
1109         timestamp is checked and the merge assumed to have been successful
1110         if the file has been updated, otherwise the user is prompted to
1111         indicate the success of the merge.
1113 mergetool.keepBackup::
1114         After performing a merge, the original file with conflict markers
1115         can be saved as a file with a `.orig` extension.  If this variable
1116         is set to `false` then this file is not preserved.  Defaults to
1117         `true` (i.e. keep the backup files).
1119 mergetool.keepTemporaries::
1120         When invoking a custom merge tool, git uses a set of temporary
1121         files to pass to the tool. If the tool returns an error and this
1122         variable is set to `true`, then these temporary files will be
1123         preserved, otherwise they will be removed after the tool has
1124         exited. Defaults to `false`.
1126 mergetool.prompt::
1127         Prompt before each invocation of the merge resolution program.
1129 pack.window::
1130         The size of the window used by linkgit:git-pack-objects[1] when no
1131         window size is given on the command line. Defaults to 10.
1133 pack.depth::
1134         The maximum delta depth used by linkgit:git-pack-objects[1] when no
1135         maximum depth is given on the command line. Defaults to 50.
1137 pack.windowMemory::
1138         The window memory size limit used by linkgit:git-pack-objects[1]
1139         when no limit is given on the command line.  The value can be
1140         suffixed with "k", "m", or "g".  Defaults to 0, meaning no
1141         limit.
1143 pack.compression::
1144         An integer -1..9, indicating the compression level for objects
1145         in a pack file. -1 is the zlib default. 0 means no
1146         compression, and 1..9 are various speed/size tradeoffs, 9 being
1147         slowest.  If not set,  defaults to core.compression.  If that is
1148         not set,  defaults to -1, the zlib default, which is "a default
1149         compromise between speed and compression (currently equivalent
1150         to level 6)."
1152 pack.deltaCacheSize::
1153         The maximum memory in bytes used for caching deltas in
1154         linkgit:git-pack-objects[1].
1155         A value of 0 means no limit. Defaults to 0.
1157 pack.deltaCacheLimit::
1158         The maximum size of a delta, that is cached in
1159         linkgit:git-pack-objects[1]. Defaults to 1000.
1161 pack.threads::
1162         Specifies the number of threads to spawn when searching for best
1163         delta matches.  This requires that linkgit:git-pack-objects[1]
1164         be compiled with pthreads otherwise this option is ignored with a
1165         warning. This is meant to reduce packing time on multiprocessor
1166         machines. The required amount of memory for the delta search window
1167         is however multiplied by the number of threads.
1168         Specifying 0 will cause git to auto-detect the number of CPU's
1169         and set the number of threads accordingly.
1171 pack.indexVersion::
1172         Specify the default pack index version.  Valid values are 1 for
1173         legacy pack index used by Git versions prior to 1.5.2, and 2 for
1174         the new pack index with capabilities for packs larger than 4 GB
1175         as well as proper protection against the repacking of corrupted
1176         packs.  Version 2 is the default.  Note that version 2 is enforced
1177         and this config option ignored whenever the corresponding pack is
1178         larger than 2 GB.
1180 If you have an old git that does not understand the version 2 `{asterisk}.idx` file,
1181 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1182 that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the
1183 other side may give you a repository that cannot be accessed with your
1184 older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,
1185 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1186 the `{asterisk}.idx` file.
1188 pack.packSizeLimit::
1189         The default maximum size of a pack.  This setting only affects
1190         packing to a file, i.e. the git:// protocol is unaffected.  It
1191         can be overridden by the `\--max-pack-size` option of
1192         linkgit:git-repack[1].
1194 pager.<cmd>::
1195         Allows turning on or off pagination of the output of a
1196         particular git subcommand when writing to a tty.  If
1197         `\--paginate` or `\--no-pager` is specified on the command line,
1198         it takes precedence over this option.  To disable pagination for
1199         all commands, set `core.pager` or `GIT_PAGER` to `cat`.
1201 pull.octopus::
1202         The default merge strategy to use when pulling multiple branches
1203         at once.
1205 pull.twohead::
1206         The default merge strategy to use when pulling a single branch.
1208 push.default::
1209         Defines the action git push should take if no refspec is given
1210         on the command line, no refspec is configured in the remote, and
1211         no refspec is implied by any of the options given on the command
1212         line. Possible values are:
1214 * `nothing` do not push anything.
1215 * `matching` push all matching branches.
1216   All branches having the same name in both ends are considered to be
1217   matching. This is the default.
1218 * `tracking` push the current branch to its upstream branch.
1219 * `current` push the current branch to a branch of the same name.
1221 rebase.stat::
1222         Whether to show a diffstat of what changed upstream since the last
1223         rebase. False by default.
1225 receive.fsckObjects::
1226         If it is set to true, git-receive-pack will check all received
1227         objects. It will abort in the case of a malformed object or a
1228         broken link. The result of an abort are only dangling objects.
1229         Defaults to false.
1231 receive.unpackLimit::
1232         If the number of objects received in a push is below this
1233         limit then the objects will be unpacked into loose object
1234         files. However if the number of received objects equals or
1235         exceeds this limit then the received pack will be stored as
1236         a pack, after adding any missing delta bases.  Storing the
1237         pack from a push can make the push operation complete faster,
1238         especially on slow filesystems.  If not set, the value of
1239         `transfer.unpackLimit` is used instead.
1241 receive.denyDeletes::
1242         If set to true, git-receive-pack will deny a ref update that deletes
1243         the ref. Use this to prevent such a ref deletion via a push.
1245 receive.denyCurrentBranch::
1246         If set to true or "refuse", receive-pack will deny a ref update
1247         to the currently checked out branch of a non-bare repository.
1248         Such a push is potentially dangerous because it brings the HEAD
1249         out of sync with the index and working tree. If set to "warn",
1250         print a warning of such a push to stderr, but allow the push to
1251         proceed. If set to false or "ignore", allow such pushes with no
1252         message. Defaults to "warn".
1254 receive.denyNonFastForwards::
1255         If set to true, git-receive-pack will deny a ref update which is
1256         not a fast forward. Use this to prevent such an update via a push,
1257         even if that push is forced. This configuration variable is
1258         set when initializing a shared repository.
1260 remote.<name>.url::
1261         The URL of a remote repository.  See linkgit:git-fetch[1] or
1262         linkgit:git-push[1].
1264 remote.<name>.proxy::
1265         For remotes that require curl (http, https and ftp), the URL to
1266         the proxy to use for that remote.  Set to the empty string to
1267         disable proxying for that remote.
1269 remote.<name>.fetch::
1270         The default set of "refspec" for linkgit:git-fetch[1]. See
1271         linkgit:git-fetch[1].
1273 remote.<name>.push::
1274         The default set of "refspec" for linkgit:git-push[1]. See
1275         linkgit:git-push[1].
1277 remote.<name>.mirror::
1278         If true, pushing to this remote will automatically behave
1279         as if the `\--mirror` option was given on the command line.
1281 remote.<name>.skipDefaultUpdate::
1282         If true, this remote will be skipped by default when updating
1283         using the update subcommand of linkgit:git-remote[1].
1285 remote.<name>.receivepack::
1286         The default program to execute on the remote side when pushing.  See
1287         option \--receive-pack of linkgit:git-push[1].
1289 remote.<name>.uploadpack::
1290         The default program to execute on the remote side when fetching.  See
1291         option \--upload-pack of linkgit:git-fetch-pack[1].
1293 remote.<name>.tagopt::
1294         Setting this value to \--no-tags disables automatic tag following when
1295         fetching from remote <name>
1297 remotes.<group>::
1298         The list of remotes which are fetched by "git remote update
1299         <group>".  See linkgit:git-remote[1].
1301 repack.usedeltabaseoffset::
1302         By default, linkgit:git-repack[1] creates packs that use
1303         delta-base offset. If you need to share your repository with
1304         git older than version 1.4.4, either directly or via a dumb
1305         protocol such as http, then you need to set this option to
1306         "false" and repack. Access from old git versions over the
1307         native protocol are unaffected by this option.
1309 rerere.autoupdate::
1310         When set to true, `git-rerere` updates the index with the
1311         resulting contents after it cleanly resolves conflicts using
1312         previously recorded resolution.  Defaults to false.
1314 rerere.enabled::
1315         Activate recording of resolved conflicts, so that identical
1316         conflict hunks can be resolved automatically, should they
1317         be encountered again.  linkgit:git-rerere[1] command is by
1318         default enabled if you create `rr-cache` directory under
1319         `$GIT_DIR`, but can be disabled by setting this option to false.
1321 showbranch.default::
1322         The default set of branches for linkgit:git-show-branch[1].
1323         See linkgit:git-show-branch[1].
1325 status.relativePaths::
1326         By default, linkgit:git-status[1] shows paths relative to the
1327         current directory. Setting this variable to `false` shows paths
1328         relative to the repository root (this was the default for git
1329         prior to v1.5.4).
1331 status.showUntrackedFiles::
1332         By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1333         files which are not currently tracked by Git. Directories which
1334         contain only untracked files, are shown with the directory name
1335         only. Showing untracked files means that Git needs to lstat() all
1336         all the files in the whole repository, which might be slow on some
1337         systems. So, this variable controls how the commands displays
1338         the untracked files. Possible values are:
1341         - 'no'     - Show no untracked files
1342         - 'normal' - Shows untracked files and directories
1343         - 'all'    - Shows also individual files in untracked directories.
1346 If this variable is not specified, it defaults to 'normal'.
1347 This variable can be overridden with the -u|--untracked-files option
1348 of linkgit:git-status[1] and linkgit:git-commit[1].
1350 tar.umask::
1351         This variable can be used to restrict the permission bits of
1352         tar archive entries.  The default is 0002, which turns off the
1353         world write bit.  The special value "user" indicates that the
1354         archiving user's umask will be used instead.  See umask(2) and
1355         linkgit:git-archive[1].
1357 transfer.unpackLimit::
1358         When `fetch.unpackLimit` or `receive.unpackLimit` are
1359         not set, the value of this variable is used instead.
1360         The default value is 100.
1362 url.<base>.insteadOf::
1363         Any URL that starts with this value will be rewritten to
1364         start, instead, with <base>. In cases where some site serves a
1365         large number of repositories, and serves them with multiple
1366         access methods, and some users need to use different access
1367         methods, this feature allows people to specify any of the
1368         equivalent URLs and have git automatically rewrite the URL to
1369         the best alternative for the particular user, even for a
1370         never-before-seen repository on the site.  When more than one
1371         insteadOf strings match a given URL, the longest match is used.
1373 user.email::
1374         Your email address to be recorded in any newly created commits.
1375         Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
1376         'EMAIL' environment variables.  See linkgit:git-commit-tree[1].
1378 user.name::
1379         Your full name to be recorded in any newly created commits.
1380         Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
1381         environment variables.  See linkgit:git-commit-tree[1].
1383 user.signingkey::
1384         If linkgit:git-tag[1] is not selecting the key you want it to
1385         automatically when creating a signed tag, you can override the
1386         default selection with this variable.  This option is passed
1387         unchanged to gpg's --local-user parameter, so you may specify a key
1388         using any method that gpg supports.
1390 web.browser::
1391         Specify a web browser that may be used by some commands.
1392         Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
1393         may use it.