Merge commit 'git/master'
[git/git-bigfiles.git] / Documentation / config.txt
blob8c9886d4df4b9add1a4853e3756665edfe51cc34
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.bigFileThreshold::
363         Number of bytes above which Git will consider a file as being
364         a large binary blob.  Such files may cause excessive memory
365         usage in many operations and will thus be excluded from delta
366         search.
368 Default is 32 MiB.  You may need to increase this value if you are
369 likely to version huge text files that may benefit from delta
370 compression.
372 Common unit suffixes of 'k', 'm', or 'g' are supported.
374 core.excludesfile::
375         In addition to '.gitignore' (per-directory) and
376         '.git/info/exclude', git looks into this file for patterns
377         of files which are not meant to be tracked.  See
378         linkgit:gitignore[5].
380 core.editor::
381         Commands such as `commit` and `tag` that lets you edit
382         messages by launching an editor uses the value of this
383         variable when it is set, and the environment variable
384         `GIT_EDITOR` is not set.  The order of preference is
385         `GIT_EDITOR` environment, `core.editor`, `VISUAL` and
386         `EDITOR` environment variables and then finally `vi`.
388 core.pager::
389         The command that git will use to paginate output.  Can
390         be overridden with the `GIT_PAGER` environment
391         variable.  Note that git sets the `LESS` environment
392         variable to `FRSX` if it is unset when it runs the
393         pager.  One can change these settings by setting the
394         `LESS` variable to some other value.  Alternately,
395         these settings can be overridden on a project or
396         global basis by setting the `core.pager` option.
397         Setting `core.pager` has no affect on the `LESS`
398         environment variable behaviour above, so if you want
399         to override git's default settings this way, you need
400         to be explicit.  For example, to disable the S option
401         in a backward compatible manner, set `core.pager`
402         to `less -+$LESS -FRX`.  This will be passed to the
403         shell by git, which will translate the final command to
404         `LESS=FRSX less -+FRSX -FRX`.
406 core.whitespace::
407         A comma separated list of common whitespace problems to
408         notice.  'git-diff' will use `color.diff.whitespace` to
409         highlight them, and 'git-apply --whitespace=error' will
410         consider them as errors.  You can prefix `-` to disable
411         any of them (e.g. `-trailing-space`):
413 * `trailing-space` treats trailing whitespaces at the end of the line
414   as an error (enabled by default).
415 * `space-before-tab` treats a space character that appears immediately
416   before a tab character in the initial indent part of the line as an
417   error (enabled by default).
418 * `indent-with-non-tab` treats a line that is indented with 8 or more
419   space characters as an error (not enabled by default).
420 * `cr-at-eol` treats a carriage-return at the end of line as
421   part of the line terminator, i.e. with it, `trailing-space`
422   does not trigger if the character before such a carriage-return
423   is not a whitespace (not enabled by default).
425 core.fsyncobjectfiles::
426         This boolean will enable 'fsync()' when writing object files.
428 This is a total waste of time and effort on a filesystem that orders
429 data writes properly, but can be useful for filesystems that do not use
430 journalling (traditional UNIX filesystems) or that only journal metadata
431 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
433 core.preloadindex::
434         Enable parallel index preload for operations like 'git diff'
436 This can speed up operations like 'git diff' and 'git status' especially
437 on filesystems like NFS that have weak caching semantics and thus
438 relatively high IO latencies.  With this set to 'true', git will do the
439 index comparison to the filesystem data in parallel, allowing
440 overlapping IO's.
442 alias.*::
443         Command aliases for the linkgit:git[1] command wrapper - e.g.
444         after defining "alias.last = cat-file commit HEAD", the invocation
445         "git last" is equivalent to "git cat-file commit HEAD". To avoid
446         confusion and troubles with script usage, aliases that
447         hide existing git commands are ignored. Arguments are split by
448         spaces, the usual shell quoting and escaping is supported.
449         quote pair and a backslash can be used to quote them.
451 If the alias expansion is prefixed with an exclamation point,
452 it will be treated as a shell command.  For example, defining
453 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
454 "git new" is equivalent to running the shell command
455 "gitk --all --not ORIG_HEAD".
457 apply.whitespace::
458         Tells 'git-apply' how to handle whitespaces, in the same way
459         as the '--whitespace' option. See linkgit:git-apply[1].
461 branch.autosetupmerge::
462         Tells 'git-branch' and 'git-checkout' to setup new branches
463         so that linkgit:git-pull[1] will appropriately merge from the
464         starting point branch. Note that even if this option is not set,
465         this behavior can be chosen per-branch using the `--track`
466         and `--no-track` options. The valid settings are: `false` -- no
467         automatic setup is done; `true` -- automatic setup is done when the
468         starting point is a remote branch; `always` -- automatic setup is
469         done when the starting point is either a local branch or remote
470         branch. This option defaults to true.
472 branch.autosetuprebase::
473         When a new branch is created with 'git-branch' or 'git-checkout'
474         that tracks another branch, this variable tells git to set
475         up pull to rebase instead of merge (see "branch.<name>.rebase").
476         When `never`, rebase is never automatically set to true.
477         When `local`, rebase is set to true for tracked branches of
478         other local branches.
479         When `remote`, rebase is set to true for tracked branches of
480         remote branches.
481         When `always`, rebase will be set to true for all tracking
482         branches.
483         See "branch.autosetupmerge" for details on how to set up a
484         branch to track another branch.
485         This option defaults to never.
487 branch.<name>.remote::
488         When in branch <name>, it tells 'git-fetch' which remote to fetch.
489         If this option is not given, 'git-fetch' defaults to remote "origin".
491 branch.<name>.merge::
492         When in branch <name>, it tells 'git-fetch' the default
493         refspec to be marked for merging in FETCH_HEAD. The value is
494         handled like the remote part of a refspec, and must match a
495         ref which is fetched from the remote given by
496         "branch.<name>.remote".
497         The merge information is used by 'git-pull' (which at first calls
498         'git-fetch') to lookup the default branch for merging. Without
499         this option, 'git-pull' defaults to merge the first refspec fetched.
500         Specify multiple values to get an octopus merge.
501         If you wish to setup 'git-pull' so that it merges into <name> from
502         another branch in the local repository, you can point
503         branch.<name>.merge to the desired branch, and use the special setting
504         `.` (a period) for branch.<name>.remote.
506 branch.<name>.mergeoptions::
507         Sets default options for merging into branch <name>. The syntax and
508         supported options are equal to that of linkgit:git-merge[1], but
509         option values containing whitespace characters are currently not
510         supported.
512 branch.<name>.rebase::
513         When true, rebase the branch <name> on top of the fetched branch,
514         instead of merging the default branch from the default remote when
515         "git pull" is run.
516         *NOTE*: this is a possibly dangerous operation; do *not* use
517         it unless you understand the implications (see linkgit:git-rebase[1]
518         for details).
520 browser.<tool>.cmd::
521         Specify the command to invoke the specified browser. The
522         specified command is evaluated in shell with the URLs passed
523         as arguments. (See linkgit:git-web--browse[1].)
525 browser.<tool>.path::
526         Override the path for the given tool that may be used to
527         browse HTML help (see '-w' option in linkgit:git-help[1]) or a
528         working repository in gitweb (see linkgit:git-instaweb[1]).
530 clean.requireForce::
531         A boolean to make git-clean do nothing unless given -f
532         or -n.   Defaults to true.
534 color.branch::
535         A boolean to enable/disable color in the output of
536         linkgit:git-branch[1]. May be set to `always`,
537         `false` (or `never`) or `auto` (or `true`), in which case colors are used
538         only when the output is to a terminal. Defaults to false.
540 color.branch.<slot>::
541         Use customized color for branch coloration. `<slot>` is one of
542         `current` (the current branch), `local` (a local branch),
543         `remote` (a tracking branch in refs/remotes/), `plain` (other
544         refs).
546 The value for these configuration variables is a list of colors (at most
547 two) and attributes (at most one), separated by spaces.  The colors
548 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
549 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
550 `blink` and `reverse`.  The first color given is the foreground; the
551 second is the background.  The position of the attribute, if any,
552 doesn't matter.
554 color.diff::
555         When set to `always`, always use colors in patch.
556         When false (or `never`), never.  When set to `true` or `auto`, use
557         colors only when the output is to the terminal. Defaults to false.
559 color.diff.<slot>::
560         Use customized color for diff colorization.  `<slot>` specifies
561         which part of the patch to use the specified color, and is one
562         of `plain` (context text), `meta` (metainformation), `frag`
563         (hunk header), `old` (removed lines), `new` (added lines),
564         `commit` (commit headers), or `whitespace` (highlighting
565         whitespace errors). The values of these variables may be specified as
566         in color.branch.<slot>.
568 color.grep::
569         When set to `always`, always highlight matches.  When `false` (or
570         `never`), never.  When set to `true` or `auto`, use color only
571         when the output is written to the terminal.  Defaults to `false`.
573 color.grep.external::
574         The string value of this variable is passed to an external 'grep'
575         command as a command line option if match highlighting is turned
576         on.  If set to an empty string, no option is passed at all,
577         turning off coloring for external 'grep' calls; this is the default.
578         For GNU grep, set it to `--color=always` to highlight matches even
579         when a pager is used.
581 color.grep.match::
582         Use customized color for matches.  The value of this variable
583         may be specified as in color.branch.<slot>.  It is passed using
584         the environment variables 'GREP_COLOR' and 'GREP_COLORS' when
585         calling an external 'grep'.
587 color.interactive::
588         When set to `always`, always use colors for interactive prompts
589         and displays (such as those used by "git-add --interactive").
590         When false (or `never`), never.  When set to `true` or `auto`, use
591         colors only when the output is to the terminal. Defaults to false.
593 color.interactive.<slot>::
594         Use customized color for 'git-add --interactive'
595         output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
596         four distinct types of normal output from interactive
597         programs.  The values of these variables may be specified as
598         in color.branch.<slot>.
600 color.pager::
601         A boolean to enable/disable colored output when the pager is in
602         use (default is true).
604 color.status::
605         A boolean to enable/disable color in the output of
606         linkgit:git-status[1]. May be set to `always`,
607         `false` (or `never`) or `auto` (or `true`), in which case colors are used
608         only when the output is to a terminal. Defaults to false.
610 color.status.<slot>::
611         Use customized color for status colorization. `<slot>` is
612         one of `header` (the header text of the status message),
613         `added` or `updated` (files which are added but not committed),
614         `changed` (files which are changed but not added in the index),
615         `untracked` (files which are not tracked by git), or
616         `nobranch` (the color the 'no branch' warning is shown in, defaulting
617         to red). The values of these variables may be specified as in
618         color.branch.<slot>.
620 color.ui::
621         When set to `always`, always use colors in all git commands which
622         are capable of colored output. When false (or `never`), never. When
623         set to `true` or `auto`, use colors only when the output is to the
624         terminal. When more specific variables of color.* are set, they always
625         take precedence over this setting. Defaults to false.
627 commit.template::
628         Specify a file to use as the template for new commit messages.
630 diff.autorefreshindex::
631         When using 'git-diff' to compare with work tree
632         files, do not consider stat-only change as changed.
633         Instead, silently run `git update-index --refresh` to
634         update the cached stat information for paths whose
635         contents in the work tree match the contents in the
636         index.  This option defaults to true.  Note that this
637         affects only 'git-diff' Porcelain, and not lower level
638         'diff' commands, such as 'git-diff-files'.
640 diff.external::
641         If this config variable is set, diff generation is not
642         performed using the internal diff machinery, but using the
643         given command.  Can be overridden with the `GIT_EXTERNAL_DIFF'
644         environment variable.  The command is called with parameters
645         as described under "git Diffs" in linkgit:git[1].  Note: if
646         you want to use an external diff program only on a subset of
647         your files, you might want to use linkgit:gitattributes[5] instead.
649 diff.mnemonicprefix::
650         If set, 'git-diff' uses a prefix pair that is different from the
651         standard "a/" and "b/" depending on what is being compared.  When
652         this configuration is in effect, reverse diff output also swaps
653         the order of the prefixes:
654 'git-diff';;
655         compares the (i)ndex and the (w)ork tree;
656 'git-diff HEAD';;
657          compares a (c)ommit and the (w)ork tree;
658 'git diff --cached';;
659         compares a (c)ommit and the (i)ndex;
660 'git-diff HEAD:file1 file2';;
661         compares an (o)bject and a (w)ork tree entity;
662 'git diff --no-index a b';;
663         compares two non-git things (1) and (2).
665 diff.renameLimit::
666         The number of files to consider when performing the copy/rename
667         detection; equivalent to the 'git-diff' option '-l'.
669 diff.renames::
670         Tells git to detect renames.  If set to any boolean value, it
671         will enable basic rename detection.  If set to "copies" or
672         "copy", it will detect copies, as well.
674 diff.suppressBlankEmpty::
675         A boolean to inhibit the standard behavior of printing a space
676         before each empty output line. Defaults to false.
678 diff.wordRegex::
679         A POSIX Extended Regular Expression used to determine what is a "word"
680         when performing word-by-word difference calculations.  Character
681         sequences that match the regular expression are "words", all other
682         characters are *ignorable* whitespace.
684 fetch.unpackLimit::
685         If the number of objects fetched over the git native
686         transfer is below this
687         limit, then the objects will be unpacked into loose object
688         files. However if the number of received objects equals or
689         exceeds this limit then the received pack will be stored as
690         a pack, after adding any missing delta bases.  Storing the
691         pack from a push can make the push operation complete faster,
692         especially on slow filesystems.  If not set, the value of
693         `transfer.unpackLimit` is used instead.
695 format.numbered::
696         A boolean which can enable or disable sequence numbers in patch
697         subjects.  It defaults to "auto" which enables it only if there
698         is more than one patch.  It can be enabled or disabled for all
699         messages by setting it to "true" or "false".  See --numbered
700         option in linkgit:git-format-patch[1].
702 format.headers::
703         Additional email headers to include in a patch to be submitted
704         by mail.  See linkgit:git-format-patch[1].
706 format.suffix::
707         The default for format-patch is to output files with the suffix
708         `.patch`. Use this variable to change that suffix (make sure to
709         include the dot if you want it).
711 format.pretty::
712         The default pretty format for log/show/whatchanged command,
713         See linkgit:git-log[1], linkgit:git-show[1],
714         linkgit:git-whatchanged[1].
716 format.thread::
717         The default threading style for 'git-format-patch'.  Can be
718         either a boolean value, `shallow` or `deep`.  'Shallow'
719         threading makes every mail a reply to the head of the series,
720         where the head is chosen from the cover letter, the
721         `\--in-reply-to`, and the first patch mail, in this order.
722         'Deep' threading makes every mail a reply to the previous one.
723         A true boolean value is the same as `shallow`, and a false
724         value disables threading.
726 gc.aggressiveWindow::
727         The window size parameter used in the delta compression
728         algorithm used by 'git-gc --aggressive'.  This defaults
729         to 10.
731 gc.auto::
732         When there are approximately more than this many loose
733         objects in the repository, `git gc --auto` will pack them.
734         Some Porcelain commands use this command to perform a
735         light-weight garbage collection from time to time.  The
736         default value is 6700.  Setting this to 0 disables it.
738 gc.autopacklimit::
739         When there are more than this many packs that are not
740         marked with `*.keep` file in the repository, `git gc
741         --auto` consolidates them into one larger pack.  The
742         default value is 50.  Setting this to 0 disables it.
744 gc.packrefs::
745         'git-gc' does not run `git pack-refs` in a bare repository by
746         default so that older dumb-transport clients can still fetch
747         from the repository.  Setting this to `true` lets 'git-gc'
748         to run `git pack-refs`.  Setting this to `false` tells
749         'git-gc' never to run `git pack-refs`. The default setting is
750         `notbare`. Enable it only when you know you do not have to
751         support such clients.  The default setting will change to `true`
752         at some stage, and setting this to `false` will continue to
753         prevent `git pack-refs` from being run from 'git-gc'.
755 gc.pruneexpire::
756         When 'git-gc' is run, it will call 'prune --expire 2.weeks.ago'.
757         Override the grace period with this config variable.  The value
758         "now" may be used to disable this  grace period and always prune
759         unreachable objects immediately.
761 gc.reflogexpire::
762         'git-reflog expire' removes reflog entries older than
763         this time; defaults to 90 days.
765 gc.reflogexpireunreachable::
766         'git-reflog expire' removes reflog entries older than
767         this time and are not reachable from the current tip;
768         defaults to 30 days.
770 gc.rerereresolved::
771         Records of conflicted merge you resolved earlier are
772         kept for this many days when 'git-rerere gc' is run.
773         The default is 60 days.  See linkgit:git-rerere[1].
775 gc.rerereunresolved::
776         Records of conflicted merge you have not resolved are
777         kept for this many days when 'git-rerere gc' is run.
778         The default is 15 days.  See linkgit:git-rerere[1].
780 gitcvs.commitmsgannotation::
781         Append this string to each commit message. Set to empty string
782         to disable this feature. Defaults to "via git-CVS emulator".
784 gitcvs.enabled::
785         Whether the CVS server interface is enabled for this repository.
786         See linkgit:git-cvsserver[1].
788 gitcvs.logfile::
789         Path to a log file where the CVS server interface well... logs
790         various stuff. See linkgit:git-cvsserver[1].
792 gitcvs.usecrlfattr::
793         If true, the server will look up the `crlf` attribute for
794         files to determine the '-k' modes to use. If `crlf` is set,
795         the '-k' mode will be left blank, so cvs clients will
796         treat it as text. If `crlf` is explicitly unset, the file
797         will be set with '-kb' mode, which suppresses any newline munging
798         the client might otherwise do. If `crlf` is not specified,
799         then 'gitcvs.allbinary' is used. See linkgit:gitattributes[5].
801 gitcvs.allbinary::
802         This is used if 'gitcvs.usecrlfattr' does not resolve
803         the correct '-kb' mode to use. If true, all
804         unresolved files are sent to the client in
805         mode '-kb'. This causes the client to treat them
806         as binary files, which suppresses any newline munging it
807         otherwise might do. Alternatively, if it is set to "guess",
808         then the contents of the file are examined to decide if
809         it is binary, similar to 'core.autocrlf'.
811 gitcvs.dbname::
812         Database used by git-cvsserver to cache revision information
813         derived from the git repository. The exact meaning depends on the
814         used database driver, for SQLite (which is the default driver) this
815         is a filename. Supports variable substitution (see
816         linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
817         Default: '%Ggitcvs.%m.sqlite'
819 gitcvs.dbdriver::
820         Used Perl DBI driver. You can specify any available driver
821         for this here, but it might not work. git-cvsserver is tested
822         with 'DBD::SQLite', reported to work with 'DBD::Pg', and
823         reported *not* to work with 'DBD::mysql'. Experimental feature.
824         May not contain double colons (`:`). Default: 'SQLite'.
825         See linkgit:git-cvsserver[1].
827 gitcvs.dbuser, gitcvs.dbpass::
828         Database user and password. Only useful if setting 'gitcvs.dbdriver',
829         since SQLite has no concept of database users and/or passwords.
830         'gitcvs.dbuser' supports variable substitution (see
831         linkgit:git-cvsserver[1] for details).
833 gitcvs.dbTableNamePrefix::
834         Database table name prefix.  Prepended to the names of any
835         database tables used, allowing a single database to be used
836         for several repositories.  Supports variable substitution (see
837         linkgit:git-cvsserver[1] for details).  Any non-alphabetic
838         characters will be replaced with underscores.
840 All gitcvs variables except for 'gitcvs.usecrlfattr' and
841 'gitcvs.allbinary' can also be specified as
842 'gitcvs.<access_method>.<varname>' (where 'access_method'
843 is one of "ext" and "pserver") to make them apply only for the given
844 access method.
846 gui.commitmsgwidth::
847         Defines how wide the commit message window is in the
848         linkgit:git-gui[1]. "75" is the default.
850 gui.diffcontext::
851         Specifies how many context lines should be used in calls to diff
852         made by the linkgit:git-gui[1]. The default is "5".
854 gui.encoding::
855         Specifies the default encoding to use for displaying of
856         file contents in linkgit:git-gui[1] and linkgit:gitk[1].
857         It can be overridden by setting the 'encoding' attribute
858         for relevant files (see linkgit:gitattributes[5]).
859         If this option is not set, the tools default to the
860         locale encoding.
862 gui.matchtrackingbranch::
863         Determines if new branches created with linkgit:git-gui[1] should
864         default to tracking remote branches with matching names or
865         not. Default: "false".
867 gui.newbranchtemplate::
868         Is used as suggested name when creating new branches using the
869         linkgit:git-gui[1].
871 gui.pruneduringfetch::
872         "true" if linkgit:git-gui[1] should prune tracking branches when
873         performing a fetch. The default value is "false".
875 gui.trustmtime::
876         Determines if linkgit:git-gui[1] should trust the file modification
877         timestamp or not. By default the timestamps are not trusted.
879 gui.spellingdictionary::
880         Specifies the dictionary used for spell checking commit messages in
881         the linkgit:git-gui[1]. When set to "none" spell checking is turned
882         off.
884 gui.fastcopyblame::
885         If true, 'git gui blame' uses '-C' instead of '-C -C' for original
886         location detection. It makes blame significantly faster on huge
887         repositories at the expense of less thorough copy detection.
889 gui.copyblamethreshold::
890         Specifies the threshold to use in 'git gui blame' original location
891         detection, measured in alphanumeric characters. See the
892         linkgit:git-blame[1] manual for more information on copy detection.
894 gui.blamehistoryctx::
895         Specifies the radius of history context in days to show in
896         linkgit:gitk[1] for the selected commit, when the `Show History
897         Context` menu item is invoked from 'git gui blame'. If this
898         variable is set to zero, the whole history is shown.
900 guitool.<name>.cmd::
901         Specifies the shell command line to execute when the corresponding item
902         of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
903         mandatory for every tool. The command is executed from the root of
904         the working directory, and in the environment it receives the name of
905         the tool as 'GIT_GUITOOL', the name of the currently selected file as
906         'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
907         the head is detached, 'CUR_BRANCH' is empty).
909 guitool.<name>.needsfile::
910         Run the tool only if a diff is selected in the GUI. It guarantees
911         that 'FILENAME' is not empty.
913 guitool.<name>.noconsole::
914         Run the command silently, without creating a window to display its
915         output.
917 guitool.<name>.norescan::
918         Don't rescan the working directory for changes after the tool
919         finishes execution.
921 guitool.<name>.confirm::
922         Show a confirmation dialog before actually running the tool.
924 guitool.<name>.argprompt::
925         Request a string argument from the user, and pass it to the tool
926         through the 'ARGS' environment variable. Since requesting an
927         argument implies confirmation, the 'confirm' option has no effect
928         if this is enabled. If the option is set to 'true', 'yes', or '1',
929         the dialog uses a built-in generic prompt; otherwise the exact
930         value of the variable is used.
932 guitool.<name>.revprompt::
933         Request a single valid revision from the user, and set the
934         'REVISION' environment variable. In other aspects this option
935         is similar to 'argprompt', and can be used together with it.
937 guitool.<name>.revunmerged::
938         Show only unmerged branches in the 'revprompt' subdialog.
939         This is useful for tools similar to merge or rebase, but not
940         for things like checkout or reset.
942 guitool.<name>.title::
943         Specifies the title to use for the prompt dialog. The default
944         is the tool name.
946 guitool.<name>.prompt::
947         Specifies the general prompt string to display at the top of
948         the dialog, before subsections for 'argprompt' and 'revprompt'.
949         The default value includes the actual command.
951 help.browser::
952         Specify the browser that will be used to display help in the
953         'web' format. See linkgit:git-help[1].
955 help.format::
956         Override the default help format used by linkgit:git-help[1].
957         Values 'man', 'info', 'web' and 'html' are supported. 'man' is
958         the default. 'web' and 'html' are the same.
960 help.autocorrect::
961         Automatically correct and execute mistyped commands after
962         waiting for the given number of deciseconds (0.1 sec). If more
963         than one command can be deduced from the entered text, nothing
964         will be executed.  If the value of this option is negative,
965         the corrected command will be executed immediately. If the
966         value is 0 - the command will be just shown but not executed.
967         This is the default.
969 http.proxy::
970         Override the HTTP proxy, normally configured using the 'http_proxy'
971         environment variable (see linkgit:curl[1]).  This can be overridden
972         on a per-remote basis; see remote.<name>.proxy
974 http.sslVerify::
975         Whether to verify the SSL certificate when fetching or pushing
976         over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
977         variable.
979 http.sslCert::
980         File containing the SSL certificate when fetching or pushing
981         over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
982         variable.
984 http.sslKey::
985         File containing the SSL private key when fetching or pushing
986         over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
987         variable.
989 http.sslCAInfo::
990         File containing the certificates to verify the peer with when
991         fetching or pushing over HTTPS. Can be overridden by the
992         'GIT_SSL_CAINFO' environment variable.
994 http.sslCAPath::
995         Path containing files with the CA certificates to verify the peer
996         with when fetching or pushing over HTTPS. Can be overridden
997         by the 'GIT_SSL_CAPATH' environment variable.
999 http.maxRequests::
1000         How many HTTP requests to launch in parallel. Can be overridden
1001         by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1003 http.lowSpeedLimit, http.lowSpeedTime::
1004         If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1005         for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1006         Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1007         'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1009 http.noEPSV::
1010         A boolean which disables using of EPSV ftp command by curl.
1011         This can helpful with some "poor" ftp servers which don't
1012         support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1013         environment variable. Default is false (curl will use EPSV).
1015 i18n.commitEncoding::
1016         Character encoding the commit messages are stored in; git itself
1017         does not care per se, but this information is necessary e.g. when
1018         importing commits from emails or in the gitk graphical history
1019         browser (and possibly at other places in the future or in other
1020         porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1022 i18n.logOutputEncoding::
1023         Character encoding the commit messages are converted to when
1024         running 'git-log' and friends.
1026 imap::
1027         The configuration variables in the 'imap' section are described
1028         in linkgit:git-imap-send[1].
1030 instaweb.browser::
1031         Specify the program that will be used to browse your working
1032         repository in gitweb. See linkgit:git-instaweb[1].
1034 instaweb.httpd::
1035         The HTTP daemon command-line to start gitweb on your working
1036         repository. See linkgit:git-instaweb[1].
1038 instaweb.local::
1039         If true the web server started by linkgit:git-instaweb[1] will
1040         be bound to the local IP (127.0.0.1).
1042 instaweb.modulepath::
1043         The module path for an apache httpd used by linkgit:git-instaweb[1].
1045 instaweb.port::
1046         The port number to bind the gitweb httpd to. See
1047         linkgit:git-instaweb[1].
1049 interactive.singlekey::
1050         In interactive programs, allow the user to provide one-letter
1051         input with a single key (i.e., without hitting enter).
1052         Currently this is used only by the `\--patch` mode of
1053         linkgit:git-add[1].  Note that this setting is silently
1054         ignored if portable keystroke input is not available.
1056 log.date::
1057         Set default date-time mode for the log command. Setting log.date
1058         value is similar to using 'git-log'\'s --date option. The value is one of the
1059         following alternatives: {relative,local,default,iso,rfc,short}.
1060         See linkgit:git-log[1].
1062 log.showroot::
1063         If true, the initial commit will be shown as a big creation event.
1064         This is equivalent to a diff against an empty tree.
1065         Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1066         normally hide the root commit will now show it. True by default.
1068 mailmap.file::
1069         The location of an augmenting mailmap file. The default
1070         mailmap, located in the root of the repository, is loaded
1071         first, then the mailmap file pointed to by this variable.
1072         The location of the mailmap file may be in a repository
1073         subdirectory, or somewhere outside of the repository itself.
1074         See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1076 man.viewer::
1077         Specify the programs that may be used to display help in the
1078         'man' format. See linkgit:git-help[1].
1080 man.<tool>.cmd::
1081         Specify the command to invoke the specified man viewer. The
1082         specified command is evaluated in shell with the man page
1083         passed as argument. (See linkgit:git-help[1].)
1085 man.<tool>.path::
1086         Override the path for the given tool that may be used to
1087         display help in the 'man' format. See linkgit:git-help[1].
1089 include::merge-config.txt[]
1091 mergetool.<tool>.path::
1092         Override the path for the given tool.  This is useful in case
1093         your tool is not in the PATH.
1095 mergetool.<tool>.cmd::
1096         Specify the command to invoke the specified merge tool.  The
1097         specified command is evaluated in shell with the following
1098         variables available: 'BASE' is the name of a temporary file
1099         containing the common base of the files to be merged, if available;
1100         'LOCAL' is the name of a temporary file containing the contents of
1101         the file on the current branch; 'REMOTE' is the name of a temporary
1102         file containing the contents of the file from the branch being
1103         merged; 'MERGED' contains the name of the file to which the merge
1104         tool should write the results of a successful merge.
1106 mergetool.<tool>.trustExitCode::
1107         For a custom merge command, specify whether the exit code of
1108         the merge command can be used to determine whether the merge was
1109         successful.  If this is not set to true then the merge target file
1110         timestamp is checked and the merge assumed to have been successful
1111         if the file has been updated, otherwise the user is prompted to
1112         indicate the success of the merge.
1114 mergetool.keepBackup::
1115         After performing a merge, the original file with conflict markers
1116         can be saved as a file with a `.orig` extension.  If this variable
1117         is set to `false` then this file is not preserved.  Defaults to
1118         `true` (i.e. keep the backup files).
1120 mergetool.keepTemporaries::
1121         When invoking a custom merge tool, git uses a set of temporary
1122         files to pass to the tool. If the tool returns an error and this
1123         variable is set to `true`, then these temporary files will be
1124         preserved, otherwise they will be removed after the tool has
1125         exited. Defaults to `false`.
1127 mergetool.prompt::
1128         Prompt before each invocation of the merge resolution program.
1130 pack.window::
1131         The size of the window used by linkgit:git-pack-objects[1] when no
1132         window size is given on the command line. Defaults to 10.
1134 pack.depth::
1135         The maximum delta depth used by linkgit:git-pack-objects[1] when no
1136         maximum depth is given on the command line. Defaults to 50.
1138 pack.windowMemory::
1139         The window memory size limit used by linkgit:git-pack-objects[1]
1140         when no limit is given on the command line.  The value can be
1141         suffixed with "k", "m", or "g".  Defaults to 0, meaning no
1142         limit.
1144 pack.compression::
1145         An integer -1..9, indicating the compression level for objects
1146         in a pack file. -1 is the zlib default. 0 means no
1147         compression, and 1..9 are various speed/size tradeoffs, 9 being
1148         slowest.  If not set,  defaults to core.compression.  If that is
1149         not set,  defaults to -1, the zlib default, which is "a default
1150         compromise between speed and compression (currently equivalent
1151         to level 6)."
1153 pack.deltaCacheSize::
1154         The maximum memory in bytes used for caching deltas in
1155         linkgit:git-pack-objects[1].
1156         A value of 0 means no limit. Defaults to 0.
1158 pack.deltaCacheLimit::
1159         The maximum size of a delta, that is cached in
1160         linkgit:git-pack-objects[1]. Defaults to 1000.
1162 pack.threads::
1163         Specifies the number of threads to spawn when searching for best
1164         delta matches.  This requires that linkgit:git-pack-objects[1]
1165         be compiled with pthreads otherwise this option is ignored with a
1166         warning. This is meant to reduce packing time on multiprocessor
1167         machines. The required amount of memory for the delta search window
1168         is however multiplied by the number of threads.
1169         Specifying 0 will cause git to auto-detect the number of CPU's
1170         and set the number of threads accordingly.
1172 pack.indexVersion::
1173         Specify the default pack index version.  Valid values are 1 for
1174         legacy pack index used by Git versions prior to 1.5.2, and 2 for
1175         the new pack index with capabilities for packs larger than 4 GB
1176         as well as proper protection against the repacking of corrupted
1177         packs.  Version 2 is the default.  Note that version 2 is enforced
1178         and this config option ignored whenever the corresponding pack is
1179         larger than 2 GB.
1181 If you have an old git that does not understand the version 2 `{asterisk}.idx` file,
1182 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1183 that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the
1184 other side may give you a repository that cannot be accessed with your
1185 older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,
1186 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1187 the `{asterisk}.idx` file.
1189 pack.packSizeLimit::
1190         The default maximum size of a pack.  This setting only affects
1191         packing to a file, i.e. the git:// protocol is unaffected.  It
1192         can be overridden by the `\--max-pack-size` option of
1193         linkgit:git-repack[1].
1195 pager.<cmd>::
1196         Allows turning on or off pagination of the output of a
1197         particular git subcommand when writing to a tty.  If
1198         `\--paginate` or `\--no-pager` is specified on the command line,
1199         it takes precedence over this option.  To disable pagination for
1200         all commands, set `core.pager` or `GIT_PAGER` to `cat`.
1202 pull.octopus::
1203         The default merge strategy to use when pulling multiple branches
1204         at once.
1206 pull.twohead::
1207         The default merge strategy to use when pulling a single branch.
1209 rebase.stat::
1210         Whether to show a diffstat of what changed upstream since the last
1211         rebase. False by default.
1213 receive.fsckObjects::
1214         If it is set to true, git-receive-pack will check all received
1215         objects. It will abort in the case of a malformed object or a
1216         broken link. The result of an abort are only dangling objects.
1217         Defaults to false.
1219 receive.unpackLimit::
1220         If the number of objects received in a push is below this
1221         limit then the objects will be unpacked into loose object
1222         files. However if the number of received objects equals or
1223         exceeds this limit then the received pack will be stored as
1224         a pack, after adding any missing delta bases.  Storing the
1225         pack from a push can make the push operation complete faster,
1226         especially on slow filesystems.  If not set, the value of
1227         `transfer.unpackLimit` is used instead.
1229 receive.denyDeletes::
1230         If set to true, git-receive-pack will deny a ref update that deletes
1231         the ref. Use this to prevent such a ref deletion via a push.
1233 receive.denyCurrentBranch::
1234         If set to true or "refuse", receive-pack will deny a ref update
1235         to the currently checked out branch of a non-bare repository.
1236         Such a push is potentially dangerous because it brings the HEAD
1237         out of sync with the index and working tree. If set to "warn",
1238         print a warning of such a push to stderr, but allow the push to
1239         proceed. If set to false or "ignore", allow such pushes with no
1240         message. Defaults to "warn".
1242 receive.denyNonFastForwards::
1243         If set to true, git-receive-pack will deny a ref update which is
1244         not a fast forward. Use this to prevent such an update via a push,
1245         even if that push is forced. This configuration variable is
1246         set when initializing a shared repository.
1248 remote.<name>.url::
1249         The URL of a remote repository.  See linkgit:git-fetch[1] or
1250         linkgit:git-push[1].
1252 remote.<name>.proxy::
1253         For remotes that require curl (http, https and ftp), the URL to
1254         the proxy to use for that remote.  Set to the empty string to
1255         disable proxying for that remote.
1257 remote.<name>.fetch::
1258         The default set of "refspec" for linkgit:git-fetch[1]. See
1259         linkgit:git-fetch[1].
1261 remote.<name>.push::
1262         The default set of "refspec" for linkgit:git-push[1]. See
1263         linkgit:git-push[1].
1265 remote.<name>.mirror::
1266         If true, pushing to this remote will automatically behave
1267         as if the `\--mirror` option was given on the command line.
1269 remote.<name>.skipDefaultUpdate::
1270         If true, this remote will be skipped by default when updating
1271         using the update subcommand of linkgit:git-remote[1].
1273 remote.<name>.receivepack::
1274         The default program to execute on the remote side when pushing.  See
1275         option \--receive-pack of linkgit:git-push[1].
1277 remote.<name>.uploadpack::
1278         The default program to execute on the remote side when fetching.  See
1279         option \--upload-pack of linkgit:git-fetch-pack[1].
1281 remote.<name>.tagopt::
1282         Setting this value to \--no-tags disables automatic tag following when
1283         fetching from remote <name>
1285 remotes.<group>::
1286         The list of remotes which are fetched by "git remote update
1287         <group>".  See linkgit:git-remote[1].
1289 repack.usedeltabaseoffset::
1290         By default, linkgit:git-repack[1] creates packs that use
1291         delta-base offset. If you need to share your repository with
1292         git older than version 1.4.4, either directly or via a dumb
1293         protocol such as http, then you need to set this option to
1294         "false" and repack. Access from old git versions over the
1295         native protocol are unaffected by this option.
1297 rerere.autoupdate::
1298         When set to true, `git-rerere` updates the index with the
1299         resulting contents after it cleanly resolves conflicts using
1300         previously recorded resolution.  Defaults to false.
1302 rerere.enabled::
1303         Activate recording of resolved conflicts, so that identical
1304         conflict hunks can be resolved automatically, should they
1305         be encountered again.  linkgit:git-rerere[1] command is by
1306         default enabled if you create `rr-cache` directory under
1307         `$GIT_DIR`, but can be disabled by setting this option to false.
1309 showbranch.default::
1310         The default set of branches for linkgit:git-show-branch[1].
1311         See linkgit:git-show-branch[1].
1313 status.relativePaths::
1314         By default, linkgit:git-status[1] shows paths relative to the
1315         current directory. Setting this variable to `false` shows paths
1316         relative to the repository root (this was the default for git
1317         prior to v1.5.4).
1319 status.showUntrackedFiles::
1320         By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1321         files which are not currently tracked by Git. Directories which
1322         contain only untracked files, are shown with the directory name
1323         only. Showing untracked files means that Git needs to lstat() all
1324         all the files in the whole repository, which might be slow on some
1325         systems. So, this variable controls how the commands displays
1326         the untracked files. Possible values are:
1329         - 'no'     - Show no untracked files
1330         - 'normal' - Shows untracked files and directories
1331         - 'all'    - Shows also individual files in untracked directories.
1334 If this variable is not specified, it defaults to 'normal'.
1335 This variable can be overridden with the -u|--untracked-files option
1336 of linkgit:git-status[1] and linkgit:git-commit[1].
1338 tar.umask::
1339         This variable can be used to restrict the permission bits of
1340         tar archive entries.  The default is 0002, which turns off the
1341         world write bit.  The special value "user" indicates that the
1342         archiving user's umask will be used instead.  See umask(2) and
1343         linkgit:git-archive[1].
1345 transfer.unpackLimit::
1346         When `fetch.unpackLimit` or `receive.unpackLimit` are
1347         not set, the value of this variable is used instead.
1348         The default value is 100.
1350 url.<base>.insteadOf::
1351         Any URL that starts with this value will be rewritten to
1352         start, instead, with <base>. In cases where some site serves a
1353         large number of repositories, and serves them with multiple
1354         access methods, and some users need to use different access
1355         methods, this feature allows people to specify any of the
1356         equivalent URLs and have git automatically rewrite the URL to
1357         the best alternative for the particular user, even for a
1358         never-before-seen repository on the site.  When more than one
1359         insteadOf strings match a given URL, the longest match is used.
1361 user.email::
1362         Your email address to be recorded in any newly created commits.
1363         Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
1364         'EMAIL' environment variables.  See linkgit:git-commit-tree[1].
1366 user.name::
1367         Your full name to be recorded in any newly created commits.
1368         Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
1369         environment variables.  See linkgit:git-commit-tree[1].
1371 user.signingkey::
1372         If linkgit:git-tag[1] is not selecting the key you want it to
1373         automatically when creating a signed tag, you can override the
1374         default selection with this variable.  This option is passed
1375         unchanged to gpg's --local-user parameter, so you may specify a key
1376         using any method that gpg supports.
1378 web.browser::
1379         Specify a web browser that may be used by some commands.
1380         Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
1381         may use it.