t4202: fix typo
[git/mingw/4msysgit/kblees.git] / Documentation / config.txt
blobd31adb6719eeff3009a2799b89d5ae6d343d3e88
1 CONFIGURATION FILE
2 ------------------
4 The git configuration file contains a number of variables that affect
5 the git command's behavior. The `.git/config` file in each repository
6 is used to store the configuration for that repository, and
7 `$HOME/.gitconfig` is used to store a per-user configuration as
8 fallback values for the `.git/config` file. The file `/etc/gitconfig`
9 can be used to store a system-wide default configuration.
11 The configuration variables are used by both the git plumbing
12 and the porcelains. The variables are divided into sections, wherein
13 the fully qualified variable name of the variable itself is the last
14 dot-separated segment and the section name is everything before the last
15 dot. The variable names are case-insensitive and only alphanumeric
16 characters are allowed. Some variables may appear multiple times.
18 Syntax
19 ~~~~~~
21 The syntax is fairly flexible and permissive; whitespaces are mostly
22 ignored.  The '#' and ';' characters begin comments to the end of line,
23 blank lines are ignored.
25 The file consists of sections and variables.  A section begins with
26 the name of the section in square brackets and continues until the next
27 section begins.  Section names are not case sensitive.  Only alphanumeric
28 characters, `-` and `.` are allowed in section names.  Each variable
29 must belong to some section, which means that there must be a section
30 header before the first setting of a variable.
32 Sections can be further divided into subsections.  To begin a subsection
33 put its name in double quotes, separated by space from the section name,
34 in the section header, like in the example below:
36 --------
37         [section "subsection"]
39 --------
41 Subsection names are case sensitive and can contain any characters except
42 newline (doublequote `"` and backslash have to be escaped as `\"` and `\\`,
43 respectively).  Section headers cannot span multiple
44 lines.  Variables may belong directly to a section or to a given subsection.
45 You can have `[section]` if you have `[section "subsection"]`, but you
46 don't need to.
48 There is also a case insensitive alternative `[section.subsection]` syntax.
49 In this syntax, subsection names follow the same restrictions as for section
50 names.
52 All the other lines 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, true/false or on/off.  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 values in double quotes if you want to
70 preserve leading or trailing whitespace, or if the variable value contains
71 comment characters (i.e. it contains '#' or ';').
72 Double quote `"` and backslash `\` characters in variable values 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 values ending in a `\` are continued on the next line in the
81 customary UNIX fashion.
83 Some variables may require a 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 (whereas the other options will only override
299         requested parts of the user's umask value). Examples: '0660' will make
300         the repo read/write-able for the owner and group, but inaccessible to
301         others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
302         repository that is group-readable but not group-writable.
303         See linkgit:git-init[1]. False by default.
305 core.warnAmbiguousRefs::
306         If true, git will warn you if the ref name you passed it is ambiguous
307         and might match multiple refs in the .git/refs/ tree. True by default.
309 core.compression::
310         An integer -1..9, indicating a default compression level.
311         -1 is the zlib default. 0 means no compression,
312         and 1..9 are various speed/size tradeoffs, 9 being slowest.
313         If set, this provides a default to other compression variables,
314         such as 'core.loosecompression' and 'pack.compression'.
316 core.loosecompression::
317         An integer -1..9, indicating the compression level for objects that
318         are not in a pack file. -1 is the zlib default. 0 means no
319         compression, and 1..9 are various speed/size tradeoffs, 9 being
320         slowest.  If not set,  defaults to core.compression.  If that is
321         not set,  defaults to 1 (best speed).
323 core.packedGitWindowSize::
324         Number of bytes of a pack file to map into memory in a
325         single mapping operation.  Larger window sizes may allow
326         your system to process a smaller number of large pack files
327         more quickly.  Smaller window sizes will negatively affect
328         performance due to increased calls to the operating system's
329         memory manager, but may improve performance when accessing
330         a large number of large pack files.
332 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
333 MiB on 32 bit platforms and 1 GiB on 64 bit platforms.  This should
334 be reasonable for all users/operating systems.  You probably do
335 not need to adjust this value.
337 Common unit suffixes of 'k', 'm', or 'g' are supported.
339 core.packedGitLimit::
340         Maximum number of bytes to map simultaneously into memory
341         from pack files.  If Git needs to access more than this many
342         bytes at once to complete an operation it will unmap existing
343         regions to reclaim virtual address space within the process.
345 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
346 This should be reasonable for all users/operating systems, except on
347 the largest projects.  You probably do not need to adjust this value.
349 Common unit suffixes of 'k', 'm', or 'g' are supported.
351 core.deltaBaseCacheLimit::
352         Maximum number of bytes to reserve for caching base objects
353         that multiple deltafied objects reference.  By storing the
354         entire decompressed base objects in a cache Git is able
355         to avoid unpacking and decompressing frequently used base
356         objects multiple times.
358 Default is 16 MiB on all platforms.  This should be reasonable
359 for all users/operating systems, except on the largest projects.
360 You probably do not need to adjust this value.
362 Common unit suffixes of 'k', 'm', or 'g' are supported.
364 core.excludesfile::
365         In addition to '.gitignore' (per-directory) and
366         '.git/info/exclude', git looks into this file for patterns
367         of files which are not meant to be tracked.  See
368         linkgit:gitignore[5].
370 core.editor::
371         Commands such as `commit` and `tag` that lets you edit
372         messages by launching an editor uses the value of this
373         variable when it is set, and the environment variable
374         `GIT_EDITOR` is not set.  The order of preference is
375         `GIT_EDITOR` environment, `core.editor`, `VISUAL` and
376         `EDITOR` environment variables and then finally `vi`.
378 core.pager::
379         The command that git will use to paginate output.  Can
380         be overridden with the `GIT_PAGER` environment
381         variable.  Note that git sets the `LESS` environment
382         variable to `FRSX` if it is unset when it runs the
383         pager.  One can change these settings by setting the
384         `LESS` variable to some other value.  Alternately,
385         these settings can be overridden on a project or
386         global basis by setting the `core.pager` option.
387         Setting `core.pager` has no affect on the `LESS`
388         environment variable behaviour above, so if you want
389         to override git's default settings this way, you need
390         to be explicit.  For example, to disable the S option
391         in a backward compatible manner, set `core.pager`
392         to `less -+$LESS -FRX`.  This will be passed to the
393         shell by git, which will translate the final command to
394         `LESS=FRSX less -+FRSX -FRX`.
396 core.whitespace::
397         A comma separated list of common whitespace problems to
398         notice.  'git-diff' will use `color.diff.whitespace` to
399         highlight them, and 'git-apply --whitespace=error' will
400         consider them as errors.  You can prefix `-` to disable
401         any of them (e.g. `-trailing-space`):
403 * `trailing-space` treats trailing whitespaces at the end of the line
404   as an error (enabled by default).
405 * `space-before-tab` treats a space character that appears immediately
406   before a tab character in the initial indent part of the line as an
407   error (enabled by default).
408 * `indent-with-non-tab` treats a line that is indented with 8 or more
409   space characters as an error (not enabled by default).
410 * `cr-at-eol` treats a carriage-return at the end of line as
411   part of the line terminator, i.e. with it, `trailing-space`
412   does not trigger if the character before such a carriage-return
413   is not a whitespace (not enabled by default).
415 core.fsyncobjectfiles::
416         This boolean will enable 'fsync()' when writing object files.
418 This is a total waste of time and effort on a filesystem that orders
419 data writes properly, but can be useful for filesystems that do not use
420 journalling (traditional UNIX filesystems) or that only journal metadata
421 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
423 core.preloadindex::
424         Enable parallel index preload for operations like 'git diff'
426 This can speed up operations like 'git diff' and 'git status' especially
427 on filesystems like NFS that have weak caching semantics and thus
428 relatively high IO latencies.  With this set to 'true', git will do the
429 index comparison to the filesystem data in parallel, allowing
430 overlapping IO's.
432 core.unreliableHardlinks::
433         Some filesystem drivers cannot properly handle hardlinking a file
434         and deleting the source right away.  In such a case, you need to
435         set this config variable to 'true'.
437 alias.*::
438         Command aliases for the linkgit:git[1] command wrapper - e.g.
439         after defining "alias.last = cat-file commit HEAD", the invocation
440         "git last" is equivalent to "git cat-file commit HEAD". To avoid
441         confusion and troubles with script usage, aliases that
442         hide existing git commands are ignored. Arguments are split by
443         spaces, the usual shell quoting and escaping is supported.
444         quote pair and a backslash can be used to quote them.
446 If the alias expansion is prefixed with an exclamation point,
447 it will be treated as a shell command.  For example, defining
448 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
449 "git new" is equivalent to running the shell command
450 "gitk --all --not ORIG_HEAD".
452 apply.whitespace::
453         Tells 'git-apply' how to handle whitespaces, in the same way
454         as the '--whitespace' option. See linkgit:git-apply[1].
456 branch.autosetupmerge::
457         Tells 'git-branch' and 'git-checkout' to setup new branches
458         so that linkgit:git-pull[1] will appropriately merge from the
459         starting point branch. Note that even if this option is not set,
460         this behavior can be chosen per-branch using the `--track`
461         and `--no-track` options. The valid settings are: `false` -- no
462         automatic setup is done; `true` -- automatic setup is done when the
463         starting point is a remote branch; `always` -- automatic setup is
464         done when the starting point is either a local branch or remote
465         branch. This option defaults to true.
467 branch.autosetuprebase::
468         When a new branch is created with 'git-branch' or 'git-checkout'
469         that tracks another branch, this variable tells git to set
470         up pull to rebase instead of merge (see "branch.<name>.rebase").
471         When `never`, rebase is never automatically set to true.
472         When `local`, rebase is set to true for tracked branches of
473         other local branches.
474         When `remote`, rebase is set to true for tracked branches of
475         remote branches.
476         When `always`, rebase will be set to true for all tracking
477         branches.
478         See "branch.autosetupmerge" for details on how to set up a
479         branch to track another branch.
480         This option defaults to never.
482 branch.<name>.remote::
483         When in branch <name>, it tells 'git-fetch' and 'git-push' which
484         remote to fetch from/push to.  It defaults to `origin` if no remote is
485         configured. `origin` is also used if you are not on any branch.
487 branch.<name>.merge::
488         Defines, together with branch.<name>.remote, the upstream branch
489         for the given branch. It tells 'git-fetch'/'git-pull' which
490         branch to merge and can also affect 'git-push' (see push.default).
491         When in branch <name>, it tells 'git-fetch' the default
492         refspec to be marked for merging in FETCH_HEAD. The value is
493         handled like the remote part of a refspec, and must match a
494         ref which is fetched from the remote given by
495         "branch.<name>.remote".
496         The merge information is used by 'git-pull' (which at first calls
497         'git-fetch') to lookup the default branch for merging. Without
498         this option, 'git-pull' defaults to merge the first refspec fetched.
499         Specify multiple values to get an octopus merge.
500         If you wish to setup 'git-pull' so that it merges into <name> from
501         another branch in the local repository, you can point
502         branch.<name>.merge to the desired branch, and use the special setting
503         `.` (a period) for branch.<name>.remote.
505 branch.<name>.mergeoptions::
506         Sets default options for merging into branch <name>. The syntax and
507         supported options are equal to that of linkgit:git-merge[1], but
508         option values containing whitespace characters are currently not
509         supported.
511 branch.<name>.rebase::
512         When true, rebase the branch <name> on top of the fetched branch,
513         instead of merging the default branch from the default remote when
514         "git pull" is run.
515         *NOTE*: this is a possibly dangerous operation; do *not* use
516         it unless you understand the implications (see linkgit:git-rebase[1]
517         for details).
519 browser.<tool>.cmd::
520         Specify the command to invoke the specified browser. The
521         specified command is evaluated in shell with the URLs passed
522         as arguments. (See linkgit:git-web--browse[1].)
524 browser.<tool>.path::
525         Override the path for the given tool that may be used to
526         browse HTML help (see '-w' option in linkgit:git-help[1]) or a
527         working repository in gitweb (see linkgit:git-instaweb[1]).
529 clean.requireForce::
530         A boolean to make git-clean do nothing unless given -f
531         or -n.   Defaults to true.
533 color.branch::
534         A boolean to enable/disable color in the output of
535         linkgit:git-branch[1]. May be set to `always`,
536         `false` (or `never`) or `auto` (or `true`), in which case colors are used
537         only when the output is to a terminal. Defaults to false.
539 color.branch.<slot>::
540         Use customized color for branch coloration. `<slot>` is one of
541         `current` (the current branch), `local` (a local branch),
542         `remote` (a tracking branch in refs/remotes/), `plain` (other
543         refs).
545 The value for these configuration variables is a list of colors (at most
546 two) and attributes (at most one), separated by spaces.  The colors
547 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
548 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
549 `blink` and `reverse`.  The first color given is the foreground; the
550 second is the background.  The position of the attribute, if any,
551 doesn't matter.
553 color.diff::
554         When set to `always`, always use colors in patch.
555         When false (or `never`), never.  When set to `true` or `auto`, use
556         colors only when the output is to the terminal. Defaults to false.
558 color.diff.<slot>::
559         Use customized color for diff colorization.  `<slot>` specifies
560         which part of the patch to use the specified color, and is one
561         of `plain` (context text), `meta` (metainformation), `frag`
562         (hunk header), `old` (removed lines), `new` (added lines),
563         `commit` (commit headers), or `whitespace` (highlighting
564         whitespace errors). The values of these variables may be specified as
565         in color.branch.<slot>.
567 color.grep::
568         When set to `always`, always highlight matches.  When `false` (or
569         `never`), never.  When set to `true` or `auto`, use color only
570         when the output is written to the terminal.  Defaults to `false`.
572 color.grep.external::
573         The string value of this variable is passed to an external 'grep'
574         command as a command line option if match highlighting is turned
575         on.  If set to an empty string, no option is passed at all,
576         turning off coloring for external 'grep' calls; this is the default.
577         For GNU grep, set it to `--color=always` to highlight matches even
578         when a pager is used.
580 color.grep.match::
581         Use customized color for matches.  The value of this variable
582         may be specified as in color.branch.<slot>.  It is passed using
583         the environment variables 'GREP_COLOR' and 'GREP_COLORS' when
584         calling an external 'grep'.
586 color.interactive::
587         When set to `always`, always use colors for interactive prompts
588         and displays (such as those used by "git-add --interactive").
589         When false (or `never`), never.  When set to `true` or `auto`, use
590         colors only when the output is to the terminal. Defaults to false.
592 color.interactive.<slot>::
593         Use customized color for 'git-add --interactive'
594         output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
595         four distinct types of normal output from interactive
596         programs.  The values of these variables may be specified as
597         in color.branch.<slot>.
599 color.pager::
600         A boolean to enable/disable colored output when the pager is in
601         use (default is true).
603 color.status::
604         A boolean to enable/disable color in the output of
605         linkgit:git-status[1]. May be set to `always`,
606         `false` (or `never`) or `auto` (or `true`), in which case colors are used
607         only when the output is to a terminal. Defaults to false.
609 color.status.<slot>::
610         Use customized color for status colorization. `<slot>` is
611         one of `header` (the header text of the status message),
612         `added` or `updated` (files which are added but not committed),
613         `changed` (files which are changed but not added in the index),
614         `untracked` (files which are not tracked by git), or
615         `nobranch` (the color the 'no branch' warning is shown in, defaulting
616         to red). The values of these variables may be specified as in
617         color.branch.<slot>.
619 color.ui::
620         When set to `always`, always use colors in all git commands which
621         are capable of colored output. When false (or `never`), never. When
622         set to `true` or `auto`, use colors only when the output is to the
623         terminal. When more specific variables of color.* are set, they always
624         take precedence over this setting. Defaults to false.
626 commit.template::
627         Specify a file to use as the template for new commit messages.
629 diff.autorefreshindex::
630         When using 'git-diff' to compare with work tree
631         files, do not consider stat-only change as changed.
632         Instead, silently run `git update-index --refresh` to
633         update the cached stat information for paths whose
634         contents in the work tree match the contents in the
635         index.  This option defaults to true.  Note that this
636         affects only 'git-diff' Porcelain, and not lower level
637         'diff' commands, such as 'git-diff-files'.
639 diff.external::
640         If this config variable is set, diff generation is not
641         performed using the internal diff machinery, but using the
642         given command.  Can be overridden with the `GIT_EXTERNAL_DIFF'
643         environment variable.  The command is called with parameters
644         as described under "git Diffs" in linkgit:git[1].  Note: if
645         you want to use an external diff program only on a subset of
646         your files, you might want to use linkgit:gitattributes[5] instead.
648 diff.mnemonicprefix::
649         If set, 'git-diff' uses a prefix pair that is different from the
650         standard "a/" and "b/" depending on what is being compared.  When
651         this configuration is in effect, reverse diff output also swaps
652         the order of the prefixes:
653 'git-diff';;
654         compares the (i)ndex and the (w)ork tree;
655 'git-diff HEAD';;
656          compares a (c)ommit and the (w)ork tree;
657 'git diff --cached';;
658         compares a (c)ommit and the (i)ndex;
659 'git-diff HEAD:file1 file2';;
660         compares an (o)bject and a (w)ork tree entity;
661 'git diff --no-index a b';;
662         compares two non-git things (1) and (2).
664 diff.renameLimit::
665         The number of files to consider when performing the copy/rename
666         detection; equivalent to the 'git-diff' option '-l'.
668 diff.renames::
669         Tells git to detect renames.  If set to any boolean value, it
670         will enable basic rename detection.  If set to "copies" or
671         "copy", it will detect copies, as well.
673 diff.suppressBlankEmpty::
674         A boolean to inhibit the standard behavior of printing a space
675         before each empty output line. Defaults to false.
677 diff.tool::
678         Controls which diff tool is used.  `diff.tool` overrides
679         `merge.tool` when used by linkgit:git-difftool[1] and has
680         the same valid values as `merge.tool` minus "tortoisemerge"
681         and plus "kompare".
683 difftool.<tool>.path::
684         Override the path for the given tool.  This is useful in case
685         your tool is not in the PATH.
687 difftool.<tool>.cmd::
688         Specify the command to invoke the specified diff tool.
689         The specified command is evaluated in shell with the following
690         variables available:  'LOCAL' is set to the name of the temporary
691         file containing the contents of the diff pre-image and 'REMOTE'
692         is set to the name of the temporary file containing the contents
693         of the diff post-image.
695 difftool.prompt::
696         Prompt before each invocation of the diff tool.
698 diff.wordRegex::
699         A POSIX Extended Regular Expression used to determine what is a "word"
700         when performing word-by-word difference calculations.  Character
701         sequences that match the regular expression are "words", all other
702         characters are *ignorable* whitespace.
704 fetch.unpackLimit::
705         If the number of objects fetched over the git native
706         transfer is below this
707         limit, then the objects will be unpacked into loose object
708         files. However if the number of received objects equals or
709         exceeds this limit then the received pack will be stored as
710         a pack, after adding any missing delta bases.  Storing the
711         pack from a push can make the push operation complete faster,
712         especially on slow filesystems.  If not set, the value of
713         `transfer.unpackLimit` is used instead.
715 format.attach::
716         Enable multipart/mixed attachments as the default for
717         'format-patch'.  The value can also be a double quoted string
718         which will enable attachments as the default and set the
719         value as the boundary.  See the --attach option in
720         linkgit:git-format-patch[1].
722 format.numbered::
723         A boolean which can enable or disable sequence numbers in patch
724         subjects.  It defaults to "auto" which enables it only if there
725         is more than one patch.  It can be enabled or disabled for all
726         messages by setting it to "true" or "false".  See --numbered
727         option in linkgit:git-format-patch[1].
729 format.headers::
730         Additional email headers to include in a patch to be submitted
731         by mail.  See linkgit:git-format-patch[1].
733 format.cc::
734         Additional "Cc:" headers to include in a patch to be submitted
735         by mail.  See the --cc option in linkgit:git-format-patch[1].
737 format.subjectprefix::
738         The default for format-patch is to output files with the '[PATCH]'
739         subject prefix. Use this variable to change that prefix.
741 format.suffix::
742         The default for format-patch is to output files with the suffix
743         `.patch`. Use this variable to change that suffix (make sure to
744         include the dot if you want it).
746 format.pretty::
747         The default pretty format for log/show/whatchanged command,
748         See linkgit:git-log[1], linkgit:git-show[1],
749         linkgit:git-whatchanged[1].
751 format.thread::
752         The default threading style for 'git-format-patch'.  Can be
753         either a boolean value, `shallow` or `deep`.  `shallow`
754         threading makes every mail a reply to the head of the series,
755         where the head is chosen from the cover letter, the
756         `\--in-reply-to`, and the first patch mail, in this order.
757         `deep` threading makes every mail a reply to the previous one.
758         A true boolean value is the same as `shallow`, and a false
759         value disables threading.
761 format.signoff::
762     A boolean value which lets you enable the `-s/--signoff` option of
763     format-patch by default. *Note:* Adding the Signed-off-by: line to a
764     patch should be a conscious act and means that you certify you have
765     the rights to submit this work under the same open source license.
766     Please see the 'SubmittingPatches' document for further discussion.
768 gc.aggressiveWindow::
769         The window size parameter used in the delta compression
770         algorithm used by 'git-gc --aggressive'.  This defaults
771         to 10.
773 gc.auto::
774         When there are approximately more than this many loose
775         objects in the repository, `git gc --auto` will pack them.
776         Some Porcelain commands use this command to perform a
777         light-weight garbage collection from time to time.  The
778         default value is 6700.  Setting this to 0 disables it.
780 gc.autopacklimit::
781         When there are more than this many packs that are not
782         marked with `*.keep` file in the repository, `git gc
783         --auto` consolidates them into one larger pack.  The
784         default value is 50.  Setting this to 0 disables it.
786 gc.packrefs::
787         'git-gc' does not run `git pack-refs` in a bare repository by
788         default so that older dumb-transport clients can still fetch
789         from the repository.  Setting this to `true` lets 'git-gc'
790         to run `git pack-refs`.  Setting this to `false` tells
791         'git-gc' never to run `git pack-refs`. The default setting is
792         `notbare`. Enable it only when you know you do not have to
793         support such clients.  The default setting will change to `true`
794         at some stage, and setting this to `false` will continue to
795         prevent `git pack-refs` from being run from 'git-gc'.
797 gc.pruneexpire::
798         When 'git-gc' is run, it will call 'prune --expire 2.weeks.ago'.
799         Override the grace period with this config variable.  The value
800         "now" may be used to disable this  grace period and always prune
801         unreachable objects immediately.
803 gc.reflogexpire::
804         'git-reflog expire' removes reflog entries older than
805         this time; defaults to 90 days.
807 gc.reflogexpireunreachable::
808         'git-reflog expire' removes reflog entries older than
809         this time and are not reachable from the current tip;
810         defaults to 30 days.
812 gc.rerereresolved::
813         Records of conflicted merge you resolved earlier are
814         kept for this many days when 'git-rerere gc' is run.
815         The default is 60 days.  See linkgit:git-rerere[1].
817 gc.rerereunresolved::
818         Records of conflicted merge you have not resolved are
819         kept for this many days when 'git-rerere gc' is run.
820         The default is 15 days.  See linkgit:git-rerere[1].
822 gitcvs.commitmsgannotation::
823         Append this string to each commit message. Set to empty string
824         to disable this feature. Defaults to "via git-CVS emulator".
826 gitcvs.enabled::
827         Whether the CVS server interface is enabled for this repository.
828         See linkgit:git-cvsserver[1].
830 gitcvs.logfile::
831         Path to a log file where the CVS server interface well... logs
832         various stuff. See linkgit:git-cvsserver[1].
834 gitcvs.usecrlfattr::
835         If true, the server will look up the `crlf` attribute for
836         files to determine the '-k' modes to use. If `crlf` is set,
837         the '-k' mode will be left blank, so cvs clients will
838         treat it as text. If `crlf` is explicitly unset, the file
839         will be set with '-kb' mode, which suppresses any newline munging
840         the client might otherwise do. If `crlf` is not specified,
841         then 'gitcvs.allbinary' is used. See linkgit:gitattributes[5].
843 gitcvs.allbinary::
844         This is used if 'gitcvs.usecrlfattr' does not resolve
845         the correct '-kb' mode to use. If true, all
846         unresolved files are sent to the client in
847         mode '-kb'. This causes the client to treat them
848         as binary files, which suppresses any newline munging it
849         otherwise might do. Alternatively, if it is set to "guess",
850         then the contents of the file are examined to decide if
851         it is binary, similar to 'core.autocrlf'.
853 gitcvs.dbname::
854         Database used by git-cvsserver to cache revision information
855         derived from the git repository. The exact meaning depends on the
856         used database driver, for SQLite (which is the default driver) this
857         is a filename. Supports variable substitution (see
858         linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
859         Default: '%Ggitcvs.%m.sqlite'
861 gitcvs.dbdriver::
862         Used Perl DBI driver. You can specify any available driver
863         for this here, but it might not work. git-cvsserver is tested
864         with 'DBD::SQLite', reported to work with 'DBD::Pg', and
865         reported *not* to work with 'DBD::mysql'. Experimental feature.
866         May not contain double colons (`:`). Default: 'SQLite'.
867         See linkgit:git-cvsserver[1].
869 gitcvs.dbuser, gitcvs.dbpass::
870         Database user and password. Only useful if setting 'gitcvs.dbdriver',
871         since SQLite has no concept of database users and/or passwords.
872         'gitcvs.dbuser' supports variable substitution (see
873         linkgit:git-cvsserver[1] for details).
875 gitcvs.dbTableNamePrefix::
876         Database table name prefix.  Prepended to the names of any
877         database tables used, allowing a single database to be used
878         for several repositories.  Supports variable substitution (see
879         linkgit:git-cvsserver[1] for details).  Any non-alphabetic
880         characters will be replaced with underscores.
882 All gitcvs variables except for 'gitcvs.usecrlfattr' and
883 'gitcvs.allbinary' can also be specified as
884 'gitcvs.<access_method>.<varname>' (where 'access_method'
885 is one of "ext" and "pserver") to make them apply only for the given
886 access method.
888 gui.commitmsgwidth::
889         Defines how wide the commit message window is in the
890         linkgit:git-gui[1]. "75" is the default.
892 gui.diffcontext::
893         Specifies how many context lines should be used in calls to diff
894         made by the linkgit:git-gui[1]. The default is "5".
896 gui.encoding::
897         Specifies the default encoding to use for displaying of
898         file contents in linkgit:git-gui[1] and linkgit:gitk[1].
899         It can be overridden by setting the 'encoding' attribute
900         for relevant files (see linkgit:gitattributes[5]).
901         If this option is not set, the tools default to the
902         locale encoding.
904 gui.matchtrackingbranch::
905         Determines if new branches created with linkgit:git-gui[1] should
906         default to tracking remote branches with matching names or
907         not. Default: "false".
909 gui.newbranchtemplate::
910         Is used as suggested name when creating new branches using the
911         linkgit:git-gui[1].
913 gui.pruneduringfetch::
914         "true" if linkgit:git-gui[1] should prune tracking branches when
915         performing a fetch. The default value is "false".
917 gui.trustmtime::
918         Determines if linkgit:git-gui[1] should trust the file modification
919         timestamp or not. By default the timestamps are not trusted.
921 gui.spellingdictionary::
922         Specifies the dictionary used for spell checking commit messages in
923         the linkgit:git-gui[1]. When set to "none" spell checking is turned
924         off.
926 gui.fastcopyblame::
927         If true, 'git gui blame' uses '-C' instead of '-C -C' for original
928         location detection. It makes blame significantly faster on huge
929         repositories at the expense of less thorough copy detection.
931 gui.copyblamethreshold::
932         Specifies the threshold to use in 'git gui blame' original location
933         detection, measured in alphanumeric characters. See the
934         linkgit:git-blame[1] manual for more information on copy detection.
936 gui.blamehistoryctx::
937         Specifies the radius of history context in days to show in
938         linkgit:gitk[1] for the selected commit, when the `Show History
939         Context` menu item is invoked from 'git gui blame'. If this
940         variable is set to zero, the whole history is shown.
942 guitool.<name>.cmd::
943         Specifies the shell command line to execute when the corresponding item
944         of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
945         mandatory for every tool. The command is executed from the root of
946         the working directory, and in the environment it receives the name of
947         the tool as 'GIT_GUITOOL', the name of the currently selected file as
948         'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
949         the head is detached, 'CUR_BRANCH' is empty).
951 guitool.<name>.needsfile::
952         Run the tool only if a diff is selected in the GUI. It guarantees
953         that 'FILENAME' is not empty.
955 guitool.<name>.noconsole::
956         Run the command silently, without creating a window to display its
957         output.
959 guitool.<name>.norescan::
960         Don't rescan the working directory for changes after the tool
961         finishes execution.
963 guitool.<name>.confirm::
964         Show a confirmation dialog before actually running the tool.
966 guitool.<name>.argprompt::
967         Request a string argument from the user, and pass it to the tool
968         through the 'ARGS' environment variable. Since requesting an
969         argument implies confirmation, the 'confirm' option has no effect
970         if this is enabled. If the option is set to 'true', 'yes', or '1',
971         the dialog uses a built-in generic prompt; otherwise the exact
972         value of the variable is used.
974 guitool.<name>.revprompt::
975         Request a single valid revision from the user, and set the
976         'REVISION' environment variable. In other aspects this option
977         is similar to 'argprompt', and can be used together with it.
979 guitool.<name>.revunmerged::
980         Show only unmerged branches in the 'revprompt' subdialog.
981         This is useful for tools similar to merge or rebase, but not
982         for things like checkout or reset.
984 guitool.<name>.title::
985         Specifies the title to use for the prompt dialog. The default
986         is the tool name.
988 guitool.<name>.prompt::
989         Specifies the general prompt string to display at the top of
990         the dialog, before subsections for 'argprompt' and 'revprompt'.
991         The default value includes the actual command.
993 help.browser::
994         Specify the browser that will be used to display help in the
995         'web' format. See linkgit:git-help[1].
997 help.format::
998         Override the default help format used by linkgit:git-help[1].
999         Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1000         the default. 'web' and 'html' are the same.
1002 help.autocorrect::
1003         Automatically correct and execute mistyped commands after
1004         waiting for the given number of deciseconds (0.1 sec). If more
1005         than one command can be deduced from the entered text, nothing
1006         will be executed.  If the value of this option is negative,
1007         the corrected command will be executed immediately. If the
1008         value is 0 - the command will be just shown but not executed.
1009         This is the default.
1011 http.proxy::
1012         Override the HTTP proxy, normally configured using the 'http_proxy'
1013         environment variable (see linkgit:curl[1]).  This can be overridden
1014         on a per-remote basis; see remote.<name>.proxy
1016 http.sslVerify::
1017         Whether to verify the SSL certificate when fetching or pushing
1018         over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1019         variable.
1021 http.sslCert::
1022         File containing the SSL certificate when fetching or pushing
1023         over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1024         variable.
1026 http.sslKey::
1027         File containing the SSL private key when fetching or pushing
1028         over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1029         variable.
1031 http.sslCAInfo::
1032         File containing the certificates to verify the peer with when
1033         fetching or pushing over HTTPS. Can be overridden by the
1034         'GIT_SSL_CAINFO' environment variable.
1036 http.sslCAPath::
1037         Path containing files with the CA certificates to verify the peer
1038         with when fetching or pushing over HTTPS. Can be overridden
1039         by the 'GIT_SSL_CAPATH' environment variable.
1041 http.maxRequests::
1042         How many HTTP requests to launch in parallel. Can be overridden
1043         by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1045 http.lowSpeedLimit, http.lowSpeedTime::
1046         If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1047         for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1048         Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1049         'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1051 http.noEPSV::
1052         A boolean which disables using of EPSV ftp command by curl.
1053         This can helpful with some "poor" ftp servers which don't
1054         support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1055         environment variable. Default is false (curl will use EPSV).
1057 i18n.commitEncoding::
1058         Character encoding the commit messages are stored in; git itself
1059         does not care per se, but this information is necessary e.g. when
1060         importing commits from emails or in the gitk graphical history
1061         browser (and possibly at other places in the future or in other
1062         porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1064 i18n.logOutputEncoding::
1065         Character encoding the commit messages are converted to when
1066         running 'git-log' and friends.
1068 imap::
1069         The configuration variables in the 'imap' section are described
1070         in linkgit:git-imap-send[1].
1072 instaweb.browser::
1073         Specify the program that will be used to browse your working
1074         repository in gitweb. See linkgit:git-instaweb[1].
1076 instaweb.httpd::
1077         The HTTP daemon command-line to start gitweb on your working
1078         repository. See linkgit:git-instaweb[1].
1080 instaweb.local::
1081         If true the web server started by linkgit:git-instaweb[1] will
1082         be bound to the local IP (127.0.0.1).
1084 instaweb.modulepath::
1085         The module path for an apache httpd used by linkgit:git-instaweb[1].
1087 instaweb.port::
1088         The port number to bind the gitweb httpd to. See
1089         linkgit:git-instaweb[1].
1091 interactive.singlekey::
1092         In interactive programs, allow the user to provide one-letter
1093         input with a single key (i.e., without hitting enter).
1094         Currently this is used only by the `\--patch` mode of
1095         linkgit:git-add[1].  Note that this setting is silently
1096         ignored if portable keystroke input is not available.
1098 log.date::
1099         Set default date-time mode for the log command. Setting log.date
1100         value is similar to using 'git-log'\'s --date option. The value is one of the
1101         following alternatives: {relative,local,default,iso,rfc,short}.
1102         See linkgit:git-log[1].
1104 log.showroot::
1105         If true, the initial commit will be shown as a big creation event.
1106         This is equivalent to a diff against an empty tree.
1107         Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1108         normally hide the root commit will now show it. True by default.
1110 mailmap.file::
1111         The location of an augmenting mailmap file. The default
1112         mailmap, located in the root of the repository, is loaded
1113         first, then the mailmap file pointed to by this variable.
1114         The location of the mailmap file may be in a repository
1115         subdirectory, or somewhere outside of the repository itself.
1116         See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1118 man.viewer::
1119         Specify the programs that may be used to display help in the
1120         'man' format. See linkgit:git-help[1].
1122 man.<tool>.cmd::
1123         Specify the command to invoke the specified man viewer. The
1124         specified command is evaluated in shell with the man page
1125         passed as argument. (See linkgit:git-help[1].)
1127 man.<tool>.path::
1128         Override the path for the given tool that may be used to
1129         display help in the 'man' format. See linkgit:git-help[1].
1131 include::merge-config.txt[]
1133 mergetool.<tool>.path::
1134         Override the path for the given tool.  This is useful in case
1135         your tool is not in the PATH.
1137 mergetool.<tool>.cmd::
1138         Specify the command to invoke the specified merge tool.  The
1139         specified command is evaluated in shell with the following
1140         variables available: 'BASE' is the name of a temporary file
1141         containing the common base of the files to be merged, if available;
1142         'LOCAL' is the name of a temporary file containing the contents of
1143         the file on the current branch; 'REMOTE' is the name of a temporary
1144         file containing the contents of the file from the branch being
1145         merged; 'MERGED' contains the name of the file to which the merge
1146         tool should write the results of a successful merge.
1148 mergetool.<tool>.trustExitCode::
1149         For a custom merge command, specify whether the exit code of
1150         the merge command can be used to determine whether the merge was
1151         successful.  If this is not set to true then the merge target file
1152         timestamp is checked and the merge assumed to have been successful
1153         if the file has been updated, otherwise the user is prompted to
1154         indicate the success of the merge.
1156 mergetool.keepBackup::
1157         After performing a merge, the original file with conflict markers
1158         can be saved as a file with a `.orig` extension.  If this variable
1159         is set to `false` then this file is not preserved.  Defaults to
1160         `true` (i.e. keep the backup files).
1162 mergetool.keepTemporaries::
1163         When invoking a custom merge tool, git uses a set of temporary
1164         files to pass to the tool. If the tool returns an error and this
1165         variable is set to `true`, then these temporary files will be
1166         preserved, otherwise they will be removed after the tool has
1167         exited. Defaults to `false`.
1169 mergetool.prompt::
1170         Prompt before each invocation of the merge resolution program.
1172 pack.window::
1173         The size of the window used by linkgit:git-pack-objects[1] when no
1174         window size is given on the command line. Defaults to 10.
1176 pack.depth::
1177         The maximum delta depth used by linkgit:git-pack-objects[1] when no
1178         maximum depth is given on the command line. Defaults to 50.
1180 pack.windowMemory::
1181         The window memory size limit used by linkgit:git-pack-objects[1]
1182         when no limit is given on the command line.  The value can be
1183         suffixed with "k", "m", or "g".  Defaults to 0, meaning no
1184         limit.
1186 pack.compression::
1187         An integer -1..9, indicating the compression level for objects
1188         in a pack file. -1 is the zlib default. 0 means no
1189         compression, and 1..9 are various speed/size tradeoffs, 9 being
1190         slowest.  If not set,  defaults to core.compression.  If that is
1191         not set,  defaults to -1, the zlib default, which is "a default
1192         compromise between speed and compression (currently equivalent
1193         to level 6)."
1195 pack.deltaCacheSize::
1196         The maximum memory in bytes used for caching deltas in
1197         linkgit:git-pack-objects[1].
1198         A value of 0 means no limit. Defaults to 0.
1200 pack.deltaCacheLimit::
1201         The maximum size of a delta, that is cached in
1202         linkgit:git-pack-objects[1]. Defaults to 1000.
1204 pack.threads::
1205         Specifies the number of threads to spawn when searching for best
1206         delta matches.  This requires that linkgit:git-pack-objects[1]
1207         be compiled with pthreads otherwise this option is ignored with a
1208         warning. This is meant to reduce packing time on multiprocessor
1209         machines. The required amount of memory for the delta search window
1210         is however multiplied by the number of threads.
1211         Specifying 0 will cause git to auto-detect the number of CPU's
1212         and set the number of threads accordingly.
1214 pack.indexVersion::
1215         Specify the default pack index version.  Valid values are 1 for
1216         legacy pack index used by Git versions prior to 1.5.2, and 2 for
1217         the new pack index with capabilities for packs larger than 4 GB
1218         as well as proper protection against the repacking of corrupted
1219         packs.  Version 2 is the default.  Note that version 2 is enforced
1220         and this config option ignored whenever the corresponding pack is
1221         larger than 2 GB.
1223 If you have an old git that does not understand the version 2 `{asterisk}.idx` file,
1224 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1225 that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the
1226 other side may give you a repository that cannot be accessed with your
1227 older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,
1228 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1229 the `{asterisk}.idx` file.
1231 pack.packSizeLimit::
1232         The default maximum size of a pack.  This setting only affects
1233         packing to a file, i.e. the git:// protocol is unaffected.  It
1234         can be overridden by the `\--max-pack-size` option of
1235         linkgit:git-repack[1].
1237 pager.<cmd>::
1238         Allows turning on or off pagination of the output of a
1239         particular git subcommand when writing to a tty.  If
1240         `\--paginate` or `\--no-pager` is specified on the command line,
1241         it takes precedence over this option.  To disable pagination for
1242         all commands, set `core.pager` or `GIT_PAGER` to `cat`.
1244 pull.octopus::
1245         The default merge strategy to use when pulling multiple branches
1246         at once.
1248 pull.twohead::
1249         The default merge strategy to use when pulling a single branch.
1251 push.default::
1252         Defines the action git push should take if no refspec is given
1253         on the command line, no refspec is configured in the remote, and
1254         no refspec is implied by any of the options given on the command
1255         line. Possible values are:
1257 * `nothing` do not push anything.
1258 * `matching` push all matching branches.
1259   All branches having the same name in both ends are considered to be
1260   matching. This is the default.
1261 * `tracking` push the current branch to its upstream branch.
1262 * `current` push the current branch to a branch of the same name.
1264 rebase.stat::
1265         Whether to show a diffstat of what changed upstream since the last
1266         rebase. False by default.
1268 receive.fsckObjects::
1269         If it is set to true, git-receive-pack will check all received
1270         objects. It will abort in the case of a malformed object or a
1271         broken link. The result of an abort are only dangling objects.
1272         Defaults to false.
1274 receive.unpackLimit::
1275         If the number of objects received in a push is below this
1276         limit then the objects will be unpacked into loose object
1277         files. However if the number of received objects equals or
1278         exceeds this limit then the received pack will be stored as
1279         a pack, after adding any missing delta bases.  Storing the
1280         pack from a push can make the push operation complete faster,
1281         especially on slow filesystems.  If not set, the value of
1282         `transfer.unpackLimit` is used instead.
1284 receive.denyDeletes::
1285         If set to true, git-receive-pack will deny a ref update that deletes
1286         the ref. Use this to prevent such a ref deletion via a push.
1288 receive.denyCurrentBranch::
1289         If set to true or "refuse", receive-pack will deny a ref update
1290         to the currently checked out branch of a non-bare repository.
1291         Such a push is potentially dangerous because it brings the HEAD
1292         out of sync with the index and working tree. If set to "warn",
1293         print a warning of such a push to stderr, but allow the push to
1294         proceed. If set to false or "ignore", allow such pushes with no
1295         message. Defaults to "warn".
1297 receive.denyNonFastForwards::
1298         If set to true, git-receive-pack will deny a ref update which is
1299         not a fast forward. Use this to prevent such an update via a push,
1300         even if that push is forced. This configuration variable is
1301         set when initializing a shared repository.
1303 remote.<name>.url::
1304         The URL of a remote repository.  See linkgit:git-fetch[1] or
1305         linkgit:git-push[1].
1307 remote.<name>.proxy::
1308         For remotes that require curl (http, https and ftp), the URL to
1309         the proxy to use for that remote.  Set to the empty string to
1310         disable proxying for that remote.
1312 remote.<name>.fetch::
1313         The default set of "refspec" for linkgit:git-fetch[1]. See
1314         linkgit:git-fetch[1].
1316 remote.<name>.push::
1317         The default set of "refspec" for linkgit:git-push[1]. See
1318         linkgit:git-push[1].
1320 remote.<name>.mirror::
1321         If true, pushing to this remote will automatically behave
1322         as if the `\--mirror` option was given on the command line.
1324 remote.<name>.skipDefaultUpdate::
1325         If true, this remote will be skipped by default when updating
1326         using the update subcommand of linkgit:git-remote[1].
1328 remote.<name>.receivepack::
1329         The default program to execute on the remote side when pushing.  See
1330         option \--receive-pack of linkgit:git-push[1].
1332 remote.<name>.uploadpack::
1333         The default program to execute on the remote side when fetching.  See
1334         option \--upload-pack of linkgit:git-fetch-pack[1].
1336 remote.<name>.tagopt::
1337         Setting this value to \--no-tags disables automatic tag following when
1338         fetching from remote <name>
1340 remotes.<group>::
1341         The list of remotes which are fetched by "git remote update
1342         <group>".  See linkgit:git-remote[1].
1344 repack.usedeltabaseoffset::
1345         By default, linkgit:git-repack[1] creates packs that use
1346         delta-base offset. If you need to share your repository with
1347         git older than version 1.4.4, either directly or via a dumb
1348         protocol such as http, then you need to set this option to
1349         "false" and repack. Access from old git versions over the
1350         native protocol are unaffected by this option.
1352 rerere.autoupdate::
1353         When set to true, `git-rerere` updates the index with the
1354         resulting contents after it cleanly resolves conflicts using
1355         previously recorded resolution.  Defaults to false.
1357 rerere.enabled::
1358         Activate recording of resolved conflicts, so that identical
1359         conflict hunks can be resolved automatically, should they
1360         be encountered again.  linkgit:git-rerere[1] command is by
1361         default enabled if you create `rr-cache` directory under
1362         `$GIT_DIR`, but can be disabled by setting this option to false.
1364 showbranch.default::
1365         The default set of branches for linkgit:git-show-branch[1].
1366         See linkgit:git-show-branch[1].
1368 status.relativePaths::
1369         By default, linkgit:git-status[1] shows paths relative to the
1370         current directory. Setting this variable to `false` shows paths
1371         relative to the repository root (this was the default for git
1372         prior to v1.5.4).
1374 status.showUntrackedFiles::
1375         By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1376         files which are not currently tracked by Git. Directories which
1377         contain only untracked files, are shown with the directory name
1378         only. Showing untracked files means that Git needs to lstat() all
1379         all the files in the whole repository, which might be slow on some
1380         systems. So, this variable controls how the commands displays
1381         the untracked files. Possible values are:
1384         - 'no'     - Show no untracked files
1385         - 'normal' - Shows untracked files and directories
1386         - 'all'    - Shows also individual files in untracked directories.
1389 If this variable is not specified, it defaults to 'normal'.
1390 This variable can be overridden with the -u|--untracked-files option
1391 of linkgit:git-status[1] and linkgit:git-commit[1].
1393 tar.umask::
1394         This variable can be used to restrict the permission bits of
1395         tar archive entries.  The default is 0002, which turns off the
1396         world write bit.  The special value "user" indicates that the
1397         archiving user's umask will be used instead.  See umask(2) and
1398         linkgit:git-archive[1].
1400 transfer.unpackLimit::
1401         When `fetch.unpackLimit` or `receive.unpackLimit` are
1402         not set, the value of this variable is used instead.
1403         The default value is 100.
1405 url.<base>.insteadOf::
1406         Any URL that starts with this value will be rewritten to
1407         start, instead, with <base>. In cases where some site serves a
1408         large number of repositories, and serves them with multiple
1409         access methods, and some users need to use different access
1410         methods, this feature allows people to specify any of the
1411         equivalent URLs and have git automatically rewrite the URL to
1412         the best alternative for the particular user, even for a
1413         never-before-seen repository on the site.  When more than one
1414         insteadOf strings match a given URL, the longest match is used.
1416 user.email::
1417         Your email address to be recorded in any newly created commits.
1418         Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
1419         'EMAIL' environment variables.  See linkgit:git-commit-tree[1].
1421 user.name::
1422         Your full name to be recorded in any newly created commits.
1423         Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
1424         environment variables.  See linkgit:git-commit-tree[1].
1426 user.signingkey::
1427         If linkgit:git-tag[1] is not selecting the key you want it to
1428         automatically when creating a signed tag, you can override the
1429         default selection with this variable.  This option is passed
1430         unchanged to gpg's --local-user parameter, so you may specify a key
1431         using any method that gpg supports.
1433 web.browser::
1434         Specify a web browser that may be used by some commands.
1435         Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
1436         may use it.