documentation: help: add "man.<tool>.path" config variable
[git/jnareb-git.git] / Documentation / config.txt
blob138ba9ad8f51665981f231525cbfdf657b2020db
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/gnu-diff -u"
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.quotepath::
121         The commands that output paths (e.g. `ls-files`,
122         `diff`), when not given the `-z` option, will quote
123         "unusual" characters in the pathname by enclosing the
124         pathname in a double-quote pair and with backslashes the
125         same way strings in C source code are quoted.  If this
126         variable is set to false, the bytes higher than 0x80 are
127         not quoted but output as verbatim.  Note that double
128         quote, backslash and control characters are always
129         quoted without `-z` regardless of the setting of this
130         variable.
132 core.autocrlf::
133         If true, makes git convert `CRLF` at the end of lines in text files to
134         `LF` when reading from the filesystem, and convert in reverse when
135         writing to the filesystem.  The variable can be set to
136         'input', in which case the conversion happens only while
137         reading from the filesystem but files are written out with
138         `LF` at the end of lines.  Currently, which paths to consider
139         "text" (i.e. be subjected to the autocrlf mechanism) is
140         decided purely based on the contents.
142 core.safecrlf::
143         If true, makes git check if converting `CRLF` as controlled by
144         `core.autocrlf` is reversible.  Git will verify if a command
145         modifies a file in the work tree either directly or indirectly.
146         For example, committing a file followed by checking out the
147         same file should yield the original file in the work tree.  If
148         this is not the case for the current setting of
149         `core.autocrlf`, git will reject the file.  The variable can
150         be set to "warn", in which case git will only warn about an
151         irreversible conversion but continue the operation.
153 CRLF conversion bears a slight chance of corrupting data.
154 autocrlf=true will convert CRLF to LF during commit and LF to
155 CRLF during checkout.  A file that contains a mixture of LF and
156 CRLF before the commit cannot be recreated by git.  For text
157 files this is the right thing to do: it corrects line endings
158 such that we have only LF line endings in the repository.
159 But for binary files that are accidentally classified as text the
160 conversion can corrupt data.
162 If you recognize such corruption early you can easily fix it by
163 setting the conversion type explicitly in .gitattributes.  Right
164 after committing you still have the original file in your work
165 tree and this file is not yet corrupted.  You can explicitly tell
166 git that this file is binary and git will handle the file
167 appropriately.
169 Unfortunately, the desired effect of cleaning up text files with
170 mixed line endings and the undesired effect of corrupting binary
171 files cannot be distinguished.  In both cases CRLFs are removed
172 in an irreversible way.  For text files this is the right thing
173 to do because CRLFs are line endings, while for binary files
174 converting CRLFs corrupts data.
176 Note, this safety check does not mean that a checkout will generate a
177 file identical to the original file for a different setting of
178 `core.autocrlf`, but only for the current one.  For example, a text
179 file with `LF` would be accepted with `core.autocrlf=input` and could
180 later be checked out with `core.autocrlf=true`, in which case the
181 resulting file would contain `CRLF`, although the original file
182 contained `LF`.  However, in both work trees the line endings would be
183 consistent, that is either all `LF` or all `CRLF`, but never mixed.  A
184 file with mixed line endings would be reported by the `core.safecrlf`
185 mechanism.
187 core.symlinks::
188         If false, symbolic links are checked out as small plain files that
189         contain the link text. linkgit:git-update-index[1] and
190         linkgit:git-add[1] will not change the recorded type to regular
191         file. Useful on filesystems like FAT that do not support
192         symbolic links. True by default.
194 core.gitProxy::
195         A "proxy command" to execute (as 'command host port') instead
196         of establishing direct connection to the remote server when
197         using the git protocol for fetching. If the variable value is
198         in the "COMMAND for DOMAIN" format, the command is applied only
199         on hostnames ending with the specified domain string. This variable
200         may be set multiple times and is matched in the given order;
201         the first match wins.
203 Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
204 (which always applies universally, without the special "for"
205 handling).
207 core.ignoreStat::
208         The working copy files are assumed to stay unchanged until you
209         mark them otherwise manually - Git will not detect the file changes
210         by lstat() calls. This is useful on systems where those are very
211         slow, such as Microsoft Windows.  See linkgit:git-update-index[1].
212         False by default.
214 core.preferSymlinkRefs::
215         Instead of the default "symref" format for HEAD
216         and other symbolic reference files, use symbolic links.
217         This is sometimes needed to work with old scripts that
218         expect HEAD to be a symbolic link.
220 core.bare::
221         If true this repository is assumed to be 'bare' and has no
222         working directory associated with it.  If this is the case a
223         number of commands that require a working directory will be
224         disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
226 This setting is automatically guessed by linkgit:git-clone[1] or
227 linkgit:git-init[1] when the repository was created.  By default a
228 repository that ends in "/.git" is assumed to be not bare (bare =
229 false), while all other repositories are assumed to be bare (bare
230 = true).
232 core.worktree::
233         Set the path to the working tree.  The value will not be
234         used in combination with repositories found automatically in
235         a .git directory (i.e. $GIT_DIR is not set).
236         This can be overridden by the GIT_WORK_TREE environment
237         variable and the '--work-tree' command line option.
239 core.logAllRefUpdates::
240         Enable the reflog. Updates to a ref <ref> is logged to the file
241         "$GIT_DIR/logs/<ref>", by appending the new and old
242         SHA1, the date/time and the reason of the update, but
243         only when the file exists.  If this configuration
244         variable is set to true, missing "$GIT_DIR/logs/<ref>"
245         file is automatically created for branch heads.
247 This information can be used to determine what commit
248 was the tip of a branch "2 days ago".
250 This value is true by default in a repository that has
251 a working directory associated with it, and false by
252 default in a bare repository.
254 core.repositoryFormatVersion::
255         Internal variable identifying the repository format and layout
256         version.
258 core.sharedRepository::
259         When 'group' (or 'true'), the repository is made shareable between
260         several users in a group (making sure all the files and objects are
261         group-writable). When 'all' (or 'world' or 'everybody'), the
262         repository will be readable by all users, additionally to being
263         group-shareable. When 'umask' (or 'false'), git will use permissions
264         reported by umask(2). When '0xxx', where '0xxx' is an octal number,
265         files in the repository will have this mode value. '0xxx' will override
266         user's umask value, and thus, users with a safe umask (0077) can use
267         this option. Examples: '0660' is equivalent to 'group'. '0640' is a
268         repository that is group-readable but not group-writable.
269         See linkgit:git-init[1]. False by default.
271 core.warnAmbiguousRefs::
272         If true, git will warn you if the ref name you passed it is ambiguous
273         and might match multiple refs in the .git/refs/ tree. True by default.
275 core.compression::
276         An integer -1..9, indicating a default compression level.
277         -1 is the zlib default. 0 means no compression,
278         and 1..9 are various speed/size tradeoffs, 9 being slowest.
279         If set, this provides a default to other compression variables,
280         such as 'core.loosecompression' and 'pack.compression'.
282 core.loosecompression::
283         An integer -1..9, indicating the compression level for objects that
284         are not in a pack file. -1 is the zlib default. 0 means no
285         compression, and 1..9 are various speed/size tradeoffs, 9 being
286         slowest.  If not set,  defaults to core.compression.  If that is
287         not set,  defaults to 1 (best speed).
289 core.packedGitWindowSize::
290         Number of bytes of a pack file to map into memory in a
291         single mapping operation.  Larger window sizes may allow
292         your system to process a smaller number of large pack files
293         more quickly.  Smaller window sizes will negatively affect
294         performance due to increased calls to the operating system's
295         memory manager, but may improve performance when accessing
296         a large number of large pack files.
298 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
299 MiB on 32 bit platforms and 1 GiB on 64 bit platforms.  This should
300 be reasonable for all users/operating systems.  You probably do
301 not need to adjust this value.
303 Common unit suffixes of 'k', 'm', or 'g' are supported.
305 core.packedGitLimit::
306         Maximum number of bytes to map simultaneously into memory
307         from pack files.  If Git needs to access more than this many
308         bytes at once to complete an operation it will unmap existing
309         regions to reclaim virtual address space within the process.
311 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
312 This should be reasonable for all users/operating systems, except on
313 the largest projects.  You probably do not need to adjust this value.
315 Common unit suffixes of 'k', 'm', or 'g' are supported.
317 core.deltaBaseCacheLimit::
318         Maximum number of bytes to reserve for caching base objects
319         that multiple deltafied objects reference.  By storing the
320         entire decompressed base objects in a cache Git is able
321         to avoid unpacking and decompressing frequently used base
322         objects multiple times.
324 Default is 16 MiB on all platforms.  This should be reasonable
325 for all users/operating systems, except on the largest projects.
326 You probably do not need to adjust this value.
328 Common unit suffixes of 'k', 'm', or 'g' are supported.
330 core.excludesfile::
331         In addition to '.gitignore' (per-directory) and
332         '.git/info/exclude', git looks into this file for patterns
333         of files which are not meant to be tracked.  See
334         linkgit:gitignore[5].
336 core.editor::
337         Commands such as `commit` and `tag` that lets you edit
338         messages by launching an editor uses the value of this
339         variable when it is set, and the environment variable
340         `GIT_EDITOR` is not set.  The order of preference is
341         `GIT_EDITOR` environment, `core.editor`, `VISUAL` and
342         `EDITOR` environment variables and then finally `vi`.
344 core.pager::
345         The command that git will use to paginate output.  Can be overridden
346         with the `GIT_PAGER` environment variable.
348 core.whitespace::
349         A comma separated list of common whitespace problems to
350         notice.  `git diff` will use `color.diff.whitespace` to
351         highlight them, and `git apply --whitespace=error` will
352         consider them as errors:
354 * `trailing-space` treats trailing whitespaces at the end of the line
355   as an error (enabled by default).
356 * `space-before-tab` treats a space character that appears immediately
357   before a tab character in the initial indent part of the line as an
358   error (enabled by default).
359 * `indent-with-non-tab` treats a line that is indented with 8 or more
360   space characters as an error (not enabled by default).
361 * `cr-at-eol` treats a carriage-return at the end of line as
362   part of the line terminator, i.e. with it, `trailing-space`
363   does not trigger if the character before such a carriage-return
364   is not a whitespace (not enabled by default).
366 alias.*::
367         Command aliases for the linkgit:git[1] command wrapper - e.g.
368         after defining "alias.last = cat-file commit HEAD", the invocation
369         "git last" is equivalent to "git cat-file commit HEAD". To avoid
370         confusion and troubles with script usage, aliases that
371         hide existing git commands are ignored. Arguments are split by
372         spaces, the usual shell quoting and escaping is supported.
373         quote pair and a backslash can be used to quote them.
375 If the alias expansion is prefixed with an exclamation point,
376 it will be treated as a shell command.  For example, defining
377 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
378 "git new" is equivalent to running the shell command
379 "gitk --all --not ORIG_HEAD".
381 apply.whitespace::
382         Tells `git-apply` how to handle whitespaces, in the same way
383         as the '--whitespace' option. See linkgit:git-apply[1].
385 branch.autosetupmerge::
386         Tells `git-branch` and `git-checkout` to setup new branches
387         so that linkgit:git-pull[1] will appropriately merge from the
388         starting point branch. Note that even if this option is not set,
389         this behavior can be chosen per-branch using the `--track`
390         and `--no-track` options. The valid settings are: `false` -- no
391         automatic setup is done; `true` -- automatic setup is done when the
392         starting point is a remote branch; `always` -- automatic setup is
393         done when the starting point is either a local branch or remote
394         branch. This option defaults to true.
396 branch.<name>.remote::
397         When in branch <name>, it tells `git fetch` which remote to fetch.
398         If this option is not given, `git fetch` defaults to remote "origin".
400 branch.<name>.merge::
401         When in branch <name>, it tells `git fetch` the default
402         refspec to be marked for merging in FETCH_HEAD. The value is
403         handled like the remote part of a refspec, and must match a
404         ref which is fetched from the remote given by
405         "branch.<name>.remote".
406         The merge information is used by `git pull` (which at first calls
407         `git fetch`) to lookup the default branch for merging. Without
408         this option, `git pull` defaults to merge the first refspec fetched.
409         Specify multiple values to get an octopus merge.
410         If you wish to setup `git pull` so that it merges into <name> from
411         another branch in the local repository, you can point
412         branch.<name>.merge to the desired branch, and use the special setting
413         `.` (a period) for branch.<name>.remote.
415 branch.<name>.mergeoptions::
416         Sets default options for merging into branch <name>. The syntax and
417         supported options are equal to that of linkgit:git-merge[1], but
418         option values containing whitespace characters are currently not
419         supported.
421 branch.<name>.rebase::
422         When true, rebase the branch <name> on top of the fetched branch,
423         instead of merging the default branch from the default remote.
424         *NOTE*: this is a possibly dangerous operation; do *not* use
425         it unless you understand the implications (see linkgit:git-rebase[1]
426         for details).
428 browser.<tool>.cmd::
429         Specify the command to invoke the specified browser. The
430         specified command is evaluated in shell with the URLs passed
431         as arguments. (See linkgit:git-web--browse[1].)
433 browser.<tool>.path::
434         Override the path for the given tool that may be used to
435         browse HTML help (see '-w' option in linkgit:git-help[1]) or a
436         working repository in gitweb (see linkgit:git-instaweb[1]).
438 clean.requireForce::
439         A boolean to make git-clean do nothing unless given -f
440         or -n.   Defaults to true.
442 color.branch::
443         A boolean to enable/disable color in the output of
444         linkgit:git-branch[1]. May be set to `always`,
445         `false` (or `never`) or `auto` (or `true`), in which case colors are used
446         only when the output is to a terminal. Defaults to false.
448 color.branch.<slot>::
449         Use customized color for branch coloration. `<slot>` is one of
450         `current` (the current branch), `local` (a local branch),
451         `remote` (a tracking branch in refs/remotes/), `plain` (other
452         refs).
454 The value for these configuration variables is a list of colors (at most
455 two) and attributes (at most one), separated by spaces.  The colors
456 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
457 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
458 `blink` and `reverse`.  The first color given is the foreground; the
459 second is the background.  The position of the attribute, if any,
460 doesn't matter.
462 color.diff::
463         When set to `always`, always use colors in patch.
464         When false (or `never`), never.  When set to `true` or `auto`, use
465         colors only when the output is to the terminal. Defaults to false.
467 color.diff.<slot>::
468         Use customized color for diff colorization.  `<slot>` specifies
469         which part of the patch to use the specified color, and is one
470         of `plain` (context text), `meta` (metainformation), `frag`
471         (hunk header), `old` (removed lines), `new` (added lines),
472         `commit` (commit headers), or `whitespace` (highlighting
473         whitespace errors). The values of these variables may be specified as
474         in color.branch.<slot>.
476 color.interactive::
477         When set to `always`, always use colors for interactive prompts
478         and displays (such as those used by "git add --interactive").
479         When false (or `never`), never.  When set to `true` or `auto`, use
480         colors only when the output is to the terminal. Defaults to false.
482 color.interactive.<slot>::
483         Use customized color for `git add --interactive`
484         output. `<slot>` may be `prompt`, `header`, or `help`, for
485         three distinct types of normal output from interactive
486         programs.  The values of these variables may be specified as
487         in color.branch.<slot>.
489 color.pager::
490         A boolean to enable/disable colored output when the pager is in
491         use (default is true).
493 color.status::
494         A boolean to enable/disable color in the output of
495         linkgit:git-status[1]. May be set to `always`,
496         `false` (or `never`) or `auto` (or `true`), in which case colors are used
497         only when the output is to a terminal. Defaults to false.
499 color.status.<slot>::
500         Use customized color for status colorization. `<slot>` is
501         one of `header` (the header text of the status message),
502         `added` or `updated` (files which are added but not committed),
503         `changed` (files which are changed but not added in the index),
504         or `untracked` (files which are not tracked by git). The values of
505         these variables may be specified as in color.branch.<slot>.
507 commit.template::
508         Specify a file to use as the template for new commit messages.
510 color.ui::
511         When set to `always`, always use colors in all git commands which
512         are capable of colored output. When false (or `never`), never. When
513         set to `true` or `auto`, use colors only when the output is to the
514         terminal. When more specific variables of color.* are set, they always
515         take precedence over this setting. Defaults to false.
517 diff.autorefreshindex::
518         When using `git diff` to compare with work tree
519         files, do not consider stat-only change as changed.
520         Instead, silently run `git update-index --refresh` to
521         update the cached stat information for paths whose
522         contents in the work tree match the contents in the
523         index.  This option defaults to true.  Note that this
524         affects only `git diff` Porcelain, and not lower level
525         `diff` commands, such as `git diff-files`.
527 diff.external::
528         If this config variable is set, diff generation is not
529         performed using the internal diff machinery, but using the
530         given command.  Note: if you want to use an external diff
531         program only on a subset of your files, you might want to
532         use linkgit:gitattributes[5] instead.
534 diff.renameLimit::
535         The number of files to consider when performing the copy/rename
536         detection; equivalent to the git diff option '-l'.
538 diff.renames::
539         Tells git to detect renames.  If set to any boolean value, it
540         will enable basic rename detection.  If set to "copies" or
541         "copy", it will detect copies, as well.
543 fetch.unpackLimit::
544         If the number of objects fetched over the git native
545         transfer is below this
546         limit, then the objects will be unpacked into loose object
547         files. However if the number of received objects equals or
548         exceeds this limit then the received pack will be stored as
549         a pack, after adding any missing delta bases.  Storing the
550         pack from a push can make the push operation complete faster,
551         especially on slow filesystems.  If not set, the value of
552         `transfer.unpackLimit` is used instead.
554 format.numbered::
555         A boolean which can enable sequence numbers in patch subjects.
556         Setting this option to "auto" will enable it only if there is
557         more than one patch.  See --numbered option in
558         linkgit:git-format-patch[1].
560 format.headers::
561         Additional email headers to include in a patch to be submitted
562         by mail.  See linkgit:git-format-patch[1].
564 format.suffix::
565         The default for format-patch is to output files with the suffix
566         `.patch`. Use this variable to change that suffix (make sure to
567         include the dot if you want it).
569 format.pretty::
570         The default pretty format for log/show/whatchanged command,
571         See linkgit:git-log[1], linkgit:git-show[1],
572         linkgit:git-whatchanged[1].
574 gc.aggressiveWindow::
575         The window size parameter used in the delta compression
576         algorithm used by 'git gc --aggressive'.  This defaults
577         to 10.
579 gc.auto::
580         When there are approximately more than this many loose
581         objects in the repository, `git gc --auto` will pack them.
582         Some Porcelain commands use this command to perform a
583         light-weight garbage collection from time to time.  The
584         default value is 6700.  Setting this to 0 disables it.
586 gc.autopacklimit::
587         When there are more than this many packs that are not
588         marked with `*.keep` file in the repository, `git gc
589         --auto` consolidates them into one larger pack.  The
590         default value is 50.  Setting this to 0 disables it.
592 gc.packrefs::
593         `git gc` does not run `git pack-refs` in a bare repository by
594         default so that older dumb-transport clients can still fetch
595         from the repository.  Setting this to `true` lets `git
596         gc` to run `git pack-refs`.  Setting this to `false` tells
597         `git gc` never to run `git pack-refs`. The default setting is
598         `notbare`. Enable it only when you know you do not have to
599         support such clients.  The default setting will change to `true`
600         at some stage, and setting this to `false` will continue to
601         prevent `git pack-refs` from being run from `git gc`.
603 gc.pruneexpire::
604         When `git gc` is run, it will call `prune --expire 2.weeks.ago`.
605         Override the grace period with this config variable.
607 gc.reflogexpire::
608         `git reflog expire` removes reflog entries older than
609         this time; defaults to 90 days.
611 gc.reflogexpireunreachable::
612         `git reflog expire` removes reflog entries older than
613         this time and are not reachable from the current tip;
614         defaults to 30 days.
616 gc.rerereresolved::
617         Records of conflicted merge you resolved earlier are
618         kept for this many days when `git rerere gc` is run.
619         The default is 60 days.  See linkgit:git-rerere[1].
621 gc.rerereunresolved::
622         Records of conflicted merge you have not resolved are
623         kept for this many days when `git rerere gc` is run.
624         The default is 15 days.  See linkgit:git-rerere[1].
626 rerere.enabled::
627         Activate recording of resolved conflicts, so that identical
628         conflict hunks can be resolved automatically, should they
629         be encountered again.  linkgit:git-rerere[1] command is by
630         default enabled if you create `rr-cache` directory under
631         `$GIT_DIR`, but can be disabled by setting this option to false.
633 gitcvs.enabled::
634         Whether the CVS server interface is enabled for this repository.
635         See linkgit:git-cvsserver[1].
637 gitcvs.logfile::
638         Path to a log file where the CVS server interface well... logs
639         various stuff. See linkgit:git-cvsserver[1].
641 gitcvs.allbinary::
642         If true, all files are sent to the client in mode '-kb'. This
643         causes the client to treat all files as binary files which suppresses
644         any newline munging it otherwise might do. A work-around for the
645         fact that there is no way yet to set single files to mode '-kb'.
647 gitcvs.dbname::
648         Database used by git-cvsserver to cache revision information
649         derived from the git repository. The exact meaning depends on the
650         used database driver, for SQLite (which is the default driver) this
651         is a filename. Supports variable substitution (see
652         linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
653         Default: '%Ggitcvs.%m.sqlite'
655 gitcvs.dbdriver::
656         Used Perl DBI driver. You can specify any available driver
657         for this here, but it might not work. git-cvsserver is tested
658         with 'DBD::SQLite', reported to work with 'DBD::Pg', and
659         reported *not* to work with 'DBD::mysql'. Experimental feature.
660         May not contain double colons (`:`). Default: 'SQLite'.
661         See linkgit:git-cvsserver[1].
663 gitcvs.dbuser, gitcvs.dbpass::
664         Database user and password. Only useful if setting 'gitcvs.dbdriver',
665         since SQLite has no concept of database users and/or passwords.
666         'gitcvs.dbuser' supports variable substitution (see
667         linkgit:git-cvsserver[1] for details).
669 gitcvs.dbTableNamePrefix::
670         Database table name prefix.  Prepended to the names of any
671         database tables used, allowing a single database to be used
672         for several repositories.  Supports variable substitution (see
673         linkgit:git-cvsserver[1] for details).  Any non-alphabetic
674         characters will be replaced with underscores.
676 All gitcvs variables except for 'gitcvs.allbinary' can also be
677 specified as 'gitcvs.<access_method>.<varname>' (where 'access_method'
678 is one of "ext" and "pserver") to make them apply only for the given
679 access method.
681 help.browser::
682         Specify the browser that will be used to display help in the
683         'web' format. See linkgit:git-help[1].
685 help.format::
686         Override the default help format used by linkgit:git-help[1].
687         Values 'man', 'info', 'web' and 'html' are supported. 'man' is
688         the default. 'web' and 'html' are the same.
690 http.proxy::
691         Override the HTTP proxy, normally configured using the 'http_proxy'
692         environment variable (see linkgit:curl[1]).  This can be overridden
693         on a per-remote basis; see remote.<name>.proxy
695 http.sslVerify::
696         Whether to verify the SSL certificate when fetching or pushing
697         over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
698         variable.
700 http.sslCert::
701         File containing the SSL certificate when fetching or pushing
702         over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
703         variable.
705 http.sslKey::
706         File containing the SSL private key when fetching or pushing
707         over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
708         variable.
710 http.sslCAInfo::
711         File containing the certificates to verify the peer with when
712         fetching or pushing over HTTPS. Can be overridden by the
713         'GIT_SSL_CAINFO' environment variable.
715 http.sslCAPath::
716         Path containing files with the CA certificates to verify the peer
717         with when fetching or pushing over HTTPS. Can be overridden
718         by the 'GIT_SSL_CAPATH' environment variable.
720 http.maxRequests::
721         How many HTTP requests to launch in parallel. Can be overridden
722         by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
724 http.lowSpeedLimit, http.lowSpeedTime::
725         If the HTTP transfer speed is less than 'http.lowSpeedLimit'
726         for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
727         Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
728         'GIT_HTTP_LOW_SPEED_TIME' environment variables.
730 http.noEPSV::
731         A boolean which disables using of EPSV ftp command by curl.
732         This can helpful with some "poor" ftp servers which don't
733         support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
734         environment variable. Default is false (curl will use EPSV).
736 i18n.commitEncoding::
737         Character encoding the commit messages are stored in; git itself
738         does not care per se, but this information is necessary e.g. when
739         importing commits from emails or in the gitk graphical history
740         browser (and possibly at other places in the future or in other
741         porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
743 i18n.logOutputEncoding::
744         Character encoding the commit messages are converted to when
745         running `git-log` and friends.
747 instaweb.browser::
748         Specify the program that will be used to browse your working
749         repository in gitweb. See linkgit:git-instaweb[1].
751 instaweb.httpd::
752         The HTTP daemon command-line to start gitweb on your working
753         repository. See linkgit:git-instaweb[1].
755 instaweb.local::
756         If true the web server started by linkgit:git-instaweb[1] will
757         be bound to the local IP (127.0.0.1).
759 instaweb.modulepath::
760         The module path for an apache httpd used by linkgit:git-instaweb[1].
762 instaweb.port::
763         The port number to bind the gitweb httpd to. See
764         linkgit:git-instaweb[1].
766 log.showroot::
767         If true, the initial commit will be shown as a big creation event.
768         This is equivalent to a diff against an empty tree.
769         Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
770         normally hide the root commit will now show it. True by default.
772 man.viewer::
773         Specify the programs that may be used to display help in the
774         'man' format. See linkgit:git-help[1].
776 merge.summary::
777         Whether to include summaries of merged commits in newly created
778         merge commit messages. False by default.
780 merge.tool::
781         Controls which merge resolution program is used by
782         linkgit:git-mergetool[1].  Valid built-in values are: "kdiff3",
783         "tkdiff", "meld", "xxdiff", "emerge", "vimdiff", "gvimdiff", and
784         "opendiff".  Any other value is treated is custom merge tool
785         and there must be a corresponing mergetool.<tool>.cmd option.
787 merge.verbosity::
788         Controls the amount of output shown by the recursive merge
789         strategy.  Level 0 outputs nothing except a final error
790         message if conflicts were detected. Level 1 outputs only
791         conflicts, 2 outputs conflicts and file changes.  Level 5 and
792         above outputs debugging information.  The default is level 2.
793         Can be overridden by 'GIT_MERGE_VERBOSITY' environment variable.
795 merge.<driver>.name::
796         Defines a human readable name for a custom low-level
797         merge driver.  See linkgit:gitattributes[5] for details.
799 merge.<driver>.driver::
800         Defines the command that implements a custom low-level
801         merge driver.  See linkgit:gitattributes[5] for details.
803 merge.<driver>.recursive::
804         Names a low-level merge driver to be used when
805         performing an internal merge between common ancestors.
806         See linkgit:gitattributes[5] for details.
808 man.<tool>.path::
809         Override the path for the given tool that may be used to
810         display help in the 'man' format. See linkgit:git-help[1].
812 mergetool.<tool>.path::
813         Override the path for the given tool.  This is useful in case
814         your tool is not in the PATH.
816 mergetool.<tool>.cmd::
817         Specify the command to invoke the specified merge tool.  The
818         specified command is evaluated in shell with the following
819         variables available: 'BASE' is the name of a temporary file
820         containing the common base of the files to be merged, if available;
821         'LOCAL' is the name of a temporary file containing the contents of
822         the file on the current branch; 'REMOTE' is the name of a temporary
823         file containing the contents of the file from the branch being
824         merged; 'MERGED' contains the name of the file to which the merge
825         tool should write the results of a successful merge.
827 mergetool.<tool>.trustExitCode::
828         For a custom merge command, specify whether the exit code of
829         the merge command can be used to determine whether the merge was
830         successful.  If this is not set to true then the merge target file
831         timestamp is checked and the merge assumed to have been successful
832         if the file has been updated, otherwise the user is prompted to
833         indicate the success of the merge.
835 mergetool.keepBackup::
836         After performing a merge, the original file with conflict markers
837         can be saved as a file with a `.orig` extension.  If this variable
838         is set to `false` then this file is not preserved.  Defaults to
839         `true` (i.e. keep the backup files).
841 pack.window::
842         The size of the window used by linkgit:git-pack-objects[1] when no
843         window size is given on the command line. Defaults to 10.
845 pack.depth::
846         The maximum delta depth used by linkgit:git-pack-objects[1] when no
847         maximum depth is given on the command line. Defaults to 50.
849 pack.windowMemory::
850         The window memory size limit used by linkgit:git-pack-objects[1]
851         when no limit is given on the command line.  The value can be
852         suffixed with "k", "m", or "g".  Defaults to 0, meaning no
853         limit.
855 pack.compression::
856         An integer -1..9, indicating the compression level for objects
857         in a pack file. -1 is the zlib default. 0 means no
858         compression, and 1..9 are various speed/size tradeoffs, 9 being
859         slowest.  If not set,  defaults to core.compression.  If that is
860         not set,  defaults to -1, the zlib default, which is "a default
861         compromise between speed and compression (currently equivalent
862         to level 6)."
864 pack.deltaCacheSize::
865         The maximum memory in bytes used for caching deltas in
866         linkgit:git-pack-objects[1].
867         A value of 0 means no limit. Defaults to 0.
869 pack.deltaCacheLimit::
870         The maximum size of a delta, that is cached in
871         linkgit:git-pack-objects[1]. Defaults to 1000.
873 pack.threads::
874         Specifies the number of threads to spawn when searching for best
875         delta matches.  This requires that linkgit:git-pack-objects[1]
876         be compiled with pthreads otherwise this option is ignored with a
877         warning. This is meant to reduce packing time on multiprocessor
878         machines. The required amount of memory for the delta search window
879         is however multiplied by the number of threads.
880         Specifying 0 will cause git to auto-detect the number of CPU's
881         and set the number of threads accordingly.
883 pack.indexVersion::
884         Specify the default pack index version.  Valid values are 1 for
885         legacy pack index used by Git versions prior to 1.5.2, and 2 for
886         the new pack index with capabilities for packs larger than 4 GB
887         as well as proper protection against the repacking of corrupted
888         packs.  Version 2 is selected and this config option ignored
889         whenever the corresponding pack is larger than 2 GB.  Otherwise
890         the default is 1.
892 pack.packSizeLimit::
893         The default maximum size of a pack.  This setting only affects
894         packing to a file, i.e. the git:// protocol is unaffected.  It
895         can be overridden by the `\--max-pack-size` option of
896         linkgit:git-repack[1].
898 pull.octopus::
899         The default merge strategy to use when pulling multiple branches
900         at once.
902 pull.twohead::
903         The default merge strategy to use when pulling a single branch.
905 remote.<name>.url::
906         The URL of a remote repository.  See linkgit:git-fetch[1] or
907         linkgit:git-push[1].
909 remote.<name>.proxy::
910         For remotes that require curl (http, https and ftp), the URL to
911         the proxy to use for that remote.  Set to the empty string to
912         disable proxying for that remote.
914 remote.<name>.fetch::
915         The default set of "refspec" for linkgit:git-fetch[1]. See
916         linkgit:git-fetch[1].
918 remote.<name>.push::
919         The default set of "refspec" for linkgit:git-push[1]. See
920         linkgit:git-push[1].
922 remote.<name>.skipDefaultUpdate::
923         If true, this remote will be skipped by default when updating
924         using the update subcommand of linkgit:git-remote[1].
926 remote.<name>.receivepack::
927         The default program to execute on the remote side when pushing.  See
928         option \--receive-pack of linkgit:git-push[1].
930 remote.<name>.uploadpack::
931         The default program to execute on the remote side when fetching.  See
932         option \--upload-pack of linkgit:git-fetch-pack[1].
934 remote.<name>.tagopt::
935         Setting this value to \--no-tags disables automatic tag following when
936         fetching from remote <name>
938 remotes.<group>::
939         The list of remotes which are fetched by "git remote update
940         <group>".  See linkgit:git-remote[1].
942 repack.usedeltabaseoffset::
943         Allow linkgit:git-repack[1] to create packs that uses
944         delta-base offset.  Defaults to false.
946 show.difftree::
947         The default linkgit:git-diff-tree[1] arguments to be used
948         for linkgit:git-show[1].
950 showbranch.default::
951         The default set of branches for linkgit:git-show-branch[1].
952         See linkgit:git-show-branch[1].
954 status.relativePaths::
955         By default, linkgit:git-status[1] shows paths relative to the
956         current directory. Setting this variable to `false` shows paths
957         relative to the repository root (this was the default for git
958         prior to v1.5.4).
960 tar.umask::
961         This variable can be used to restrict the permission bits of
962         tar archive entries.  The default is 0002, which turns off the
963         world write bit.  The special value "user" indicates that the
964         archiving user's umask will be used instead.  See umask(2) and
965         linkgit:git-archive[1].
967 url.<base>.insteadOf::
968         Any URL that starts with this value will be rewritten to
969         start, instead, with <base>. In cases where some site serves a
970         large number of repositories, and serves them with multiple
971         access methods, and some users need to use different access
972         methods, this feature allows people to specify any of the
973         equivalent URLs and have git automatically rewrite the URL to
974         the best alternative for the particular user, even for a
975         never-before-seen repository on the site.  When more than one
976         insteadOf strings match a given URL, the longest match is used.
978 user.email::
979         Your email address to be recorded in any newly created commits.
980         Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
981         'EMAIL' environment variables.  See linkgit:git-commit-tree[1].
983 user.name::
984         Your full name to be recorded in any newly created commits.
985         Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
986         environment variables.  See linkgit:git-commit-tree[1].
988 user.signingkey::
989         If linkgit:git-tag[1] is not selecting the key you want it to
990         automatically when creating a signed tag, you can override the
991         default selection with this variable.  This option is passed
992         unchanged to gpg's --local-user parameter, so you may specify a key
993         using any method that gpg supports.
995 whatchanged.difftree::
996         The default linkgit:git-diff-tree[1] arguments to be used
997         for linkgit:git-whatchanged[1].
999 imap::
1000         The configuration variables in the 'imap' section are described
1001         in linkgit:git-imap-send[1].
1003 receive.fsckObjects::
1004         If it is set to true, git-receive-pack will check all received
1005         objects. It will abort in the case of a malformed object or a
1006         broken link. The result of an abort are only dangling objects.
1007         Defaults to false.
1009 receive.unpackLimit::
1010         If the number of objects received in a push is below this
1011         limit then the objects will be unpacked into loose object
1012         files. However if the number of received objects equals or
1013         exceeds this limit then the received pack will be stored as
1014         a pack, after adding any missing delta bases.  Storing the
1015         pack from a push can make the push operation complete faster,
1016         especially on slow filesystems.  If not set, the value of
1017         `transfer.unpackLimit` is used instead.
1019 receive.denyNonFastForwards::
1020         If set to true, git-receive-pack will deny a ref update which is
1021         not a fast forward. Use this to prevent such an update via a push,
1022         even if that push is forced. This configuration variable is
1023         set when initializing a shared repository.
1025 transfer.unpackLimit::
1026         When `fetch.unpackLimit` or `receive.unpackLimit` are
1027         not set, the value of this variable is used instead.
1028         The default value is 100.
1030 web.browser::
1031         Specify a web browser that may be used by some commands.
1032         Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
1033         may use it.