Merge branch 'maint'
[git/dscho.git] / Documentation / config.txt
blob0865f4e01a7d37c102dced01120798b79af4f4b1
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). See linkgit:git-init[1]. False by default.
266 core.warnAmbiguousRefs::
267         If true, git will warn you if the ref name you passed it is ambiguous
268         and might match multiple refs in the .git/refs/ tree. True by default.
270 core.compression::
271         An integer -1..9, indicating a default compression level.
272         -1 is the zlib default. 0 means no compression,
273         and 1..9 are various speed/size tradeoffs, 9 being slowest.
274         If set, this provides a default to other compression variables,
275         such as 'core.loosecompression' and 'pack.compression'.
277 core.loosecompression::
278         An integer -1..9, indicating the compression level for objects that
279         are not in a pack file. -1 is the zlib default. 0 means no
280         compression, and 1..9 are various speed/size tradeoffs, 9 being
281         slowest.  If not set,  defaults to core.compression.  If that is
282         not set,  defaults to 1 (best speed).
284 core.packedGitWindowSize::
285         Number of bytes of a pack file to map into memory in a
286         single mapping operation.  Larger window sizes may allow
287         your system to process a smaller number of large pack files
288         more quickly.  Smaller window sizes will negatively affect
289         performance due to increased calls to the operating system's
290         memory manager, but may improve performance when accessing
291         a large number of large pack files.
293 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
294 MiB on 32 bit platforms and 1 GiB on 64 bit platforms.  This should
295 be reasonable for all users/operating systems.  You probably do
296 not need to adjust this value.
298 Common unit suffixes of 'k', 'm', or 'g' are supported.
300 core.packedGitLimit::
301         Maximum number of bytes to map simultaneously into memory
302         from pack files.  If Git needs to access more than this many
303         bytes at once to complete an operation it will unmap existing
304         regions to reclaim virtual address space within the process.
306 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
307 This should be reasonable for all users/operating systems, except on
308 the largest projects.  You probably do not need to adjust this value.
310 Common unit suffixes of 'k', 'm', or 'g' are supported.
312 core.deltaBaseCacheLimit::
313         Maximum number of bytes to reserve for caching base objects
314         that multiple deltafied objects reference.  By storing the
315         entire decompressed base objects in a cache Git is able
316         to avoid unpacking and decompressing frequently used base
317         objects multiple times.
319 Default is 16 MiB on all platforms.  This should be reasonable
320 for all users/operating systems, except on the largest projects.
321 You probably do not need to adjust this value.
323 Common unit suffixes of 'k', 'm', or 'g' are supported.
325 core.excludesfile::
326         In addition to '.gitignore' (per-directory) and
327         '.git/info/exclude', git looks into this file for patterns
328         of files which are not meant to be tracked.  See
329         linkgit:gitignore[5].
331 core.editor::
332         Commands such as `commit` and `tag` that lets you edit
333         messages by launching an editor uses the value of this
334         variable when it is set, and the environment variable
335         `GIT_EDITOR` is not set.  The order of preference is
336         `GIT_EDITOR` environment, `core.editor`, `VISUAL` and
337         `EDITOR` environment variables and then finally `vi`.
339 core.pager::
340         The command that git will use to paginate output.  Can be overridden
341         with the `GIT_PAGER` environment variable.
343 core.whitespace::
344         A comma separated list of common whitespace problems to
345         notice.  `git diff` will use `color.diff.whitespace` to
346         highlight them, and `git apply --whitespace=error` will
347         consider them as errors:
349 * `trailing-space` treats trailing whitespaces at the end of the line
350   as an error (enabled by default).
351 * `space-before-tab` treats a space character that appears immediately
352   before a tab character in the initial indent part of the line as an
353   error (enabled by default).
354 * `indent-with-non-tab` treats a line that is indented with 8 or more
355   space characters as an error (not enabled by default).
356 * `cr-at-eol` treats a carriage-return at the end of line as
357   part of the line terminator, i.e. with it, `trailing-space`
358   does not trigger if the character before such a carriage-return
359   is not a whitespace (not enabled by default).
361 alias.*::
362         Command aliases for the linkgit:git[1] command wrapper - e.g.
363         after defining "alias.last = cat-file commit HEAD", the invocation
364         "git last" is equivalent to "git cat-file commit HEAD". To avoid
365         confusion and troubles with script usage, aliases that
366         hide existing git commands are ignored. Arguments are split by
367         spaces, the usual shell quoting and escaping is supported.
368         quote pair and a backslash can be used to quote them.
370 If the alias expansion is prefixed with an exclamation point,
371 it will be treated as a shell command.  For example, defining
372 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
373 "git new" is equivalent to running the shell command
374 "gitk --all --not ORIG_HEAD".
376 apply.whitespace::
377         Tells `git-apply` how to handle whitespaces, in the same way
378         as the '--whitespace' option. See linkgit:git-apply[1].
380 branch.autosetupmerge::
381         Tells `git-branch` and `git-checkout` to setup new branches
382         so that linkgit:git-pull[1] will appropriately merge from the
383         starting point branch. Note that even if this option is not set,
384         this behavior can be chosen per-branch using the `--track`
385         and `--no-track` options. The valid settings are: `false` -- no
386         automatic setup is done; `true` -- automatic setup is done when the
387         starting point is a remote branch; `always` -- automatic setup is
388         done when the starting point is either a local branch or remote
389         branch. This option defaults to true.
391 branch.<name>.remote::
392         When in branch <name>, it tells `git fetch` which remote to fetch.
393         If this option is not given, `git fetch` defaults to remote "origin".
395 branch.<name>.merge::
396         When in branch <name>, it tells `git fetch` the default
397         refspec to be marked for merging in FETCH_HEAD. The value is
398         handled like the remote part of a refspec, and must match a
399         ref which is fetched from the remote given by
400         "branch.<name>.remote".
401         The merge information is used by `git pull` (which at first calls
402         `git fetch`) to lookup the default branch for merging. Without
403         this option, `git pull` defaults to merge the first refspec fetched.
404         Specify multiple values to get an octopus merge.
405         If you wish to setup `git pull` so that it merges into <name> from
406         another branch in the local repository, you can point
407         branch.<name>.merge to the desired branch, and use the special setting
408         `.` (a period) for branch.<name>.remote.
410 branch.<name>.mergeoptions::
411         Sets default options for merging into branch <name>. The syntax and
412         supported options are equal to that of linkgit:git-merge[1], but
413         option values containing whitespace characters are currently not
414         supported.
416 branch.<name>.rebase::
417         When true, rebase the branch <name> on top of the fetched branch,
418         instead of merging the default branch from the default remote.
419         *NOTE*: this is a possibly dangerous operation; do *not* use
420         it unless you understand the implications (see linkgit:git-rebase[1]
421         for details).
423 browser.<tool>.cmd::
424         Specify the command to invoke the specified browser. The
425         specified command is evaluated in shell with the URLs passed
426         as arguments. (See linkgit:git-web--browse[1].)
428 browser.<tool>.path::
429         Override the path for the given tool that may be used to
430         browse HTML help (see '-w' option in linkgit:git-help[1]) or a
431         working repository in gitweb (see linkgit:git-instaweb[1]).
433 clean.requireForce::
434         A boolean to make git-clean do nothing unless given -f
435         or -n.   Defaults to true.
437 color.branch::
438         A boolean to enable/disable color in the output of
439         linkgit:git-branch[1]. May be set to `always`,
440         `false` (or `never`) or `auto` (or `true`), in which case colors are used
441         only when the output is to a terminal. Defaults to false.
443 color.branch.<slot>::
444         Use customized color for branch coloration. `<slot>` is one of
445         `current` (the current branch), `local` (a local branch),
446         `remote` (a tracking branch in refs/remotes/), `plain` (other
447         refs).
449 The value for these configuration variables is a list of colors (at most
450 two) and attributes (at most one), separated by spaces.  The colors
451 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
452 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
453 `blink` and `reverse`.  The first color given is the foreground; the
454 second is the background.  The position of the attribute, if any,
455 doesn't matter.
457 color.diff::
458         When set to `always`, always use colors in patch.
459         When false (or `never`), never.  When set to `true` or `auto`, use
460         colors only when the output is to the terminal. Defaults to false.
462 color.diff.<slot>::
463         Use customized color for diff colorization.  `<slot>` specifies
464         which part of the patch to use the specified color, and is one
465         of `plain` (context text), `meta` (metainformation), `frag`
466         (hunk header), `old` (removed lines), `new` (added lines),
467         `commit` (commit headers), or `whitespace` (highlighting
468         whitespace errors). The values of these variables may be specified as
469         in color.branch.<slot>.
471 color.interactive::
472         When set to `always`, always use colors for interactive prompts
473         and displays (such as those used by "git add --interactive").
474         When false (or `never`), never.  When set to `true` or `auto`, use
475         colors only when the output is to the terminal. Defaults to false.
477 color.interactive.<slot>::
478         Use customized color for `git add --interactive`
479         output. `<slot>` may be `prompt`, `header`, or `help`, for
480         three distinct types of normal output from interactive
481         programs.  The values of these variables may be specified as
482         in color.branch.<slot>.
484 color.pager::
485         A boolean to enable/disable colored output when the pager is in
486         use (default is true).
488 color.status::
489         A boolean to enable/disable color in the output of
490         linkgit:git-status[1]. May be set to `always`,
491         `false` (or `never`) or `auto` (or `true`), in which case colors are used
492         only when the output is to a terminal. Defaults to false.
494 color.status.<slot>::
495         Use customized color for status colorization. `<slot>` is
496         one of `header` (the header text of the status message),
497         `added` or `updated` (files which are added but not committed),
498         `changed` (files which are changed but not added in the index),
499         or `untracked` (files which are not tracked by git). The values of
500         these variables may be specified as in color.branch.<slot>.
502 commit.template::
503         Specify a file to use as the template for new commit messages.
505 color.ui::
506         When set to `always`, always use colors in all git commands which
507         are capable of colored output. When false (or `never`), never. When
508         set to `true` or `auto`, use colors only when the output is to the
509         terminal. When more specific variables of color.* are set, they always
510         take precedence over this setting. Defaults to false.
512 diff.autorefreshindex::
513         When using `git diff` to compare with work tree
514         files, do not consider stat-only change as changed.
515         Instead, silently run `git update-index --refresh` to
516         update the cached stat information for paths whose
517         contents in the work tree match the contents in the
518         index.  This option defaults to true.  Note that this
519         affects only `git diff` Porcelain, and not lower level
520         `diff` commands, such as `git diff-files`.
522 diff.external::
523         If this config variable is set, diff generation is not
524         performed using the internal diff machinery, but using the
525         given command.  Note: if you want to use an external diff
526         program only on a subset of your files, you might want to
527         use linkgit:gitattributes[5] instead.
529 diff.renameLimit::
530         The number of files to consider when performing the copy/rename
531         detection; equivalent to the git diff option '-l'.
533 diff.renames::
534         Tells git to detect renames.  If set to any boolean value, it
535         will enable basic rename detection.  If set to "copies" or
536         "copy", it will detect copies, as well.
538 fetch.unpackLimit::
539         If the number of objects fetched over the git native
540         transfer is below this
541         limit, then the objects will be unpacked into loose object
542         files. However if the number of received objects equals or
543         exceeds this limit then the received pack will be stored as
544         a pack, after adding any missing delta bases.  Storing the
545         pack from a push can make the push operation complete faster,
546         especially on slow filesystems.  If not set, the value of
547         `transfer.unpackLimit` is used instead.
549 format.numbered::
550         A boolean which can enable sequence numbers in patch subjects.
551         Setting this option to "auto" will enable it only if there is
552         more than one patch.  See --numbered option in
553         linkgit:git-format-patch[1].
555 format.headers::
556         Additional email headers to include in a patch to be submitted
557         by mail.  See linkgit:git-format-patch[1].
559 format.suffix::
560         The default for format-patch is to output files with the suffix
561         `.patch`. Use this variable to change that suffix (make sure to
562         include the dot if you want it).
564 format.pretty::
565         The default pretty format for log/show/whatchanged command,
566         See linkgit:git-log[1], linkgit:git-show[1],
567         linkgit:git-whatchanged[1].
569 gc.aggressiveWindow::
570         The window size parameter used in the delta compression
571         algorithm used by 'git gc --aggressive'.  This defaults
572         to 10.
574 gc.auto::
575         When there are approximately more than this many loose
576         objects in the repository, `git gc --auto` will pack them.
577         Some Porcelain commands use this command to perform a
578         light-weight garbage collection from time to time.  The
579         default value is 6700.  Setting this to 0 disables it.
581 gc.autopacklimit::
582         When there are more than this many packs that are not
583         marked with `*.keep` file in the repository, `git gc
584         --auto` consolidates them into one larger pack.  The
585         default value is 20.  Setting this to 0 disables it.
587 gc.packrefs::
588         `git gc` does not run `git pack-refs` in a bare repository by
589         default so that older dumb-transport clients can still fetch
590         from the repository.  Setting this to `true` lets `git
591         gc` to run `git pack-refs`.  Setting this to `false` tells
592         `git gc` never to run `git pack-refs`. The default setting is
593         `notbare`. Enable it only when you know you do not have to
594         support such clients.  The default setting will change to `true`
595         at some stage, and setting this to `false` will continue to
596         prevent `git pack-refs` from being run from `git gc`.
598 gc.pruneexpire::
599         When `git gc` is run, it will call `prune --expire 2.weeks.ago`.
600         Override the grace period with this config variable.
602 gc.reflogexpire::
603         `git reflog expire` removes reflog entries older than
604         this time; defaults to 90 days.
606 gc.reflogexpireunreachable::
607         `git reflog expire` removes reflog entries older than
608         this time and are not reachable from the current tip;
609         defaults to 30 days.
611 gc.rerereresolved::
612         Records of conflicted merge you resolved earlier are
613         kept for this many days when `git rerere gc` is run.
614         The default is 60 days.  See linkgit:git-rerere[1].
616 gc.rerereunresolved::
617         Records of conflicted merge you have not resolved are
618         kept for this many days when `git rerere gc` is run.
619         The default is 15 days.  See linkgit:git-rerere[1].
621 rerere.enabled::
622         Activate recording of resolved conflicts, so that identical
623         conflict hunks can be resolved automatically, should they
624         be encountered again.  linkgit:git-rerere[1] command is by
625         default enabled if you create `rr-cache` directory under
626         `$GIT_DIR`, but can be disabled by setting this option to false.
628 gitcvs.enabled::
629         Whether the CVS server interface is enabled for this repository.
630         See linkgit:git-cvsserver[1].
632 gitcvs.logfile::
633         Path to a log file where the CVS server interface well... logs
634         various stuff. See linkgit:git-cvsserver[1].
636 gitcvs.allbinary::
637         If true, all files are sent to the client in mode '-kb'. This
638         causes the client to treat all files as binary files which suppresses
639         any newline munging it otherwise might do. A work-around for the
640         fact that there is no way yet to set single files to mode '-kb'.
642 gitcvs.dbname::
643         Database used by git-cvsserver to cache revision information
644         derived from the git repository. The exact meaning depends on the
645         used database driver, for SQLite (which is the default driver) this
646         is a filename. Supports variable substitution (see
647         linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
648         Default: '%Ggitcvs.%m.sqlite'
650 gitcvs.dbdriver::
651         Used Perl DBI driver. You can specify any available driver
652         for this here, but it might not work. git-cvsserver is tested
653         with 'DBD::SQLite', reported to work with 'DBD::Pg', and
654         reported *not* to work with 'DBD::mysql'. Experimental feature.
655         May not contain double colons (`:`). Default: 'SQLite'.
656         See linkgit:git-cvsserver[1].
658 gitcvs.dbuser, gitcvs.dbpass::
659         Database user and password. Only useful if setting 'gitcvs.dbdriver',
660         since SQLite has no concept of database users and/or passwords.
661         'gitcvs.dbuser' supports variable substitution (see
662         linkgit:git-cvsserver[1] for details).
664 All gitcvs variables except for 'gitcvs.allbinary' can also be
665 specified as 'gitcvs.<access_method>.<varname>' (where 'access_method'
666 is one of "ext" and "pserver") to make them apply only for the given
667 access method.
669 help.browser::
670         Specify the browser that will be used to display help in the
671         'web' format. See linkgit:git-help[1].
673 help.format::
674         Override the default help format used by linkgit:git-help[1].
675         Values 'man', 'info', 'web' and 'html' are supported. 'man' is
676         the default. 'web' and 'html' are the same.
678 http.proxy::
679         Override the HTTP proxy, normally configured using the 'http_proxy'
680         environment variable (see linkgit:curl[1]).  This can be overridden
681         on a per-remote basis; see remote.<name>.proxy
683 http.sslVerify::
684         Whether to verify the SSL certificate when fetching or pushing
685         over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
686         variable.
688 http.sslCert::
689         File containing the SSL certificate when fetching or pushing
690         over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
691         variable.
693 http.sslKey::
694         File containing the SSL private key when fetching or pushing
695         over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
696         variable.
698 http.sslCAInfo::
699         File containing the certificates to verify the peer with when
700         fetching or pushing over HTTPS. Can be overridden by the
701         'GIT_SSL_CAINFO' environment variable.
703 http.sslCAPath::
704         Path containing files with the CA certificates to verify the peer
705         with when fetching or pushing over HTTPS. Can be overridden
706         by the 'GIT_SSL_CAPATH' environment variable.
708 http.maxRequests::
709         How many HTTP requests to launch in parallel. Can be overridden
710         by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
712 http.lowSpeedLimit, http.lowSpeedTime::
713         If the HTTP transfer speed is less than 'http.lowSpeedLimit'
714         for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
715         Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
716         'GIT_HTTP_LOW_SPEED_TIME' environment variables.
718 http.noEPSV::
719         A boolean which disables using of EPSV ftp command by curl.
720         This can helpful with some "poor" ftp servers which don't
721         support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
722         environment variable. Default is false (curl will use EPSV).
724 i18n.commitEncoding::
725         Character encoding the commit messages are stored in; git itself
726         does not care per se, but this information is necessary e.g. when
727         importing commits from emails or in the gitk graphical history
728         browser (and possibly at other places in the future or in other
729         porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
731 i18n.logOutputEncoding::
732         Character encoding the commit messages are converted to when
733         running `git-log` and friends.
735 instaweb.browser::
736         Specify the program that will be used to browse your working
737         repository in gitweb. See linkgit:git-instaweb[1].
739 instaweb.httpd::
740         The HTTP daemon command-line to start gitweb on your working
741         repository. See linkgit:git-instaweb[1].
743 instaweb.local::
744         If true the web server started by linkgit:git-instaweb[1] will
745         be bound to the local IP (127.0.0.1).
747 instaweb.modulepath::
748         The module path for an apache httpd used by linkgit:git-instaweb[1].
750 instaweb.port::
751         The port number to bind the gitweb httpd to. See
752         linkgit:git-instaweb[1].
754 log.showroot::
755         If true, the initial commit will be shown as a big creation event.
756         This is equivalent to a diff against an empty tree.
757         Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
758         normally hide the root commit will now show it. True by default.
760 man.viewer::
761         Specify the programs that may be used to display help in the
762         'man' format. See linkgit:git-help[1].
764 merge.summary::
765         Whether to include summaries of merged commits in newly created
766         merge commit messages. False by default.
768 merge.tool::
769         Controls which merge resolution program is used by
770         linkgit:git-mergetool[1].  Valid built-in values are: "kdiff3",
771         "tkdiff", "meld", "xxdiff", "emerge", "vimdiff", "gvimdiff", and
772         "opendiff".  Any other value is treated is custom merge tool
773         and there must be a corresponing mergetool.<tool>.cmd option.
775 merge.verbosity::
776         Controls the amount of output shown by the recursive merge
777         strategy.  Level 0 outputs nothing except a final error
778         message if conflicts were detected. Level 1 outputs only
779         conflicts, 2 outputs conflicts and file changes.  Level 5 and
780         above outputs debugging information.  The default is level 2.
781         Can be overridden by 'GIT_MERGE_VERBOSITY' environment variable.
783 merge.<driver>.name::
784         Defines a human readable name for a custom low-level
785         merge driver.  See linkgit:gitattributes[5] for details.
787 merge.<driver>.driver::
788         Defines the command that implements a custom low-level
789         merge driver.  See linkgit:gitattributes[5] for details.
791 merge.<driver>.recursive::
792         Names a low-level merge driver to be used when
793         performing an internal merge between common ancestors.
794         See linkgit:gitattributes[5] for details.
796 mergetool.<tool>.path::
797         Override the path for the given tool.  This is useful in case
798         your tool is not in the PATH.
800 mergetool.<tool>.cmd::
801         Specify the command to invoke the specified merge tool.  The
802         specified command is evaluated in shell with the following
803         variables available: 'BASE' is the name of a temporary file
804         containing the common base of the files to be merged, if available;
805         'LOCAL' is the name of a temporary file containing the contents of
806         the file on the current branch; 'REMOTE' is the name of a temporary
807         file containing the contents of the file from the branch being
808         merged; 'MERGED' contains the name of the file to which the merge
809         tool should write the results of a successful merge.
811 mergetool.<tool>.trustExitCode::
812         For a custom merge command, specify whether the exit code of
813         the merge command can be used to determine whether the merge was
814         successful.  If this is not set to true then the merge target file
815         timestamp is checked and the merge assumed to have been successful
816         if the file has been updated, otherwise the user is prompted to
817         indicate the success of the merge.
819 mergetool.keepBackup::
820         After performing a merge, the original file with conflict markers
821         can be saved as a file with a `.orig` extension.  If this variable
822         is set to `false` then this file is not preserved.  Defaults to
823         `true` (i.e. keep the backup files).
825 pack.window::
826         The size of the window used by linkgit:git-pack-objects[1] when no
827         window size is given on the command line. Defaults to 10.
829 pack.depth::
830         The maximum delta depth used by linkgit:git-pack-objects[1] when no
831         maximum depth is given on the command line. Defaults to 50.
833 pack.windowMemory::
834         The window memory size limit used by linkgit:git-pack-objects[1]
835         when no limit is given on the command line.  The value can be
836         suffixed with "k", "m", or "g".  Defaults to 0, meaning no
837         limit.
839 pack.compression::
840         An integer -1..9, indicating the compression level for objects
841         in a pack file. -1 is the zlib default. 0 means no
842         compression, and 1..9 are various speed/size tradeoffs, 9 being
843         slowest.  If not set,  defaults to core.compression.  If that is
844         not set,  defaults to -1, the zlib default, which is "a default
845         compromise between speed and compression (currently equivalent
846         to level 6)."
848 pack.deltaCacheSize::
849         The maximum memory in bytes used for caching deltas in
850         linkgit:git-pack-objects[1].
851         A value of 0 means no limit. Defaults to 0.
853 pack.deltaCacheLimit::
854         The maximum size of a delta, that is cached in
855         linkgit:git-pack-objects[1]. Defaults to 1000.
857 pack.threads::
858         Specifies the number of threads to spawn when searching for best
859         delta matches.  This requires that linkgit:git-pack-objects[1]
860         be compiled with pthreads otherwise this option is ignored with a
861         warning. This is meant to reduce packing time on multiprocessor
862         machines. The required amount of memory for the delta search window
863         is however multiplied by the number of threads.
864         Specifying 0 will cause git to auto-detect the number of CPU's
865         and set the number of threads accordingly.
867 pack.indexVersion::
868         Specify the default pack index version.  Valid values are 1 for
869         legacy pack index used by Git versions prior to 1.5.2, and 2 for
870         the new pack index with capabilities for packs larger than 4 GB
871         as well as proper protection against the repacking of corrupted
872         packs.  Version 2 is selected and this config option ignored
873         whenever the corresponding pack is larger than 2 GB.  Otherwise
874         the default is 1.
876 pack.packSizeLimit::
877         The default maximum size of a pack.  This setting only affects
878         packing to a file, i.e. the git:// protocol is unaffected.  It
879         can be overridden by the `\--max-pack-size` option of
880         linkgit:git-repack[1].
882 pull.octopus::
883         The default merge strategy to use when pulling multiple branches
884         at once.
886 pull.twohead::
887         The default merge strategy to use when pulling a single branch.
889 remote.<name>.url::
890         The URL of a remote repository.  See linkgit:git-fetch[1] or
891         linkgit:git-push[1].
893 remote.<name>.proxy::
894         For remotes that require curl (http, https and ftp), the URL to
895         the proxy to use for that remote.  Set to the empty string to
896         disable proxying for that remote.
898 remote.<name>.fetch::
899         The default set of "refspec" for linkgit:git-fetch[1]. See
900         linkgit:git-fetch[1].
902 remote.<name>.push::
903         The default set of "refspec" for linkgit:git-push[1]. See
904         linkgit:git-push[1].
906 remote.<name>.skipDefaultUpdate::
907         If true, this remote will be skipped by default when updating
908         using the update subcommand of linkgit:git-remote[1].
910 remote.<name>.receivepack::
911         The default program to execute on the remote side when pushing.  See
912         option \--receive-pack of linkgit:git-push[1].
914 remote.<name>.uploadpack::
915         The default program to execute on the remote side when fetching.  See
916         option \--upload-pack of linkgit:git-fetch-pack[1].
918 remote.<name>.tagopt::
919         Setting this value to \--no-tags disables automatic tag following when
920         fetching from remote <name>
922 remotes.<group>::
923         The list of remotes which are fetched by "git remote update
924         <group>".  See linkgit:git-remote[1].
926 repack.usedeltabaseoffset::
927         Allow linkgit:git-repack[1] to create packs that uses
928         delta-base offset.  Defaults to false.
930 show.difftree::
931         The default linkgit:git-diff-tree[1] arguments to be used
932         for linkgit:git-show[1].
934 showbranch.default::
935         The default set of branches for linkgit:git-show-branch[1].
936         See linkgit:git-show-branch[1].
938 status.relativePaths::
939         By default, linkgit:git-status[1] shows paths relative to the
940         current directory. Setting this variable to `false` shows paths
941         relative to the repository root (this was the default for git
942         prior to v1.5.4).
944 tar.umask::
945         This variable can be used to restrict the permission bits of
946         tar archive entries.  The default is 0002, which turns off the
947         world write bit.  The special value "user" indicates that the
948         archiving user's umask will be used instead.  See umask(2) and
949         linkgit:git-archive[1].
951 url.<base>.insteadOf::
952         Any URL that starts with this value will be rewritten to
953         start, instead, with <base>. In cases where some site serves a
954         large number of repositories, and serves them with multiple
955         access methods, and some users need to use different access
956         methods, this feature allows people to specify any of the
957         equivalent URLs and have git automatically rewrite the URL to
958         the best alternative for the particular user, even for a
959         never-before-seen repository on the site.  When more than one
960         insteadOf strings match a given URL, the longest match is used.
962 user.email::
963         Your email address to be recorded in any newly created commits.
964         Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
965         'EMAIL' environment variables.  See linkgit:git-commit-tree[1].
967 user.name::
968         Your full name to be recorded in any newly created commits.
969         Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
970         environment variables.  See linkgit:git-commit-tree[1].
972 user.signingkey::
973         If linkgit:git-tag[1] is not selecting the key you want it to
974         automatically when creating a signed tag, you can override the
975         default selection with this variable.  This option is passed
976         unchanged to gpg's --local-user parameter, so you may specify a key
977         using any method that gpg supports.
979 whatchanged.difftree::
980         The default linkgit:git-diff-tree[1] arguments to be used
981         for linkgit:git-whatchanged[1].
983 imap::
984         The configuration variables in the 'imap' section are described
985         in linkgit:git-imap-send[1].
987 receive.unpackLimit::
988         If the number of objects received in a push is below this
989         limit then the objects will be unpacked into loose object
990         files. However if the number of received objects equals or
991         exceeds this limit then the received pack will be stored as
992         a pack, after adding any missing delta bases.  Storing the
993         pack from a push can make the push operation complete faster,
994         especially on slow filesystems.  If not set, the value of
995         `transfer.unpackLimit` is used instead.
997 receive.denyNonFastForwards::
998         If set to true, git-receive-pack will deny a ref update which is
999         not a fast forward. Use this to prevent such an update via a push,
1000         even if that push is forced. This configuration variable is
1001         set when initializing a shared repository.
1003 transfer.unpackLimit::
1004         When `fetch.unpackLimit` or `receive.unpackLimit` are
1005         not set, the value of this variable is used instead.
1006         The default value is 100.
1008 web.browser::
1009         Specify a web browser that may be used by some commands.
1010         Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
1011         may use it.