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