blob: 35056e1a9cd44af119f98465cd7c4cabb9ba0c33 [file] [log] [blame]
Junio C Hamano07824ce2006-04-25 07:36:541CONFIGURATION FILE
2------------------
3
4The git configuration file contains a number of variables that affect
Junio C Hamano8f76dc62007-01-17 07:24:255the git command's behavior. `.git/config` file for each repository
6is used to store the information for that repository, and
7`$HOME/.gitconfig` is used to store per user information to give
Junio C Hamano79556902007-02-24 11:15:548fallback values for `.git/config` file. The file `/etc/gitconfig`
9can be used to store system-wide defaults.
Junio C Hamano8f76dc62007-01-17 07:24:2510
11They can be used by both the git plumbing
Junio C Hamanof1d14802006-06-08 00:48:1712and the porcelains. The variables are divided into sections, where
Junio C Hamano07824ce2006-04-25 07:36:5413in the fully qualified variable name the variable itself is the last
14dot-separated segment and the section name is everything before the last
15dot. The variable names are case-insensitive and only alphanumeric
16characters are allowed. Some variables may appear multiple times.
17
Junio C Hamanobee172f2007-01-23 08:44:1818Syntax
19~~~~~~
20
Junio C Hamano07824ce2006-04-25 07:36:5421The syntax is fairly flexible and permissive; whitespaces are mostly
Junio C Hamanobee172f2007-01-23 08:44:1822ignored. The '#' and ';' characters begin comments to the end of line,
23blank lines are ignored.
24
25The file consists of sections and variables. A section begins with
26the name of the section in square brackets and continues until the next
27section begins. Section names are not case sensitive. Only alphanumeric
Junio C Hamanoea82cff2009-03-18 01:54:4828characters, `-` and `.` are allowed in section names. Each variable
Junio C Hamanobee172f2007-01-23 08:44:1829must belong to some section, which means that there must be section
30header before first setting of a variable.
31
32Sections can be further divided into subsections. To begin a subsection
33put its name in double quotes, separated by space from the section name,
34in the section header, like in example below:
35
36--------
37[section "subsection"]
38
39--------
40
Junio C Hamanofa0d4cf2007-01-25 02:23:5841Subsection names can contain any characters except newline (doublequote
Junio C Hamanoea82cff2009-03-18 01:54:4842`"` and backslash have to be escaped as `\"` and `\\`,
Junio C Hamanoee1e4282007-02-04 08:32:0443respectively) and are case sensitive. Section header cannot span multiple
Junio C Hamanobee172f2007-01-23 08:44:1844lines. Variables may belong directly to a section or to a given subsection.
45You can have `[section]` if you have `[section "subsection"]`, but you
46don't need to.
47
48There is also (case insensitive) alternative `[section.subsection]` syntax.
49In this syntax subsection names follow the same restrictions as for section
50name.
51
52All 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
54is taken as 'name' and the variable is recognized as boolean "true".
55The variable names are case-insensitive and only alphanumeric
Junio C Hamanoea82cff2009-03-18 01:54:4856characters and `-` are allowed. There can be more than one value
Junio C Hamanobee172f2007-01-23 08:44:1857for a given variable; we say then that variable is multivalued.
58
59Leading and trailing whitespace in a variable value is discarded.
60Internal whitespace within a variable value is retained verbatim.
61
62The values following the equals sign in variable assign are all either
63a string, an integer, or a boolean. Boolean values may be given as yes/no,
Junio C Hamano4cfa5362009-04-18 23:01:01640/1, true/false or on/off. Case is not significant in boolean values, when
Junio C Hamanobee172f2007-01-23 08:44:1865converting value to the canonical form using '--bool' type specifier;
Junio C Hamanoba4b9282008-07-06 05:20:3166'git-config' will ensure that the output is "true" or "false".
Junio C Hamanobee172f2007-01-23 08:44:1867
68String values may be entirely or partially enclosed in double quotes.
69You need to enclose variable value in double quotes if you want to
70preserve leading or trailing whitespace, or if variable value contains
71beginning of comment characters (if it contains '#' or ';').
Junio C Hamanoea82cff2009-03-18 01:54:4872Double quote `"` and backslash `\` characters in variable value must
73be escaped: use `\"` for `"` and `\\` for `\`.
Junio C Hamanobee172f2007-01-23 08:44:1874
Junio C Hamanoea82cff2009-03-18 01:54:4875The following escape sequences (beside `\"` and `\\`) are recognized:
76`\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
77and `\b` for backspace (BS). No other char escape sequence, nor octal
Junio C Hamanobee172f2007-01-23 08:44:1878char sequences are valid.
79
Junio C Hamanoea82cff2009-03-18 01:54:4880Variable value ending in a `\` is continued on the next line in the
Junio C Hamanobee172f2007-01-23 08:44:1881customary UNIX fashion.
82
83Some variables may require special value format.
Junio C Hamano07824ce2006-04-25 07:36:5484
85Example
86~~~~~~~
87
88# Core variables
89[core]
90; Don't trust file modes
91filemode = false
92
93# Our diff algorithm
94[diff]
Junio C Hamano85c71572008-07-28 00:03:3195external = /usr/local/bin/diff-wrapper
Junio C Hamano07824ce2006-04-25 07:36:5496renames = true
97
Junio C Hamano52401ef2006-12-19 00:54:3898[branch "devel"]
99remote = origin
100merge = refs/heads/devel
101
Junio C Hamanobee172f2007-01-23 08:44:18102# Proxy settings
103[core]
Junio C Hamanoc71a8732007-08-04 00:27:26104gitProxy="ssh" for "kernel.org"
Junio C Hamanobee172f2007-01-23 08:44:18105gitProxy=default-proxy ; for the rest
Junio C Hamano52401ef2006-12-19 00:54:38106
Junio C Hamano07824ce2006-04-25 07:36:54107Variables
108~~~~~~~~~
109
110Note that this list is non-comprehensive and not necessarily complete.
Junio C Hamanof1d14802006-06-08 00:48:17111For command-specific variables, you will find a more detailed description
112in the appropriate manual page. You will find a description of non-core
Junio C Hamano07824ce2006-04-25 07:36:54113porcelain configuration variables in the respective porcelain documentation.
114
115core.fileMode::
116If false, the executable bit differences between the index and
117the working copy are ignored; useful on broken filesystems like FAT.
Junio C Hamano35738e82008-01-07 07:55:46118See linkgit:git-update-index[1]. True by default.
Junio C Hamano07824ce2006-04-25 07:36:54119
Junio C Hamanoa476efa2008-10-10 15:31:42120core.ignoreCygwinFSTricks::
121This option is only used by Cygwin implementation of Git. If false,
122the Cygwin stat() and lstat() functions are used. This may be useful
123if your repository consists of a few separate directories joined in
124one hierarchy using Cygwin mount. If true, Git uses native Win32 API
125whenever it is possible and falls back to Cygwin functions only to
126handle symbol links. The native mode is more than twice faster than
Junio C Hamano7d06a8a2008-10-20 05:42:33127normal Cygwin l/stat() functions. True by default, unless core.filemode
128is true, in which case ignoreCygwinFSTricks is ignored as Cygwin's
129POSIX emulation is required to support core.filemode.
Junio C Hamanoa476efa2008-10-10 15:31:42130
Junio C Hamano90ccff32008-07-29 08:17:24131core.trustctime::
132If false, the ctime differences between the index and the
133working copy are ignored; useful when the inode change time
134is regularly modified by something outside Git (file system
135crawlers and some backup systems).
136See linkgit:git-update-index[1]. True by default.
137
Junio C Hamanod526ba92007-07-02 00:17:42138core.quotepath::
Junio C Hamanoba4b9282008-07-06 05:20:31139The commands that output paths (e.g. 'ls-files',
140'diff'), when not given the `-z` option, will quote
Junio C Hamanod526ba92007-07-02 00:17:42141"unusual" characters in the pathname by enclosing the
142pathname in a double-quote pair and with backslashes the
143same way strings in C source code are quoted. If this
144variable is set to false, the bytes higher than 0x80 are
145not quoted but output as verbatim. Note that double
146quote, backslash and control characters are always
147quoted without `-z` regardless of the setting of this
148variable.
149
Junio C Hamanod9e0e5d2007-04-14 16:22:04150core.autocrlf::
151If true, makes git convert `CRLF` at the end of lines in text files to
152`LF` when reading from the filesystem, and convert in reverse when
153writing to the filesystem. The variable can be set to
154'input', in which case the conversion happens only while
155reading from the filesystem but files are written out with
156`LF` at the end of lines. Currently, which paths to consider
157"text" (i.e. be subjected to the autocrlf mechanism) is
158decided purely based on the contents.
159
Junio C Hamano26e590a2008-02-17 03:53:51160core.safecrlf::
161If true, makes git check if converting `CRLF` as controlled by
162`core.autocrlf` is reversible. Git will verify if a command
163modifies a file in the work tree either directly or indirectly.
164For example, committing a file followed by checking out the
165same file should yield the original file in the work tree. If
166this is not the case for the current setting of
167`core.autocrlf`, git will reject the file. The variable can
168be set to "warn", in which case git will only warn about an
169irreversible conversion but continue the operation.
170+
171CRLF conversion bears a slight chance of corrupting data.
172autocrlf=true will convert CRLF to LF during commit and LF to
173CRLF during checkout. A file that contains a mixture of LF and
174CRLF before the commit cannot be recreated by git. For text
175files this is the right thing to do: it corrects line endings
176such that we have only LF line endings in the repository.
177But for binary files that are accidentally classified as text the
178conversion can corrupt data.
179+
180If you recognize such corruption early you can easily fix it by
181setting the conversion type explicitly in .gitattributes. Right
182after committing you still have the original file in your work
183tree and this file is not yet corrupted. You can explicitly tell
184git that this file is binary and git will handle the file
185appropriately.
186+
187Unfortunately, the desired effect of cleaning up text files with
188mixed line endings and the undesired effect of corrupting binary
189files cannot be distinguished. In both cases CRLFs are removed
190in an irreversible way. For text files this is the right thing
191to do because CRLFs are line endings, while for binary files
192converting CRLFs corrupts data.
193+
194Note, this safety check does not mean that a checkout will generate a
195file identical to the original file for a different setting of
196`core.autocrlf`, but only for the current one. For example, a text
197file with `LF` would be accepted with `core.autocrlf=input` and could
198later be checked out with `core.autocrlf=true`, in which case the
199resulting file would contain `CRLF`, although the original file
200contained `LF`. However, in both work trees the line endings would be
201consistent, that is either all `LF` or all `CRLF`, but never mixed. A
202file with mixed line endings would be reported by the `core.safecrlf`
203mechanism.
204
Junio C Hamanoaa83a7d2007-03-05 02:37:29205core.symlinks::
206If false, symbolic links are checked out as small plain files that
Junio C Hamano35738e82008-01-07 07:55:46207contain the link text. linkgit:git-update-index[1] and
208linkgit:git-add[1] will not change the recorded type to regular
Junio C Hamanoaa83a7d2007-03-05 02:37:29209file. Useful on filesystems like FAT that do not support
210symbolic links. True by default.
211
Junio C Hamano07824ce2006-04-25 07:36:54212core.gitProxy::
213A "proxy command" to execute (as 'command host port') instead
214of establishing direct connection to the remote server when
215using the git protocol for fetching. If the variable value is
216in the "COMMAND for DOMAIN" format, the command is applied only
217on hostnames ending with the specified domain string. This variable
218may be set multiple times and is matched in the given order;
219the first match wins.
Junio C Hamanof1d14802006-06-08 00:48:17220+
221Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
222(which always applies universally, without the special "for"
223handling).
Junio C Hamanoea82cff2009-03-18 01:54:48224+
225The special string `none` can be used as the proxy command to
226specify that no proxy be used for a given domain pattern.
227This is useful for excluding servers inside a firewall from
228proxy use, while defaulting to a common proxy for external domains.
Junio C Hamano07824ce2006-04-25 07:36:54229
230core.ignoreStat::
Junio C Hamano054ea082008-06-01 08:26:34231If true, commands which modify both the working tree and the index
232will mark the updated paths with the "assume unchanged" bit in the
233index. These marked files are then assumed to stay unchanged in the
234working copy, until you mark them otherwise manually - Git will not
235detect the file changes by lstat() calls. This is useful on systems
236where those are very slow, such as Microsoft Windows.
237See linkgit:git-update-index[1].
Junio C Hamano07824ce2006-04-25 07:36:54238False by default.
239
Junio C Hamano88a3a072006-05-04 08:01:43240core.preferSymlinkRefs::
241Instead of the default "symref" format for HEAD
242and other symbolic reference files, use symbolic links.
243This is sometimes needed to work with old scripts that
244expect HEAD to be a symbolic link.
Junio C Hamano07824ce2006-04-25 07:36:54245
Junio C Hamano1025e752007-02-23 07:21:26246core.bare::
247If true this repository is assumed to be 'bare' and has no
248working directory associated with it. If this is the case a
249number of commands that require a working directory will be
Junio C Hamano35738e82008-01-07 07:55:46250disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
Junio C Hamano1025e752007-02-23 07:21:26251+
Junio C Hamano35738e82008-01-07 07:55:46252This setting is automatically guessed by linkgit:git-clone[1] or
253linkgit:git-init[1] when the repository was created. By default a
Junio C Hamano1025e752007-02-23 07:21:26254repository that ends in "/.git" is assumed to be not bare (bare =
255false), while all other repositories are assumed to be bare (bare
256= true).
257
Junio C Hamanod526ba92007-07-02 00:17:42258core.worktree::
259Set the path to the working tree. The value will not be
260used in combination with repositories found automatically in
261a .git directory (i.e. $GIT_DIR is not set).
Junio C Hamano764a6672007-10-23 01:23:31262This can be overridden by the GIT_WORK_TREE environment
Junio C Hamano7d575a52008-04-30 08:45:27263variable and the '--work-tree' command line option. It can be
264a absolute path or relative path to the directory specified by
265--git-dir or GIT_DIR.
266Note: If --git-dir or GIT_DIR are specified but none of
267--work-tree, GIT_WORK_TREE and core.worktree is specified,
268the current working directory is regarded as the top directory
269of your working tree.
Junio C Hamanod526ba92007-07-02 00:17:42270
Junio C Hamano341071d2006-06-04 07:24:48271core.logAllRefUpdates::
Junio C Hamanocae86272007-08-21 02:20:49272Enable the reflog. Updates to a ref <ref> is logged to the file
Junio C Hamanoa2ec14f2006-11-02 00:22:48273"$GIT_DIR/logs/<ref>", by appending the new and old
274SHA1, the date/time and the reason of the update, but
275only when the file exists. If this configuration
276variable is set to true, missing "$GIT_DIR/logs/<ref>"
277file is automatically created for branch heads.
Junio C Hamano1caaf472006-12-31 08:29:35278+
279This information can be used to determine what commit
280was the tip of a branch "2 days ago".
281+
282This value is true by default in a repository that has
283a working directory associated with it, and false by
284default in a bare repository.
Junio C Hamano341071d2006-06-04 07:24:48285
Junio C Hamano07824ce2006-04-25 07:36:54286core.repositoryFormatVersion::
287Internal variable identifying the repository format and layout
288version.
289
290core.sharedRepository::
Junio C Hamano0ab78ae2006-08-09 01:00:42291When 'group' (or 'true'), the repository is made shareable between
292several users in a group (making sure all the files and objects are
293group-writable). When 'all' (or 'world' or 'everybody'), the
294repository will be readable by all users, additionally to being
295group-shareable. When 'umask' (or 'false'), git will use permissions
Junio C Hamano2f102bb2008-04-26 02:23:37296reported by umask(2). When '0xxx', where '0xxx' is an octal number,
297files in the repository will have this mode value. '0xxx' will override
Junio C Hamano83eded12009-04-20 08:18:00298user's umask value (whereas the other options will only override
299requested parts of the user's umask value). Examples: '0660' will make
300the repo read/write-able for the owner and group, but inaccessible to
301others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
Junio C Hamano2f102bb2008-04-26 02:23:37302repository that is group-readable but not group-writable.
303See linkgit:git-init[1]. False by default.
Junio C Hamano07824ce2006-04-25 07:36:54304
305core.warnAmbiguousRefs::
306If true, git will warn you if the ref name you passed it is ambiguous
307and might match multiple refs in the .git/refs/ tree. True by default.
308
Junio C Hamano7ec15722006-07-07 02:03:59309core.compression::
Junio C Hamanof2ce2972007-05-20 19:12:09310An integer -1..9, indicating a default compression level.
311-1 is the zlib default. 0 means no compression,
312and 1..9 are various speed/size tradeoffs, 9 being slowest.
Junio C Hamano2e72a942007-11-21 08:54:42313If set, this provides a default to other compression variables,
314such as 'core.loosecompression' and 'pack.compression'.
Junio C Hamanoa126a3b2006-07-04 04:55:26315
Junio C Hamanof2ce2972007-05-20 19:12:09316core.loosecompression::
317An integer -1..9, indicating the compression level for objects that
318are not in a pack file. -1 is the zlib default. 0 means no
319compression, and 1..9 are various speed/size tradeoffs, 9 being
320slowest. If not set, defaults to core.compression. If that is
Junio C Hamano2e72a942007-11-21 08:54:42321not set, defaults to 1 (best speed).
Junio C Hamano28d9dfe2006-07-25 03:50:49322
Junio C Hamanofc4d38c2007-01-08 06:53:32323core.packedGitWindowSize::
324Number of bytes of a pack file to map into memory in a
325single mapping operation. Larger window sizes may allow
326your system to process a smaller number of large pack files
327more quickly. Smaller window sizes will negatively affect
328performance due to increased calls to the operating system's
329memory manager, but may improve performance when accessing
330a large number of large pack files.
331+
332Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
333MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
334be reasonable for all users/operating systems. You probably do
335not need to adjust this value.
336+
337Common unit suffixes of 'k', 'm', or 'g' are supported.
338
339core.packedGitLimit::
340Maximum number of bytes to map simultaneously into memory
341from pack files. If Git needs to access more than this many
342bytes at once to complete an operation it will unmap existing
343regions to reclaim virtual address space within the process.
344+
345Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
346This should be reasonable for all users/operating systems, except on
347the largest projects. You probably do not need to adjust this value.
348+
349Common unit suffixes of 'k', 'm', or 'g' are supported.
350
Junio C Hamanob8c51282007-03-19 10:43:30351core.deltaBaseCacheLimit::
352Maximum number of bytes to reserve for caching base objects
353that multiple deltafied objects reference. By storing the
354entire decompressed base objects in a cache Git is able
355to avoid unpacking and decompressing frequently used base
356objects multiple times.
357+
358Default is 16 MiB on all platforms. This should be reasonable
359for all users/operating systems, except on the largest projects.
360You probably do not need to adjust this value.
361+
362Common unit suffixes of 'k', 'm', or 'g' are supported.
363
Junio C Hamano1d90cb02007-07-03 07:05:31364core.excludesfile::
Junio C Hamano5e284b42007-05-22 07:23:37365In addition to '.gitignore' (per-directory) and
366'.git/info/exclude', git looks into this file for patterns
Junio C Hamano679d22d2007-06-02 21:13:44367of files which are not meant to be tracked. See
Junio C Hamano35738e82008-01-07 07:55:46368linkgit:gitignore[5].
Junio C Hamano5e284b42007-05-22 07:23:37369
Junio C Hamanof6002a92007-07-20 10:28:22370core.editor::
371Commands such as `commit` and `tag` that lets you edit
Junio C Hamanoa6387422007-08-25 03:54:27372messages by launching an editor uses the value of this
Junio C Hamanof6002a92007-07-20 10:28:22373variable when it is set, and the environment variable
374`GIT_EDITOR` is not set. The order of preference is
Junio C Hamanode9879a2007-07-22 09:33:42375`GIT_EDITOR` environment, `core.editor`, `VISUAL` and
376`EDITOR` environment variables and then finally `vi`.
Junio C Hamanof6002a92007-07-20 10:28:22377
Junio C Hamano28d8ede2007-07-05 05:51:38378core.pager::
Junio C Hamano0551f6a2008-08-25 00:33:33379The command that git will use to paginate output. Can
380be overridden with the `GIT_PAGER` environment
381variable. Note that git sets the `LESS` environment
382variable to `FRSX` if it is unset when it runs the
383pager. One can change these settings by setting the
Junio C Hamanoa476efa2008-10-10 15:31:42384`LESS` variable to some other value. Alternately,
385these settings can be overridden on a project or
386global basis by setting the `core.pager` option.
387Setting `core.pager` has no affect on the `LESS`
388environment variable behaviour above, so if you want
389to override git's default settings this way, you need
390to be explicit. For example, to disable the S option
391in a backward compatible manner, set `core.pager`
Junio C Hamanoea82cff2009-03-18 01:54:48392to `less -+$LESS -FRX`. This will be passed to the
Junio C Hamanoa476efa2008-10-10 15:31:42393shell by git, which will translate the final command to
Junio C Hamanoea82cff2009-03-18 01:54:48394`LESS=FRSX less -+FRSX -FRX`.
Junio C Hamano28d8ede2007-07-05 05:51:38395
Junio C Hamano942b35e2007-12-09 10:19:33396core.whitespace::
397A comma separated list of common whitespace problems to
Junio C Hamanoba4b9282008-07-06 05:20:31398notice. 'git-diff' will use `color.diff.whitespace` to
399highlight them, and 'git-apply --whitespace=error' will
Junio C Hamano3db8b412008-07-26 06:45:59400consider them as errors. You can prefix `-` to disable
401any of them (e.g. `-trailing-space`):
Junio C Hamano942b35e2007-12-09 10:19:33402+
403* `trailing-space` treats trailing whitespaces at the end of the line
404 as an error (enabled by default).
405* `space-before-tab` treats a space character that appears immediately
406 before a tab character in the initial indent part of the line as an
407 error (enabled by default).
408* `indent-with-non-tab` treats a line that is indented with 8 or more
Junio C Hamano42a2e2d2007-12-16 22:13:42409 space characters as an error (not enabled by default).
Junio C Hamano601f3e52008-02-25 08:40:42410* `cr-at-eol` treats a carriage-return at the end of line as
411 part of the line terminator, i.e. with it, `trailing-space`
412 does not trigger if the character before such a carriage-return
413 is not a whitespace (not enabled by default).
Junio C Hamano942b35e2007-12-09 10:19:33414
Junio C Hamano9eb57532008-06-26 06:33:46415core.fsyncobjectfiles::
416This boolean will enable 'fsync()' when writing object files.
417+
418This is a total waste of time and effort on a filesystem that orders
419data writes properly, but can be useful for filesystems that do not use
420journalling (traditional UNIX filesystems) or that only journal metadata
421and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
422
Junio C Hamano610d1762008-11-28 06:27:13423core.preloadindex::
424Enable parallel index preload for operations like 'git diff'
425+
426This can speed up operations like 'git diff' and 'git status' especially
427on filesystems like NFS that have weak caching semantics and thus
428relatively high IO latencies. With this set to 'true', git will do the
429index comparison to the filesystem data in parallel, allowing
430overlapping IO's.
431
Junio C Hamano33db4372006-06-07 19:51:45432alias.*::
Junio C Hamano35738e82008-01-07 07:55:46433Command aliases for the linkgit:git[1] command wrapper - e.g.
Junio C Hamano33db4372006-06-07 19:51:45434after defining "alias.last = cat-file commit HEAD", the invocation
435"git last" is equivalent to "git cat-file commit HEAD". To avoid
Junio C Hamanof1d14802006-06-08 00:48:17436confusion and troubles with script usage, aliases that
437hide existing git commands are ignored. Arguments are split by
438spaces, the usual shell quoting and escaping is supported.
439quote pair and a backslash can be used to quote them.
Junio C Hamanodbb64592007-09-01 11:17:39440+
441If the alias expansion is prefixed with an exclamation point,
442it will be treated as a shell command. For example, defining
443"alias.new = !gitk --all --not ORIG_HEAD", the invocation
444"git new" is equivalent to running the shell command
445"gitk --all --not ORIG_HEAD".
Junio C Hamano9cb74f22007-02-12 04:15:05446
Junio C Hamano07824ce2006-04-25 07:36:54447apply.whitespace::
Junio C Hamanoba4b9282008-07-06 05:20:31448Tells 'git-apply' how to handle whitespaces, in the same way
Junio C Hamano35738e82008-01-07 07:55:46449as the '--whitespace' option. See linkgit:git-apply[1].
Junio C Hamano07824ce2006-04-25 07:36:54450
Junio C Hamano7fd84172007-05-24 07:00:32451branch.autosetupmerge::
Junio C Hamanoba4b9282008-07-06 05:20:31452Tells 'git-branch' and 'git-checkout' to setup new branches
Junio C Hamano24bc09a2008-02-28 00:27:44453so that linkgit:git-pull[1] will appropriately merge from the
454starting point branch. Note that even if this option is not set,
Junio C Hamano7fd84172007-05-24 07:00:32455this behavior can be chosen per-branch using the `--track`
Junio C Hamano24bc09a2008-02-28 00:27:44456and `--no-track` options. The valid settings are: `false` -- no
457automatic setup is done; `true` -- automatic setup is done when the
458starting point is a remote branch; `always` -- automatic setup is
459done when the starting point is either a local branch or remote
460branch. This option defaults to true.
Junio C Hamano7fd84172007-05-24 07:00:32461
Junio C Hamano869bb802008-05-12 00:29:47462branch.autosetuprebase::
Junio C Hamanoba4b9282008-07-06 05:20:31463When a new branch is created with 'git-branch' or 'git-checkout'
Junio C Hamano869bb802008-05-12 00:29:47464that tracks another branch, this variable tells git to set
465up pull to rebase instead of merge (see "branch.<name>.rebase").
466When `never`, rebase is never automatically set to true.
467When `local`, rebase is set to true for tracked branches of
468other local branches.
469When `remote`, rebase is set to true for tracked branches of
470remote branches.
471When `always`, rebase will be set to true for all tracking
472branches.
473See "branch.autosetupmerge" for details on how to set up a
474branch to track another branch.
475This option defaults to never.
476
Junio C Hamano47c1e3c2006-09-25 04:45:55477branch.<name>.remote::
Junio C Hamano0706c802009-03-30 22:34:19478When in branch <name>, it tells 'git-fetch' and 'git-push' which
479remote to fetch from/push to. It defaults to `origin` if no remote is
480configured. `origin` is also used if you are not on any branch.
Junio C Hamano47c1e3c2006-09-25 04:45:55481
482branch.<name>.merge::
Junio C Hamano0706c802009-03-30 22:34:19483Defines, together with branch.<name>.remote, the upstream branch
484for the given branch. It tells 'git-fetch'/'git-pull' which
Junio C Hamano5f9a6f02009-04-06 08:26:56485branch to merge and can also affect 'git-push' (see push.default).
Junio C Hamanoba4b9282008-07-06 05:20:31486When in branch <name>, it tells 'git-fetch' the default
Junio C Hamanoc2b47092007-10-25 06:50:31487refspec to be marked for merging in FETCH_HEAD. The value is
488handled like the remote part of a refspec, and must match a
489ref which is fetched from the remote given by
490"branch.<name>.remote".
Junio C Hamanoba4b9282008-07-06 05:20:31491The merge information is used by 'git-pull' (which at first calls
492'git-fetch') to lookup the default branch for merging. Without
493this option, 'git-pull' defaults to merge the first refspec fetched.
Junio C Hamano96010b22006-12-09 21:15:46494Specify multiple values to get an octopus merge.
Junio C Hamanoba4b9282008-07-06 05:20:31495If you wish to setup 'git-pull' so that it merges into <name> from
Junio C Hamano6e149c02007-03-16 10:21:07496another branch in the local repository, you can point
497branch.<name>.merge to the desired branch, and use the special setting
498`.` (a period) for branch.<name>.remote.
Junio C Hamano47c1e3c2006-09-25 04:45:55499
Junio C Hamano1b50ce92007-10-03 12:05:53500branch.<name>.mergeoptions::
501Sets default options for merging into branch <name>. The syntax and
Junio C Hamano35738e82008-01-07 07:55:46502supported options are equal to that of linkgit:git-merge[1], but
Junio C Hamano1b50ce92007-10-03 12:05:53503option values containing whitespace characters are currently not
504supported.
505
Junio C Hamano0c999702007-12-03 09:57:55506branch.<name>.rebase::
507When true, rebase the branch <name> on top of the fetched branch,
Junio C Hamano6d76d612008-05-09 05:46:08508instead of merging the default branch from the default remote when
509"git pull" is run.
Junio C Hamano0c999702007-12-03 09:57:55510*NOTE*: this is a possibly dangerous operation; do *not* use
Junio C Hamano35738e82008-01-07 07:55:46511it unless you understand the implications (see linkgit:git-rebase[1]
Junio C Hamano0c999702007-12-03 09:57:55512for details).
513
Junio C Hamano8760ea62008-03-14 08:58:45514browser.<tool>.cmd::
515Specify the command to invoke the specified browser. The
516specified command is evaluated in shell with the URLs passed
517as arguments. (See linkgit:git-web--browse[1].)
518
Junio C Hamanoe35a6fc2008-01-29 09:46:27519browser.<tool>.path::
520Override the path for the given tool that may be used to
521browse HTML help (see '-w' option in linkgit:git-help[1]) or a
522working repository in gitweb (see linkgit:git-instaweb[1]).
523
Junio C Hamano47b9acd2007-04-24 07:34:34524clean.requireForce::
Junio C Hamano422cfec2007-11-08 08:07:45525A boolean to make git-clean do nothing unless given -f
526or -n. Defaults to true.
Junio C Hamano47b9acd2007-04-24 07:34:34527
Junio C Hamanoeb692952007-01-03 22:02:12528color.branch::
529A boolean to enable/disable color in the output of
Junio C Hamano35738e82008-01-07 07:55:46530linkgit:git-branch[1]. May be set to `always`,
Junio C Hamano0fc8cd92007-12-06 03:26:21531`false` (or `never`) or `auto` (or `true`), in which case colors are used
Junio C Hamanoeb692952007-01-03 22:02:12532only when the output is to a terminal. Defaults to false.
533
534color.branch.<slot>::
535Use customized color for branch coloration. `<slot>` is one of
536`current` (the current branch), `local` (a local branch),
537`remote` (a tracking branch in refs/remotes/), `plain` (other
Junio C Hamano5a702332007-01-28 20:55:22538refs).
539+
540The value for these configuration variables is a list of colors (at most
541two) and attributes (at most one), separated by spaces. The colors
542accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
543`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
544`blink` and `reverse`. The first color given is the foreground; the
545second is the background. The position of the attribute, if any,
546doesn't matter.
Junio C Hamanoeb692952007-01-03 22:02:12547
Junio C Hamano3f403b02006-12-13 10:14:13548color.diff::
Junio C Hamano0fc8cd92007-12-06 03:26:21549When set to `always`, always use colors in patch.
550When false (or `never`), never. When set to `true` or `auto`, use
551colors only when the output is to the terminal. Defaults to false.
Junio C Hamano9ae1a062006-07-10 08:12:34552
Junio C Hamano3f403b02006-12-13 10:14:13553color.diff.<slot>::
Junio C Hamano5a702332007-01-28 20:55:22554Use customized color for diff colorization. `<slot>` specifies
555which part of the patch to use the specified color, and is one
556of `plain` (context text), `meta` (metainformation), `frag`
557(hunk header), `old` (removed lines), `new` (added lines),
Junio C Hamano942b35e2007-12-09 10:19:33558`commit` (commit headers), or `whitespace` (highlighting
559whitespace errors). The values of these variables may be specified as
Junio C Hamano5a702332007-01-28 20:55:22560in color.branch.<slot>.
Junio C Hamano9ae1a062006-07-10 08:12:34561
Junio C Hamanod257cff2009-03-18 05:27:16562color.grep::
563When set to `always`, always highlight matches. When `false` (or
564`never`), never. When set to `true` or `auto`, use color only
565when the output is written to the terminal. Defaults to `false`.
566
567color.grep.external::
568The string value of this variable is passed to an external 'grep'
569command as a command line option if match highlighting is turned
570on. If set to an empty string, no option is passed at all,
571turning off coloring for external 'grep' calls; this is the default.
572For GNU grep, set it to `--color=always` to highlight matches even
573when a pager is used.
574
575color.grep.match::
576Use customized color for matches. The value of this variable
577may be specified as in color.branch.<slot>. It is passed using
578the environment variables 'GREP_COLOR' and 'GREP_COLORS' when
579calling an external 'grep'.
580
Junio C Hamano00b8b632007-12-07 09:50:49581color.interactive::
Junio C Hamano35738e82008-01-07 07:55:46582When set to `always`, always use colors for interactive prompts
Junio C Hamanoba4b9282008-07-06 05:20:31583and displays (such as those used by "git-add --interactive").
Junio C Hamano00b8b632007-12-07 09:50:49584When false (or `never`), never. When set to `true` or `auto`, use
585colors only when the output is to the terminal. Defaults to false.
586
587color.interactive.<slot>::
Junio C Hamanoba4b9282008-07-06 05:20:31588Use customized color for 'git-add --interactive'
Junio C Hamanoe5bf6c12009-02-07 21:43:10589output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
590four distinct types of normal output from interactive
Junio C Hamano00b8b632007-12-07 09:50:49591programs. The values of these variables may be specified as
592in color.branch.<slot>.
593
Junio C Hamanoe7935c42006-12-13 21:32:17594color.pager::
595A boolean to enable/disable colored output when the pager is in
596use (default is true).
597
598color.status::
599A boolean to enable/disable color in the output of
Junio C Hamano35738e82008-01-07 07:55:46600linkgit:git-status[1]. May be set to `always`,
Junio C Hamano0fc8cd92007-12-06 03:26:21601`false` (or `never`) or `auto` (or `true`), in which case colors are used
Junio C Hamanoe7935c42006-12-13 21:32:17602only when the output is to a terminal. Defaults to false.
603
604color.status.<slot>::
605Use customized color for status colorization. `<slot>` is
606one of `header` (the header text of the status message),
Junio C Hamano7d23f5e2006-12-16 07:44:04607`added` or `updated` (files which are added but not committed),
608`changed` (files which are changed but not added in the index),
Junio C Hamanob713ff12008-05-24 01:12:30609`untracked` (files which are not tracked by git), or
610`nobranch` (the color the 'no branch' warning is shown in, defaulting
611to red). The values of these variables may be specified as in
612color.branch.<slot>.
Junio C Hamanoe7935c42006-12-13 21:32:17613
Junio C Hamano83d46a22008-02-21 02:29:42614color.ui::
615When set to `always`, always use colors in all git commands which
616are capable of colored output. When false (or `never`), never. When
617set to `true` or `auto`, use colors only when the output is to the
618terminal. When more specific variables of color.* are set, they always
619take precedence over this setting. Defaults to false.
620
Junio C Hamano4653c6f2008-11-26 22:50:20621commit.template::
622Specify a file to use as the template for new commit messages.
623
Junio C Hamanodbb64592007-09-01 11:17:39624diff.autorefreshindex::
Junio C Hamanoba4b9282008-07-06 05:20:31625When using 'git-diff' to compare with work tree
Junio C Hamanodbb64592007-09-01 11:17:39626files, do not consider stat-only change as changed.
627Instead, silently run `git update-index --refresh` to
628update the cached stat information for paths whose
629contents in the work tree match the contents in the
630index. This option defaults to true. Note that this
Junio C Hamanoba4b9282008-07-06 05:20:31631affects only 'git-diff' Porcelain, and not lower level
632'diff' commands, such as 'git-diff-files'.
Junio C Hamanodbb64592007-09-01 11:17:39633
Junio C Hamano1fbbbc12007-12-18 07:01:27634diff.external::
635If this config variable is set, diff generation is not
636performed using the internal diff machinery, but using the
Junio C Hamano85c71572008-07-28 00:03:31637given command. Can be overridden with the `GIT_EXTERNAL_DIFF'
638environment variable. The command is called with parameters
639as described under "git Diffs" in linkgit:git[1]. Note: if
640you want to use an external diff program only on a subset of
641your files, you might want to use linkgit:gitattributes[5] instead.
Junio C Hamano1fbbbc12007-12-18 07:01:27642
Junio C Hamano5e4d8de2008-09-19 06:27:02643diff.mnemonicprefix::
644If set, 'git-diff' uses a prefix pair that is different from the
645standard "a/" and "b/" depending on what is being compared. When
646this configuration is in effect, reverse diff output also swaps
647the order of the prefixes:
648'git-diff';;
649compares the (i)ndex and the (w)ork tree;
650'git-diff HEAD';;
651 compares a (c)ommit and the (w)ork tree;
652'git diff --cached';;
653compares a (c)ommit and the (i)ndex;
654'git-diff HEAD:file1 file2';;
655compares an (o)bject and a (w)ork tree entity;
656'git diff --no-index a b';;
657compares two non-git things (1) and (2).
658
Junio C Hamano07824ce2006-04-25 07:36:54659diff.renameLimit::
660The number of files to consider when performing the copy/rename
Junio C Hamanoba4b9282008-07-06 05:20:31661detection; equivalent to the 'git-diff' option '-l'.
Junio C Hamano07824ce2006-04-25 07:36:54662
Junio C Hamano9ae1a062006-07-10 08:12:34663diff.renames::
664Tells git to detect renames. If set to any boolean value, it
665will enable basic rename detection. If set to "copies" or
666"copy", it will detect copies, as well.
667
Junio C Hamanobc4852e2009-01-21 10:51:14668diff.suppressBlankEmpty::
Junio C Hamanof1231492008-12-22 08:27:21669A boolean to inhibit the standard behavior of printing a space
670before each empty output line. Defaults to false.
671
Junio C Hamano3bd66e92009-04-18 06:17:56672diff.tool::
673Controls which diff tool is used. `diff.tool` overrides
674`merge.tool` when used by linkgit:git-difftool[1] and has
675the same valid values as `merge.tool` minus "tortoisemerge"
676and plus "kompare".
677
678difftool.<tool>.path::
679Override the path for the given tool. This is useful in case
680your tool is not in the PATH.
681
682difftool.<tool>.cmd::
683Specify the command to invoke the specified diff tool.
684The specified command is evaluated in shell with the following
685variables available: 'LOCAL' is set to the name of the temporary
686file containing the contents of the diff pre-image and 'REMOTE'
687is set to the name of the temporary file containing the contents
688of the diff post-image.
689
690difftool.prompt::
691Prompt before each invocation of the diff tool.
692
Junio C Hamano20d47e32009-01-26 06:36:02693diff.wordRegex::
694A POSIX Extended Regular Expression used to determine what is a "word"
695when performing word-by-word difference calculations. Character
696sequences that match the regular expression are "words", all other
697characters are *ignorable* whitespace.
698
Junio C Hamano54ea8d32007-01-25 07:59:48699fetch.unpackLimit::
700If the number of objects fetched over the git native
701transfer is below this
702limit, then the objects will be unpacked into loose object
703files. However if the number of received objects equals or
704exceeds this limit then the received pack will be stored as
705a pack, after adding any missing delta bases. Storing the
706pack from a push can make the push operation complete faster,
Junio C Hamanoe77b0152008-01-12 06:44:17707especially on slow filesystems. If not set, the value of
708`transfer.unpackLimit` is used instead.
Junio C Hamano54ea8d32007-01-25 07:59:48709
Junio C Hamano8c5802d2007-11-15 00:13:36710format.numbered::
Junio C Hamano7d06a8a2008-10-20 05:42:33711A boolean which can enable or disable sequence numbers in patch
712subjects. It defaults to "auto" which enables it only if there
713is more than one patch. It can be enabled or disabled for all
714messages by setting it to "true" or "false". See --numbered
715option in linkgit:git-format-patch[1].
Junio C Hamano8c5802d2007-11-15 00:13:36716
Junio C Hamano07824ce2006-04-25 07:36:54717format.headers::
718Additional email headers to include in a patch to be submitted
Junio C Hamano35738e82008-01-07 07:55:46719by mail. See linkgit:git-format-patch[1].
Junio C Hamano07824ce2006-04-25 07:36:54720
Junio C Hamanod4c8e112007-03-04 10:32:38721format.suffix::
722The default for format-patch is to output files with the suffix
723`.patch`. Use this variable to change that suffix (make sure to
724include the dot if you want it).
725
Junio C Hamano86bcccc2008-03-08 09:33:55726format.pretty::
727The default pretty format for log/show/whatchanged command,
728See linkgit:git-log[1], linkgit:git-show[1],
729linkgit:git-whatchanged[1].
730
Junio C Hamanoea6a7642009-03-11 23:56:19731format.thread::
732The default threading style for 'git-format-patch'. Can be
733either a boolean value, `shallow` or `deep`. 'Shallow'
734threading makes every mail a reply to the head of the series,
735where the head is chosen from the cover letter, the
736`\--in-reply-to`, and the first patch mail, in this order.
737'Deep' threading makes every mail a reply to the previous one.
738A true boolean value is the same as `shallow`, and a false
739value disables threading.
740
Junio C Hamano5f9a6f02009-04-06 08:26:56741format.signoff::
742 A boolean value which lets you enable the `-s/--signoff` option of
743 format-patch by default. *Note:* Adding the Signed-off-by: line to a
744 patch should be a conscious act and means that you certify you have
745 the rights to submit this work under the same open source license.
746 Please see the 'SubmittingPatches' document for further discussion.
747
Junio C Hamanof2ce2972007-05-20 19:12:09748gc.aggressiveWindow::
749The window size parameter used in the delta compression
Junio C Hamanoba4b9282008-07-06 05:20:31750algorithm used by 'git-gc --aggressive'. This defaults
Junio C Hamanof2ce2972007-05-20 19:12:09751to 10.
752
Junio C Hamano1b50ce92007-10-03 12:05:53753gc.auto::
754When there are approximately more than this many loose
755objects in the repository, `git gc --auto` will pack them.
756Some Porcelain commands use this command to perform a
Junio C Hamanoe77b0152008-01-12 06:44:17757light-weight garbage collection from time to time. The
758default value is 6700. Setting this to 0 disables it.
Junio C Hamano1b50ce92007-10-03 12:05:53759
760gc.autopacklimit::
761When there are more than this many packs that are not
762marked with `*.keep` file in the repository, `git gc
Junio C Hamanoe77b0152008-01-12 06:44:17763--auto` consolidates them into one larger pack. The
Junio C Hamano25c0b702008-03-23 09:41:37764default value is 50. Setting this to 0 disables it.
Junio C Hamano1b50ce92007-10-03 12:05:53765
Junio C Hamano9d52e572007-02-13 23:48:20766gc.packrefs::
Junio C Hamanoba4b9282008-07-06 05:20:31767'git-gc' does not run `git pack-refs` in a bare repository by
Junio C Hamano9d52e572007-02-13 23:48:20768default so that older dumb-transport clients can still fetch
Junio C Hamanoba4b9282008-07-06 05:20:31769from the repository. Setting this to `true` lets 'git-gc'
770to run `git pack-refs`. Setting this to `false` tells
771'git-gc' never to run `git pack-refs`. The default setting is
Junio C Hamano9d52e572007-02-13 23:48:20772`notbare`. Enable it only when you know you do not have to
773support such clients. The default setting will change to `true`
774at some stage, and setting this to `false` will continue to
Junio C Hamanoba4b9282008-07-06 05:20:31775prevent `git pack-refs` from being run from 'git-gc'.
Junio C Hamano9d52e572007-02-13 23:48:20776
Junio C Hamano09a926d2008-03-13 07:55:29777gc.pruneexpire::
Junio C Hamanoba4b9282008-07-06 05:20:31778When 'git-gc' is run, it will call 'prune --expire 2.weeks.ago'.
Junio C Hamanoa3148f52009-01-14 08:49:57779Override the grace period with this config variable. The value
780"now" may be used to disable this grace period and always prune
781unreachable objects immediately.
Junio C Hamano09a926d2008-03-13 07:55:29782
Junio C Hamano74640642006-12-27 10:59:55783gc.reflogexpire::
Junio C Hamanoba4b9282008-07-06 05:20:31784'git-reflog expire' removes reflog entries older than
Junio C Hamano74640642006-12-27 10:59:55785this time; defaults to 90 days.
786
787gc.reflogexpireunreachable::
Junio C Hamanoba4b9282008-07-06 05:20:31788'git-reflog expire' removes reflog entries older than
Junio C Hamano74640642006-12-27 10:59:55789this time and are not reachable from the current tip;
790defaults to 30 days.
791
792gc.rerereresolved::
793Records of conflicted merge you resolved earlier are
Junio C Hamanoba4b9282008-07-06 05:20:31794kept for this many days when 'git-rerere gc' is run.
Junio C Hamano35738e82008-01-07 07:55:46795The default is 60 days. See linkgit:git-rerere[1].
Junio C Hamano74640642006-12-27 10:59:55796
797gc.rerereunresolved::
798Records of conflicted merge you have not resolved are
Junio C Hamanoba4b9282008-07-06 05:20:31799kept for this many days when 'git-rerere gc' is run.
Junio C Hamano35738e82008-01-07 07:55:46800The default is 15 days. See linkgit:git-rerere[1].
Junio C Hamano74640642006-12-27 10:59:55801
Junio C Hamanoa3148f52009-01-14 08:49:57802gitcvs.commitmsgannotation::
803Append this string to each commit message. Set to empty string
804to disable this feature. Defaults to "via git-CVS emulator".
805
Junio C Hamano07824ce2006-04-25 07:36:54806gitcvs.enabled::
Junio C Hamanoa6387422007-08-25 03:54:27807Whether the CVS server interface is enabled for this repository.
Junio C Hamano35738e82008-01-07 07:55:46808See linkgit:git-cvsserver[1].
Junio C Hamano07824ce2006-04-25 07:36:54809
810gitcvs.logfile::
Junio C Hamanoa6387422007-08-25 03:54:27811Path to a log file where the CVS server interface well... logs
Junio C Hamano35738e82008-01-07 07:55:46812various stuff. See linkgit:git-cvsserver[1].
Junio C Hamano07824ce2006-04-25 07:36:54813
Junio C Hamano17bd2272008-09-01 06:11:17814gitcvs.usecrlfattr::
Junio C Hamanodfccbb02008-05-26 01:16:14815If true, the server will look up the `crlf` attribute for
816files to determine the '-k' modes to use. If `crlf` is set,
817the '-k' mode will be left blank, so cvs clients will
818treat it as text. If `crlf` is explicitly unset, the file
Junio C Hamanocb1c44f2008-08-06 06:19:33819will be set with '-kb' mode, which suppresses any newline munging
Junio C Hamanodfccbb02008-05-26 01:16:14820the client might otherwise do. If `crlf` is not specified,
Junio C Hamanod32738e2008-07-09 19:53:42821then 'gitcvs.allbinary' is used. See linkgit:gitattributes[5].
Junio C Hamanodfccbb02008-05-26 01:16:14822
Junio C Hamanod9e0e5d2007-04-14 16:22:04823gitcvs.allbinary::
Junio C Hamanodfccbb02008-05-26 01:16:14824This is used if 'gitcvs.usecrlfattr' does not resolve
825the correct '-kb' mode to use. If true, all
826unresolved files are sent to the client in
827mode '-kb'. This causes the client to treat them
828as binary files, which suppresses any newline munging it
829otherwise might do. Alternatively, if it is set to "guess",
830then the contents of the file are examined to decide if
831it is binary, similar to 'core.autocrlf'.
Junio C Hamanoa2ad99e2007-04-18 09:57:04832
833gitcvs.dbname::
834Database used by git-cvsserver to cache revision information
835derived from the git repository. The exact meaning depends on the
836used database driver, for SQLite (which is the default driver) this
837is a filename. Supports variable substitution (see
Junio C Hamano35738e82008-01-07 07:55:46838linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
Junio C Hamanoa2ad99e2007-04-18 09:57:04839Default: '%Ggitcvs.%m.sqlite'
840
841gitcvs.dbdriver::
842Used Perl DBI driver. You can specify any available driver
843 for this here, but it might not work. git-cvsserver is tested
844with 'DBD::SQLite', reported to work with 'DBD::Pg', and
845reported *not* to work with 'DBD::mysql'. Experimental feature.
846May not contain double colons (`:`). Default: 'SQLite'.
Junio C Hamano35738e82008-01-07 07:55:46847See linkgit:git-cvsserver[1].
Junio C Hamanod9e0e5d2007-04-14 16:22:04848
Junio C Hamanoa2ad99e2007-04-18 09:57:04849gitcvs.dbuser, gitcvs.dbpass::
850Database user and password. Only useful if setting 'gitcvs.dbdriver',
851since SQLite has no concept of database users and/or passwords.
852'gitcvs.dbuser' supports variable substitution (see
Junio C Hamano35738e82008-01-07 07:55:46853linkgit:git-cvsserver[1] for details).
Junio C Hamanoa2ad99e2007-04-18 09:57:04854
Junio C Hamanoa74efce2008-04-02 08:39:08855gitcvs.dbTableNamePrefix::
856Database table name prefix. Prepended to the names of any
857database tables used, allowing a single database to be used
858for several repositories. Supports variable substitution (see
859linkgit:git-cvsserver[1] for details). Any non-alphabetic
860characters will be replaced with underscores.
861
Junio C Hamanodfccbb02008-05-26 01:16:14862All gitcvs variables except for 'gitcvs.usecrlfattr' and
863'gitcvs.allbinary' can also be specified as
864'gitcvs.<access_method>.<varname>' (where 'access_method'
Junio C Hamanoa6387422007-08-25 03:54:27865is one of "ext" and "pserver") to make them apply only for the given
866access method.
Junio C Hamanoa2ad99e2007-04-18 09:57:04867
Junio C Hamano6d76d612008-05-09 05:46:08868gui.commitmsgwidth::
869Defines how wide the commit message window is in the
870linkgit:git-gui[1]. "75" is the default.
871
872gui.diffcontext::
873Specifies how many context lines should be used in calls to diff
874made by the linkgit:git-gui[1]. The default is "5".
875
Junio C Hamanod3452a02008-11-15 08:07:55876gui.encoding::
877Specifies the default encoding to use for displaying of
878file contents in linkgit:git-gui[1] and linkgit:gitk[1].
879It can be overridden by setting the 'encoding' attribute
880for relevant files (see linkgit:gitattributes[5]).
881If this option is not set, the tools default to the
882locale encoding.
883
Junio C Hamano6d76d612008-05-09 05:46:08884gui.matchtrackingbranch::
885Determines if new branches created with linkgit:git-gui[1] should
886default to tracking remote branches with matching names or
887not. Default: "false".
888
889gui.newbranchtemplate::
890Is used as suggested name when creating new branches using the
891linkgit:git-gui[1].
892
893gui.pruneduringfetch::
894"true" if linkgit:git-gui[1] should prune tracking branches when
895performing a fetch. The default value is "false".
896
897gui.trustmtime::
898Determines if linkgit:git-gui[1] should trust the file modification
899timestamp or not. By default the timestamps are not trusted.
900
901gui.spellingdictionary::
902Specifies the dictionary used for spell checking commit messages in
903the linkgit:git-gui[1]. When set to "none" spell checking is turned
904off.
905
Junio C Hamanod3452a02008-11-15 08:07:55906gui.fastcopyblame::
907If true, 'git gui blame' uses '-C' instead of '-C -C' for original
908location detection. It makes blame significantly faster on huge
909repositories at the expense of less thorough copy detection.
910
911gui.copyblamethreshold::
Junio C Hamano610d1762008-11-28 06:27:13912Specifies the threshold to use in 'git gui blame' original location
Junio C Hamanod3452a02008-11-15 08:07:55913detection, measured in alphanumeric characters. See the
914linkgit:git-blame[1] manual for more information on copy detection.
915
916gui.blamehistoryctx::
917Specifies the radius of history context in days to show in
918linkgit:gitk[1] for the selected commit, when the `Show History
919Context` menu item is invoked from 'git gui blame'. If this
920variable is set to zero, the whole history is shown.
921
Junio C Hamano92d312a2008-12-15 07:22:20922guitool.<name>.cmd::
923Specifies the shell command line to execute when the corresponding item
924of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
925mandatory for every tool. The command is executed from the root of
926the working directory, and in the environment it receives the name of
927the tool as 'GIT_GUITOOL', the name of the currently selected file as
928'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
929the head is detached, 'CUR_BRANCH' is empty).
930
931guitool.<name>.needsfile::
932Run the tool only if a diff is selected in the GUI. It guarantees
933that 'FILENAME' is not empty.
934
935guitool.<name>.noconsole::
936Run the command silently, without creating a window to display its
937output.
938
939guitool.<name>.norescan::
940Don't rescan the working directory for changes after the tool
941finishes execution.
942
943guitool.<name>.confirm::
944Show a confirmation dialog before actually running the tool.
945
946guitool.<name>.argprompt::
947Request a string argument from the user, and pass it to the tool
948through the 'ARGS' environment variable. Since requesting an
949argument implies confirmation, the 'confirm' option has no effect
950if this is enabled. If the option is set to 'true', 'yes', or '1',
951the dialog uses a built-in generic prompt; otherwise the exact
952value of the variable is used.
953
954guitool.<name>.revprompt::
955Request a single valid revision from the user, and set the
956'REVISION' environment variable. In other aspects this option
957is similar to 'argprompt', and can be used together with it.
958
959guitool.<name>.revunmerged::
960Show only unmerged branches in the 'revprompt' subdialog.
961This is useful for tools similar to merge or rebase, but not
962for things like checkout or reset.
963
964guitool.<name>.title::
965Specifies the title to use for the prompt dialog. The default
966is the tool name.
967
968guitool.<name>.prompt::
969Specifies the general prompt string to display at the top of
970the dialog, before subsections for 'argprompt' and 'revprompt'.
971The default value includes the actual command.
972
Junio C Hamano4e272312008-01-08 09:13:21973help.browser::
974Specify the browser that will be used to display help in the
975'web' format. See linkgit:git-help[1].
976
977help.format::
978Override the default help format used by linkgit:git-help[1].
979Values 'man', 'info', 'web' and 'html' are supported. 'man' is
980the default. 'web' and 'html' are the same.
981
Junio C Hamanof24b8062008-09-09 01:34:39982help.autocorrect::
983Automatically correct and execute mistyped commands after
984waiting for the given number of deciseconds (0.1 sec). If more
985than one command can be deduced from the entered text, nothing
986will be executed. If the value of this option is negative,
987the corrected command will be executed immediately. If the
988value is 0 - the command will be just shown but not executed.
989This is the default.
990
Junio C Hamano58256872007-12-04 08:31:13991http.proxy::
992Override the HTTP proxy, normally configured using the 'http_proxy'
Junio C Hamano35738e82008-01-07 07:55:46993environment variable (see linkgit:curl[1]). This can be overridden
Junio C Hamano58256872007-12-04 08:31:13994on a per-remote basis; see remote.<name>.proxy
995
Junio C Hamano07824ce2006-04-25 07:36:54996http.sslVerify::
997Whether to verify the SSL certificate when fetching or pushing
Junio C Hamano33db4372006-06-07 19:51:45998over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
Junio C Hamano07824ce2006-04-25 07:36:54999variable.
1000
1001http.sslCert::
1002File containing the SSL certificate when fetching or pushing
Junio C Hamano33db4372006-06-07 19:51:451003over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
Junio C Hamano07824ce2006-04-25 07:36:541004variable.
1005
1006http.sslKey::
1007File containing the SSL private key when fetching or pushing
Junio C Hamano341071d2006-06-04 07:24:481008over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
Junio C Hamano07824ce2006-04-25 07:36:541009variable.
1010
1011http.sslCAInfo::
1012File containing the certificates to verify the peer with when
Junio C Hamano341071d2006-06-04 07:24:481013fetching or pushing over HTTPS. Can be overridden by the
Junio C Hamano07824ce2006-04-25 07:36:541014'GIT_SSL_CAINFO' environment variable.
1015
1016http.sslCAPath::
1017Path containing files with the CA certificates to verify the peer
Junio C Hamano33db4372006-06-07 19:51:451018with when fetching or pushing over HTTPS. Can be overridden
Junio C Hamano07824ce2006-04-25 07:36:541019by the 'GIT_SSL_CAPATH' environment variable.
1020
1021http.maxRequests::
Junio C Hamano341071d2006-06-04 07:24:481022How many HTTP requests to launch in parallel. Can be overridden
Junio C Hamano07824ce2006-04-25 07:36:541023by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1024
1025http.lowSpeedLimit, http.lowSpeedTime::
1026If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1027for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
Junio C Hamano341071d2006-06-04 07:24:481028Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
Junio C Hamano07824ce2006-04-25 07:36:541029'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1030
Junio C Hamanof1dcdfe2006-09-29 08:10:511031http.noEPSV::
1032A boolean which disables using of EPSV ftp command by curl.
Junio C Hamanod9e0e5d2007-04-14 16:22:041033This can helpful with some "poor" ftp servers which don't
Junio C Hamanof1dcdfe2006-09-29 08:10:511034support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1035environment variable. Default is false (curl will use EPSV).
1036
Junio C Hamano07824ce2006-04-25 07:36:541037i18n.commitEncoding::
1038Character encoding the commit messages are stored in; git itself
1039does not care per se, but this information is necessary e.g. when
1040importing commits from emails or in the gitk graphical history
1041browser (and possibly at other places in the future or in other
Junio C Hamano35738e82008-01-07 07:55:461042porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
Junio C Hamano07824ce2006-04-25 07:36:541043
Junio C Hamano51f92e22006-12-29 05:18:281044i18n.logOutputEncoding::
1045Character encoding the commit messages are converted to when
Junio C Hamanoba4b9282008-07-06 05:20:311046running 'git-log' and friends.
Junio C Hamano51f92e22006-12-29 05:18:281047
Junio C Hamano4653c6f2008-11-26 22:50:201048imap::
1049The configuration variables in the 'imap' section are described
1050in linkgit:git-imap-send[1].
1051
Junio C Hamano4e272312008-01-08 09:13:211052instaweb.browser::
1053Specify the program that will be used to browse your working
1054repository in gitweb. See linkgit:git-instaweb[1].
1055
1056instaweb.httpd::
1057The HTTP daemon command-line to start gitweb on your working
1058repository. See linkgit:git-instaweb[1].
1059
1060instaweb.local::
1061If true the web server started by linkgit:git-instaweb[1] will
1062be bound to the local IP (127.0.0.1).
1063
1064instaweb.modulepath::
1065The module path for an apache httpd used by linkgit:git-instaweb[1].
1066
1067instaweb.port::
1068The port number to bind the gitweb httpd to. See
1069linkgit:git-instaweb[1].
1070
Junio C Hamanoe5bf6c12009-02-07 21:43:101071interactive.singlekey::
1072In interactive programs, allow the user to provide one-letter
1073input with a single key (i.e., without hitting enter).
1074Currently this is used only by the `\--patch` mode of
1075linkgit:git-add[1]. Note that this setting is silently
1076ignored if portable keystroke input is not available.
1077
Junio C Hamanob713ff12008-05-24 01:12:301078log.date::
1079Set default date-time mode for the log command. Setting log.date
Junio C Hamanoba4b9282008-07-06 05:20:311080value is similar to using 'git-log'\'s --date option. The value is one of the
Junio C Hamanob713ff12008-05-24 01:12:301081following alternatives: {relative,local,default,iso,rfc,short}.
1082See linkgit:git-log[1].
1083
Junio C Hamanofe9acab2006-11-24 12:10:551084log.showroot::
1085If true, the initial commit will be shown as a big creation event.
1086This is equivalent to a diff against an empty tree.
Junio C Hamano35738e82008-01-07 07:55:461087Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
Junio C Hamanofe9acab2006-11-24 12:10:551088normally hide the root commit will now show it. True by default.
1089
Junio C Hamano8bc410e2009-02-15 10:38:191090mailmap.file::
1091The location of an augmenting mailmap file. The default
1092mailmap, located in the root of the repository, is loaded
1093first, then the mailmap file pointed to by this variable.
1094The location of the mailmap file may be in a repository
1095subdirectory, or somewhere outside of the repository itself.
1096See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1097
Junio C Hamano8b588d52008-03-15 09:48:371098man.viewer::
1099Specify the programs that may be used to display help in the
1100'man' format. See linkgit:git-help[1].
1101
Junio C Hamano6d76d612008-05-09 05:46:081102man.<tool>.cmd::
1103Specify the command to invoke the specified man viewer. The
1104specified command is evaluated in shell with the man page
1105passed as argument. (See linkgit:git-help[1].)
Junio C Hamano103ad7f2007-03-14 11:19:261106
Junio C Hamano6d76d612008-05-09 05:46:081107man.<tool>.path::
1108Override the path for the given tool that may be used to
1109display help in the 'man' format. See linkgit:git-help[1].
Junio C Hamanoe90436a2007-04-22 07:22:131110
Junio C Hamano4653c6f2008-11-26 22:50:201111include::merge-config.txt[]
Junio C Hamanoa476efa2008-10-10 15:31:421112
Junio C Hamano1fbbbc12007-12-18 07:01:271113mergetool.<tool>.path::
1114Override the path for the given tool. This is useful in case
1115your tool is not in the PATH.
1116
Junio C Hamano86bcccc2008-03-08 09:33:551117mergetool.<tool>.cmd::
1118Specify the command to invoke the specified merge tool. The
1119specified command is evaluated in shell with the following
1120variables available: 'BASE' is the name of a temporary file
1121containing the common base of the files to be merged, if available;
1122'LOCAL' is the name of a temporary file containing the contents of
1123the file on the current branch; 'REMOTE' is the name of a temporary
1124file containing the contents of the file from the branch being
1125merged; 'MERGED' contains the name of the file to which the merge
1126tool should write the results of a successful merge.
1127
1128mergetool.<tool>.trustExitCode::
1129For a custom merge command, specify whether the exit code of
1130the merge command can be used to determine whether the merge was
1131successful. If this is not set to true then the merge target file
1132timestamp is checked and the merge assumed to have been successful
1133if the file has been updated, otherwise the user is prompted to
1134indicate the success of the merge.
1135
1136mergetool.keepBackup::
1137After performing a merge, the original file with conflict markers
1138can be saved as a file with a `.orig` extension. If this variable
1139is set to `false` then this file is not preserved. Defaults to
1140`true` (i.e. keep the backup files).
1141
Junio C Hamano10b7a342009-01-01 22:05:171142mergetool.keepTemporaries::
1143When invoking a custom merge tool, git uses a set of temporary
1144files to pass to the tool. If the tool returns an error and this
1145variable is set to `true`, then these temporary files will be
1146preserved, otherwise they will be removed after the tool has
1147exited. Defaults to `false`.
1148
1149mergetool.prompt::
1150Prompt before each invocation of the merge resolution program.
1151
Junio C Hamano75cc4c92006-07-24 08:25:031152pack.window::
Junio C Hamano35738e82008-01-07 07:55:461153The size of the window used by linkgit:git-pack-objects[1] when no
Junio C Hamano75cc4c92006-07-24 08:25:031154window size is given on the command line. Defaults to 10.
1155
Junio C Hamano91d44c52007-05-09 07:16:071156pack.depth::
Junio C Hamano35738e82008-01-07 07:55:461157The maximum delta depth used by linkgit:git-pack-objects[1] when no
Junio C Hamano91d44c52007-05-09 07:16:071158maximum depth is given on the command line. Defaults to 50.
1159
Junio C Hamano235d53f2007-07-13 00:25:151160pack.windowMemory::
Junio C Hamano35738e82008-01-07 07:55:461161The window memory size limit used by linkgit:git-pack-objects[1]
Junio C Hamano235d53f2007-07-13 00:25:151162when no limit is given on the command line. The value can be
1163suffixed with "k", "m", or "g". Defaults to 0, meaning no
1164limit.
1165
Junio C Hamanof2ce2972007-05-20 19:12:091166pack.compression::
1167An integer -1..9, indicating the compression level for objects
1168in a pack file. -1 is the zlib default. 0 means no
1169compression, and 1..9 are various speed/size tradeoffs, 9 being
1170slowest. If not set, defaults to core.compression. If that is
Junio C Hamano2e72a942007-11-21 08:54:421171not set, defaults to -1, the zlib default, which is "a default
1172compromise between speed and compression (currently equivalent
1173to level 6)."
Junio C Hamanof2ce2972007-05-20 19:12:091174
Junio C Hamano679d22d2007-06-02 21:13:441175pack.deltaCacheSize::
Junio C Hamanoa6387422007-08-25 03:54:271176The maximum memory in bytes used for caching deltas in
Junio C Hamano35738e82008-01-07 07:55:461177linkgit:git-pack-objects[1].
Junio C Hamano679d22d2007-06-02 21:13:441178A value of 0 means no limit. Defaults to 0.
1179
1180pack.deltaCacheLimit::
Junio C Hamano58155b42007-09-15 07:46:141181The maximum size of a delta, that is cached in
Junio C Hamano35738e82008-01-07 07:55:461182linkgit:git-pack-objects[1]. Defaults to 1000.
Junio C Hamano679d22d2007-06-02 21:13:441183
Junio C Hamano58155b42007-09-15 07:46:141184pack.threads::
1185Specifies the number of threads to spawn when searching for best
Junio C Hamano35738e82008-01-07 07:55:461186delta matches. This requires that linkgit:git-pack-objects[1]
Junio C Hamano58155b42007-09-15 07:46:141187be compiled with pthreads otherwise this option is ignored with a
1188warning. This is meant to reduce packing time on multiprocessor
1189machines. The required amount of memory for the delta search window
1190is however multiplied by the number of threads.
Junio C Hamano24bc09a2008-02-28 00:27:441191Specifying 0 will cause git to auto-detect the number of CPU's
1192and set the number of threads accordingly.
Junio C Hamano58155b42007-09-15 07:46:141193
Junio C Hamanod814b6d2007-11-04 11:13:491194pack.indexVersion::
1195Specify the default pack index version. Valid values are 1 for
1196legacy pack index used by Git versions prior to 1.5.2, and 2 for
1197the new pack index with capabilities for packs larger than 4 GB
1198as well as proper protection against the repacking of corrupted
Junio C Hamanofce7c7e2008-07-02 03:06:381199packs. Version 2 is the default. Note that version 2 is enforced
1200and this config option ignored whenever the corresponding pack is
1201larger than 2 GB.
1202+
1203If you have an old git that does not understand the version 2 `{asterisk}.idx` file,
1204cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1205that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the
1206other side may give you a repository that cannot be accessed with your
1207older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,
1208you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1209the `{asterisk}.idx` file.
Junio C Hamanod814b6d2007-11-04 11:13:491210
Junio C Hamano09a926d2008-03-13 07:55:291211pack.packSizeLimit::
Junio C Hamano49dccaf2008-02-10 10:48:011212The default maximum size of a pack. This setting only affects
1213packing to a file, i.e. the git:// protocol is unaffected. It
1214can be overridden by the `\--max-pack-size` option of
1215linkgit:git-repack[1].
1216
Junio C Hamano9e96a1a2008-08-16 10:23:181217pager.<cmd>::
Junio C Hamano0551f6a2008-08-25 00:33:331218Allows turning on or off pagination of the output of a
1219particular git subcommand when writing to a tty. If
1220`\--paginate` or `\--no-pager` is specified on the command line,
1221it takes precedence over this option. To disable pagination for
Junio C Hamanoea82cff2009-03-18 01:54:481222all commands, set `core.pager` or `GIT_PAGER` to `cat`.
Junio C Hamano9e96a1a2008-08-16 10:23:181223
Junio C Hamano07824ce2006-04-25 07:36:541224pull.octopus::
1225The default merge strategy to use when pulling multiple branches
1226at once.
1227
1228pull.twohead::
1229The default merge strategy to use when pulling a single branch.
1230
Junio C Hamano1de75722009-03-26 08:39:381231push.default::
1232Defines the action git push should take if no refspec is given
1233on the command line, no refspec is configured in the remote, and
1234no refspec is implied by any of the options given on the command
Junio C Hamano0706c802009-03-30 22:34:191235line. Possible values are:
Junio C Hamano1de75722009-03-26 08:39:381236+
1237* `nothing` do not push anything.
Junio C Hamano0706c802009-03-30 22:34:191238* `matching` push all matching branches.
Junio C Hamano1de75722009-03-26 08:39:381239 All branches having the same name in both ends are considered to be
Junio C Hamano0706c802009-03-30 22:34:191240 matching. This is the default.
Junio C Hamano98e32c32009-04-13 02:39:531241* `tracking` push the current branch to its upstream branch.
Junio C Hamano0706c802009-03-30 22:34:191242* `current` push the current branch to a branch of the same name.
Junio C Hamano1de75722009-03-26 08:39:381243
Junio C Hamanoea6a7642009-03-11 23:56:191244rebase.stat::
1245Whether to show a diffstat of what changed upstream since the last
1246rebase. False by default.
1247
Junio C Hamano4653c6f2008-11-26 22:50:201248receive.fsckObjects::
1249If it is set to true, git-receive-pack will check all received
1250objects. It will abort in the case of a malformed object or a
1251broken link. The result of an abort are only dangling objects.
1252Defaults to false.
1253
1254receive.unpackLimit::
1255If the number of objects received in a push is below this
1256limit then the objects will be unpacked into loose object
1257files. However if the number of received objects equals or
1258exceeds this limit then the received pack will be stored as
1259a pack, after adding any missing delta bases. Storing the
1260pack from a push can make the push operation complete faster,
1261especially on slow filesystems. If not set, the value of
1262`transfer.unpackLimit` is used instead.
1263
1264receive.denyDeletes::
1265If set to true, git-receive-pack will deny a ref update that deletes
1266the ref. Use this to prevent such a ref deletion via a push.
1267
1268receive.denyCurrentBranch::
1269If set to true or "refuse", receive-pack will deny a ref update
1270to the currently checked out branch of a non-bare repository.
1271Such a push is potentially dangerous because it brings the HEAD
1272out of sync with the index and working tree. If set to "warn",
1273print a warning of such a push to stderr, but allow the push to
1274proceed. If set to false or "ignore", allow such pushes with no
1275message. Defaults to "warn".
1276
1277receive.denyNonFastForwards::
1278If set to true, git-receive-pack will deny a ref update which is
1279not a fast forward. Use this to prevent such an update via a push,
1280even if that push is forced. This configuration variable is
1281set when initializing a shared repository.
1282
Junio C Hamano249572f2006-10-24 05:44:081283remote.<name>.url::
Junio C Hamano35738e82008-01-07 07:55:461284The URL of a remote repository. See linkgit:git-fetch[1] or
1285linkgit:git-push[1].
Junio C Hamano249572f2006-10-24 05:44:081286
Junio C Hamano58256872007-12-04 08:31:131287remote.<name>.proxy::
1288For remotes that require curl (http, https and ftp), the URL to
1289the proxy to use for that remote. Set to the empty string to
1290disable proxying for that remote.
1291
Junio C Hamano249572f2006-10-24 05:44:081292remote.<name>.fetch::
Junio C Hamano35738e82008-01-07 07:55:461293The default set of "refspec" for linkgit:git-fetch[1]. See
1294linkgit:git-fetch[1].
Junio C Hamano249572f2006-10-24 05:44:081295
1296remote.<name>.push::
Junio C Hamano35738e82008-01-07 07:55:461297The default set of "refspec" for linkgit:git-push[1]. See
1298linkgit:git-push[1].
Junio C Hamano249572f2006-10-24 05:44:081299
Junio C Hamano47d68a52008-05-06 06:35:401300remote.<name>.mirror::
1301If true, pushing to this remote will automatically behave
1302as if the `\--mirror` option was given on the command line.
1303
Junio C Hamano118d2772007-02-21 20:24:101304remote.<name>.skipDefaultUpdate::
1305If true, this remote will be skipped by default when updating
Junio C Hamano35738e82008-01-07 07:55:461306using the update subcommand of linkgit:git-remote[1].
Junio C Hamano118d2772007-02-21 20:24:101307
Junio C Hamano4ad294b2007-01-20 02:22:501308remote.<name>.receivepack::
Junio C Hamano54ea8d32007-01-25 07:59:481309The default program to execute on the remote side when pushing. See
Junio C Hamano86bcccc2008-03-08 09:33:551310option \--receive-pack of linkgit:git-push[1].
Junio C Hamano4ad294b2007-01-20 02:22:501311
Junio C Hamano54ea8d32007-01-25 07:59:481312remote.<name>.uploadpack::
1313The default program to execute on the remote side when fetching. See
Junio C Hamano86bcccc2008-03-08 09:33:551314option \--upload-pack of linkgit:git-fetch-pack[1].
Junio C Hamano54ea8d32007-01-25 07:59:481315
Junio C Hamano17dde0e2007-02-26 09:50:211316remote.<name>.tagopt::
Junio C Hamano86bcccc2008-03-08 09:33:551317Setting this value to \--no-tags disables automatic tag following when
1318fetching from remote <name>
Junio C Hamano17dde0e2007-02-26 09:50:211319
Junio C Hamano118d2772007-02-21 20:24:101320remotes.<group>::
1321The list of remotes which are fetched by "git remote update
Junio C Hamano35738e82008-01-07 07:55:461322<group>". See linkgit:git-remote[1].
Junio C Hamano118d2772007-02-21 20:24:101323
Junio C Hamano77b7e902006-10-23 07:18:501324repack.usedeltabaseoffset::
Junio C Hamanofce7c7e2008-07-02 03:06:381325By default, linkgit:git-repack[1] creates packs that use
1326delta-base offset. If you need to share your repository with
1327git older than version 1.4.4, either directly or via a dumb
1328protocol such as http, then you need to set this option to
1329"false" and repack. Access from old git versions over the
1330native protocol are unaffected by this option.
Junio C Hamano77b7e902006-10-23 07:18:501331
Junio C Hamano4653c6f2008-11-26 22:50:201332rerere.autoupdate::
1333When set to true, `git-rerere` updates the index with the
1334resulting contents after it cleanly resolves conflicts using
1335previously recorded resolution. Defaults to false.
1336
1337rerere.enabled::
1338Activate recording of resolved conflicts, so that identical
1339conflict hunks can be resolved automatically, should they
1340be encountered again. linkgit:git-rerere[1] command is by
1341default enabled if you create `rr-cache` directory under
1342`$GIT_DIR`, but can be disabled by setting this option to false.
1343
Junio C Hamano07824ce2006-04-25 07:36:541344showbranch.default::
Junio C Hamano35738e82008-01-07 07:55:461345The default set of branches for linkgit:git-show-branch[1].
1346See linkgit:git-show-branch[1].
Junio C Hamano07824ce2006-04-25 07:36:541347
Junio C Hamano942b35e2007-12-09 10:19:331348status.relativePaths::
Junio C Hamano35738e82008-01-07 07:55:461349By default, linkgit:git-status[1] shows paths relative to the
Junio C Hamano942b35e2007-12-09 10:19:331350current directory. Setting this variable to `false` shows paths
1351relative to the repository root (this was the default for git
1352prior to v1.5.4).
1353
Junio C Hamano4224f992008-06-23 07:14:081354status.showUntrackedFiles::
1355By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1356files which are not currently tracked by Git. Directories which
1357contain only untracked files, are shown with the directory name
1358only. Showing untracked files means that Git needs to lstat() all
1359all the files in the whole repository, which might be slow on some
1360systems. So, this variable controls how the commands displays
1361the untracked files. Possible values are:
1362+
1363--
1364- 'no' - Show no untracked files
1365- 'normal' - Shows untracked files and directories
1366- 'all' - Shows also individual files in untracked directories.
1367--
1368+
1369If this variable is not specified, it defaults to 'normal'.
1370This variable can be overridden with the -u|--untracked-files option
1371of linkgit:git-status[1] and linkgit:git-commit[1].
1372
Junio C Hamano75cc4c92006-07-24 08:25:031373tar.umask::
Junio C Hamanobdebabb2007-08-23 00:25:091374This variable can be used to restrict the permission bits of
1375tar archive entries. The default is 0002, which turns off the
1376world write bit. The special value "user" indicates that the
1377archiving user's umask will be used instead. See umask(2) and
Junio C Hamano35738e82008-01-07 07:55:461378linkgit:git-archive[1].
Junio C Hamano75cc4c92006-07-24 08:25:031379
Junio C Hamano4653c6f2008-11-26 22:50:201380transfer.unpackLimit::
1381When `fetch.unpackLimit` or `receive.unpackLimit` are
1382not set, the value of this variable is used instead.
1383The default value is 100.
1384
Junio C Hamano24bc09a2008-02-28 00:27:441385url.<base>.insteadOf::
1386Any URL that starts with this value will be rewritten to
1387start, instead, with <base>. In cases where some site serves a
1388large number of repositories, and serves them with multiple
1389access methods, and some users need to use different access
1390methods, this feature allows people to specify any of the
1391equivalent URLs and have git automatically rewrite the URL to
1392the best alternative for the particular user, even for a
1393never-before-seen repository on the site. When more than one
1394insteadOf strings match a given URL, the longest match is used.
1395
Junio C Hamano07824ce2006-04-25 07:36:541396user.email::
1397Your email address to be recorded in any newly created commits.
Junio C Hamano469d60e2007-04-29 18:30:341398Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
Junio C Hamano35738e82008-01-07 07:55:461399'EMAIL' environment variables. See linkgit:git-commit-tree[1].
Junio C Hamano07824ce2006-04-25 07:36:541400
1401user.name::
1402Your full name to be recorded in any newly created commits.
Junio C Hamano341071d2006-06-04 07:24:481403Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
Junio C Hamano35738e82008-01-07 07:55:461404environment variables. See linkgit:git-commit-tree[1].
Junio C Hamano07824ce2006-04-25 07:36:541405
Junio C Hamanoa890c4f2007-01-28 10:29:211406user.signingkey::
Junio C Hamano35738e82008-01-07 07:55:461407If linkgit:git-tag[1] is not selecting the key you want it to
Junio C Hamanoa890c4f2007-01-28 10:29:211408automatically when creating a signed tag, you can override the
1409default selection with this variable. This option is passed
1410unchanged to gpg's --local-user parameter, so you may specify a key
1411using any method that gpg supports.
1412
Junio C Hamano4e272312008-01-08 09:13:211413web.browser::
1414Specify a web browser that may be used by some commands.
1415Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
1416may use it.