grep: add support for coloring with external greps
[git/jrn.git] / Documentation / config.txt
blob4d42bff7182ce0d0b72bd5d6f13ac11e2e2ef372
1 CONFIGURATION FILE
2 ------------------
4 The git configuration file contains a number of variables that affect
5 the git command's behavior. `.git/config` file for each repository
6 is used to store the information for that repository, and
7 `$HOME/.gitconfig` is used to store per user information to give
8 fallback values for `.git/config` file. The file `/etc/gitconfig`
9 can be used to store system-wide defaults.
11 They can be used by both the git plumbing
12 and the porcelains. The variables are divided into sections, where
13 in the fully qualified variable name 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 section
30 header before 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 example below:
36 --------
37         [section "subsection"]
39 --------
41 Subsection names can contain any characters except newline (doublequote
42 '`"`' and backslash have to be escaped as '`\"`' and '`\\`',
43 respectively) and are case sensitive.  Section header 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 (case insensitive) alternative `[section.subsection]` syntax.
49 In this syntax subsection names follow the same restrictions as for section
50 name.
52 All the other lines are recognized as setting variables, in the form
53 'name = value'.  If there is no equal sign on the line, the entire line
54 is taken as 'name' and the variable is recognized as boolean "true".
55 The variable names are case-insensitive and only alphanumeric
56 characters and '`-`' are allowed.  There can be more than one value
57 for a given variable; we say then that variable is multivalued.
59 Leading and trailing whitespace in a variable value is discarded.
60 Internal whitespace within a variable value is retained verbatim.
62 The values following the equals sign in variable assign are all either
63 a string, an integer, or a boolean.  Boolean values may be given as yes/no,
64 0/1 or true/false.  Case is not significant in boolean values, when
65 converting value to the canonical form using '--bool' type specifier;
66 'git-config' will ensure that the output is "true" or "false".
68 String values may be entirely or partially enclosed in double quotes.
69 You need to enclose variable value in double quotes if you want to
70 preserve leading or trailing whitespace, or if variable value contains
71 beginning of comment characters (if it contains '#' or ';').
72 Double quote '`"`' and backslash '`\`' characters in variable value must
73 be escaped: use '`\"`' for '`"`' and '`\\`' for '`\`'.
75 The following escape sequences (beside '`\"`' and '`\\`') are recognized:
76 '`\n`' for newline character (NL), '`\t`' for horizontal tabulation (HT, TAB)
77 and '`\b`' for backspace (BS).  No other char escape sequence, nor octal
78 char sequences are valid.
80 Variable value ending in a '`\`' is continued on the next line in the
81 customary UNIX fashion.
83 Some variables may require special value format.
85 Example
86 ~~~~~~~
88         # Core variables
89         [core]
90                 ; Don't trust file modes
91                 filemode = false
93         # Our diff algorithm
94         [diff]
95                 external = /usr/local/bin/diff-wrapper
96                 renames = true
98         [branch "devel"]
99                 remote = origin
100                 merge = refs/heads/devel
102         # Proxy settings
103         [core]
104                 gitProxy="ssh" for "kernel.org"
105                 gitProxy=default-proxy ; for the rest
107 Variables
108 ~~~~~~~~~
110 Note that this list is non-comprehensive and not necessarily complete.
111 For command-specific variables, you will find a more detailed description
112 in the appropriate manual page. You will find a description of non-core
113 porcelain configuration variables in the respective porcelain documentation.
115 core.fileMode::
116         If false, the executable bit differences between the index and
117         the working copy are ignored; useful on broken filesystems like FAT.
118         See linkgit:git-update-index[1]. True by default.
120 core.ignoreCygwinFSTricks::
121         This option is only used by Cygwin implementation of Git. If false,
122         the Cygwin stat() and lstat() functions are used. This may be useful
123         if your repository consists of a few separate directories joined in
124         one hierarchy using Cygwin mount. If true, Git uses native Win32 API
125         whenever it is possible and falls back to Cygwin functions only to
126         handle symbol links. The native mode is more than twice faster than
127         normal Cygwin l/stat() functions. True by default, unless core.filemode
128         is true, in which case ignoreCygwinFSTricks is ignored as Cygwin's
129         POSIX emulation is required to support core.filemode.
131 core.trustctime::
132         If false, the ctime differences between the index and the
133         working copy are ignored; useful when the inode change time
134         is regularly modified by something outside Git (file system
135         crawlers and some backup systems).
136         See linkgit:git-update-index[1]. True by default.
138 core.quotepath::
139         The commands that output paths (e.g. 'ls-files',
140         'diff'), when not given the `-z` option, will quote
141         "unusual" characters in the pathname by enclosing the
142         pathname in a double-quote pair and with backslashes the
143         same way strings in C source code are quoted.  If this
144         variable is set to false, the bytes higher than 0x80 are
145         not quoted but output as verbatim.  Note that double
146         quote, backslash and control characters are always
147         quoted without `-z` regardless of the setting of this
148         variable.
150 core.autocrlf::
151         If true, makes git convert `CRLF` at the end of lines in text files to
152         `LF` when reading from the filesystem, and convert in reverse when
153         writing to the filesystem.  The variable can be set to
154         'input', in which case the conversion happens only while
155         reading from the filesystem but files are written out with
156         `LF` at the end of lines.  Currently, which paths to consider
157         "text" (i.e. be subjected to the autocrlf mechanism) is
158         decided purely based on the contents.
160 core.safecrlf::
161         If true, makes git check if converting `CRLF` as controlled by
162         `core.autocrlf` is reversible.  Git will verify if a command
163         modifies a file in the work tree either directly or indirectly.
164         For example, committing a file followed by checking out the
165         same file should yield the original file in the work tree.  If
166         this is not the case for the current setting of
167         `core.autocrlf`, git will reject the file.  The variable can
168         be set to "warn", in which case git will only warn about an
169         irreversible conversion but continue the operation.
171 CRLF conversion bears a slight chance of corrupting data.
172 autocrlf=true will convert CRLF to LF during commit and LF to
173 CRLF during checkout.  A file that contains a mixture of LF and
174 CRLF before the commit cannot be recreated by git.  For text
175 files this is the right thing to do: it corrects line endings
176 such that we have only LF line endings in the repository.
177 But for binary files that are accidentally classified as text the
178 conversion can corrupt data.
180 If you recognize such corruption early you can easily fix it by
181 setting the conversion type explicitly in .gitattributes.  Right
182 after committing you still have the original file in your work
183 tree and this file is not yet corrupted.  You can explicitly tell
184 git that this file is binary and git will handle the file
185 appropriately.
187 Unfortunately, the desired effect of cleaning up text files with
188 mixed line endings and the undesired effect of corrupting binary
189 files cannot be distinguished.  In both cases CRLFs are removed
190 in an irreversible way.  For text files this is the right thing
191 to do because CRLFs are line endings, while for binary files
192 converting CRLFs corrupts data.
194 Note, this safety check does not mean that a checkout will generate a
195 file identical to the original file for a different setting of
196 `core.autocrlf`, but only for the current one.  For example, a text
197 file with `LF` would be accepted with `core.autocrlf=input` and could
198 later be checked out with `core.autocrlf=true`, in which case the
199 resulting file would contain `CRLF`, although the original file
200 contained `LF`.  However, in both work trees the line endings would be
201 consistent, that is either all `LF` or all `CRLF`, but never mixed.  A
202 file with mixed line endings would be reported by the `core.safecrlf`
203 mechanism.
205 core.symlinks::
206         If false, symbolic links are checked out as small plain files that
207         contain the link text. linkgit:git-update-index[1] and
208         linkgit:git-add[1] will not change the recorded type to regular
209         file. Useful on filesystems like FAT that do not support
210         symbolic links. True by default.
212 core.gitProxy::
213         A "proxy command" to execute (as 'command host port') instead
214         of establishing direct connection to the remote server when
215         using the git protocol for fetching. If the variable value is
216         in the "COMMAND for DOMAIN" format, the command is applied only
217         on hostnames ending with the specified domain string. This variable
218         may be set multiple times and is matched in the given order;
219         the first match wins.
221 Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
222 (which always applies universally, without the special "for"
223 handling).
225 core.ignoreStat::
226         If true, commands which modify both the working tree and the index
227         will mark the updated paths with the "assume unchanged" bit in the
228         index. These marked files are then assumed to stay unchanged in the
229         working copy, until you mark them otherwise manually - Git will not
230         detect the file changes by lstat() calls. This is useful on systems
231         where those are very slow, such as Microsoft Windows.
232         See linkgit:git-update-index[1].
233         False by default.
235 core.preferSymlinkRefs::
236         Instead of the default "symref" format for HEAD
237         and other symbolic reference files, use symbolic links.
238         This is sometimes needed to work with old scripts that
239         expect HEAD to be a symbolic link.
241 core.bare::
242         If true this repository is assumed to be 'bare' and has no
243         working directory associated with it.  If this is the case a
244         number of commands that require a working directory will be
245         disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
247 This setting is automatically guessed by linkgit:git-clone[1] or
248 linkgit:git-init[1] when the repository was created.  By default a
249 repository that ends in "/.git" is assumed to be not bare (bare =
250 false), while all other repositories are assumed to be bare (bare
251 = true).
253 core.worktree::
254         Set the path to the working tree.  The value will not be
255         used in combination with repositories found automatically in
256         a .git directory (i.e. $GIT_DIR is not set).
257         This can be overridden by the GIT_WORK_TREE environment
258         variable and the '--work-tree' command line option. It can be
259         a absolute path or relative path to the directory specified by
260         --git-dir or GIT_DIR.
261         Note: If --git-dir or GIT_DIR are specified but none of
262         --work-tree, GIT_WORK_TREE and core.worktree is specified,
263         the current working directory is regarded as the top directory
264         of your working tree.
266 core.logAllRefUpdates::
267         Enable the reflog. Updates to a ref <ref> is logged to the file
268         "$GIT_DIR/logs/<ref>", by appending the new and old
269         SHA1, the date/time and the reason of the update, but
270         only when the file exists.  If this configuration
271         variable is set to true, missing "$GIT_DIR/logs/<ref>"
272         file is automatically created for branch heads.
274 This information can be used to determine what commit
275 was the tip of a branch "2 days ago".
277 This value is true by default in a repository that has
278 a working directory associated with it, and false by
279 default in a bare repository.
281 core.repositoryFormatVersion::
282         Internal variable identifying the repository format and layout
283         version.
285 core.sharedRepository::
286         When 'group' (or 'true'), the repository is made shareable between
287         several users in a group (making sure all the files and objects are
288         group-writable). When 'all' (or 'world' or 'everybody'), the
289         repository will be readable by all users, additionally to being
290         group-shareable. When 'umask' (or 'false'), git will use permissions
291         reported by umask(2). When '0xxx', where '0xxx' is an octal number,
292         files in the repository will have this mode value. '0xxx' will override
293         user's umask value, and thus, users with a safe umask (0077) can use
294         this option. Examples: '0660' is equivalent to 'group'. '0640' is a
295         repository that is group-readable but not group-writable.
296         See linkgit:git-init[1]. False by default.
298 core.warnAmbiguousRefs::
299         If true, git will warn you if the ref name you passed it is ambiguous
300         and might match multiple refs in the .git/refs/ tree. True by default.
302 core.compression::
303         An integer -1..9, indicating a default compression level.
304         -1 is the zlib default. 0 means no compression,
305         and 1..9 are various speed/size tradeoffs, 9 being slowest.
306         If set, this provides a default to other compression variables,
307         such as 'core.loosecompression' and 'pack.compression'.
309 core.loosecompression::
310         An integer -1..9, indicating the compression level for objects that
311         are not in a pack file. -1 is the zlib default. 0 means no
312         compression, and 1..9 are various speed/size tradeoffs, 9 being
313         slowest.  If not set,  defaults to core.compression.  If that is
314         not set,  defaults to 1 (best speed).
316 core.packedGitWindowSize::
317         Number of bytes of a pack file to map into memory in a
318         single mapping operation.  Larger window sizes may allow
319         your system to process a smaller number of large pack files
320         more quickly.  Smaller window sizes will negatively affect
321         performance due to increased calls to the operating system's
322         memory manager, but may improve performance when accessing
323         a large number of large pack files.
325 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
326 MiB on 32 bit platforms and 1 GiB on 64 bit platforms.  This should
327 be reasonable for all users/operating systems.  You probably do
328 not need to adjust this value.
330 Common unit suffixes of 'k', 'm', or 'g' are supported.
332 core.packedGitLimit::
333         Maximum number of bytes to map simultaneously into memory
334         from pack files.  If Git needs to access more than this many
335         bytes at once to complete an operation it will unmap existing
336         regions to reclaim virtual address space within the process.
338 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
339 This should be reasonable for all users/operating systems, except on
340 the largest projects.  You probably do not need to adjust this value.
342 Common unit suffixes of 'k', 'm', or 'g' are supported.
344 core.deltaBaseCacheLimit::
345         Maximum number of bytes to reserve for caching base objects
346         that multiple deltafied objects reference.  By storing the
347         entire decompressed base objects in a cache Git is able
348         to avoid unpacking and decompressing frequently used base
349         objects multiple times.
351 Default is 16 MiB on all platforms.  This should be reasonable
352 for all users/operating systems, except on the largest projects.
353 You probably do not need to adjust this value.
355 Common unit suffixes of 'k', 'm', or 'g' are supported.
357 core.excludesfile::
358         In addition to '.gitignore' (per-directory) and
359         '.git/info/exclude', git looks into this file for patterns
360         of files which are not meant to be tracked.  See
361         linkgit:gitignore[5].
363 core.editor::
364         Commands such as `commit` and `tag` that lets you edit
365         messages by launching an editor uses the value of this
366         variable when it is set, and the environment variable
367         `GIT_EDITOR` is not set.  The order of preference is
368         `GIT_EDITOR` environment, `core.editor`, `VISUAL` and
369         `EDITOR` environment variables and then finally `vi`.
371 core.pager::
372         The command that git will use to paginate output.  Can
373         be overridden with the `GIT_PAGER` environment
374         variable.  Note that git sets the `LESS` environment
375         variable to `FRSX` if it is unset when it runs the
376         pager.  One can change these settings by setting the
377         `LESS` variable to some other value.  Alternately,
378         these settings can be overridden on a project or
379         global basis by setting the `core.pager` option.
380         Setting `core.pager` has no affect on the `LESS`
381         environment variable behaviour above, so if you want
382         to override git's default settings this way, you need
383         to be explicit.  For example, to disable the S option
384         in a backward compatible manner, set `core.pager`
385         to "`less -+$LESS -FRX`".  This will be passed to the
386         shell by git, which will translate the final command to
387         "`LESS=FRSX less -+FRSX -FRX`".
389 core.whitespace::
390         A comma separated list of common whitespace problems to
391         notice.  'git-diff' will use `color.diff.whitespace` to
392         highlight them, and 'git-apply --whitespace=error' will
393         consider them as errors.  You can prefix `-` to disable
394         any of them (e.g. `-trailing-space`):
396 * `trailing-space` treats trailing whitespaces at the end of the line
397   as an error (enabled by default).
398 * `space-before-tab` treats a space character that appears immediately
399   before a tab character in the initial indent part of the line as an
400   error (enabled by default).
401 * `indent-with-non-tab` treats a line that is indented with 8 or more
402   space characters as an error (not enabled by default).
403 * `cr-at-eol` treats a carriage-return at the end of line as
404   part of the line terminator, i.e. with it, `trailing-space`
405   does not trigger if the character before such a carriage-return
406   is not a whitespace (not enabled by default).
408 core.fsyncobjectfiles::
409         This boolean will enable 'fsync()' when writing object files.
411 This is a total waste of time and effort on a filesystem that orders
412 data writes properly, but can be useful for filesystems that do not use
413 journalling (traditional UNIX filesystems) or that only journal metadata
414 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
416 core.preloadindex::
417         Enable parallel index preload for operations like 'git diff'
419 This can speed up operations like 'git diff' and 'git status' especially
420 on filesystems like NFS that have weak caching semantics and thus
421 relatively high IO latencies.  With this set to 'true', git will do the
422 index comparison to the filesystem data in parallel, allowing
423 overlapping IO's.
425 alias.*::
426         Command aliases for the linkgit:git[1] command wrapper - e.g.
427         after defining "alias.last = cat-file commit HEAD", the invocation
428         "git last" is equivalent to "git cat-file commit HEAD". To avoid
429         confusion and troubles with script usage, aliases that
430         hide existing git commands are ignored. Arguments are split by
431         spaces, the usual shell quoting and escaping is supported.
432         quote pair and a backslash can be used to quote them.
434 If the alias expansion is prefixed with an exclamation point,
435 it will be treated as a shell command.  For example, defining
436 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
437 "git new" is equivalent to running the shell command
438 "gitk --all --not ORIG_HEAD".
440 apply.whitespace::
441         Tells 'git-apply' how to handle whitespaces, in the same way
442         as the '--whitespace' option. See linkgit:git-apply[1].
444 branch.autosetupmerge::
445         Tells 'git-branch' and 'git-checkout' to setup new branches
446         so that linkgit:git-pull[1] will appropriately merge from the
447         starting point branch. Note that even if this option is not set,
448         this behavior can be chosen per-branch using the `--track`
449         and `--no-track` options. The valid settings are: `false` -- no
450         automatic setup is done; `true` -- automatic setup is done when the
451         starting point is a remote branch; `always` -- automatic setup is
452         done when the starting point is either a local branch or remote
453         branch. This option defaults to true.
455 branch.autosetuprebase::
456         When a new branch is created with 'git-branch' or 'git-checkout'
457         that tracks another branch, this variable tells git to set
458         up pull to rebase instead of merge (see "branch.<name>.rebase").
459         When `never`, rebase is never automatically set to true.
460         When `local`, rebase is set to true for tracked branches of
461         other local branches.
462         When `remote`, rebase is set to true for tracked branches of
463         remote branches.
464         When `always`, rebase will be set to true for all tracking
465         branches.
466         See "branch.autosetupmerge" for details on how to set up a
467         branch to track another branch.
468         This option defaults to never.
470 branch.<name>.remote::
471         When in branch <name>, it tells 'git-fetch' which remote to fetch.
472         If this option is not given, 'git-fetch' defaults to remote "origin".
474 branch.<name>.merge::
475         When in branch <name>, it tells 'git-fetch' the default
476         refspec to be marked for merging in FETCH_HEAD. The value is
477         handled like the remote part of a refspec, and must match a
478         ref which is fetched from the remote given by
479         "branch.<name>.remote".
480         The merge information is used by 'git-pull' (which at first calls
481         'git-fetch') to lookup the default branch for merging. Without
482         this option, 'git-pull' defaults to merge the first refspec fetched.
483         Specify multiple values to get an octopus merge.
484         If you wish to setup 'git-pull' so that it merges into <name> from
485         another branch in the local repository, you can point
486         branch.<name>.merge to the desired branch, and use the special setting
487         `.` (a period) for branch.<name>.remote.
489 branch.<name>.mergeoptions::
490         Sets default options for merging into branch <name>. The syntax and
491         supported options are equal to that of linkgit:git-merge[1], but
492         option values containing whitespace characters are currently not
493         supported.
495 branch.<name>.rebase::
496         When true, rebase the branch <name> on top of the fetched branch,
497         instead of merging the default branch from the default remote when
498         "git pull" is run.
499         *NOTE*: this is a possibly dangerous operation; do *not* use
500         it unless you understand the implications (see linkgit:git-rebase[1]
501         for details).
503 browser.<tool>.cmd::
504         Specify the command to invoke the specified browser. The
505         specified command is evaluated in shell with the URLs passed
506         as arguments. (See linkgit:git-web--browse[1].)
508 browser.<tool>.path::
509         Override the path for the given tool that may be used to
510         browse HTML help (see '-w' option in linkgit:git-help[1]) or a
511         working repository in gitweb (see linkgit:git-instaweb[1]).
513 clean.requireForce::
514         A boolean to make git-clean do nothing unless given -f
515         or -n.   Defaults to true.
517 color.branch::
518         A boolean to enable/disable color in the output of
519         linkgit:git-branch[1]. May be set to `always`,
520         `false` (or `never`) or `auto` (or `true`), in which case colors are used
521         only when the output is to a terminal. Defaults to false.
523 color.branch.<slot>::
524         Use customized color for branch coloration. `<slot>` is one of
525         `current` (the current branch), `local` (a local branch),
526         `remote` (a tracking branch in refs/remotes/), `plain` (other
527         refs).
529 The value for these configuration variables is a list of colors (at most
530 two) and attributes (at most one), separated by spaces.  The colors
531 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
532 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
533 `blink` and `reverse`.  The first color given is the foreground; the
534 second is the background.  The position of the attribute, if any,
535 doesn't matter.
537 color.diff::
538         When set to `always`, always use colors in patch.
539         When false (or `never`), never.  When set to `true` or `auto`, use
540         colors only when the output is to the terminal. Defaults to false.
542 color.diff.<slot>::
543         Use customized color for diff colorization.  `<slot>` specifies
544         which part of the patch to use the specified color, and is one
545         of `plain` (context text), `meta` (metainformation), `frag`
546         (hunk header), `old` (removed lines), `new` (added lines),
547         `commit` (commit headers), or `whitespace` (highlighting
548         whitespace errors). The values of these variables may be specified as
549         in color.branch.<slot>.
551 color.grep::
552         When set to `always`, always highlight matches.  When `false` (or
553         `never`), never.  When set to `true` or `auto`, use color only
554         when the output is written to the terminal.  Defaults to `false`.
556 color.grep.external::
557         The string value of this variable is passed to an external 'grep'
558         command as a command line option if match highlighting is turned
559         on.  If set to an empty string, no option is passed at all,
560         turning off coloring for external 'grep' calls; this is the default.
561         For GNU grep, set it to `--color=always` to highlight matches even
562         when a pager is used.
564 color.grep.match::
565         Use customized color for matches.  The value of this variable
566         may be specified as in color.branch.<slot>.  It is passed using
567         the environment variables 'GREP_COLOR' and 'GREP_COLORS' when
568         calling an external 'grep'.
570 color.interactive::
571         When set to `always`, always use colors for interactive prompts
572         and displays (such as those used by "git-add --interactive").
573         When false (or `never`), never.  When set to `true` or `auto`, use
574         colors only when the output is to the terminal. Defaults to false.
576 color.interactive.<slot>::
577         Use customized color for 'git-add --interactive'
578         output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
579         four distinct types of normal output from interactive
580         programs.  The values of these variables may be specified as
581         in color.branch.<slot>.
583 color.pager::
584         A boolean to enable/disable colored output when the pager is in
585         use (default is true).
587 color.status::
588         A boolean to enable/disable color in the output of
589         linkgit:git-status[1]. May be set to `always`,
590         `false` (or `never`) or `auto` (or `true`), in which case colors are used
591         only when the output is to a terminal. Defaults to false.
593 color.status.<slot>::
594         Use customized color for status colorization. `<slot>` is
595         one of `header` (the header text of the status message),
596         `added` or `updated` (files which are added but not committed),
597         `changed` (files which are changed but not added in the index),
598         `untracked` (files which are not tracked by git), or
599         `nobranch` (the color the 'no branch' warning is shown in, defaulting
600         to red). The values of these variables may be specified as in
601         color.branch.<slot>.
603 color.ui::
604         When set to `always`, always use colors in all git commands which
605         are capable of colored output. When false (or `never`), never. When
606         set to `true` or `auto`, use colors only when the output is to the
607         terminal. When more specific variables of color.* are set, they always
608         take precedence over this setting. Defaults to false.
610 commit.template::
611         Specify a file to use as the template for new commit messages.
613 diff.autorefreshindex::
614         When using 'git-diff' to compare with work tree
615         files, do not consider stat-only change as changed.
616         Instead, silently run `git update-index --refresh` to
617         update the cached stat information for paths whose
618         contents in the work tree match the contents in the
619         index.  This option defaults to true.  Note that this
620         affects only 'git-diff' Porcelain, and not lower level
621         'diff' commands, such as 'git-diff-files'.
623 diff.external::
624         If this config variable is set, diff generation is not
625         performed using the internal diff machinery, but using the
626         given command.  Can be overridden with the `GIT_EXTERNAL_DIFF'
627         environment variable.  The command is called with parameters
628         as described under "git Diffs" in linkgit:git[1].  Note: if
629         you want to use an external diff program only on a subset of
630         your files, you might want to use linkgit:gitattributes[5] instead.
632 diff.mnemonicprefix::
633         If set, 'git-diff' uses a prefix pair that is different from the
634         standard "a/" and "b/" depending on what is being compared.  When
635         this configuration is in effect, reverse diff output also swaps
636         the order of the prefixes:
637 'git-diff';;
638         compares the (i)ndex and the (w)ork tree;
639 'git-diff HEAD';;
640          compares a (c)ommit and the (w)ork tree;
641 'git diff --cached';;
642         compares a (c)ommit and the (i)ndex;
643 'git-diff HEAD:file1 file2';;
644         compares an (o)bject and a (w)ork tree entity;
645 'git diff --no-index a b';;
646         compares two non-git things (1) and (2).
648 diff.renameLimit::
649         The number of files to consider when performing the copy/rename
650         detection; equivalent to the 'git-diff' option '-l'.
652 diff.renames::
653         Tells git to detect renames.  If set to any boolean value, it
654         will enable basic rename detection.  If set to "copies" or
655         "copy", it will detect copies, as well.
657 diff.suppressBlankEmpty::
658         A boolean to inhibit the standard behavior of printing a space
659         before each empty output line. Defaults to false.
661 diff.wordRegex::
662         A POSIX Extended Regular Expression used to determine what is a "word"
663         when performing word-by-word difference calculations.  Character
664         sequences that match the regular expression are "words", all other
665         characters are *ignorable* whitespace.
667 fetch.unpackLimit::
668         If the number of objects fetched over the git native
669         transfer is below this
670         limit, then the objects will be unpacked into loose object
671         files. However if the number of received objects equals or
672         exceeds this limit then the received pack will be stored as
673         a pack, after adding any missing delta bases.  Storing the
674         pack from a push can make the push operation complete faster,
675         especially on slow filesystems.  If not set, the value of
676         `transfer.unpackLimit` is used instead.
678 format.numbered::
679         A boolean which can enable or disable sequence numbers in patch
680         subjects.  It defaults to "auto" which enables it only if there
681         is more than one patch.  It can be enabled or disabled for all
682         messages by setting it to "true" or "false".  See --numbered
683         option in linkgit:git-format-patch[1].
685 format.headers::
686         Additional email headers to include in a patch to be submitted
687         by mail.  See linkgit:git-format-patch[1].
689 format.suffix::
690         The default for format-patch is to output files with the suffix
691         `.patch`. Use this variable to change that suffix (make sure to
692         include the dot if you want it).
694 format.pretty::
695         The default pretty format for log/show/whatchanged command,
696         See linkgit:git-log[1], linkgit:git-show[1],
697         linkgit:git-whatchanged[1].
699 gc.aggressiveWindow::
700         The window size parameter used in the delta compression
701         algorithm used by 'git-gc --aggressive'.  This defaults
702         to 10.
704 gc.auto::
705         When there are approximately more than this many loose
706         objects in the repository, `git gc --auto` will pack them.
707         Some Porcelain commands use this command to perform a
708         light-weight garbage collection from time to time.  The
709         default value is 6700.  Setting this to 0 disables it.
711 gc.autopacklimit::
712         When there are more than this many packs that are not
713         marked with `*.keep` file in the repository, `git gc
714         --auto` consolidates them into one larger pack.  The
715         default value is 50.  Setting this to 0 disables it.
717 gc.packrefs::
718         'git-gc' does not run `git pack-refs` in a bare repository by
719         default so that older dumb-transport clients can still fetch
720         from the repository.  Setting this to `true` lets 'git-gc'
721         to run `git pack-refs`.  Setting this to `false` tells
722         'git-gc' never to run `git pack-refs`. The default setting is
723         `notbare`. Enable it only when you know you do not have to
724         support such clients.  The default setting will change to `true`
725         at some stage, and setting this to `false` will continue to
726         prevent `git pack-refs` from being run from 'git-gc'.
728 gc.pruneexpire::
729         When 'git-gc' is run, it will call 'prune --expire 2.weeks.ago'.
730         Override the grace period with this config variable.  The value
731         "now" may be used to disable this  grace period and always prune
732         unreachable objects immediately.
734 gc.reflogexpire::
735         'git-reflog expire' removes reflog entries older than
736         this time; defaults to 90 days.
738 gc.reflogexpireunreachable::
739         'git-reflog expire' removes reflog entries older than
740         this time and are not reachable from the current tip;
741         defaults to 30 days.
743 gc.rerereresolved::
744         Records of conflicted merge you resolved earlier are
745         kept for this many days when 'git-rerere gc' is run.
746         The default is 60 days.  See linkgit:git-rerere[1].
748 gc.rerereunresolved::
749         Records of conflicted merge you have not resolved are
750         kept for this many days when 'git-rerere gc' is run.
751         The default is 15 days.  See linkgit:git-rerere[1].
753 gitcvs.commitmsgannotation::
754         Append this string to each commit message. Set to empty string
755         to disable this feature. Defaults to "via git-CVS emulator".
757 gitcvs.enabled::
758         Whether the CVS server interface is enabled for this repository.
759         See linkgit:git-cvsserver[1].
761 gitcvs.logfile::
762         Path to a log file where the CVS server interface well... logs
763         various stuff. See linkgit:git-cvsserver[1].
765 gitcvs.usecrlfattr::
766         If true, the server will look up the `crlf` attribute for
767         files to determine the '-k' modes to use. If `crlf` is set,
768         the '-k' mode will be left blank, so cvs clients will
769         treat it as text. If `crlf` is explicitly unset, the file
770         will be set with '-kb' mode, which suppresses any newline munging
771         the client might otherwise do. If `crlf` is not specified,
772         then 'gitcvs.allbinary' is used. See linkgit:gitattributes[5].
774 gitcvs.allbinary::
775         This is used if 'gitcvs.usecrlfattr' does not resolve
776         the correct '-kb' mode to use. If true, all
777         unresolved files are sent to the client in
778         mode '-kb'. This causes the client to treat them
779         as binary files, which suppresses any newline munging it
780         otherwise might do. Alternatively, if it is set to "guess",
781         then the contents of the file are examined to decide if
782         it is binary, similar to 'core.autocrlf'.
784 gitcvs.dbname::
785         Database used by git-cvsserver to cache revision information
786         derived from the git repository. The exact meaning depends on the
787         used database driver, for SQLite (which is the default driver) this
788         is a filename. Supports variable substitution (see
789         linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
790         Default: '%Ggitcvs.%m.sqlite'
792 gitcvs.dbdriver::
793         Used Perl DBI driver. You can specify any available driver
794         for this here, but it might not work. git-cvsserver is tested
795         with 'DBD::SQLite', reported to work with 'DBD::Pg', and
796         reported *not* to work with 'DBD::mysql'. Experimental feature.
797         May not contain double colons (`:`). Default: 'SQLite'.
798         See linkgit:git-cvsserver[1].
800 gitcvs.dbuser, gitcvs.dbpass::
801         Database user and password. Only useful if setting 'gitcvs.dbdriver',
802         since SQLite has no concept of database users and/or passwords.
803         'gitcvs.dbuser' supports variable substitution (see
804         linkgit:git-cvsserver[1] for details).
806 gitcvs.dbTableNamePrefix::
807         Database table name prefix.  Prepended to the names of any
808         database tables used, allowing a single database to be used
809         for several repositories.  Supports variable substitution (see
810         linkgit:git-cvsserver[1] for details).  Any non-alphabetic
811         characters will be replaced with underscores.
813 All gitcvs variables except for 'gitcvs.usecrlfattr' and
814 'gitcvs.allbinary' can also be specified as
815 'gitcvs.<access_method>.<varname>' (where 'access_method'
816 is one of "ext" and "pserver") to make them apply only for the given
817 access method.
819 gui.commitmsgwidth::
820         Defines how wide the commit message window is in the
821         linkgit:git-gui[1]. "75" is the default.
823 gui.diffcontext::
824         Specifies how many context lines should be used in calls to diff
825         made by the linkgit:git-gui[1]. The default is "5".
827 gui.encoding::
828         Specifies the default encoding to use for displaying of
829         file contents in linkgit:git-gui[1] and linkgit:gitk[1].
830         It can be overridden by setting the 'encoding' attribute
831         for relevant files (see linkgit:gitattributes[5]).
832         If this option is not set, the tools default to the
833         locale encoding.
835 gui.matchtrackingbranch::
836         Determines if new branches created with linkgit:git-gui[1] should
837         default to tracking remote branches with matching names or
838         not. Default: "false".
840 gui.newbranchtemplate::
841         Is used as suggested name when creating new branches using the
842         linkgit:git-gui[1].
844 gui.pruneduringfetch::
845         "true" if linkgit:git-gui[1] should prune tracking branches when
846         performing a fetch. The default value is "false".
848 gui.trustmtime::
849         Determines if linkgit:git-gui[1] should trust the file modification
850         timestamp or not. By default the timestamps are not trusted.
852 gui.spellingdictionary::
853         Specifies the dictionary used for spell checking commit messages in
854         the linkgit:git-gui[1]. When set to "none" spell checking is turned
855         off.
857 gui.fastcopyblame::
858         If true, 'git gui blame' uses '-C' instead of '-C -C' for original
859         location detection. It makes blame significantly faster on huge
860         repositories at the expense of less thorough copy detection.
862 gui.copyblamethreshold::
863         Specifies the threshold to use in 'git gui blame' original location
864         detection, measured in alphanumeric characters. See the
865         linkgit:git-blame[1] manual for more information on copy detection.
867 gui.blamehistoryctx::
868         Specifies the radius of history context in days to show in
869         linkgit:gitk[1] for the selected commit, when the `Show History
870         Context` menu item is invoked from 'git gui blame'. If this
871         variable is set to zero, the whole history is shown.
873 guitool.<name>.cmd::
874         Specifies the shell command line to execute when the corresponding item
875         of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
876         mandatory for every tool. The command is executed from the root of
877         the working directory, and in the environment it receives the name of
878         the tool as 'GIT_GUITOOL', the name of the currently selected file as
879         'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
880         the head is detached, 'CUR_BRANCH' is empty).
882 guitool.<name>.needsfile::
883         Run the tool only if a diff is selected in the GUI. It guarantees
884         that 'FILENAME' is not empty.
886 guitool.<name>.noconsole::
887         Run the command silently, without creating a window to display its
888         output.
890 guitool.<name>.norescan::
891         Don't rescan the working directory for changes after the tool
892         finishes execution.
894 guitool.<name>.confirm::
895         Show a confirmation dialog before actually running the tool.
897 guitool.<name>.argprompt::
898         Request a string argument from the user, and pass it to the tool
899         through the 'ARGS' environment variable. Since requesting an
900         argument implies confirmation, the 'confirm' option has no effect
901         if this is enabled. If the option is set to 'true', 'yes', or '1',
902         the dialog uses a built-in generic prompt; otherwise the exact
903         value of the variable is used.
905 guitool.<name>.revprompt::
906         Request a single valid revision from the user, and set the
907         'REVISION' environment variable. In other aspects this option
908         is similar to 'argprompt', and can be used together with it.
910 guitool.<name>.revunmerged::
911         Show only unmerged branches in the 'revprompt' subdialog.
912         This is useful for tools similar to merge or rebase, but not
913         for things like checkout or reset.
915 guitool.<name>.title::
916         Specifies the title to use for the prompt dialog. The default
917         is the tool name.
919 guitool.<name>.prompt::
920         Specifies the general prompt string to display at the top of
921         the dialog, before subsections for 'argprompt' and 'revprompt'.
922         The default value includes the actual command.
924 help.browser::
925         Specify the browser that will be used to display help in the
926         'web' format. See linkgit:git-help[1].
928 help.format::
929         Override the default help format used by linkgit:git-help[1].
930         Values 'man', 'info', 'web' and 'html' are supported. 'man' is
931         the default. 'web' and 'html' are the same.
933 help.autocorrect::
934         Automatically correct and execute mistyped commands after
935         waiting for the given number of deciseconds (0.1 sec). If more
936         than one command can be deduced from the entered text, nothing
937         will be executed.  If the value of this option is negative,
938         the corrected command will be executed immediately. If the
939         value is 0 - the command will be just shown but not executed.
940         This is the default.
942 http.proxy::
943         Override the HTTP proxy, normally configured using the 'http_proxy'
944         environment variable (see linkgit:curl[1]).  This can be overridden
945         on a per-remote basis; see remote.<name>.proxy
947 http.sslVerify::
948         Whether to verify the SSL certificate when fetching or pushing
949         over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
950         variable.
952 http.sslCert::
953         File containing the SSL certificate when fetching or pushing
954         over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
955         variable.
957 http.sslKey::
958         File containing the SSL private key when fetching or pushing
959         over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
960         variable.
962 http.sslCAInfo::
963         File containing the certificates to verify the peer with when
964         fetching or pushing over HTTPS. Can be overridden by the
965         'GIT_SSL_CAINFO' environment variable.
967 http.sslCAPath::
968         Path containing files with the CA certificates to verify the peer
969         with when fetching or pushing over HTTPS. Can be overridden
970         by the 'GIT_SSL_CAPATH' environment variable.
972 http.maxRequests::
973         How many HTTP requests to launch in parallel. Can be overridden
974         by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
976 http.lowSpeedLimit, http.lowSpeedTime::
977         If the HTTP transfer speed is less than 'http.lowSpeedLimit'
978         for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
979         Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
980         'GIT_HTTP_LOW_SPEED_TIME' environment variables.
982 http.noEPSV::
983         A boolean which disables using of EPSV ftp command by curl.
984         This can helpful with some "poor" ftp servers which don't
985         support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
986         environment variable. Default is false (curl will use EPSV).
988 i18n.commitEncoding::
989         Character encoding the commit messages are stored in; git itself
990         does not care per se, but this information is necessary e.g. when
991         importing commits from emails or in the gitk graphical history
992         browser (and possibly at other places in the future or in other
993         porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
995 i18n.logOutputEncoding::
996         Character encoding the commit messages are converted to when
997         running 'git-log' and friends.
999 imap::
1000         The configuration variables in the 'imap' section are described
1001         in linkgit:git-imap-send[1].
1003 instaweb.browser::
1004         Specify the program that will be used to browse your working
1005         repository in gitweb. See linkgit:git-instaweb[1].
1007 instaweb.httpd::
1008         The HTTP daemon command-line to start gitweb on your working
1009         repository. See linkgit:git-instaweb[1].
1011 instaweb.local::
1012         If true the web server started by linkgit:git-instaweb[1] will
1013         be bound to the local IP (127.0.0.1).
1015 instaweb.modulepath::
1016         The module path for an apache httpd used by linkgit:git-instaweb[1].
1018 instaweb.port::
1019         The port number to bind the gitweb httpd to. See
1020         linkgit:git-instaweb[1].
1022 interactive.singlekey::
1023         In interactive programs, allow the user to provide one-letter
1024         input with a single key (i.e., without hitting enter).
1025         Currently this is used only by the `\--patch` mode of
1026         linkgit:git-add[1].  Note that this setting is silently
1027         ignored if portable keystroke input is not available.
1029 log.date::
1030         Set default date-time mode for the log command. Setting log.date
1031         value is similar to using 'git-log'\'s --date option. The value is one of the
1032         following alternatives: {relative,local,default,iso,rfc,short}.
1033         See linkgit:git-log[1].
1035 log.showroot::
1036         If true, the initial commit will be shown as a big creation event.
1037         This is equivalent to a diff against an empty tree.
1038         Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1039         normally hide the root commit will now show it. True by default.
1041 mailmap.file::
1042         The location of an augmenting mailmap file. The default
1043         mailmap, located in the root of the repository, is loaded
1044         first, then the mailmap file pointed to by this variable.
1045         The location of the mailmap file may be in a repository
1046         subdirectory, or somewhere outside of the repository itself.
1047         See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1049 man.viewer::
1050         Specify the programs that may be used to display help in the
1051         'man' format. See linkgit:git-help[1].
1053 man.<tool>.cmd::
1054         Specify the command to invoke the specified man viewer. The
1055         specified command is evaluated in shell with the man page
1056         passed as argument. (See linkgit:git-help[1].)
1058 man.<tool>.path::
1059         Override the path for the given tool that may be used to
1060         display help in the 'man' format. See linkgit:git-help[1].
1062 include::merge-config.txt[]
1064 mergetool.<tool>.path::
1065         Override the path for the given tool.  This is useful in case
1066         your tool is not in the PATH.
1068 mergetool.<tool>.cmd::
1069         Specify the command to invoke the specified merge tool.  The
1070         specified command is evaluated in shell with the following
1071         variables available: 'BASE' is the name of a temporary file
1072         containing the common base of the files to be merged, if available;
1073         'LOCAL' is the name of a temporary file containing the contents of
1074         the file on the current branch; 'REMOTE' is the name of a temporary
1075         file containing the contents of the file from the branch being
1076         merged; 'MERGED' contains the name of the file to which the merge
1077         tool should write the results of a successful merge.
1079 mergetool.<tool>.trustExitCode::
1080         For a custom merge command, specify whether the exit code of
1081         the merge command can be used to determine whether the merge was
1082         successful.  If this is not set to true then the merge target file
1083         timestamp is checked and the merge assumed to have been successful
1084         if the file has been updated, otherwise the user is prompted to
1085         indicate the success of the merge.
1087 mergetool.keepBackup::
1088         After performing a merge, the original file with conflict markers
1089         can be saved as a file with a `.orig` extension.  If this variable
1090         is set to `false` then this file is not preserved.  Defaults to
1091         `true` (i.e. keep the backup files).
1093 mergetool.keepTemporaries::
1094         When invoking a custom merge tool, git uses a set of temporary
1095         files to pass to the tool. If the tool returns an error and this
1096         variable is set to `true`, then these temporary files will be
1097         preserved, otherwise they will be removed after the tool has
1098         exited. Defaults to `false`.
1100 mergetool.prompt::
1101         Prompt before each invocation of the merge resolution program.
1103 pack.window::
1104         The size of the window used by linkgit:git-pack-objects[1] when no
1105         window size is given on the command line. Defaults to 10.
1107 pack.depth::
1108         The maximum delta depth used by linkgit:git-pack-objects[1] when no
1109         maximum depth is given on the command line. Defaults to 50.
1111 pack.windowMemory::
1112         The window memory size limit used by linkgit:git-pack-objects[1]
1113         when no limit is given on the command line.  The value can be
1114         suffixed with "k", "m", or "g".  Defaults to 0, meaning no
1115         limit.
1117 pack.compression::
1118         An integer -1..9, indicating the compression level for objects
1119         in a pack file. -1 is the zlib default. 0 means no
1120         compression, and 1..9 are various speed/size tradeoffs, 9 being
1121         slowest.  If not set,  defaults to core.compression.  If that is
1122         not set,  defaults to -1, the zlib default, which is "a default
1123         compromise between speed and compression (currently equivalent
1124         to level 6)."
1126 pack.deltaCacheSize::
1127         The maximum memory in bytes used for caching deltas in
1128         linkgit:git-pack-objects[1].
1129         A value of 0 means no limit. Defaults to 0.
1131 pack.deltaCacheLimit::
1132         The maximum size of a delta, that is cached in
1133         linkgit:git-pack-objects[1]. Defaults to 1000.
1135 pack.threads::
1136         Specifies the number of threads to spawn when searching for best
1137         delta matches.  This requires that linkgit:git-pack-objects[1]
1138         be compiled with pthreads otherwise this option is ignored with a
1139         warning. This is meant to reduce packing time on multiprocessor
1140         machines. The required amount of memory for the delta search window
1141         is however multiplied by the number of threads.
1142         Specifying 0 will cause git to auto-detect the number of CPU's
1143         and set the number of threads accordingly.
1145 pack.indexVersion::
1146         Specify the default pack index version.  Valid values are 1 for
1147         legacy pack index used by Git versions prior to 1.5.2, and 2 for
1148         the new pack index with capabilities for packs larger than 4 GB
1149         as well as proper protection against the repacking of corrupted
1150         packs.  Version 2 is the default.  Note that version 2 is enforced
1151         and this config option ignored whenever the corresponding pack is
1152         larger than 2 GB.
1154 If you have an old git that does not understand the version 2 `{asterisk}.idx` file,
1155 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1156 that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the
1157 other side may give you a repository that cannot be accessed with your
1158 older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,
1159 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1160 the `{asterisk}.idx` file.
1162 pack.packSizeLimit::
1163         The default maximum size of a pack.  This setting only affects
1164         packing to a file, i.e. the git:// protocol is unaffected.  It
1165         can be overridden by the `\--max-pack-size` option of
1166         linkgit:git-repack[1].
1168 pager.<cmd>::
1169         Allows turning on or off pagination of the output of a
1170         particular git subcommand when writing to a tty.  If
1171         `\--paginate` or `\--no-pager` is specified on the command line,
1172         it takes precedence over this option.  To disable pagination for
1173         all commands, set `core.pager` or 'GIT_PAGER' to "`cat`".
1175 pull.octopus::
1176         The default merge strategy to use when pulling multiple branches
1177         at once.
1179 pull.twohead::
1180         The default merge strategy to use when pulling a single branch.
1182 receive.fsckObjects::
1183         If it is set to true, git-receive-pack will check all received
1184         objects. It will abort in the case of a malformed object or a
1185         broken link. The result of an abort are only dangling objects.
1186         Defaults to false.
1188 receive.unpackLimit::
1189         If the number of objects received in a push is below this
1190         limit then the objects will be unpacked into loose object
1191         files. However if the number of received objects equals or
1192         exceeds this limit then the received pack will be stored as
1193         a pack, after adding any missing delta bases.  Storing the
1194         pack from a push can make the push operation complete faster,
1195         especially on slow filesystems.  If not set, the value of
1196         `transfer.unpackLimit` is used instead.
1198 receive.denyDeletes::
1199         If set to true, git-receive-pack will deny a ref update that deletes
1200         the ref. Use this to prevent such a ref deletion via a push.
1202 receive.denyCurrentBranch::
1203         If set to true or "refuse", receive-pack will deny a ref update
1204         to the currently checked out branch of a non-bare repository.
1205         Such a push is potentially dangerous because it brings the HEAD
1206         out of sync with the index and working tree. If set to "warn",
1207         print a warning of such a push to stderr, but allow the push to
1208         proceed. If set to false or "ignore", allow such pushes with no
1209         message. Defaults to "warn".
1211 receive.denyNonFastForwards::
1212         If set to true, git-receive-pack will deny a ref update which is
1213         not a fast forward. Use this to prevent such an update via a push,
1214         even if that push is forced. This configuration variable is
1215         set when initializing a shared repository.
1217 remote.<name>.url::
1218         The URL of a remote repository.  See linkgit:git-fetch[1] or
1219         linkgit:git-push[1].
1221 remote.<name>.proxy::
1222         For remotes that require curl (http, https and ftp), the URL to
1223         the proxy to use for that remote.  Set to the empty string to
1224         disable proxying for that remote.
1226 remote.<name>.fetch::
1227         The default set of "refspec" for linkgit:git-fetch[1]. See
1228         linkgit:git-fetch[1].
1230 remote.<name>.push::
1231         The default set of "refspec" for linkgit:git-push[1]. See
1232         linkgit:git-push[1].
1234 remote.<name>.mirror::
1235         If true, pushing to this remote will automatically behave
1236         as if the `\--mirror` option was given on the command line.
1238 remote.<name>.skipDefaultUpdate::
1239         If true, this remote will be skipped by default when updating
1240         using the update subcommand of linkgit:git-remote[1].
1242 remote.<name>.receivepack::
1243         The default program to execute on the remote side when pushing.  See
1244         option \--receive-pack of linkgit:git-push[1].
1246 remote.<name>.uploadpack::
1247         The default program to execute on the remote side when fetching.  See
1248         option \--upload-pack of linkgit:git-fetch-pack[1].
1250 remote.<name>.tagopt::
1251         Setting this value to \--no-tags disables automatic tag following when
1252         fetching from remote <name>
1254 remotes.<group>::
1255         The list of remotes which are fetched by "git remote update
1256         <group>".  See linkgit:git-remote[1].
1258 repack.usedeltabaseoffset::
1259         By default, linkgit:git-repack[1] creates packs that use
1260         delta-base offset. If you need to share your repository with
1261         git older than version 1.4.4, either directly or via a dumb
1262         protocol such as http, then you need to set this option to
1263         "false" and repack. Access from old git versions over the
1264         native protocol are unaffected by this option.
1266 rerere.autoupdate::
1267         When set to true, `git-rerere` updates the index with the
1268         resulting contents after it cleanly resolves conflicts using
1269         previously recorded resolution.  Defaults to false.
1271 rerere.enabled::
1272         Activate recording of resolved conflicts, so that identical
1273         conflict hunks can be resolved automatically, should they
1274         be encountered again.  linkgit:git-rerere[1] command is by
1275         default enabled if you create `rr-cache` directory under
1276         `$GIT_DIR`, but can be disabled by setting this option to false.
1278 showbranch.default::
1279         The default set of branches for linkgit:git-show-branch[1].
1280         See linkgit:git-show-branch[1].
1282 status.relativePaths::
1283         By default, linkgit:git-status[1] shows paths relative to the
1284         current directory. Setting this variable to `false` shows paths
1285         relative to the repository root (this was the default for git
1286         prior to v1.5.4).
1288 status.showUntrackedFiles::
1289         By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1290         files which are not currently tracked by Git. Directories which
1291         contain only untracked files, are shown with the directory name
1292         only. Showing untracked files means that Git needs to lstat() all
1293         all the files in the whole repository, which might be slow on some
1294         systems. So, this variable controls how the commands displays
1295         the untracked files. Possible values are:
1298         - 'no'     - Show no untracked files
1299         - 'normal' - Shows untracked files and directories
1300         - 'all'    - Shows also individual files in untracked directories.
1303 If this variable is not specified, it defaults to 'normal'.
1304 This variable can be overridden with the -u|--untracked-files option
1305 of linkgit:git-status[1] and linkgit:git-commit[1].
1307 tar.umask::
1308         This variable can be used to restrict the permission bits of
1309         tar archive entries.  The default is 0002, which turns off the
1310         world write bit.  The special value "user" indicates that the
1311         archiving user's umask will be used instead.  See umask(2) and
1312         linkgit:git-archive[1].
1314 transfer.unpackLimit::
1315         When `fetch.unpackLimit` or `receive.unpackLimit` are
1316         not set, the value of this variable is used instead.
1317         The default value is 100.
1319 url.<base>.insteadOf::
1320         Any URL that starts with this value will be rewritten to
1321         start, instead, with <base>. In cases where some site serves a
1322         large number of repositories, and serves them with multiple
1323         access methods, and some users need to use different access
1324         methods, this feature allows people to specify any of the
1325         equivalent URLs and have git automatically rewrite the URL to
1326         the best alternative for the particular user, even for a
1327         never-before-seen repository on the site.  When more than one
1328         insteadOf strings match a given URL, the longest match is used.
1330 user.email::
1331         Your email address to be recorded in any newly created commits.
1332         Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
1333         'EMAIL' environment variables.  See linkgit:git-commit-tree[1].
1335 user.name::
1336         Your full name to be recorded in any newly created commits.
1337         Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
1338         environment variables.  See linkgit:git-commit-tree[1].
1340 user.signingkey::
1341         If linkgit:git-tag[1] is not selecting the key you want it to
1342         automatically when creating a signed tag, you can override the
1343         default selection with this variable.  This option is passed
1344         unchanged to gpg's --local-user parameter, so you may specify a key
1345         using any method that gpg supports.
1347 web.browser::
1348         Specify a web browser that may be used by some commands.
1349         Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
1350         may use it.