Merge branch 'maint'
[git/dkf.git] / Documentation / config.txt
blob217980f48d9d9ac71860d61313e9afa9c6b7c332
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. It can be
238         a absolute path or relative path to the directory specified by
239         --git-dir or GIT_DIR.
240         Note: If --git-dir or GIT_DIR are specified but none of
241         --work-tree, GIT_WORK_TREE and core.worktree is specified,
242         the current working directory is regarded as the top directory
243         of your working tree.
245 core.logAllRefUpdates::
246         Enable the reflog. Updates to a ref <ref> is logged to the file
247         "$GIT_DIR/logs/<ref>", by appending the new and old
248         SHA1, the date/time and the reason of the update, but
249         only when the file exists.  If this configuration
250         variable is set to true, missing "$GIT_DIR/logs/<ref>"
251         file is automatically created for branch heads.
253 This information can be used to determine what commit
254 was the tip of a branch "2 days ago".
256 This value is true by default in a repository that has
257 a working directory associated with it, and false by
258 default in a bare repository.
260 core.repositoryFormatVersion::
261         Internal variable identifying the repository format and layout
262         version.
264 core.sharedRepository::
265         When 'group' (or 'true'), the repository is made shareable between
266         several users in a group (making sure all the files and objects are
267         group-writable). When 'all' (or 'world' or 'everybody'), the
268         repository will be readable by all users, additionally to being
269         group-shareable. When 'umask' (or 'false'), git will use permissions
270         reported by umask(2). When '0xxx', where '0xxx' is an octal number,
271         files in the repository will have this mode value. '0xxx' will override
272         user's umask value, and thus, users with a safe umask (0077) can use
273         this option. Examples: '0660' is equivalent to 'group'. '0640' is a
274         repository that is group-readable but not group-writable.
275         See linkgit:git-init[1]. False by default.
277 core.warnAmbiguousRefs::
278         If true, git will warn you if the ref name you passed it is ambiguous
279         and might match multiple refs in the .git/refs/ tree. True by default.
281 core.compression::
282         An integer -1..9, indicating a default compression level.
283         -1 is the zlib default. 0 means no compression,
284         and 1..9 are various speed/size tradeoffs, 9 being slowest.
285         If set, this provides a default to other compression variables,
286         such as 'core.loosecompression' and 'pack.compression'.
288 core.loosecompression::
289         An integer -1..9, indicating the compression level for objects that
290         are not in a pack file. -1 is the zlib default. 0 means no
291         compression, and 1..9 are various speed/size tradeoffs, 9 being
292         slowest.  If not set,  defaults to core.compression.  If that is
293         not set,  defaults to 1 (best speed).
295 core.packedGitWindowSize::
296         Number of bytes of a pack file to map into memory in a
297         single mapping operation.  Larger window sizes may allow
298         your system to process a smaller number of large pack files
299         more quickly.  Smaller window sizes will negatively affect
300         performance due to increased calls to the operating system's
301         memory manager, but may improve performance when accessing
302         a large number of large pack files.
304 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
305 MiB on 32 bit platforms and 1 GiB on 64 bit platforms.  This should
306 be reasonable for all users/operating systems.  You probably do
307 not need to adjust this value.
309 Common unit suffixes of 'k', 'm', or 'g' are supported.
311 core.packedGitLimit::
312         Maximum number of bytes to map simultaneously into memory
313         from pack files.  If Git needs to access more than this many
314         bytes at once to complete an operation it will unmap existing
315         regions to reclaim virtual address space within the process.
317 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
318 This should be reasonable for all users/operating systems, except on
319 the largest projects.  You probably do not need to adjust this value.
321 Common unit suffixes of 'k', 'm', or 'g' are supported.
323 core.deltaBaseCacheLimit::
324         Maximum number of bytes to reserve for caching base objects
325         that multiple deltafied objects reference.  By storing the
326         entire decompressed base objects in a cache Git is able
327         to avoid unpacking and decompressing frequently used base
328         objects multiple times.
330 Default is 16 MiB on all platforms.  This should be reasonable
331 for all users/operating systems, except on the largest projects.
332 You probably do not need to adjust this value.
334 Common unit suffixes of 'k', 'm', or 'g' are supported.
336 core.excludesfile::
337         In addition to '.gitignore' (per-directory) and
338         '.git/info/exclude', git looks into this file for patterns
339         of files which are not meant to be tracked.  See
340         linkgit:gitignore[5].
342 core.editor::
343         Commands such as `commit` and `tag` that lets you edit
344         messages by launching an editor uses the value of this
345         variable when it is set, and the environment variable
346         `GIT_EDITOR` is not set.  The order of preference is
347         `GIT_EDITOR` environment, `core.editor`, `VISUAL` and
348         `EDITOR` environment variables and then finally `vi`.
350 core.pager::
351         The command that git will use to paginate output.  Can be overridden
352         with the `GIT_PAGER` environment variable.
354 core.whitespace::
355         A comma separated list of common whitespace problems to
356         notice.  `git diff` will use `color.diff.whitespace` to
357         highlight them, and `git apply --whitespace=error` will
358         consider them as errors:
360 * `trailing-space` treats trailing whitespaces at the end of the line
361   as an error (enabled by default).
362 * `space-before-tab` treats a space character that appears immediately
363   before a tab character in the initial indent part of the line as an
364   error (enabled by default).
365 * `indent-with-non-tab` treats a line that is indented with 8 or more
366   space characters as an error (not enabled by default).
367 * `cr-at-eol` treats a carriage-return at the end of line as
368   part of the line terminator, i.e. with it, `trailing-space`
369   does not trigger if the character before such a carriage-return
370   is not a whitespace (not enabled by default).
372 alias.*::
373         Command aliases for the linkgit:git[1] command wrapper - e.g.
374         after defining "alias.last = cat-file commit HEAD", the invocation
375         "git last" is equivalent to "git cat-file commit HEAD". To avoid
376         confusion and troubles with script usage, aliases that
377         hide existing git commands are ignored. Arguments are split by
378         spaces, the usual shell quoting and escaping is supported.
379         quote pair and a backslash can be used to quote them.
381 If the alias expansion is prefixed with an exclamation point,
382 it will be treated as a shell command.  For example, defining
383 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
384 "git new" is equivalent to running the shell command
385 "gitk --all --not ORIG_HEAD".
387 apply.whitespace::
388         Tells `git-apply` how to handle whitespaces, in the same way
389         as the '--whitespace' option. See linkgit:git-apply[1].
391 branch.autosetupmerge::
392         Tells `git-branch` and `git-checkout` to setup new branches
393         so that linkgit:git-pull[1] will appropriately merge from the
394         starting point branch. Note that even if this option is not set,
395         this behavior can be chosen per-branch using the `--track`
396         and `--no-track` options. The valid settings are: `false` -- no
397         automatic setup is done; `true` -- automatic setup is done when the
398         starting point is a remote branch; `always` -- automatic setup is
399         done when the starting point is either a local branch or remote
400         branch. This option defaults to true.
402 branch.autosetuprebase::
403         When a new branch is created with `git-branch` or `git-checkout`
404         that tracks another branch, this variable tells git to set
405         up pull to rebase instead of merge (see "branch.<name>.rebase").
406         When `never`, rebase is never automatically set to true.
407         When `local`, rebase is set to true for tracked branches of
408         other local branches.
409         When `remote`, rebase is set to true for tracked branches of
410         remote branches.
411         When `always`, rebase will be set to true for all tracking
412         branches.
413         See "branch.autosetupmerge" for details on how to set up a
414         branch to track another branch.
415         This option defaults to never.
417 branch.<name>.remote::
418         When in branch <name>, it tells `git fetch` which remote to fetch.
419         If this option is not given, `git fetch` defaults to remote "origin".
421 branch.<name>.merge::
422         When in branch <name>, it tells `git fetch` the default
423         refspec to be marked for merging in FETCH_HEAD. The value is
424         handled like the remote part of a refspec, and must match a
425         ref which is fetched from the remote given by
426         "branch.<name>.remote".
427         The merge information is used by `git pull` (which at first calls
428         `git fetch`) to lookup the default branch for merging. Without
429         this option, `git pull` defaults to merge the first refspec fetched.
430         Specify multiple values to get an octopus merge.
431         If you wish to setup `git pull` so that it merges into <name> from
432         another branch in the local repository, you can point
433         branch.<name>.merge to the desired branch, and use the special setting
434         `.` (a period) for branch.<name>.remote.
436 branch.<name>.mergeoptions::
437         Sets default options for merging into branch <name>. The syntax and
438         supported options are equal to that of linkgit:git-merge[1], but
439         option values containing whitespace characters are currently not
440         supported.
442 branch.<name>.rebase::
443         When true, rebase the branch <name> on top of the fetched branch,
444         instead of merging the default branch from the default remote when
445         "git pull" is run.
446         *NOTE*: this is a possibly dangerous operation; do *not* use
447         it unless you understand the implications (see linkgit:git-rebase[1]
448         for details).
450 browser.<tool>.cmd::
451         Specify the command to invoke the specified browser. The
452         specified command is evaluated in shell with the URLs passed
453         as arguments. (See linkgit:git-web--browse[1].)
455 browser.<tool>.path::
456         Override the path for the given tool that may be used to
457         browse HTML help (see '-w' option in linkgit:git-help[1]) or a
458         working repository in gitweb (see linkgit:git-instaweb[1]).
460 clean.requireForce::
461         A boolean to make git-clean do nothing unless given -f
462         or -n.   Defaults to true.
464 color.branch::
465         A boolean to enable/disable color in the output of
466         linkgit:git-branch[1]. May be set to `always`,
467         `false` (or `never`) or `auto` (or `true`), in which case colors are used
468         only when the output is to a terminal. Defaults to false.
470 color.branch.<slot>::
471         Use customized color for branch coloration. `<slot>` is one of
472         `current` (the current branch), `local` (a local branch),
473         `remote` (a tracking branch in refs/remotes/), `plain` (other
474         refs).
476 The value for these configuration variables is a list of colors (at most
477 two) and attributes (at most one), separated by spaces.  The colors
478 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
479 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
480 `blink` and `reverse`.  The first color given is the foreground; the
481 second is the background.  The position of the attribute, if any,
482 doesn't matter.
484 color.diff::
485         When set to `always`, always use colors in patch.
486         When false (or `never`), never.  When set to `true` or `auto`, use
487         colors only when the output is to the terminal. Defaults to false.
489 color.diff.<slot>::
490         Use customized color for diff colorization.  `<slot>` specifies
491         which part of the patch to use the specified color, and is one
492         of `plain` (context text), `meta` (metainformation), `frag`
493         (hunk header), `old` (removed lines), `new` (added lines),
494         `commit` (commit headers), or `whitespace` (highlighting
495         whitespace errors). The values of these variables may be specified as
496         in color.branch.<slot>.
498 color.interactive::
499         When set to `always`, always use colors for interactive prompts
500         and displays (such as those used by "git add --interactive").
501         When false (or `never`), never.  When set to `true` or `auto`, use
502         colors only when the output is to the terminal. Defaults to false.
504 color.interactive.<slot>::
505         Use customized color for `git add --interactive`
506         output. `<slot>` may be `prompt`, `header`, or `help`, for
507         three distinct types of normal output from interactive
508         programs.  The values of these variables may be specified as
509         in color.branch.<slot>.
511 color.pager::
512         A boolean to enable/disable colored output when the pager is in
513         use (default is true).
515 color.status::
516         A boolean to enable/disable color in the output of
517         linkgit:git-status[1]. May be set to `always`,
518         `false` (or `never`) or `auto` (or `true`), in which case colors are used
519         only when the output is to a terminal. Defaults to false.
521 color.status.<slot>::
522         Use customized color for status colorization. `<slot>` is
523         one of `header` (the header text of the status message),
524         `added` or `updated` (files which are added but not committed),
525         `changed` (files which are changed but not added in the index),
526         or `untracked` (files which are not tracked by git). The values of
527         these variables may be specified as in color.branch.<slot>.
529 commit.template::
530         Specify a file to use as the template for new commit messages.
532 color.ui::
533         When set to `always`, always use colors in all git commands which
534         are capable of colored output. When false (or `never`), never. When
535         set to `true` or `auto`, use colors only when the output is to the
536         terminal. When more specific variables of color.* are set, they always
537         take precedence over this setting. Defaults to false.
539 diff.autorefreshindex::
540         When using `git diff` to compare with work tree
541         files, do not consider stat-only change as changed.
542         Instead, silently run `git update-index --refresh` to
543         update the cached stat information for paths whose
544         contents in the work tree match the contents in the
545         index.  This option defaults to true.  Note that this
546         affects only `git diff` Porcelain, and not lower level
547         `diff` commands, such as `git diff-files`.
549 diff.external::
550         If this config variable is set, diff generation is not
551         performed using the internal diff machinery, but using the
552         given command.  Note: if you want to use an external diff
553         program only on a subset of your files, you might want to
554         use linkgit:gitattributes[5] instead.
556 diff.renameLimit::
557         The number of files to consider when performing the copy/rename
558         detection; equivalent to the git diff option '-l'.
560 diff.renames::
561         Tells git to detect renames.  If set to any boolean value, it
562         will enable basic rename detection.  If set to "copies" or
563         "copy", it will detect copies, as well.
565 fetch.unpackLimit::
566         If the number of objects fetched over the git native
567         transfer is below this
568         limit, then the objects will be unpacked into loose object
569         files. However if the number of received objects equals or
570         exceeds this limit then the received pack will be stored as
571         a pack, after adding any missing delta bases.  Storing the
572         pack from a push can make the push operation complete faster,
573         especially on slow filesystems.  If not set, the value of
574         `transfer.unpackLimit` is used instead.
576 format.numbered::
577         A boolean which can enable sequence numbers in patch subjects.
578         Setting this option to "auto" will enable it only if there is
579         more than one patch.  See --numbered option in
580         linkgit:git-format-patch[1].
582 format.headers::
583         Additional email headers to include in a patch to be submitted
584         by mail.  See linkgit:git-format-patch[1].
586 format.suffix::
587         The default for format-patch is to output files with the suffix
588         `.patch`. Use this variable to change that suffix (make sure to
589         include the dot if you want it).
591 format.pretty::
592         The default pretty format for log/show/whatchanged command,
593         See linkgit:git-log[1], linkgit:git-show[1],
594         linkgit:git-whatchanged[1].
596 gc.aggressiveWindow::
597         The window size parameter used in the delta compression
598         algorithm used by 'git gc --aggressive'.  This defaults
599         to 10.
601 gc.auto::
602         When there are approximately more than this many loose
603         objects in the repository, `git gc --auto` will pack them.
604         Some Porcelain commands use this command to perform a
605         light-weight garbage collection from time to time.  The
606         default value is 6700.  Setting this to 0 disables it.
608 gc.autopacklimit::
609         When there are more than this many packs that are not
610         marked with `*.keep` file in the repository, `git gc
611         --auto` consolidates them into one larger pack.  The
612         default value is 50.  Setting this to 0 disables it.
614 gc.packrefs::
615         `git gc` does not run `git pack-refs` in a bare repository by
616         default so that older dumb-transport clients can still fetch
617         from the repository.  Setting this to `true` lets `git
618         gc` to run `git pack-refs`.  Setting this to `false` tells
619         `git gc` never to run `git pack-refs`. The default setting is
620         `notbare`. Enable it only when you know you do not have to
621         support such clients.  The default setting will change to `true`
622         at some stage, and setting this to `false` will continue to
623         prevent `git pack-refs` from being run from `git gc`.
625 gc.pruneexpire::
626         When `git gc` is run, it will call `prune --expire 2.weeks.ago`.
627         Override the grace period with this config variable.
629 gc.reflogexpire::
630         `git reflog expire` removes reflog entries older than
631         this time; defaults to 90 days.
633 gc.reflogexpireunreachable::
634         `git reflog expire` removes reflog entries older than
635         this time and are not reachable from the current tip;
636         defaults to 30 days.
638 gc.rerereresolved::
639         Records of conflicted merge you resolved earlier are
640         kept for this many days when `git rerere gc` is run.
641         The default is 60 days.  See linkgit:git-rerere[1].
643 gc.rerereunresolved::
644         Records of conflicted merge you have not resolved are
645         kept for this many days when `git rerere gc` is run.
646         The default is 15 days.  See linkgit:git-rerere[1].
648 rerere.enabled::
649         Activate recording of resolved conflicts, so that identical
650         conflict hunks can be resolved automatically, should they
651         be encountered again.  linkgit:git-rerere[1] command is by
652         default enabled if you create `rr-cache` directory under
653         `$GIT_DIR`, but can be disabled by setting this option to false.
655 gitcvs.enabled::
656         Whether the CVS server interface is enabled for this repository.
657         See linkgit:git-cvsserver[1].
659 gitcvs.logfile::
660         Path to a log file where the CVS server interface well... logs
661         various stuff. See linkgit:git-cvsserver[1].
663 gitcvs.allbinary::
664         If true, all files are sent to the client in mode '-kb'. This
665         causes the client to treat all files as binary files which suppresses
666         any newline munging it otherwise might do. A work-around for the
667         fact that there is no way yet to set single files to mode '-kb'.
669 gitcvs.dbname::
670         Database used by git-cvsserver to cache revision information
671         derived from the git repository. The exact meaning depends on the
672         used database driver, for SQLite (which is the default driver) this
673         is a filename. Supports variable substitution (see
674         linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
675         Default: '%Ggitcvs.%m.sqlite'
677 gitcvs.dbdriver::
678         Used Perl DBI driver. You can specify any available driver
679         for this here, but it might not work. git-cvsserver is tested
680         with 'DBD::SQLite', reported to work with 'DBD::Pg', and
681         reported *not* to work with 'DBD::mysql'. Experimental feature.
682         May not contain double colons (`:`). Default: 'SQLite'.
683         See linkgit:git-cvsserver[1].
685 gitcvs.dbuser, gitcvs.dbpass::
686         Database user and password. Only useful if setting 'gitcvs.dbdriver',
687         since SQLite has no concept of database users and/or passwords.
688         'gitcvs.dbuser' supports variable substitution (see
689         linkgit:git-cvsserver[1] for details).
691 gitcvs.dbTableNamePrefix::
692         Database table name prefix.  Prepended to the names of any
693         database tables used, allowing a single database to be used
694         for several repositories.  Supports variable substitution (see
695         linkgit:git-cvsserver[1] for details).  Any non-alphabetic
696         characters will be replaced with underscores.
698 All gitcvs variables except for 'gitcvs.allbinary' can also be
699 specified as 'gitcvs.<access_method>.<varname>' (where 'access_method'
700 is one of "ext" and "pserver") to make them apply only for the given
701 access method.
703 gui.commitmsgwidth::
704         Defines how wide the commit message window is in the
705         linkgit:git-gui[1]. "75" is the default.
707 gui.diffcontext::
708         Specifies how many context lines should be used in calls to diff
709         made by the linkgit:git-gui[1]. The default is "5".
711 gui.matchtrackingbranch::
712         Determines if new branches created with linkgit:git-gui[1] should
713         default to tracking remote branches with matching names or
714         not. Default: "false".
716 gui.newbranchtemplate::
717         Is used as suggested name when creating new branches using the
718         linkgit:git-gui[1].
720 gui.pruneduringfetch::
721         "true" if linkgit:git-gui[1] should prune tracking branches when
722         performing a fetch. The default value is "false".
724 gui.trustmtime::
725         Determines if linkgit:git-gui[1] should trust the file modification
726         timestamp or not. By default the timestamps are not trusted.
728 gui.spellingdictionary::
729         Specifies the dictionary used for spell checking commit messages in
730         the linkgit:git-gui[1]. When set to "none" spell checking is turned
731         off.
733 help.browser::
734         Specify the browser that will be used to display help in the
735         'web' format. See linkgit:git-help[1].
737 help.format::
738         Override the default help format used by linkgit:git-help[1].
739         Values 'man', 'info', 'web' and 'html' are supported. 'man' is
740         the default. 'web' and 'html' are the same.
742 http.proxy::
743         Override the HTTP proxy, normally configured using the 'http_proxy'
744         environment variable (see linkgit:curl[1]).  This can be overridden
745         on a per-remote basis; see remote.<name>.proxy
747 http.sslVerify::
748         Whether to verify the SSL certificate when fetching or pushing
749         over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
750         variable.
752 http.sslCert::
753         File containing the SSL certificate when fetching or pushing
754         over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
755         variable.
757 http.sslKey::
758         File containing the SSL private key when fetching or pushing
759         over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
760         variable.
762 http.sslCAInfo::
763         File containing the certificates to verify the peer with when
764         fetching or pushing over HTTPS. Can be overridden by the
765         'GIT_SSL_CAINFO' environment variable.
767 http.sslCAPath::
768         Path containing files with the CA certificates to verify the peer
769         with when fetching or pushing over HTTPS. Can be overridden
770         by the 'GIT_SSL_CAPATH' environment variable.
772 http.maxRequests::
773         How many HTTP requests to launch in parallel. Can be overridden
774         by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
776 http.lowSpeedLimit, http.lowSpeedTime::
777         If the HTTP transfer speed is less than 'http.lowSpeedLimit'
778         for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
779         Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
780         'GIT_HTTP_LOW_SPEED_TIME' environment variables.
782 http.noEPSV::
783         A boolean which disables using of EPSV ftp command by curl.
784         This can helpful with some "poor" ftp servers which don't
785         support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
786         environment variable. Default is false (curl will use EPSV).
788 i18n.commitEncoding::
789         Character encoding the commit messages are stored in; git itself
790         does not care per se, but this information is necessary e.g. when
791         importing commits from emails or in the gitk graphical history
792         browser (and possibly at other places in the future or in other
793         porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
795 i18n.logOutputEncoding::
796         Character encoding the commit messages are converted to when
797         running `git-log` and friends.
799 instaweb.browser::
800         Specify the program that will be used to browse your working
801         repository in gitweb. See linkgit:git-instaweb[1].
803 instaweb.httpd::
804         The HTTP daemon command-line to start gitweb on your working
805         repository. See linkgit:git-instaweb[1].
807 instaweb.local::
808         If true the web server started by linkgit:git-instaweb[1] will
809         be bound to the local IP (127.0.0.1).
811 instaweb.modulepath::
812         The module path for an apache httpd used by linkgit:git-instaweb[1].
814 instaweb.port::
815         The port number to bind the gitweb httpd to. See
816         linkgit:git-instaweb[1].
818 log.showroot::
819         If true, the initial commit will be shown as a big creation event.
820         This is equivalent to a diff against an empty tree.
821         Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
822         normally hide the root commit will now show it. True by default.
824 man.viewer::
825         Specify the programs that may be used to display help in the
826         'man' format. See linkgit:git-help[1].
828 include::merge-config.txt[]
830 man.<tool>.cmd::
831         Specify the command to invoke the specified man viewer. The
832         specified command is evaluated in shell with the man page
833         passed as argument. (See linkgit:git-help[1].)
835 man.<tool>.path::
836         Override the path for the given tool that may be used to
837         display help in the 'man' format. See linkgit:git-help[1].
839 mergetool.<tool>.path::
840         Override the path for the given tool.  This is useful in case
841         your tool is not in the PATH.
843 mergetool.<tool>.cmd::
844         Specify the command to invoke the specified merge tool.  The
845         specified command is evaluated in shell with the following
846         variables available: 'BASE' is the name of a temporary file
847         containing the common base of the files to be merged, if available;
848         'LOCAL' is the name of a temporary file containing the contents of
849         the file on the current branch; 'REMOTE' is the name of a temporary
850         file containing the contents of the file from the branch being
851         merged; 'MERGED' contains the name of the file to which the merge
852         tool should write the results of a successful merge.
854 mergetool.<tool>.trustExitCode::
855         For a custom merge command, specify whether the exit code of
856         the merge command can be used to determine whether the merge was
857         successful.  If this is not set to true then the merge target file
858         timestamp is checked and the merge assumed to have been successful
859         if the file has been updated, otherwise the user is prompted to
860         indicate the success of the merge.
862 mergetool.keepBackup::
863         After performing a merge, the original file with conflict markers
864         can be saved as a file with a `.orig` extension.  If this variable
865         is set to `false` then this file is not preserved.  Defaults to
866         `true` (i.e. keep the backup files).
868 pack.window::
869         The size of the window used by linkgit:git-pack-objects[1] when no
870         window size is given on the command line. Defaults to 10.
872 pack.depth::
873         The maximum delta depth used by linkgit:git-pack-objects[1] when no
874         maximum depth is given on the command line. Defaults to 50.
876 pack.windowMemory::
877         The window memory size limit used by linkgit:git-pack-objects[1]
878         when no limit is given on the command line.  The value can be
879         suffixed with "k", "m", or "g".  Defaults to 0, meaning no
880         limit.
882 pack.compression::
883         An integer -1..9, indicating the compression level for objects
884         in a pack file. -1 is the zlib default. 0 means no
885         compression, and 1..9 are various speed/size tradeoffs, 9 being
886         slowest.  If not set,  defaults to core.compression.  If that is
887         not set,  defaults to -1, the zlib default, which is "a default
888         compromise between speed and compression (currently equivalent
889         to level 6)."
891 pack.deltaCacheSize::
892         The maximum memory in bytes used for caching deltas in
893         linkgit:git-pack-objects[1].
894         A value of 0 means no limit. Defaults to 0.
896 pack.deltaCacheLimit::
897         The maximum size of a delta, that is cached in
898         linkgit:git-pack-objects[1]. Defaults to 1000.
900 pack.threads::
901         Specifies the number of threads to spawn when searching for best
902         delta matches.  This requires that linkgit:git-pack-objects[1]
903         be compiled with pthreads otherwise this option is ignored with a
904         warning. This is meant to reduce packing time on multiprocessor
905         machines. The required amount of memory for the delta search window
906         is however multiplied by the number of threads.
907         Specifying 0 will cause git to auto-detect the number of CPU's
908         and set the number of threads accordingly.
910 pack.indexVersion::
911         Specify the default pack index version.  Valid values are 1 for
912         legacy pack index used by Git versions prior to 1.5.2, and 2 for
913         the new pack index with capabilities for packs larger than 4 GB
914         as well as proper protection against the repacking of corrupted
915         packs.  Version 2 is selected and this config option ignored
916         whenever the corresponding pack is larger than 2 GB.  Otherwise
917         the default is 1.
919 pack.packSizeLimit::
920         The default maximum size of a pack.  This setting only affects
921         packing to a file, i.e. the git:// protocol is unaffected.  It
922         can be overridden by the `\--max-pack-size` option of
923         linkgit:git-repack[1].
925 pull.octopus::
926         The default merge strategy to use when pulling multiple branches
927         at once.
929 pull.twohead::
930         The default merge strategy to use when pulling a single branch.
932 remote.<name>.url::
933         The URL of a remote repository.  See linkgit:git-fetch[1] or
934         linkgit:git-push[1].
936 remote.<name>.proxy::
937         For remotes that require curl (http, https and ftp), the URL to
938         the proxy to use for that remote.  Set to the empty string to
939         disable proxying for that remote.
941 remote.<name>.fetch::
942         The default set of "refspec" for linkgit:git-fetch[1]. See
943         linkgit:git-fetch[1].
945 remote.<name>.push::
946         The default set of "refspec" for linkgit:git-push[1]. See
947         linkgit:git-push[1].
949 remote.<name>.mirror::
950         If true, pushing to this remote will automatically behave
951         as if the `\--mirror` option was given on the command line.
953 remote.<name>.skipDefaultUpdate::
954         If true, this remote will be skipped by default when updating
955         using the update subcommand of linkgit:git-remote[1].
957 remote.<name>.receivepack::
958         The default program to execute on the remote side when pushing.  See
959         option \--receive-pack of linkgit:git-push[1].
961 remote.<name>.uploadpack::
962         The default program to execute on the remote side when fetching.  See
963         option \--upload-pack of linkgit:git-fetch-pack[1].
965 remote.<name>.tagopt::
966         Setting this value to \--no-tags disables automatic tag following when
967         fetching from remote <name>
969 remotes.<group>::
970         The list of remotes which are fetched by "git remote update
971         <group>".  See linkgit:git-remote[1].
973 repack.usedeltabaseoffset::
974         Allow linkgit:git-repack[1] to create packs that uses
975         delta-base offset.  Defaults to false.
977 show.difftree::
978         The default linkgit:git-diff-tree[1] arguments to be used
979         for linkgit:git-show[1].
981 showbranch.default::
982         The default set of branches for linkgit:git-show-branch[1].
983         See linkgit:git-show-branch[1].
985 status.relativePaths::
986         By default, linkgit:git-status[1] shows paths relative to the
987         current directory. Setting this variable to `false` shows paths
988         relative to the repository root (this was the default for git
989         prior to v1.5.4).
991 tar.umask::
992         This variable can be used to restrict the permission bits of
993         tar archive entries.  The default is 0002, which turns off the
994         world write bit.  The special value "user" indicates that the
995         archiving user's umask will be used instead.  See umask(2) and
996         linkgit:git-archive[1].
998 url.<base>.insteadOf::
999         Any URL that starts with this value will be rewritten to
1000         start, instead, with <base>. In cases where some site serves a
1001         large number of repositories, and serves them with multiple
1002         access methods, and some users need to use different access
1003         methods, this feature allows people to specify any of the
1004         equivalent URLs and have git automatically rewrite the URL to
1005         the best alternative for the particular user, even for a
1006         never-before-seen repository on the site.  When more than one
1007         insteadOf strings match a given URL, the longest match is used.
1009 user.email::
1010         Your email address to be recorded in any newly created commits.
1011         Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
1012         'EMAIL' environment variables.  See linkgit:git-commit-tree[1].
1014 user.name::
1015         Your full name to be recorded in any newly created commits.
1016         Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
1017         environment variables.  See linkgit:git-commit-tree[1].
1019 user.signingkey::
1020         If linkgit:git-tag[1] is not selecting the key you want it to
1021         automatically when creating a signed tag, you can override the
1022         default selection with this variable.  This option is passed
1023         unchanged to gpg's --local-user parameter, so you may specify a key
1024         using any method that gpg supports.
1026 whatchanged.difftree::
1027         The default linkgit:git-diff-tree[1] arguments to be used
1028         for linkgit:git-whatchanged[1].
1030 imap::
1031         The configuration variables in the 'imap' section are described
1032         in linkgit:git-imap-send[1].
1034 receive.fsckObjects::
1035         If it is set to true, git-receive-pack will check all received
1036         objects. It will abort in the case of a malformed object or a
1037         broken link. The result of an abort are only dangling objects.
1038         Defaults to false.
1040 receive.unpackLimit::
1041         If the number of objects received in a push is below this
1042         limit then the objects will be unpacked into loose object
1043         files. However if the number of received objects equals or
1044         exceeds this limit then the received pack will be stored as
1045         a pack, after adding any missing delta bases.  Storing the
1046         pack from a push can make the push operation complete faster,
1047         especially on slow filesystems.  If not set, the value of
1048         `transfer.unpackLimit` is used instead.
1050 receive.denyNonFastForwards::
1051         If set to true, git-receive-pack will deny a ref update which is
1052         not a fast forward. Use this to prevent such an update via a push,
1053         even if that push is forced. This configuration variable is
1054         set when initializing a shared repository.
1056 transfer.unpackLimit::
1057         When `fetch.unpackLimit` or `receive.unpackLimit` are
1058         not set, the value of this variable is used instead.
1059         The default value is 100.
1061 web.browser::
1062         Specify a web browser that may be used by some commands.
1063         Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
1064         may use it.