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