Code

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