run_command: report failure to execute the program, but optionally don't
[git/dscho.git] / Documentation / config.txt
blob2fecbe32a68bd981959735dd14e6e311d16b233a
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.createObject::
433         You can set this to 'link', in which case a hardlink followed by
434         a delete of the source are used to make sure that object creation
435         will not overwrite existing objects.
437 On some file system/operating system combinations, this is unreliable.
438 Set this config setting to 'rename' there; However, This will remove the
439 check that makes sure that existing object files will not get overwritten.
441 add.ignore-errors::
442         Tells 'git-add' to continue adding files when some files cannot be
443         added due to indexing errors. Equivalent to the '--ignore-errors'
444         option of linkgit:git-add[1].
446 alias.*::
447         Command aliases for the linkgit:git[1] command wrapper - e.g.
448         after defining "alias.last = cat-file commit HEAD", the invocation
449         "git last" is equivalent to "git cat-file commit HEAD". To avoid
450         confusion and troubles with script usage, aliases that
451         hide existing git commands are ignored. Arguments are split by
452         spaces, the usual shell quoting and escaping is supported.
453         quote pair and a backslash can be used to quote them.
455 If the alias expansion is prefixed with an exclamation point,
456 it will be treated as a shell command.  For example, defining
457 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
458 "git new" is equivalent to running the shell command
459 "gitk --all --not ORIG_HEAD".
461 apply.whitespace::
462         Tells 'git-apply' how to handle whitespaces, in the same way
463         as the '--whitespace' option. See linkgit:git-apply[1].
465 branch.autosetupmerge::
466         Tells 'git-branch' and 'git-checkout' to setup new branches
467         so that linkgit:git-pull[1] will appropriately merge from the
468         starting point branch. Note that even if this option is not set,
469         this behavior can be chosen per-branch using the `--track`
470         and `--no-track` options. The valid settings are: `false` -- no
471         automatic setup is done; `true` -- automatic setup is done when the
472         starting point is a remote branch; `always` -- automatic setup is
473         done when the starting point is either a local branch or remote
474         branch. This option defaults to true.
476 branch.autosetuprebase::
477         When a new branch is created with 'git-branch' or 'git-checkout'
478         that tracks another branch, this variable tells git to set
479         up pull to rebase instead of merge (see "branch.<name>.rebase").
480         When `never`, rebase is never automatically set to true.
481         When `local`, rebase is set to true for tracked branches of
482         other local branches.
483         When `remote`, rebase is set to true for tracked branches of
484         remote branches.
485         When `always`, rebase will be set to true for all tracking
486         branches.
487         See "branch.autosetupmerge" for details on how to set up a
488         branch to track another branch.
489         This option defaults to never.
491 branch.<name>.remote::
492         When in branch <name>, it tells 'git-fetch' and 'git-push' which
493         remote to fetch from/push to.  It defaults to `origin` if no remote is
494         configured. `origin` is also used if you are not on any branch.
496 branch.<name>.merge::
497         Defines, together with branch.<name>.remote, the upstream branch
498         for the given branch. It tells 'git-fetch'/'git-pull' which
499         branch to merge and can also affect 'git-push' (see push.default).
500         When in branch <name>, it tells 'git-fetch' the default
501         refspec to be marked for merging in FETCH_HEAD. The value is
502         handled like the remote part of a refspec, and must match a
503         ref which is fetched from the remote given by
504         "branch.<name>.remote".
505         The merge information is used by 'git-pull' (which at first calls
506         'git-fetch') to lookup the default branch for merging. Without
507         this option, 'git-pull' defaults to merge the first refspec fetched.
508         Specify multiple values to get an octopus merge.
509         If you wish to setup 'git-pull' so that it merges into <name> from
510         another branch in the local repository, you can point
511         branch.<name>.merge to the desired branch, and use the special setting
512         `.` (a period) for branch.<name>.remote.
514 branch.<name>.mergeoptions::
515         Sets default options for merging into branch <name>. The syntax and
516         supported options are equal to that of linkgit:git-merge[1], but
517         option values containing whitespace characters are currently not
518         supported.
520 branch.<name>.rebase::
521         When true, rebase the branch <name> on top of the fetched branch,
522         instead of merging the default branch from the default remote when
523         "git pull" is run.
524         *NOTE*: this is a possibly dangerous operation; do *not* use
525         it unless you understand the implications (see linkgit:git-rebase[1]
526         for details).
528 browser.<tool>.cmd::
529         Specify the command to invoke the specified browser. The
530         specified command is evaluated in shell with the URLs passed
531         as arguments. (See linkgit:git-web--browse[1].)
533 browser.<tool>.path::
534         Override the path for the given tool that may be used to
535         browse HTML help (see '-w' option in linkgit:git-help[1]) or a
536         working repository in gitweb (see linkgit:git-instaweb[1]).
538 clean.requireForce::
539         A boolean to make git-clean do nothing unless given -f
540         or -n.   Defaults to true.
542 color.branch::
543         A boolean to enable/disable color in the output of
544         linkgit:git-branch[1]. May be set to `always`,
545         `false` (or `never`) or `auto` (or `true`), in which case colors are used
546         only when the output is to a terminal. Defaults to false.
548 color.branch.<slot>::
549         Use customized color for branch coloration. `<slot>` is one of
550         `current` (the current branch), `local` (a local branch),
551         `remote` (a tracking branch in refs/remotes/), `plain` (other
552         refs).
554 The value for these configuration variables is a list of colors (at most
555 two) and attributes (at most one), separated by spaces.  The colors
556 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
557 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
558 `blink` and `reverse`.  The first color given is the foreground; the
559 second is the background.  The position of the attribute, if any,
560 doesn't matter.
562 color.diff::
563         When set to `always`, always use colors in patch.
564         When false (or `never`), never.  When set to `true` or `auto`, use
565         colors only when the output is to the terminal. Defaults to false.
567 color.diff.<slot>::
568         Use customized color for diff colorization.  `<slot>` specifies
569         which part of the patch to use the specified color, and is one
570         of `plain` (context text), `meta` (metainformation), `frag`
571         (hunk header), `old` (removed lines), `new` (added lines),
572         `commit` (commit headers), or `whitespace` (highlighting
573         whitespace errors). The values of these variables may be specified as
574         in color.branch.<slot>.
576 color.grep::
577         When set to `always`, always highlight matches.  When `false` (or
578         `never`), never.  When set to `true` or `auto`, use color only
579         when the output is written to the terminal.  Defaults to `false`.
581 color.grep.external::
582         The string value of this variable is passed to an external 'grep'
583         command as a command line option if match highlighting is turned
584         on.  If set to an empty string, no option is passed at all,
585         turning off coloring for external 'grep' calls; this is the default.
586         For GNU grep, set it to `--color=always` to highlight matches even
587         when a pager is used.
589 color.grep.match::
590         Use customized color for matches.  The value of this variable
591         may be specified as in color.branch.<slot>.  It is passed using
592         the environment variables 'GREP_COLOR' and 'GREP_COLORS' when
593         calling an external 'grep'.
595 color.interactive::
596         When set to `always`, always use colors for interactive prompts
597         and displays (such as those used by "git-add --interactive").
598         When false (or `never`), never.  When set to `true` or `auto`, use
599         colors only when the output is to the terminal. Defaults to false.
601 color.interactive.<slot>::
602         Use customized color for 'git-add --interactive'
603         output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
604         four distinct types of normal output from interactive
605         programs.  The values of these variables may be specified as
606         in color.branch.<slot>.
608 color.pager::
609         A boolean to enable/disable colored output when the pager is in
610         use (default is true).
612 color.showbranch::
613         A boolean to enable/disable color in the output of
614         linkgit:git-show-branch[1]. May be set to `always`,
615         `false` (or `never`) or `auto` (or `true`), in which case colors are used
616         only when the output is to a terminal. Defaults to false.
618 color.status::
619         A boolean to enable/disable color in the output of
620         linkgit:git-status[1]. May be set to `always`,
621         `false` (or `never`) or `auto` (or `true`), in which case colors are used
622         only when the output is to a terminal. Defaults to false.
624 color.status.<slot>::
625         Use customized color for status colorization. `<slot>` is
626         one of `header` (the header text of the status message),
627         `added` or `updated` (files which are added but not committed),
628         `changed` (files which are changed but not added in the index),
629         `untracked` (files which are not tracked by git), or
630         `nobranch` (the color the 'no branch' warning is shown in, defaulting
631         to red). The values of these variables may be specified as in
632         color.branch.<slot>.
634 color.ui::
635         When set to `always`, always use colors in all git commands which
636         are capable of colored output. When false (or `never`), never. When
637         set to `true` or `auto`, use colors only when the output is to the
638         terminal. When more specific variables of color.* are set, they always
639         take precedence over this setting. Defaults to false.
641 commit.template::
642         Specify a file to use as the template for new commit messages.
644 diff.autorefreshindex::
645         When using 'git-diff' to compare with work tree
646         files, do not consider stat-only change as changed.
647         Instead, silently run `git update-index --refresh` to
648         update the cached stat information for paths whose
649         contents in the work tree match the contents in the
650         index.  This option defaults to true.  Note that this
651         affects only 'git-diff' Porcelain, and not lower level
652         'diff' commands, such as 'git-diff-files'.
654 diff.external::
655         If this config variable is set, diff generation is not
656         performed using the internal diff machinery, but using the
657         given command.  Can be overridden with the `GIT_EXTERNAL_DIFF'
658         environment variable.  The command is called with parameters
659         as described under "git Diffs" in linkgit:git[1].  Note: if
660         you want to use an external diff program only on a subset of
661         your files, you might want to use linkgit:gitattributes[5] instead.
663 diff.mnemonicprefix::
664         If set, 'git-diff' uses a prefix pair that is different from the
665         standard "a/" and "b/" depending on what is being compared.  When
666         this configuration is in effect, reverse diff output also swaps
667         the order of the prefixes:
668 'git-diff';;
669         compares the (i)ndex and the (w)ork tree;
670 'git-diff HEAD';;
671          compares a (c)ommit and the (w)ork tree;
672 'git diff --cached';;
673         compares a (c)ommit and the (i)ndex;
674 'git-diff HEAD:file1 file2';;
675         compares an (o)bject and a (w)ork tree entity;
676 'git diff --no-index a b';;
677         compares two non-git things (1) and (2).
679 diff.renameLimit::
680         The number of files to consider when performing the copy/rename
681         detection; equivalent to the 'git-diff' option '-l'.
683 diff.renames::
684         Tells git to detect renames.  If set to any boolean value, it
685         will enable basic rename detection.  If set to "copies" or
686         "copy", it will detect copies, as well.
688 diff.suppressBlankEmpty::
689         A boolean to inhibit the standard behavior of printing a space
690         before each empty output line. Defaults to false.
692 diff.tool::
693         Controls which diff tool is used.  `diff.tool` overrides
694         `merge.tool` when used by linkgit:git-difftool[1] and has
695         the same valid values as `merge.tool` minus "tortoisemerge"
696         and plus "kompare".
698 difftool.<tool>.path::
699         Override the path for the given tool.  This is useful in case
700         your tool is not in the PATH.
702 difftool.<tool>.cmd::
703         Specify the command to invoke the specified diff tool.
704         The specified command is evaluated in shell with the following
705         variables available:  'LOCAL' is set to the name of the temporary
706         file containing the contents of the diff pre-image and 'REMOTE'
707         is set to the name of the temporary file containing the contents
708         of the diff post-image.
710 difftool.prompt::
711         Prompt before each invocation of the diff tool.
713 diff.wordRegex::
714         A POSIX Extended Regular Expression used to determine what is a "word"
715         when performing word-by-word difference calculations.  Character
716         sequences that match the regular expression are "words", all other
717         characters are *ignorable* whitespace.
719 fetch.unpackLimit::
720         If the number of objects fetched over the git native
721         transfer is below this
722         limit, then the objects will be unpacked into loose object
723         files. However if the number of received objects equals or
724         exceeds this limit then the received pack will be stored as
725         a pack, after adding any missing delta bases.  Storing the
726         pack from a push can make the push operation complete faster,
727         especially on slow filesystems.  If not set, the value of
728         `transfer.unpackLimit` is used instead.
730 format.attach::
731         Enable multipart/mixed attachments as the default for
732         'format-patch'.  The value can also be a double quoted string
733         which will enable attachments as the default and set the
734         value as the boundary.  See the --attach option in
735         linkgit:git-format-patch[1].
737 format.numbered::
738         A boolean which can enable or disable sequence numbers in patch
739         subjects.  It defaults to "auto" which enables it only if there
740         is more than one patch.  It can be enabled or disabled for all
741         messages by setting it to "true" or "false".  See --numbered
742         option in linkgit:git-format-patch[1].
744 format.headers::
745         Additional email headers to include in a patch to be submitted
746         by mail.  See linkgit:git-format-patch[1].
748 format.cc::
749         Additional "Cc:" headers to include in a patch to be submitted
750         by mail.  See the --cc option in linkgit:git-format-patch[1].
752 format.subjectprefix::
753         The default for format-patch is to output files with the '[PATCH]'
754         subject prefix. Use this variable to change that prefix.
756 format.suffix::
757         The default for format-patch is to output files with the suffix
758         `.patch`. Use this variable to change that suffix (make sure to
759         include the dot if you want it).
761 format.pretty::
762         The default pretty format for log/show/whatchanged command,
763         See linkgit:git-log[1], linkgit:git-show[1],
764         linkgit:git-whatchanged[1].
766 format.thread::
767         The default threading style for 'git-format-patch'.  Can be
768         either a boolean value, `shallow` or `deep`.  `shallow`
769         threading makes every mail a reply to the head of the series,
770         where the head is chosen from the cover letter, the
771         `\--in-reply-to`, and the first patch mail, in this order.
772         `deep` threading makes every mail a reply to the previous one.
773         A true boolean value is the same as `shallow`, and a false
774         value disables threading.
776 format.signoff::
777     A boolean value which lets you enable the `-s/--signoff` option of
778     format-patch by default. *Note:* Adding the Signed-off-by: line to a
779     patch should be a conscious act and means that you certify you have
780     the rights to submit this work under the same open source license.
781     Please see the 'SubmittingPatches' document for further discussion.
783 gc.aggressiveWindow::
784         The window size parameter used in the delta compression
785         algorithm used by 'git-gc --aggressive'.  This defaults
786         to 10.
788 gc.auto::
789         When there are approximately more than this many loose
790         objects in the repository, `git gc --auto` will pack them.
791         Some Porcelain commands use this command to perform a
792         light-weight garbage collection from time to time.  The
793         default value is 6700.  Setting this to 0 disables it.
795 gc.autopacklimit::
796         When there are more than this many packs that are not
797         marked with `*.keep` file in the repository, `git gc
798         --auto` consolidates them into one larger pack.  The
799         default value is 50.  Setting this to 0 disables it.
801 gc.packrefs::
802         'git-gc' does not run `git pack-refs` in a bare repository by
803         default so that older dumb-transport clients can still fetch
804         from the repository.  Setting this to `true` lets 'git-gc'
805         to run `git pack-refs`.  Setting this to `false` tells
806         'git-gc' never to run `git pack-refs`. The default setting is
807         `notbare`. Enable it only when you know you do not have to
808         support such clients.  The default setting will change to `true`
809         at some stage, and setting this to `false` will continue to
810         prevent `git pack-refs` from being run from 'git-gc'.
812 gc.pruneexpire::
813         When 'git-gc' is run, it will call 'prune --expire 2.weeks.ago'.
814         Override the grace period with this config variable.  The value
815         "now" may be used to disable this  grace period and always prune
816         unreachable objects immediately.
818 gc.reflogexpire::
819         'git-reflog expire' removes reflog entries older than
820         this time; defaults to 90 days.
822 gc.reflogexpireunreachable::
823         'git-reflog expire' removes reflog entries older than
824         this time and are not reachable from the current tip;
825         defaults to 30 days.
827 gc.rerereresolved::
828         Records of conflicted merge you resolved earlier are
829         kept for this many days when 'git-rerere gc' is run.
830         The default is 60 days.  See linkgit:git-rerere[1].
832 gc.rerereunresolved::
833         Records of conflicted merge you have not resolved are
834         kept for this many days when 'git-rerere gc' is run.
835         The default is 15 days.  See linkgit:git-rerere[1].
837 gitcvs.commitmsgannotation::
838         Append this string to each commit message. Set to empty string
839         to disable this feature. Defaults to "via git-CVS emulator".
841 gitcvs.enabled::
842         Whether the CVS server interface is enabled for this repository.
843         See linkgit:git-cvsserver[1].
845 gitcvs.logfile::
846         Path to a log file where the CVS server interface well... logs
847         various stuff. See linkgit:git-cvsserver[1].
849 gitcvs.usecrlfattr::
850         If true, the server will look up the `crlf` attribute for
851         files to determine the '-k' modes to use. If `crlf` is set,
852         the '-k' mode will be left blank, so cvs clients will
853         treat it as text. If `crlf` is explicitly unset, the file
854         will be set with '-kb' mode, which suppresses any newline munging
855         the client might otherwise do. If `crlf` is not specified,
856         then 'gitcvs.allbinary' is used. See linkgit:gitattributes[5].
858 gitcvs.allbinary::
859         This is used if 'gitcvs.usecrlfattr' does not resolve
860         the correct '-kb' mode to use. If true, all
861         unresolved files are sent to the client in
862         mode '-kb'. This causes the client to treat them
863         as binary files, which suppresses any newline munging it
864         otherwise might do. Alternatively, if it is set to "guess",
865         then the contents of the file are examined to decide if
866         it is binary, similar to 'core.autocrlf'.
868 gitcvs.dbname::
869         Database used by git-cvsserver to cache revision information
870         derived from the git repository. The exact meaning depends on the
871         used database driver, for SQLite (which is the default driver) this
872         is a filename. Supports variable substitution (see
873         linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
874         Default: '%Ggitcvs.%m.sqlite'
876 gitcvs.dbdriver::
877         Used Perl DBI driver. You can specify any available driver
878         for this here, but it might not work. git-cvsserver is tested
879         with 'DBD::SQLite', reported to work with 'DBD::Pg', and
880         reported *not* to work with 'DBD::mysql'. Experimental feature.
881         May not contain double colons (`:`). Default: 'SQLite'.
882         See linkgit:git-cvsserver[1].
884 gitcvs.dbuser, gitcvs.dbpass::
885         Database user and password. Only useful if setting 'gitcvs.dbdriver',
886         since SQLite has no concept of database users and/or passwords.
887         'gitcvs.dbuser' supports variable substitution (see
888         linkgit:git-cvsserver[1] for details).
890 gitcvs.dbTableNamePrefix::
891         Database table name prefix.  Prepended to the names of any
892         database tables used, allowing a single database to be used
893         for several repositories.  Supports variable substitution (see
894         linkgit:git-cvsserver[1] for details).  Any non-alphabetic
895         characters will be replaced with underscores.
897 All gitcvs variables except for 'gitcvs.usecrlfattr' and
898 'gitcvs.allbinary' can also be specified as
899 'gitcvs.<access_method>.<varname>' (where 'access_method'
900 is one of "ext" and "pserver") to make them apply only for the given
901 access method.
903 gui.commitmsgwidth::
904         Defines how wide the commit message window is in the
905         linkgit:git-gui[1]. "75" is the default.
907 gui.diffcontext::
908         Specifies how many context lines should be used in calls to diff
909         made by the linkgit:git-gui[1]. The default is "5".
911 gui.encoding::
912         Specifies the default encoding to use for displaying of
913         file contents in linkgit:git-gui[1] and linkgit:gitk[1].
914         It can be overridden by setting the 'encoding' attribute
915         for relevant files (see linkgit:gitattributes[5]).
916         If this option is not set, the tools default to the
917         locale encoding.
919 gui.matchtrackingbranch::
920         Determines if new branches created with linkgit:git-gui[1] should
921         default to tracking remote branches with matching names or
922         not. Default: "false".
924 gui.newbranchtemplate::
925         Is used as suggested name when creating new branches using the
926         linkgit:git-gui[1].
928 gui.pruneduringfetch::
929         "true" if linkgit:git-gui[1] should prune tracking branches when
930         performing a fetch. The default value is "false".
932 gui.trustmtime::
933         Determines if linkgit:git-gui[1] should trust the file modification
934         timestamp or not. By default the timestamps are not trusted.
936 gui.spellingdictionary::
937         Specifies the dictionary used for spell checking commit messages in
938         the linkgit:git-gui[1]. When set to "none" spell checking is turned
939         off.
941 gui.fastcopyblame::
942         If true, 'git gui blame' uses '-C' instead of '-C -C' for original
943         location detection. It makes blame significantly faster on huge
944         repositories at the expense of less thorough copy detection.
946 gui.copyblamethreshold::
947         Specifies the threshold to use in 'git gui blame' original location
948         detection, measured in alphanumeric characters. See the
949         linkgit:git-blame[1] manual for more information on copy detection.
951 gui.blamehistoryctx::
952         Specifies the radius of history context in days to show in
953         linkgit:gitk[1] for the selected commit, when the `Show History
954         Context` menu item is invoked from 'git gui blame'. If this
955         variable is set to zero, the whole history is shown.
957 guitool.<name>.cmd::
958         Specifies the shell command line to execute when the corresponding item
959         of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
960         mandatory for every tool. The command is executed from the root of
961         the working directory, and in the environment it receives the name of
962         the tool as 'GIT_GUITOOL', the name of the currently selected file as
963         'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
964         the head is detached, 'CUR_BRANCH' is empty).
966 guitool.<name>.needsfile::
967         Run the tool only if a diff is selected in the GUI. It guarantees
968         that 'FILENAME' is not empty.
970 guitool.<name>.noconsole::
971         Run the command silently, without creating a window to display its
972         output.
974 guitool.<name>.norescan::
975         Don't rescan the working directory for changes after the tool
976         finishes execution.
978 guitool.<name>.confirm::
979         Show a confirmation dialog before actually running the tool.
981 guitool.<name>.argprompt::
982         Request a string argument from the user, and pass it to the tool
983         through the 'ARGS' environment variable. Since requesting an
984         argument implies confirmation, the 'confirm' option has no effect
985         if this is enabled. If the option is set to 'true', 'yes', or '1',
986         the dialog uses a built-in generic prompt; otherwise the exact
987         value of the variable is used.
989 guitool.<name>.revprompt::
990         Request a single valid revision from the user, and set the
991         'REVISION' environment variable. In other aspects this option
992         is similar to 'argprompt', and can be used together with it.
994 guitool.<name>.revunmerged::
995         Show only unmerged branches in the 'revprompt' subdialog.
996         This is useful for tools similar to merge or rebase, but not
997         for things like checkout or reset.
999 guitool.<name>.title::
1000         Specifies the title to use for the prompt dialog. The default
1001         is the tool name.
1003 guitool.<name>.prompt::
1004         Specifies the general prompt string to display at the top of
1005         the dialog, before subsections for 'argprompt' and 'revprompt'.
1006         The default value includes the actual command.
1008 help.browser::
1009         Specify the browser that will be used to display help in the
1010         'web' format. See linkgit:git-help[1].
1012 help.format::
1013         Override the default help format used by linkgit:git-help[1].
1014         Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1015         the default. 'web' and 'html' are the same.
1017 help.autocorrect::
1018         Automatically correct and execute mistyped commands after
1019         waiting for the given number of deciseconds (0.1 sec). If more
1020         than one command can be deduced from the entered text, nothing
1021         will be executed.  If the value of this option is negative,
1022         the corrected command will be executed immediately. If the
1023         value is 0 - the command will be just shown but not executed.
1024         This is the default.
1026 http.proxy::
1027         Override the HTTP proxy, normally configured using the 'http_proxy'
1028         environment variable (see linkgit:curl[1]).  This can be overridden
1029         on a per-remote basis; see remote.<name>.proxy
1031 http.sslVerify::
1032         Whether to verify the SSL certificate when fetching or pushing
1033         over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1034         variable.
1036 http.sslCert::
1037         File containing the SSL certificate when fetching or pushing
1038         over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1039         variable.
1041 http.sslKey::
1042         File containing the SSL private key when fetching or pushing
1043         over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1044         variable.
1046 http.sslCAInfo::
1047         File containing the certificates to verify the peer with when
1048         fetching or pushing over HTTPS. Can be overridden by the
1049         'GIT_SSL_CAINFO' environment variable.
1051 http.sslCAPath::
1052         Path containing files with the CA certificates to verify the peer
1053         with when fetching or pushing over HTTPS. Can be overridden
1054         by the 'GIT_SSL_CAPATH' environment variable.
1056 http.maxRequests::
1057         How many HTTP requests to launch in parallel. Can be overridden
1058         by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1060 http.lowSpeedLimit, http.lowSpeedTime::
1061         If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1062         for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1063         Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1064         'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1066 http.noEPSV::
1067         A boolean which disables using of EPSV ftp command by curl.
1068         This can helpful with some "poor" ftp servers which don't
1069         support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1070         environment variable. Default is false (curl will use EPSV).
1072 i18n.commitEncoding::
1073         Character encoding the commit messages are stored in; git itself
1074         does not care per se, but this information is necessary e.g. when
1075         importing commits from emails or in the gitk graphical history
1076         browser (and possibly at other places in the future or in other
1077         porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1079 i18n.logOutputEncoding::
1080         Character encoding the commit messages are converted to when
1081         running 'git-log' and friends.
1083 imap::
1084         The configuration variables in the 'imap' section are described
1085         in linkgit:git-imap-send[1].
1087 instaweb.browser::
1088         Specify the program that will be used to browse your working
1089         repository in gitweb. See linkgit:git-instaweb[1].
1091 instaweb.httpd::
1092         The HTTP daemon command-line to start gitweb on your working
1093         repository. See linkgit:git-instaweb[1].
1095 instaweb.local::
1096         If true the web server started by linkgit:git-instaweb[1] will
1097         be bound to the local IP (127.0.0.1).
1099 instaweb.modulepath::
1100         The module path for an apache httpd used by linkgit:git-instaweb[1].
1102 instaweb.port::
1103         The port number to bind the gitweb httpd to. See
1104         linkgit:git-instaweb[1].
1106 interactive.singlekey::
1107         In interactive programs, allow the user to provide one-letter
1108         input with a single key (i.e., without hitting enter).
1109         Currently this is used only by the `\--patch` mode of
1110         linkgit:git-add[1].  Note that this setting is silently
1111         ignored if portable keystroke input is not available.
1113 log.date::
1114         Set default date-time mode for the log command. Setting log.date
1115         value is similar to using 'git-log'\'s --date option. The value is one of the
1116         following alternatives: {relative,local,default,iso,rfc,short}.
1117         See linkgit:git-log[1].
1119 log.showroot::
1120         If true, the initial commit will be shown as a big creation event.
1121         This is equivalent to a diff against an empty tree.
1122         Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1123         normally hide the root commit will now show it. True by default.
1125 mailmap.file::
1126         The location of an augmenting mailmap file. The default
1127         mailmap, located in the root of the repository, is loaded
1128         first, then the mailmap file pointed to by this variable.
1129         The location of the mailmap file may be in a repository
1130         subdirectory, or somewhere outside of the repository itself.
1131         See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1133 man.viewer::
1134         Specify the programs that may be used to display help in the
1135         'man' format. See linkgit:git-help[1].
1137 man.<tool>.cmd::
1138         Specify the command to invoke the specified man viewer. The
1139         specified command is evaluated in shell with the man page
1140         passed as argument. (See linkgit:git-help[1].)
1142 man.<tool>.path::
1143         Override the path for the given tool that may be used to
1144         display help in the 'man' format. See linkgit:git-help[1].
1146 include::merge-config.txt[]
1148 mergetool.<tool>.path::
1149         Override the path for the given tool.  This is useful in case
1150         your tool is not in the PATH.
1152 mergetool.<tool>.cmd::
1153         Specify the command to invoke the specified merge tool.  The
1154         specified command is evaluated in shell with the following
1155         variables available: 'BASE' is the name of a temporary file
1156         containing the common base of the files to be merged, if available;
1157         'LOCAL' is the name of a temporary file containing the contents of
1158         the file on the current branch; 'REMOTE' is the name of a temporary
1159         file containing the contents of the file from the branch being
1160         merged; 'MERGED' contains the name of the file to which the merge
1161         tool should write the results of a successful merge.
1163 mergetool.<tool>.trustExitCode::
1164         For a custom merge command, specify whether the exit code of
1165         the merge command can be used to determine whether the merge was
1166         successful.  If this is not set to true then the merge target file
1167         timestamp is checked and the merge assumed to have been successful
1168         if the file has been updated, otherwise the user is prompted to
1169         indicate the success of the merge.
1171 mergetool.keepBackup::
1172         After performing a merge, the original file with conflict markers
1173         can be saved as a file with a `.orig` extension.  If this variable
1174         is set to `false` then this file is not preserved.  Defaults to
1175         `true` (i.e. keep the backup files).
1177 mergetool.keepTemporaries::
1178         When invoking a custom merge tool, git uses a set of temporary
1179         files to pass to the tool. If the tool returns an error and this
1180         variable is set to `true`, then these temporary files will be
1181         preserved, otherwise they will be removed after the tool has
1182         exited. Defaults to `false`.
1184 mergetool.prompt::
1185         Prompt before each invocation of the merge resolution program.
1187 pack.window::
1188         The size of the window used by linkgit:git-pack-objects[1] when no
1189         window size is given on the command line. Defaults to 10.
1191 pack.depth::
1192         The maximum delta depth used by linkgit:git-pack-objects[1] when no
1193         maximum depth is given on the command line. Defaults to 50.
1195 pack.windowMemory::
1196         The window memory size limit used by linkgit:git-pack-objects[1]
1197         when no limit is given on the command line.  The value can be
1198         suffixed with "k", "m", or "g".  Defaults to 0, meaning no
1199         limit.
1201 pack.compression::
1202         An integer -1..9, indicating the compression level for objects
1203         in a pack file. -1 is the zlib default. 0 means no
1204         compression, and 1..9 are various speed/size tradeoffs, 9 being
1205         slowest.  If not set,  defaults to core.compression.  If that is
1206         not set,  defaults to -1, the zlib default, which is "a default
1207         compromise between speed and compression (currently equivalent
1208         to level 6)."
1210 pack.deltaCacheSize::
1211         The maximum memory in bytes used for caching deltas in
1212         linkgit:git-pack-objects[1].
1213         A value of 0 means no limit. Defaults to 0.
1215 pack.deltaCacheLimit::
1216         The maximum size of a delta, that is cached in
1217         linkgit:git-pack-objects[1]. Defaults to 1000.
1219 pack.threads::
1220         Specifies the number of threads to spawn when searching for best
1221         delta matches.  This requires that linkgit:git-pack-objects[1]
1222         be compiled with pthreads otherwise this option is ignored with a
1223         warning. This is meant to reduce packing time on multiprocessor
1224         machines. The required amount of memory for the delta search window
1225         is however multiplied by the number of threads.
1226         Specifying 0 will cause git to auto-detect the number of CPU's
1227         and set the number of threads accordingly.
1229 pack.indexVersion::
1230         Specify the default pack index version.  Valid values are 1 for
1231         legacy pack index used by Git versions prior to 1.5.2, and 2 for
1232         the new pack index with capabilities for packs larger than 4 GB
1233         as well as proper protection against the repacking of corrupted
1234         packs.  Version 2 is the default.  Note that version 2 is enforced
1235         and this config option ignored whenever the corresponding pack is
1236         larger than 2 GB.
1238 If you have an old git that does not understand the version 2 `{asterisk}.idx` file,
1239 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1240 that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the
1241 other side may give you a repository that cannot be accessed with your
1242 older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,
1243 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1244 the `{asterisk}.idx` file.
1246 pack.packSizeLimit::
1247         The default maximum size of a pack.  This setting only affects
1248         packing to a file, i.e. the git:// protocol is unaffected.  It
1249         can be overridden by the `\--max-pack-size` option of
1250         linkgit:git-repack[1].
1252 pager.<cmd>::
1253         Allows turning on or off pagination of the output of a
1254         particular git subcommand when writing to a tty.  If
1255         `\--paginate` or `\--no-pager` is specified on the command line,
1256         it takes precedence over this option.  To disable pagination for
1257         all commands, set `core.pager` or `GIT_PAGER` to `cat`.
1259 pull.octopus::
1260         The default merge strategy to use when pulling multiple branches
1261         at once.
1263 pull.twohead::
1264         The default merge strategy to use when pulling a single branch.
1266 push.default::
1267         Defines the action git push should take if no refspec is given
1268         on the command line, no refspec is configured in the remote, and
1269         no refspec is implied by any of the options given on the command
1270         line. Possible values are:
1272 * `nothing` do not push anything.
1273 * `matching` push all matching branches.
1274   All branches having the same name in both ends are considered to be
1275   matching. This is the default.
1276 * `tracking` push the current branch to its upstream branch.
1277 * `current` push the current branch to a branch of the same name.
1279 rebase.stat::
1280         Whether to show a diffstat of what changed upstream since the last
1281         rebase. False by default.
1283 receive.fsckObjects::
1284         If it is set to true, git-receive-pack will check all received
1285         objects. It will abort in the case of a malformed object or a
1286         broken link. The result of an abort are only dangling objects.
1287         Defaults to false.
1289 receive.unpackLimit::
1290         If the number of objects received in a push is below this
1291         limit then the objects will be unpacked into loose object
1292         files. However if the number of received objects equals or
1293         exceeds this limit then the received pack will be stored as
1294         a pack, after adding any missing delta bases.  Storing the
1295         pack from a push can make the push operation complete faster,
1296         especially on slow filesystems.  If not set, the value of
1297         `transfer.unpackLimit` is used instead.
1299 receive.denyDeletes::
1300         If set to true, git-receive-pack will deny a ref update that deletes
1301         the ref. Use this to prevent such a ref deletion via a push.
1303 receive.denyCurrentBranch::
1304         If set to true or "refuse", receive-pack will deny a ref update
1305         to the currently checked out branch of a non-bare repository.
1306         Such a push is potentially dangerous because it brings the HEAD
1307         out of sync with the index and working tree. If set to "warn",
1308         print a warning of such a push to stderr, but allow the push to
1309         proceed. If set to false or "ignore", allow such pushes with no
1310         message. Defaults to "warn".
1312 receive.denyNonFastForwards::
1313         If set to true, git-receive-pack will deny a ref update which is
1314         not a fast forward. Use this to prevent such an update via a push,
1315         even if that push is forced. This configuration variable is
1316         set when initializing a shared repository.
1318 remote.<name>.url::
1319         The URL of a remote repository.  See linkgit:git-fetch[1] or
1320         linkgit:git-push[1].
1322 remote.<name>.pushurl::
1323         The push URL of a remote repository.  See linkgit:git-push[1].
1325 remote.<name>.proxy::
1326         For remotes that require curl (http, https and ftp), the URL to
1327         the proxy to use for that remote.  Set to the empty string to
1328         disable proxying for that remote.
1330 remote.<name>.fetch::
1331         The default set of "refspec" for linkgit:git-fetch[1]. See
1332         linkgit:git-fetch[1].
1334 remote.<name>.push::
1335         The default set of "refspec" for linkgit:git-push[1]. See
1336         linkgit:git-push[1].
1338 remote.<name>.mirror::
1339         If true, pushing to this remote will automatically behave
1340         as if the `\--mirror` option was given on the command line.
1342 remote.<name>.skipDefaultUpdate::
1343         If true, this remote will be skipped by default when updating
1344         using the update subcommand of linkgit:git-remote[1].
1346 remote.<name>.receivepack::
1347         The default program to execute on the remote side when pushing.  See
1348         option \--receive-pack of linkgit:git-push[1].
1350 remote.<name>.uploadpack::
1351         The default program to execute on the remote side when fetching.  See
1352         option \--upload-pack of linkgit:git-fetch-pack[1].
1354 remote.<name>.tagopt::
1355         Setting this value to \--no-tags disables automatic tag following when
1356         fetching from remote <name>
1358 remotes.<group>::
1359         The list of remotes which are fetched by "git remote update
1360         <group>".  See linkgit:git-remote[1].
1362 repack.usedeltabaseoffset::
1363         By default, linkgit:git-repack[1] creates packs that use
1364         delta-base offset. If you need to share your repository with
1365         git older than version 1.4.4, either directly or via a dumb
1366         protocol such as http, then you need to set this option to
1367         "false" and repack. Access from old git versions over the
1368         native protocol are unaffected by this option.
1370 rerere.autoupdate::
1371         When set to true, `git-rerere` updates the index with the
1372         resulting contents after it cleanly resolves conflicts using
1373         previously recorded resolution.  Defaults to false.
1375 rerere.enabled::
1376         Activate recording of resolved conflicts, so that identical
1377         conflict hunks can be resolved automatically, should they
1378         be encountered again.  linkgit:git-rerere[1] command is by
1379         default enabled if you create `rr-cache` directory under
1380         `$GIT_DIR`, but can be disabled by setting this option to false.
1382 showbranch.default::
1383         The default set of branches for linkgit:git-show-branch[1].
1384         See linkgit:git-show-branch[1].
1386 status.relativePaths::
1387         By default, linkgit:git-status[1] shows paths relative to the
1388         current directory. Setting this variable to `false` shows paths
1389         relative to the repository root (this was the default for git
1390         prior to v1.5.4).
1392 status.showUntrackedFiles::
1393         By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1394         files which are not currently tracked by Git. Directories which
1395         contain only untracked files, are shown with the directory name
1396         only. Showing untracked files means that Git needs to lstat() all
1397         all the files in the whole repository, which might be slow on some
1398         systems. So, this variable controls how the commands displays
1399         the untracked files. Possible values are:
1402         - 'no'     - Show no untracked files
1403         - 'normal' - Shows untracked files and directories
1404         - 'all'    - Shows also individual files in untracked directories.
1407 If this variable is not specified, it defaults to 'normal'.
1408 This variable can be overridden with the -u|--untracked-files option
1409 of linkgit:git-status[1] and linkgit:git-commit[1].
1411 tar.umask::
1412         This variable can be used to restrict the permission bits of
1413         tar archive entries.  The default is 0002, which turns off the
1414         world write bit.  The special value "user" indicates that the
1415         archiving user's umask will be used instead.  See umask(2) and
1416         linkgit:git-archive[1].
1418 transfer.unpackLimit::
1419         When `fetch.unpackLimit` or `receive.unpackLimit` are
1420         not set, the value of this variable is used instead.
1421         The default value is 100.
1423 url.<base>.insteadOf::
1424         Any URL that starts with this value will be rewritten to
1425         start, instead, with <base>. In cases where some site serves a
1426         large number of repositories, and serves them with multiple
1427         access methods, and some users need to use different access
1428         methods, this feature allows people to specify any of the
1429         equivalent URLs and have git automatically rewrite the URL to
1430         the best alternative for the particular user, even for a
1431         never-before-seen repository on the site.  When more than one
1432         insteadOf strings match a given URL, the longest match is used.
1434 user.email::
1435         Your email address to be recorded in any newly created commits.
1436         Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
1437         'EMAIL' environment variables.  See linkgit:git-commit-tree[1].
1439 user.name::
1440         Your full name to be recorded in any newly created commits.
1441         Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
1442         environment variables.  See linkgit:git-commit-tree[1].
1444 user.signingkey::
1445         If linkgit:git-tag[1] is not selecting the key you want it to
1446         automatically when creating a signed tag, you can override the
1447         default selection with this variable.  This option is passed
1448         unchanged to gpg's --local-user parameter, so you may specify a key
1449         using any method that gpg supports.
1451 web.browser::
1452         Specify a web browser that may be used by some commands.
1453         Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
1454         may use it.