blob: 5256c7fb811ae6f5777bf528a22b19b16b132f26 [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 Hamanof4581102009-04-25 08:29:595the git command's behavior. The `.git/config` file in each repository
6is used to store the configuration for that repository, and
7`$HOME/.gitconfig` is used to store a per-user configuration as
8fallback values for the `.git/config` file. The file `/etc/gitconfig`
9can be used to store a system-wide default configuration.
Junio C Hamano8f76dc62007-01-17 07:24:2510
Junio C Hamanof4581102009-04-25 08:29:5911The configuration variables are used by both the git plumbing
12and the porcelains. The variables are divided into sections, wherein
13the fully qualified variable name of the variable itself is the last
Junio C Hamano07824ce2006-04-25 07:36:5414dot-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 Hamanof4581102009-04-25 08:29:5929must belong to some section, which means that there must be a section
30header before the first setting of a variable.
Junio C Hamanobee172f2007-01-23 08:44:1831
32Sections can be further divided into subsections. To begin a subsection
33put its name in double quotes, separated by space from the section name,
Junio C Hamanof4581102009-04-25 08:29:5934in the section header, like in the example below:
Junio C Hamanobee172f2007-01-23 08:44:1835
36--------
37[section "subsection"]
38
39--------
40
Junio C Hamanof4581102009-04-25 08:29:5941Subsection names are case sensitive and can contain any characters except
42newline (doublequote `"` and backslash have to be escaped as `\"` and `\\`,
43respectively). Section headers 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
Junio C Hamanof4581102009-04-25 08:29:5948There is also a case insensitive alternative `[section.subsection]` syntax.
49In this syntax, subsection names follow the same restrictions as for section
50names.
Junio C Hamanobee172f2007-01-23 08:44:1851
Junio C Hamanoaa2cd762009-07-26 08:14:0152All the other lines (and the remainder of the line after the section
53header) are recognized as setting variables, in the form
Junio C Hamanobee172f2007-01-23 08:44:1854'name = value'. If there is no equal sign on the line, the entire line
55is taken as 'name' and the variable is recognized as boolean "true".
56The variable names are case-insensitive and only alphanumeric
Junio C Hamanoea82cff2009-03-18 01:54:4857characters and `-` are allowed. There can be more than one value
Junio C Hamanobee172f2007-01-23 08:44:1858for a given variable; we say then that variable is multivalued.
59
60Leading and trailing whitespace in a variable value is discarded.
61Internal whitespace within a variable value is retained verbatim.
62
63The values following the equals sign in variable assign are all either
64a string, an integer, or a boolean. Boolean values may be given as yes/no,
Junio C Hamano4cfa5362009-04-18 23:01:01650/1, true/false or on/off. Case is not significant in boolean values, when
Junio C Hamanobee172f2007-01-23 08:44:1866converting value to the canonical form using '--bool' type specifier;
Junio C Hamanoba4b9282008-07-06 05:20:3167'git-config' will ensure that the output is "true" or "false".
Junio C Hamanobee172f2007-01-23 08:44:1868
69String values may be entirely or partially enclosed in double quotes.
Junio C Hamanof4581102009-04-25 08:29:5970You need to enclose variable values in double quotes if you want to
71preserve leading or trailing whitespace, or if the variable value contains
72comment characters (i.e. it contains '#' or ';').
73Double quote `"` and backslash `\` characters in variable values must
Junio C Hamanoea82cff2009-03-18 01:54:4874be escaped: use `\"` for `"` and `\\` for `\`.
Junio C Hamanobee172f2007-01-23 08:44:1875
Junio C Hamanoea82cff2009-03-18 01:54:4876The following escape sequences (beside `\"` and `\\`) are recognized:
77`\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
78and `\b` for backspace (BS). No other char escape sequence, nor octal
Junio C Hamanobee172f2007-01-23 08:44:1879char sequences are valid.
80
Junio C Hamanof4581102009-04-25 08:29:5981Variable values ending in a `\` are continued on the next line in the
Junio C Hamanobee172f2007-01-23 08:44:1882customary UNIX fashion.
83
Junio C Hamanof4581102009-04-25 08:29:5984Some variables may require a special value format.
Junio C Hamano07824ce2006-04-25 07:36:5485
86Example
87~~~~~~~
88
89# Core variables
90[core]
91; Don't trust file modes
92filemode = false
93
94# Our diff algorithm
95[diff]
Junio C Hamano85c71572008-07-28 00:03:3196external = /usr/local/bin/diff-wrapper
Junio C Hamano07824ce2006-04-25 07:36:5497renames = true
98
Junio C Hamano52401ef2006-12-19 00:54:3899[branch "devel"]
100remote = origin
101merge = refs/heads/devel
102
Junio C Hamanobee172f2007-01-23 08:44:18103# Proxy settings
104[core]
Junio C Hamanoc71a8732007-08-04 00:27:26105gitProxy="ssh" for "kernel.org"
Junio C Hamanobee172f2007-01-23 08:44:18106gitProxy=default-proxy ; for the rest
Junio C Hamano52401ef2006-12-19 00:54:38107
Junio C Hamano07824ce2006-04-25 07:36:54108Variables
109~~~~~~~~~
110
111Note that this list is non-comprehensive and not necessarily complete.
Junio C Hamanof1d14802006-06-08 00:48:17112For command-specific variables, you will find a more detailed description
113in the appropriate manual page. You will find a description of non-core
Junio C Hamano07824ce2006-04-25 07:36:54114porcelain configuration variables in the respective porcelain documentation.
115
116core.fileMode::
117If false, the executable bit differences between the index and
118the working copy are ignored; useful on broken filesystems like FAT.
Junio C Hamano35738e82008-01-07 07:55:46119See linkgit:git-update-index[1]. True by default.
Junio C Hamano07824ce2006-04-25 07:36:54120
Junio C Hamanoa476efa2008-10-10 15:31:42121core.ignoreCygwinFSTricks::
122This option is only used by Cygwin implementation of Git. If false,
123the Cygwin stat() and lstat() functions are used. This may be useful
124if your repository consists of a few separate directories joined in
125one hierarchy using Cygwin mount. If true, Git uses native Win32 API
126whenever it is possible and falls back to Cygwin functions only to
127handle symbol links. The native mode is more than twice faster than
Junio C Hamano7d06a8a2008-10-20 05:42:33128normal Cygwin l/stat() functions. True by default, unless core.filemode
129is true, in which case ignoreCygwinFSTricks is ignored as Cygwin's
130POSIX emulation is required to support core.filemode.
Junio C Hamanoa476efa2008-10-10 15:31:42131
Junio C Hamano90ccff32008-07-29 08:17:24132core.trustctime::
133If false, the ctime differences between the index and the
134working copy are ignored; useful when the inode change time
135is regularly modified by something outside Git (file system
136crawlers and some backup systems).
137See linkgit:git-update-index[1]. True by default.
138
Junio C Hamanod526ba92007-07-02 00:17:42139core.quotepath::
Junio C Hamanoba4b9282008-07-06 05:20:31140The commands that output paths (e.g. 'ls-files',
141'diff'), when not given the `-z` option, will quote
Junio C Hamanod526ba92007-07-02 00:17:42142"unusual" characters in the pathname by enclosing the
143pathname in a double-quote pair and with backslashes the
144same way strings in C source code are quoted. If this
145variable is set to false, the bytes higher than 0x80 are
146not quoted but output as verbatim. Note that double
147quote, backslash and control characters are always
148quoted without `-z` regardless of the setting of this
149variable.
150
Junio C Hamanod9e0e5d2007-04-14 16:22:04151core.autocrlf::
152If true, makes git convert `CRLF` at the end of lines in text files to
153`LF` when reading from the filesystem, and convert in reverse when
154writing to the filesystem. The variable can be set to
155'input', in which case the conversion happens only while
156reading from the filesystem but files are written out with
157`LF` at the end of lines. Currently, which paths to consider
158"text" (i.e. be subjected to the autocrlf mechanism) is
159decided purely based on the contents.
160
Junio C Hamano26e590a2008-02-17 03:53:51161core.safecrlf::
162If true, makes git check if converting `CRLF` as controlled by
163`core.autocrlf` is reversible. Git will verify if a command
164modifies a file in the work tree either directly or indirectly.
165For example, committing a file followed by checking out the
166same file should yield the original file in the work tree. If
167this is not the case for the current setting of
168`core.autocrlf`, git will reject the file. The variable can
169be set to "warn", in which case git will only warn about an
170irreversible conversion but continue the operation.
171+
172CRLF conversion bears a slight chance of corrupting data.
173autocrlf=true will convert CRLF to LF during commit and LF to
174CRLF during checkout. A file that contains a mixture of LF and
175CRLF before the commit cannot be recreated by git. For text
176files this is the right thing to do: it corrects line endings
177such that we have only LF line endings in the repository.
178But for binary files that are accidentally classified as text the
179conversion can corrupt data.
180+
181If you recognize such corruption early you can easily fix it by
182setting the conversion type explicitly in .gitattributes. Right
183after committing you still have the original file in your work
184tree and this file is not yet corrupted. You can explicitly tell
185git that this file is binary and git will handle the file
186appropriately.
187+
188Unfortunately, the desired effect of cleaning up text files with
189mixed line endings and the undesired effect of corrupting binary
190files cannot be distinguished. In both cases CRLFs are removed
191in an irreversible way. For text files this is the right thing
192to do because CRLFs are line endings, while for binary files
193converting CRLFs corrupts data.
194+
195Note, this safety check does not mean that a checkout will generate a
196file identical to the original file for a different setting of
197`core.autocrlf`, but only for the current one. For example, a text
198file with `LF` would be accepted with `core.autocrlf=input` and could
199later be checked out with `core.autocrlf=true`, in which case the
200resulting file would contain `CRLF`, although the original file
201contained `LF`. However, in both work trees the line endings would be
202consistent, that is either all `LF` or all `CRLF`, but never mixed. A
203file with mixed line endings would be reported by the `core.safecrlf`
204mechanism.
205
Junio C Hamanoaa83a7d2007-03-05 02:37:29206core.symlinks::
207If false, symbolic links are checked out as small plain files that
Junio C Hamano35738e82008-01-07 07:55:46208contain the link text. linkgit:git-update-index[1] and
209linkgit:git-add[1] will not change the recorded type to regular
Junio C Hamanoaa83a7d2007-03-05 02:37:29210file. Useful on filesystems like FAT that do not support
211symbolic links. True by default.
212
Junio C Hamano07824ce2006-04-25 07:36:54213core.gitProxy::
214A "proxy command" to execute (as 'command host port') instead
215of establishing direct connection to the remote server when
216using the git protocol for fetching. If the variable value is
217in the "COMMAND for DOMAIN" format, the command is applied only
218on hostnames ending with the specified domain string. This variable
219may be set multiple times and is matched in the given order;
220the first match wins.
Junio C Hamanof1d14802006-06-08 00:48:17221+
222Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
223(which always applies universally, without the special "for"
224handling).
Junio C Hamanoea82cff2009-03-18 01:54:48225+
226The special string `none` can be used as the proxy command to
227specify that no proxy be used for a given domain pattern.
228This is useful for excluding servers inside a firewall from
229proxy use, while defaulting to a common proxy for external domains.
Junio C Hamano07824ce2006-04-25 07:36:54230
231core.ignoreStat::
Junio C Hamano054ea082008-06-01 08:26:34232If true, commands which modify both the working tree and the index
233will mark the updated paths with the "assume unchanged" bit in the
234index. These marked files are then assumed to stay unchanged in the
235working copy, until you mark them otherwise manually - Git will not
236detect the file changes by lstat() calls. This is useful on systems
237where those are very slow, such as Microsoft Windows.
238See linkgit:git-update-index[1].
Junio C Hamano07824ce2006-04-25 07:36:54239False by default.
240
Junio C Hamano88a3a072006-05-04 08:01:43241core.preferSymlinkRefs::
242Instead of the default "symref" format for HEAD
243and other symbolic reference files, use symbolic links.
244This is sometimes needed to work with old scripts that
245expect HEAD to be a symbolic link.
Junio C Hamano07824ce2006-04-25 07:36:54246
Junio C Hamano1025e752007-02-23 07:21:26247core.bare::
248If true this repository is assumed to be 'bare' and has no
249working directory associated with it. If this is the case a
250number of commands that require a working directory will be
Junio C Hamano35738e82008-01-07 07:55:46251disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
Junio C Hamano1025e752007-02-23 07:21:26252+
Junio C Hamano35738e82008-01-07 07:55:46253This setting is automatically guessed by linkgit:git-clone[1] or
254linkgit:git-init[1] when the repository was created. By default a
Junio C Hamano1025e752007-02-23 07:21:26255repository that ends in "/.git" is assumed to be not bare (bare =
256false), while all other repositories are assumed to be bare (bare
257= true).
258
Junio C Hamanod526ba92007-07-02 00:17:42259core.worktree::
260Set the path to the working tree. The value will not be
261used in combination with repositories found automatically in
262a .git directory (i.e. $GIT_DIR is not set).
Junio C Hamano764a6672007-10-23 01:23:31263This can be overridden by the GIT_WORK_TREE environment
Junio C Hamano7d575a52008-04-30 08:45:27264variable and the '--work-tree' command line option. It can be
265a absolute path or relative path to the directory specified by
266--git-dir or GIT_DIR.
267Note: If --git-dir or GIT_DIR are specified but none of
268--work-tree, GIT_WORK_TREE and core.worktree is specified,
269the current working directory is regarded as the top directory
270of your working tree.
Junio C Hamanod526ba92007-07-02 00:17:42271
Junio C Hamano341071d2006-06-04 07:24:48272core.logAllRefUpdates::
Junio C Hamanocae86272007-08-21 02:20:49273Enable the reflog. Updates to a ref <ref> is logged to the file
Junio C Hamanoa2ec14f2006-11-02 00:22:48274"$GIT_DIR/logs/<ref>", by appending the new and old
275SHA1, the date/time and the reason of the update, but
276only when the file exists. If this configuration
277variable is set to true, missing "$GIT_DIR/logs/<ref>"
278file is automatically created for branch heads.
Junio C Hamano1caaf472006-12-31 08:29:35279+
280This information can be used to determine what commit
281was the tip of a branch "2 days ago".
282+
283This value is true by default in a repository that has
284a working directory associated with it, and false by
285default in a bare repository.
Junio C Hamano341071d2006-06-04 07:24:48286
Junio C Hamano07824ce2006-04-25 07:36:54287core.repositoryFormatVersion::
288Internal variable identifying the repository format and layout
289version.
290
291core.sharedRepository::
Junio C Hamano0ab78ae2006-08-09 01:00:42292When 'group' (or 'true'), the repository is made shareable between
293several users in a group (making sure all the files and objects are
294group-writable). When 'all' (or 'world' or 'everybody'), the
295repository will be readable by all users, additionally to being
296group-shareable. When 'umask' (or 'false'), git will use permissions
Junio C Hamano2f102bb2008-04-26 02:23:37297reported by umask(2). When '0xxx', where '0xxx' is an octal number,
298files in the repository will have this mode value. '0xxx' will override
Junio C Hamano83eded12009-04-20 08:18:00299user's umask value (whereas the other options will only override
300requested parts of the user's umask value). Examples: '0660' will make
301the repo read/write-able for the owner and group, but inaccessible to
302others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
Junio C Hamano2f102bb2008-04-26 02:23:37303repository that is group-readable but not group-writable.
304See linkgit:git-init[1]. False by default.
Junio C Hamano07824ce2006-04-25 07:36:54305
306core.warnAmbiguousRefs::
307If true, git will warn you if the ref name you passed it is ambiguous
308and might match multiple refs in the .git/refs/ tree. True by default.
309
Junio C Hamano7ec15722006-07-07 02:03:59310core.compression::
Junio C Hamanof2ce2972007-05-20 19:12:09311An integer -1..9, indicating a default compression level.
312-1 is the zlib default. 0 means no compression,
313and 1..9 are various speed/size tradeoffs, 9 being slowest.
Junio C Hamano2e72a942007-11-21 08:54:42314If set, this provides a default to other compression variables,
315such as 'core.loosecompression' and 'pack.compression'.
Junio C Hamanoa126a3b2006-07-04 04:55:26316
Junio C Hamanof2ce2972007-05-20 19:12:09317core.loosecompression::
318An integer -1..9, indicating the compression level for objects that
319are not in a pack file. -1 is the zlib default. 0 means no
320compression, and 1..9 are various speed/size tradeoffs, 9 being
321slowest. If not set, defaults to core.compression. If that is
Junio C Hamano2e72a942007-11-21 08:54:42322not set, defaults to 1 (best speed).
Junio C Hamano28d9dfe2006-07-25 03:50:49323
Junio C Hamanofc4d38c2007-01-08 06:53:32324core.packedGitWindowSize::
325Number of bytes of a pack file to map into memory in a
326single mapping operation. Larger window sizes may allow
327your system to process a smaller number of large pack files
328more quickly. Smaller window sizes will negatively affect
329performance due to increased calls to the operating system's
330memory manager, but may improve performance when accessing
331a large number of large pack files.
332+
333Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
334MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
335be reasonable for all users/operating systems. You probably do
336not need to adjust this value.
337+
338Common unit suffixes of 'k', 'm', or 'g' are supported.
339
340core.packedGitLimit::
341Maximum number of bytes to map simultaneously into memory
342from pack files. If Git needs to access more than this many
343bytes at once to complete an operation it will unmap existing
344regions to reclaim virtual address space within the process.
345+
346Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
347This should be reasonable for all users/operating systems, except on
348the largest projects. You probably do not need to adjust this value.
349+
350Common unit suffixes of 'k', 'm', or 'g' are supported.
351
Junio C Hamanob8c51282007-03-19 10:43:30352core.deltaBaseCacheLimit::
353Maximum number of bytes to reserve for caching base objects
354that multiple deltafied objects reference. By storing the
355entire decompressed base objects in a cache Git is able
356to avoid unpacking and decompressing frequently used base
357objects multiple times.
358+
359Default is 16 MiB on all platforms. This should be reasonable
360for all users/operating systems, except on the largest projects.
361You probably do not need to adjust this value.
362+
363Common unit suffixes of 'k', 'm', or 'g' are supported.
364
Junio C Hamano1d90cb02007-07-03 07:05:31365core.excludesfile::
Junio C Hamano5e284b42007-05-22 07:23:37366In addition to '.gitignore' (per-directory) and
367'.git/info/exclude', git looks into this file for patterns
Junio C Hamano679d22d2007-06-02 21:13:44368of files which are not meant to be tracked. See
Junio C Hamano35738e82008-01-07 07:55:46369linkgit:gitignore[5].
Junio C Hamano5e284b42007-05-22 07:23:37370
Junio C Hamanof6002a92007-07-20 10:28:22371core.editor::
372Commands such as `commit` and `tag` that lets you edit
Junio C Hamanoa6387422007-08-25 03:54:27373messages by launching an editor uses the value of this
Junio C Hamanof6002a92007-07-20 10:28:22374variable when it is set, and the environment variable
375`GIT_EDITOR` is not set. The order of preference is
Junio C Hamanode9879a2007-07-22 09:33:42376`GIT_EDITOR` environment, `core.editor`, `VISUAL` and
377`EDITOR` environment variables and then finally `vi`.
Junio C Hamanof6002a92007-07-20 10:28:22378
Junio C Hamano28d8ede2007-07-05 05:51:38379core.pager::
Junio C Hamano0551f6a2008-08-25 00:33:33380The command that git will use to paginate output. Can
381be overridden with the `GIT_PAGER` environment
382variable. Note that git sets the `LESS` environment
383variable to `FRSX` if it is unset when it runs the
384pager. One can change these settings by setting the
Junio C Hamanoa476efa2008-10-10 15:31:42385`LESS` variable to some other value. Alternately,
386these settings can be overridden on a project or
387global basis by setting the `core.pager` option.
388Setting `core.pager` has no affect on the `LESS`
389environment variable behaviour above, so if you want
390to override git's default settings this way, you need
391to be explicit. For example, to disable the S option
392in a backward compatible manner, set `core.pager`
Junio C Hamanoea82cff2009-03-18 01:54:48393to `less -+$LESS -FRX`. This will be passed to the
Junio C Hamanoa476efa2008-10-10 15:31:42394shell by git, which will translate the final command to
Junio C Hamanoea82cff2009-03-18 01:54:48395`LESS=FRSX less -+FRSX -FRX`.
Junio C Hamano28d8ede2007-07-05 05:51:38396
Junio C Hamano942b35e2007-12-09 10:19:33397core.whitespace::
398A comma separated list of common whitespace problems to
Junio C Hamanoba4b9282008-07-06 05:20:31399notice. 'git-diff' will use `color.diff.whitespace` to
400highlight them, and 'git-apply --whitespace=error' will
Junio C Hamano3db8b412008-07-26 06:45:59401consider them as errors. You can prefix `-` to disable
402any of them (e.g. `-trailing-space`):
Junio C Hamano942b35e2007-12-09 10:19:33403+
404* `trailing-space` treats trailing whitespaces at the end of the line
405 as an error (enabled by default).
406* `space-before-tab` treats a space character that appears immediately
407 before a tab character in the initial indent part of the line as an
408 error (enabled by default).
409* `indent-with-non-tab` treats a line that is indented with 8 or more
Junio C Hamano42a2e2d2007-12-16 22:13:42410 space characters as an error (not enabled by default).
Junio C Hamano601f3e52008-02-25 08:40:42411* `cr-at-eol` treats a carriage-return at the end of line as
412 part of the line terminator, i.e. with it, `trailing-space`
413 does not trigger if the character before such a carriage-return
414 is not a whitespace (not enabled by default).
Junio C Hamano942b35e2007-12-09 10:19:33415
Junio C Hamano9eb57532008-06-26 06:33:46416core.fsyncobjectfiles::
417This boolean will enable 'fsync()' when writing object files.
418+
419This is a total waste of time and effort on a filesystem that orders
420data writes properly, but can be useful for filesystems that do not use
421journalling (traditional UNIX filesystems) or that only journal metadata
422and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
423
Junio C Hamano610d1762008-11-28 06:27:13424core.preloadindex::
425Enable parallel index preload for operations like 'git diff'
426+
427This can speed up operations like 'git diff' and 'git status' especially
428on filesystems like NFS that have weak caching semantics and thus
429relatively high IO latencies. With this set to 'true', git will do the
430index comparison to the filesystem data in parallel, allowing
431overlapping IO's.
432
Junio C Hamanoa9499de2009-04-30 03:38:48433core.createObject::
434You can set this to 'link', in which case a hardlink followed by
435a delete of the source are used to make sure that object creation
436will not overwrite existing objects.
437+
438On some file system/operating system combinations, this is unreliable.
439Set this config setting to 'rename' there; However, This will remove the
440check that makes sure that existing object files will not get overwritten.
Junio C Hamanoe91ea772009-04-26 01:41:41441
Junio C Hamano3d141512009-06-01 01:22:40442add.ignore-errors::
443Tells 'git-add' to continue adding files when some files cannot be
444added due to indexing errors. Equivalent to the '--ignore-errors'
445option of linkgit:git-add[1].
446
Junio C Hamano33db4372006-06-07 19:51:45447alias.*::
Junio C Hamano35738e82008-01-07 07:55:46448Command aliases for the linkgit:git[1] command wrapper - e.g.
Junio C Hamano33db4372006-06-07 19:51:45449after defining "alias.last = cat-file commit HEAD", the invocation
450"git last" is equivalent to "git cat-file commit HEAD". To avoid
Junio C Hamanof1d14802006-06-08 00:48:17451confusion and troubles with script usage, aliases that
452hide existing git commands are ignored. Arguments are split by
453spaces, the usual shell quoting and escaping is supported.
454quote pair and a backslash can be used to quote them.
Junio C Hamanodbb64592007-09-01 11:17:39455+
456If the alias expansion is prefixed with an exclamation point,
457it will be treated as a shell command. For example, defining
458"alias.new = !gitk --all --not ORIG_HEAD", the invocation
459"git new" is equivalent to running the shell command
Junio C Hamano48bc1ce2009-07-09 16:49:19460"gitk --all --not ORIG_HEAD". Note that shell commands will be
461executed from the top-level directory of a repository, which may
462not necessarily be the current directory.
Junio C Hamano9cb74f22007-02-12 04:15:05463
Junio C Hamanofe24db02009-08-22 05:10:47464apply.ignorewhitespace::
465When set to 'change', tells 'git-apply' to ignore changes in
466whitespace, in the same way as the '--ignore-space-change'
467option.
468When set to one of: no, none, never, false tells 'git-apply' to
469respect all whitespace differences.
470See linkgit:git-apply[1].
471
Junio C Hamano07824ce2006-04-25 07:36:54472apply.whitespace::
Junio C Hamanoba4b9282008-07-06 05:20:31473Tells 'git-apply' how to handle whitespaces, in the same way
Junio C Hamano35738e82008-01-07 07:55:46474as the '--whitespace' option. See linkgit:git-apply[1].
Junio C Hamano07824ce2006-04-25 07:36:54475
Junio C Hamano7fd84172007-05-24 07:00:32476branch.autosetupmerge::
Junio C Hamanoba4b9282008-07-06 05:20:31477Tells 'git-branch' and 'git-checkout' to setup new branches
Junio C Hamano24bc09a2008-02-28 00:27:44478so that linkgit:git-pull[1] will appropriately merge from the
479starting point branch. Note that even if this option is not set,
Junio C Hamano7fd84172007-05-24 07:00:32480this behavior can be chosen per-branch using the `--track`
Junio C Hamano24bc09a2008-02-28 00:27:44481and `--no-track` options. The valid settings are: `false` -- no
482automatic setup is done; `true` -- automatic setup is done when the
483starting point is a remote branch; `always` -- automatic setup is
484done when the starting point is either a local branch or remote
485branch. This option defaults to true.
Junio C Hamano7fd84172007-05-24 07:00:32486
Junio C Hamano869bb802008-05-12 00:29:47487branch.autosetuprebase::
Junio C Hamanoba4b9282008-07-06 05:20:31488When a new branch is created with 'git-branch' or 'git-checkout'
Junio C Hamano869bb802008-05-12 00:29:47489that tracks another branch, this variable tells git to set
490up pull to rebase instead of merge (see "branch.<name>.rebase").
491When `never`, rebase is never automatically set to true.
492When `local`, rebase is set to true for tracked branches of
493other local branches.
494When `remote`, rebase is set to true for tracked branches of
495remote branches.
496When `always`, rebase will be set to true for all tracking
497branches.
498See "branch.autosetupmerge" for details on how to set up a
499branch to track another branch.
500This option defaults to never.
501
Junio C Hamano47c1e3c2006-09-25 04:45:55502branch.<name>.remote::
Junio C Hamano0706c802009-03-30 22:34:19503When in branch <name>, it tells 'git-fetch' and 'git-push' which
504remote to fetch from/push to. It defaults to `origin` if no remote is
505configured. `origin` is also used if you are not on any branch.
Junio C Hamano47c1e3c2006-09-25 04:45:55506
507branch.<name>.merge::
Junio C Hamano0706c802009-03-30 22:34:19508Defines, together with branch.<name>.remote, the upstream branch
509for the given branch. It tells 'git-fetch'/'git-pull' which
Junio C Hamano5f9a6f02009-04-06 08:26:56510branch to merge and can also affect 'git-push' (see push.default).
Junio C Hamanoba4b9282008-07-06 05:20:31511When in branch <name>, it tells 'git-fetch' the default
Junio C Hamanoc2b47092007-10-25 06:50:31512refspec to be marked for merging in FETCH_HEAD. The value is
513handled like the remote part of a refspec, and must match a
514ref which is fetched from the remote given by
515"branch.<name>.remote".
Junio C Hamanoba4b9282008-07-06 05:20:31516The merge information is used by 'git-pull' (which at first calls
517'git-fetch') to lookup the default branch for merging. Without
518this option, 'git-pull' defaults to merge the first refspec fetched.
Junio C Hamano96010b22006-12-09 21:15:46519Specify multiple values to get an octopus merge.
Junio C Hamanoba4b9282008-07-06 05:20:31520If you wish to setup 'git-pull' so that it merges into <name> from
Junio C Hamano6e149c02007-03-16 10:21:07521another branch in the local repository, you can point
522branch.<name>.merge to the desired branch, and use the special setting
523`.` (a period) for branch.<name>.remote.
Junio C Hamano47c1e3c2006-09-25 04:45:55524
Junio C Hamano1b50ce92007-10-03 12:05:53525branch.<name>.mergeoptions::
526Sets default options for merging into branch <name>. The syntax and
Junio C Hamano35738e82008-01-07 07:55:46527supported options are equal to that of linkgit:git-merge[1], but
Junio C Hamano1b50ce92007-10-03 12:05:53528option values containing whitespace characters are currently not
529supported.
530
Junio C Hamano0c999702007-12-03 09:57:55531branch.<name>.rebase::
532When true, rebase the branch <name> on top of the fetched branch,
Junio C Hamano6d76d612008-05-09 05:46:08533instead of merging the default branch from the default remote when
534"git pull" is run.
Junio C Hamano0c999702007-12-03 09:57:55535*NOTE*: this is a possibly dangerous operation; do *not* use
Junio C Hamano35738e82008-01-07 07:55:46536it unless you understand the implications (see linkgit:git-rebase[1]
Junio C Hamano0c999702007-12-03 09:57:55537for details).
538
Junio C Hamano8760ea62008-03-14 08:58:45539browser.<tool>.cmd::
540Specify the command to invoke the specified browser. The
541specified command is evaluated in shell with the URLs passed
542as arguments. (See linkgit:git-web--browse[1].)
543
Junio C Hamanoe35a6fc2008-01-29 09:46:27544browser.<tool>.path::
545Override the path for the given tool that may be used to
546browse HTML help (see '-w' option in linkgit:git-help[1]) or a
547working repository in gitweb (see linkgit:git-instaweb[1]).
548
Junio C Hamano47b9acd2007-04-24 07:34:34549clean.requireForce::
Junio C Hamano422cfec2007-11-08 08:07:45550A boolean to make git-clean do nothing unless given -f
551or -n. Defaults to true.
Junio C Hamano47b9acd2007-04-24 07:34:34552
Junio C Hamanoeb692952007-01-03 22:02:12553color.branch::
554A boolean to enable/disable color in the output of
Junio C Hamano35738e82008-01-07 07:55:46555linkgit:git-branch[1]. May be set to `always`,
Junio C Hamano0fc8cd92007-12-06 03:26:21556`false` (or `never`) or `auto` (or `true`), in which case colors are used
Junio C Hamanoeb692952007-01-03 22:02:12557only when the output is to a terminal. Defaults to false.
558
559color.branch.<slot>::
560Use customized color for branch coloration. `<slot>` is one of
561`current` (the current branch), `local` (a local branch),
562`remote` (a tracking branch in refs/remotes/), `plain` (other
Junio C Hamano5a702332007-01-28 20:55:22563refs).
564+
565The value for these configuration variables is a list of colors (at most
566two) and attributes (at most one), separated by spaces. The colors
567accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
568`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
569`blink` and `reverse`. The first color given is the foreground; the
570second is the background. The position of the attribute, if any,
571doesn't matter.
Junio C Hamanoeb692952007-01-03 22:02:12572
Junio C Hamano3f403b02006-12-13 10:14:13573color.diff::
Junio C Hamano0fc8cd92007-12-06 03:26:21574When set to `always`, always use colors in patch.
575When false (or `never`), never. When set to `true` or `auto`, use
576colors only when the output is to the terminal. Defaults to false.
Junio C Hamano9ae1a062006-07-10 08:12:34577
Junio C Hamano3f403b02006-12-13 10:14:13578color.diff.<slot>::
Junio C Hamano5a702332007-01-28 20:55:22579Use customized color for diff colorization. `<slot>` specifies
580which part of the patch to use the specified color, and is one
581of `plain` (context text), `meta` (metainformation), `frag`
582(hunk header), `old` (removed lines), `new` (added lines),
Junio C Hamano942b35e2007-12-09 10:19:33583`commit` (commit headers), or `whitespace` (highlighting
584whitespace errors). The values of these variables may be specified as
Junio C Hamano5a702332007-01-28 20:55:22585in color.branch.<slot>.
Junio C Hamano9ae1a062006-07-10 08:12:34586
Junio C Hamanod257cff2009-03-18 05:27:16587color.grep::
588When set to `always`, always highlight matches. When `false` (or
589`never`), never. When set to `true` or `auto`, use color only
590when the output is written to the terminal. Defaults to `false`.
591
592color.grep.external::
593The string value of this variable is passed to an external 'grep'
594command as a command line option if match highlighting is turned
595on. If set to an empty string, no option is passed at all,
596turning off coloring for external 'grep' calls; this is the default.
597For GNU grep, set it to `--color=always` to highlight matches even
598when a pager is used.
599
600color.grep.match::
601Use customized color for matches. The value of this variable
602may be specified as in color.branch.<slot>. It is passed using
603the environment variables 'GREP_COLOR' and 'GREP_COLORS' when
604calling an external 'grep'.
605
Junio C Hamano00b8b632007-12-07 09:50:49606color.interactive::
Junio C Hamano35738e82008-01-07 07:55:46607When set to `always`, always use colors for interactive prompts
Junio C Hamanoba4b9282008-07-06 05:20:31608and displays (such as those used by "git-add --interactive").
Junio C Hamano00b8b632007-12-07 09:50:49609When false (or `never`), never. When set to `true` or `auto`, use
610colors only when the output is to the terminal. Defaults to false.
611
612color.interactive.<slot>::
Junio C Hamanoba4b9282008-07-06 05:20:31613Use customized color for 'git-add --interactive'
Junio C Hamanoe5bf6c12009-02-07 21:43:10614output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
615four distinct types of normal output from interactive
Junio C Hamano27a128b2009-08-13 01:23:00616commands. The values of these variables may be specified as
Junio C Hamano00b8b632007-12-07 09:50:49617in color.branch.<slot>.
618
Junio C Hamanoe7935c42006-12-13 21:32:17619color.pager::
620A boolean to enable/disable colored output when the pager is in
621use (default is true).
622
Junio C Hamano52ba2952009-05-18 17:43:02623color.showbranch::
624A boolean to enable/disable color in the output of
625linkgit:git-show-branch[1]. May be set to `always`,
626`false` (or `never`) or `auto` (or `true`), in which case colors are used
627only when the output is to a terminal. Defaults to false.
628
Junio C Hamanoe7935c42006-12-13 21:32:17629color.status::
630A boolean to enable/disable color in the output of
Junio C Hamano35738e82008-01-07 07:55:46631linkgit:git-status[1]. May be set to `always`,
Junio C Hamano0fc8cd92007-12-06 03:26:21632`false` (or `never`) or `auto` (or `true`), in which case colors are used
Junio C Hamanoe7935c42006-12-13 21:32:17633only when the output is to a terminal. Defaults to false.
634
635color.status.<slot>::
636Use customized color for status colorization. `<slot>` is
637one of `header` (the header text of the status message),
Junio C Hamano7d23f5e2006-12-16 07:44:04638`added` or `updated` (files which are added but not committed),
639`changed` (files which are changed but not added in the index),
Junio C Hamanob713ff12008-05-24 01:12:30640`untracked` (files which are not tracked by git), or
641`nobranch` (the color the 'no branch' warning is shown in, defaulting
642to red). The values of these variables may be specified as in
643color.branch.<slot>.
Junio C Hamanoe7935c42006-12-13 21:32:17644
Junio C Hamano83d46a22008-02-21 02:29:42645color.ui::
646When set to `always`, always use colors in all git commands which
647are capable of colored output. When false (or `never`), never. When
648set to `true` or `auto`, use colors only when the output is to the
649terminal. When more specific variables of color.* are set, they always
650take precedence over this setting. Defaults to false.
651
Junio C Hamano4653c6f2008-11-26 22:50:20652commit.template::
653Specify a file to use as the template for new commit messages.
654
Junio C Hamanodbb64592007-09-01 11:17:39655diff.autorefreshindex::
Junio C Hamanoba4b9282008-07-06 05:20:31656When using 'git-diff' to compare with work tree
Junio C Hamanodbb64592007-09-01 11:17:39657files, do not consider stat-only change as changed.
658Instead, silently run `git update-index --refresh` to
659update the cached stat information for paths whose
660contents in the work tree match the contents in the
661index. This option defaults to true. Note that this
Junio C Hamanoba4b9282008-07-06 05:20:31662affects only 'git-diff' Porcelain, and not lower level
663'diff' commands, such as 'git-diff-files'.
Junio C Hamanodbb64592007-09-01 11:17:39664
Junio C Hamano1fbbbc12007-12-18 07:01:27665diff.external::
666If this config variable is set, diff generation is not
667performed using the internal diff machinery, but using the
Junio C Hamano85c71572008-07-28 00:03:31668given command. Can be overridden with the `GIT_EXTERNAL_DIFF'
669environment variable. The command is called with parameters
670as described under "git Diffs" in linkgit:git[1]. Note: if
671you want to use an external diff program only on a subset of
672your files, you might want to use linkgit:gitattributes[5] instead.
Junio C Hamano1fbbbc12007-12-18 07:01:27673
Junio C Hamano5e4d8de2008-09-19 06:27:02674diff.mnemonicprefix::
675If set, 'git-diff' uses a prefix pair that is different from the
676standard "a/" and "b/" depending on what is being compared. When
677this configuration is in effect, reverse diff output also swaps
678the order of the prefixes:
679'git-diff';;
680compares the (i)ndex and the (w)ork tree;
681'git-diff HEAD';;
682 compares a (c)ommit and the (w)ork tree;
683'git diff --cached';;
684compares a (c)ommit and the (i)ndex;
685'git-diff HEAD:file1 file2';;
686compares an (o)bject and a (w)ork tree entity;
687'git diff --no-index a b';;
688compares two non-git things (1) and (2).
689
Junio C Hamano07824ce2006-04-25 07:36:54690diff.renameLimit::
691The number of files to consider when performing the copy/rename
Junio C Hamanoba4b9282008-07-06 05:20:31692detection; equivalent to the 'git-diff' option '-l'.
Junio C Hamano07824ce2006-04-25 07:36:54693
Junio C Hamano9ae1a062006-07-10 08:12:34694diff.renames::
695Tells git to detect renames. If set to any boolean value, it
696will enable basic rename detection. If set to "copies" or
697"copy", it will detect copies, as well.
698
Junio C Hamanobc4852e2009-01-21 10:51:14699diff.suppressBlankEmpty::
Junio C Hamanof1231492008-12-22 08:27:21700A boolean to inhibit the standard behavior of printing a space
701before each empty output line. Defaults to false.
702
Junio C Hamano3bd66e92009-04-18 06:17:56703diff.tool::
704Controls which diff tool is used. `diff.tool` overrides
705`merge.tool` when used by linkgit:git-difftool[1] and has
706the same valid values as `merge.tool` minus "tortoisemerge"
707and plus "kompare".
708
709difftool.<tool>.path::
710Override the path for the given tool. This is useful in case
711your tool is not in the PATH.
712
713difftool.<tool>.cmd::
714Specify the command to invoke the specified diff tool.
715The specified command is evaluated in shell with the following
716variables available: 'LOCAL' is set to the name of the temporary
717file containing the contents of the diff pre-image and 'REMOTE'
718is set to the name of the temporary file containing the contents
719of the diff post-image.
720
721difftool.prompt::
722Prompt before each invocation of the diff tool.
723
Junio C Hamano20d47e32009-01-26 06:36:02724diff.wordRegex::
725A POSIX Extended Regular Expression used to determine what is a "word"
726when performing word-by-word difference calculations. Character
727sequences that match the regular expression are "words", all other
728characters are *ignorable* whitespace.
729
Junio C Hamano54ea8d32007-01-25 07:59:48730fetch.unpackLimit::
731If the number of objects fetched over the git native
732transfer is below this
733limit, then the objects will be unpacked into loose object
734files. However if the number of received objects equals or
735exceeds this limit then the received pack will be stored as
736a pack, after adding any missing delta bases. Storing the
737pack from a push can make the push operation complete faster,
Junio C Hamanoe77b0152008-01-12 06:44:17738especially on slow filesystems. If not set, the value of
739`transfer.unpackLimit` is used instead.
Junio C Hamano54ea8d32007-01-25 07:59:48740
Junio C Hamanof4581102009-04-25 08:29:59741format.attach::
742Enable multipart/mixed attachments as the default for
743'format-patch'. The value can also be a double quoted string
744which will enable attachments as the default and set the
745value as the boundary. See the --attach option in
746linkgit:git-format-patch[1].
747
Junio C Hamano8c5802d2007-11-15 00:13:36748format.numbered::
Junio C Hamano7d06a8a2008-10-20 05:42:33749A boolean which can enable or disable sequence numbers in patch
750subjects. It defaults to "auto" which enables it only if there
751is more than one patch. It can be enabled or disabled for all
752messages by setting it to "true" or "false". See --numbered
753option in linkgit:git-format-patch[1].
Junio C Hamano8c5802d2007-11-15 00:13:36754
Junio C Hamano07824ce2006-04-25 07:36:54755format.headers::
756Additional email headers to include in a patch to be submitted
Junio C Hamano35738e82008-01-07 07:55:46757by mail. See linkgit:git-format-patch[1].
Junio C Hamano07824ce2006-04-25 07:36:54758
Junio C Hamanof4581102009-04-25 08:29:59759format.cc::
760Additional "Cc:" headers to include in a patch to be submitted
761by mail. See the --cc option in linkgit:git-format-patch[1].
762
763format.subjectprefix::
764The default for format-patch is to output files with the '[PATCH]'
765subject prefix. Use this variable to change that prefix.
766
Junio C Hamanod4c8e112007-03-04 10:32:38767format.suffix::
768The default for format-patch is to output files with the suffix
769`.patch`. Use this variable to change that suffix (make sure to
770include the dot if you want it).
771
Junio C Hamano86bcccc2008-03-08 09:33:55772format.pretty::
773The default pretty format for log/show/whatchanged command,
774See linkgit:git-log[1], linkgit:git-show[1],
775linkgit:git-whatchanged[1].
776
Junio C Hamanoea6a7642009-03-11 23:56:19777format.thread::
778The default threading style for 'git-format-patch'. Can be
Junio C Hamanof4581102009-04-25 08:29:59779either a boolean value, `shallow` or `deep`. `shallow`
Junio C Hamanoea6a7642009-03-11 23:56:19780threading makes every mail a reply to the head of the series,
781where the head is chosen from the cover letter, the
782`\--in-reply-to`, and the first patch mail, in this order.
Junio C Hamanof4581102009-04-25 08:29:59783`deep` threading makes every mail a reply to the previous one.
Junio C Hamanoea6a7642009-03-11 23:56:19784A true boolean value is the same as `shallow`, and a false
785value disables threading.
786
Junio C Hamano5f9a6f02009-04-06 08:26:56787format.signoff::
788 A boolean value which lets you enable the `-s/--signoff` option of
789 format-patch by default. *Note:* Adding the Signed-off-by: line to a
790 patch should be a conscious act and means that you certify you have
791 the rights to submit this work under the same open source license.
792 Please see the 'SubmittingPatches' document for further discussion.
793
Junio C Hamanof2ce2972007-05-20 19:12:09794gc.aggressiveWindow::
795The window size parameter used in the delta compression
Junio C Hamanoba4b9282008-07-06 05:20:31796algorithm used by 'git-gc --aggressive'. This defaults
Junio C Hamanof2ce2972007-05-20 19:12:09797to 10.
798
Junio C Hamano1b50ce92007-10-03 12:05:53799gc.auto::
800When there are approximately more than this many loose
801objects in the repository, `git gc --auto` will pack them.
802Some Porcelain commands use this command to perform a
Junio C Hamanoe77b0152008-01-12 06:44:17803light-weight garbage collection from time to time. The
804default value is 6700. Setting this to 0 disables it.
Junio C Hamano1b50ce92007-10-03 12:05:53805
806gc.autopacklimit::
807When there are more than this many packs that are not
808marked with `*.keep` file in the repository, `git gc
Junio C Hamanoe77b0152008-01-12 06:44:17809--auto` consolidates them into one larger pack. The
Junio C Hamano25c0b702008-03-23 09:41:37810default value is 50. Setting this to 0 disables it.
Junio C Hamano1b50ce92007-10-03 12:05:53811
Junio C Hamano9d52e572007-02-13 23:48:20812gc.packrefs::
Junio C Hamanoba4b9282008-07-06 05:20:31813'git-gc' does not run `git pack-refs` in a bare repository by
Junio C Hamano9d52e572007-02-13 23:48:20814default so that older dumb-transport clients can still fetch
Junio C Hamanoba4b9282008-07-06 05:20:31815from the repository. Setting this to `true` lets 'git-gc'
816to run `git pack-refs`. Setting this to `false` tells
817'git-gc' never to run `git pack-refs`. The default setting is
Junio C Hamano9d52e572007-02-13 23:48:20818`notbare`. Enable it only when you know you do not have to
819support such clients. The default setting will change to `true`
820at some stage, and setting this to `false` will continue to
Junio C Hamanoba4b9282008-07-06 05:20:31821prevent `git pack-refs` from being run from 'git-gc'.
Junio C Hamano9d52e572007-02-13 23:48:20822
Junio C Hamano09a926d2008-03-13 07:55:29823gc.pruneexpire::
Junio C Hamanoba4b9282008-07-06 05:20:31824When 'git-gc' is run, it will call 'prune --expire 2.weeks.ago'.
Junio C Hamanoa3148f52009-01-14 08:49:57825Override the grace period with this config variable. The value
826"now" may be used to disable this grace period and always prune
827unreachable objects immediately.
Junio C Hamano09a926d2008-03-13 07:55:29828
Junio C Hamano74640642006-12-27 10:59:55829gc.reflogexpire::
Junio C Hamanoba4b9282008-07-06 05:20:31830'git-reflog expire' removes reflog entries older than
Junio C Hamano74640642006-12-27 10:59:55831this time; defaults to 90 days.
832
833gc.reflogexpireunreachable::
Junio C Hamanoba4b9282008-07-06 05:20:31834'git-reflog expire' removes reflog entries older than
Junio C Hamano74640642006-12-27 10:59:55835this time and are not reachable from the current tip;
836defaults to 30 days.
837
838gc.rerereresolved::
839Records of conflicted merge you resolved earlier are
Junio C Hamanoba4b9282008-07-06 05:20:31840kept for this many days when 'git-rerere gc' is run.
Junio C Hamano35738e82008-01-07 07:55:46841The default is 60 days. See linkgit:git-rerere[1].
Junio C Hamano74640642006-12-27 10:59:55842
843gc.rerereunresolved::
844Records of conflicted merge you have not resolved are
Junio C Hamanoba4b9282008-07-06 05:20:31845kept for this many days when 'git-rerere gc' is run.
Junio C Hamano35738e82008-01-07 07:55:46846The default is 15 days. See linkgit:git-rerere[1].
Junio C Hamano74640642006-12-27 10:59:55847
Junio C Hamanoa3148f52009-01-14 08:49:57848gitcvs.commitmsgannotation::
849Append this string to each commit message. Set to empty string
850to disable this feature. Defaults to "via git-CVS emulator".
851
Junio C Hamano07824ce2006-04-25 07:36:54852gitcvs.enabled::
Junio C Hamanoa6387422007-08-25 03:54:27853Whether the CVS server interface is enabled for this repository.
Junio C Hamano35738e82008-01-07 07:55:46854See linkgit:git-cvsserver[1].
Junio C Hamano07824ce2006-04-25 07:36:54855
856gitcvs.logfile::
Junio C Hamanoa6387422007-08-25 03:54:27857Path to a log file where the CVS server interface well... logs
Junio C Hamano35738e82008-01-07 07:55:46858various stuff. See linkgit:git-cvsserver[1].
Junio C Hamano07824ce2006-04-25 07:36:54859
Junio C Hamano17bd2272008-09-01 06:11:17860gitcvs.usecrlfattr::
Junio C Hamanodfccbb02008-05-26 01:16:14861If true, the server will look up the `crlf` attribute for
862files to determine the '-k' modes to use. If `crlf` is set,
863the '-k' mode will be left blank, so cvs clients will
864treat it as text. If `crlf` is explicitly unset, the file
Junio C Hamanocb1c44f2008-08-06 06:19:33865will be set with '-kb' mode, which suppresses any newline munging
Junio C Hamanodfccbb02008-05-26 01:16:14866the client might otherwise do. If `crlf` is not specified,
Junio C Hamanod32738e2008-07-09 19:53:42867then 'gitcvs.allbinary' is used. See linkgit:gitattributes[5].
Junio C Hamanodfccbb02008-05-26 01:16:14868
Junio C Hamanod9e0e5d2007-04-14 16:22:04869gitcvs.allbinary::
Junio C Hamanodfccbb02008-05-26 01:16:14870This is used if 'gitcvs.usecrlfattr' does not resolve
871the correct '-kb' mode to use. If true, all
872unresolved files are sent to the client in
873mode '-kb'. This causes the client to treat them
874as binary files, which suppresses any newline munging it
875otherwise might do. Alternatively, if it is set to "guess",
876then the contents of the file are examined to decide if
877it is binary, similar to 'core.autocrlf'.
Junio C Hamanoa2ad99e2007-04-18 09:57:04878
879gitcvs.dbname::
880Database used by git-cvsserver to cache revision information
881derived from the git repository. The exact meaning depends on the
882used database driver, for SQLite (which is the default driver) this
883is a filename. Supports variable substitution (see
Junio C Hamano35738e82008-01-07 07:55:46884linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
Junio C Hamanoa2ad99e2007-04-18 09:57:04885Default: '%Ggitcvs.%m.sqlite'
886
887gitcvs.dbdriver::
888Used Perl DBI driver. You can specify any available driver
889 for this here, but it might not work. git-cvsserver is tested
890with 'DBD::SQLite', reported to work with 'DBD::Pg', and
891reported *not* to work with 'DBD::mysql'. Experimental feature.
892May not contain double colons (`:`). Default: 'SQLite'.
Junio C Hamano35738e82008-01-07 07:55:46893See linkgit:git-cvsserver[1].
Junio C Hamanod9e0e5d2007-04-14 16:22:04894
Junio C Hamanoa2ad99e2007-04-18 09:57:04895gitcvs.dbuser, gitcvs.dbpass::
896Database user and password. Only useful if setting 'gitcvs.dbdriver',
897since SQLite has no concept of database users and/or passwords.
898'gitcvs.dbuser' supports variable substitution (see
Junio C Hamano35738e82008-01-07 07:55:46899linkgit:git-cvsserver[1] for details).
Junio C Hamanoa2ad99e2007-04-18 09:57:04900
Junio C Hamanoa74efce2008-04-02 08:39:08901gitcvs.dbTableNamePrefix::
902Database table name prefix. Prepended to the names of any
903database tables used, allowing a single database to be used
904for several repositories. Supports variable substitution (see
905linkgit:git-cvsserver[1] for details). Any non-alphabetic
906characters will be replaced with underscores.
907
Junio C Hamanodfccbb02008-05-26 01:16:14908All gitcvs variables except for 'gitcvs.usecrlfattr' and
909'gitcvs.allbinary' can also be specified as
910'gitcvs.<access_method>.<varname>' (where 'access_method'
Junio C Hamanoa6387422007-08-25 03:54:27911is one of "ext" and "pserver") to make them apply only for the given
912access method.
Junio C Hamanoa2ad99e2007-04-18 09:57:04913
Junio C Hamano6d76d612008-05-09 05:46:08914gui.commitmsgwidth::
915Defines how wide the commit message window is in the
916linkgit:git-gui[1]. "75" is the default.
917
918gui.diffcontext::
919Specifies how many context lines should be used in calls to diff
920made by the linkgit:git-gui[1]. The default is "5".
921
Junio C Hamanod3452a02008-11-15 08:07:55922gui.encoding::
923Specifies the default encoding to use for displaying of
924file contents in linkgit:git-gui[1] and linkgit:gitk[1].
925It can be overridden by setting the 'encoding' attribute
926for relevant files (see linkgit:gitattributes[5]).
927If this option is not set, the tools default to the
928locale encoding.
929
Junio C Hamano6d76d612008-05-09 05:46:08930gui.matchtrackingbranch::
931Determines if new branches created with linkgit:git-gui[1] should
932default to tracking remote branches with matching names or
933not. Default: "false".
934
935gui.newbranchtemplate::
936Is used as suggested name when creating new branches using the
937linkgit:git-gui[1].
938
939gui.pruneduringfetch::
940"true" if linkgit:git-gui[1] should prune tracking branches when
941performing a fetch. The default value is "false".
942
943gui.trustmtime::
944Determines if linkgit:git-gui[1] should trust the file modification
945timestamp or not. By default the timestamps are not trusted.
946
947gui.spellingdictionary::
948Specifies the dictionary used for spell checking commit messages in
949the linkgit:git-gui[1]. When set to "none" spell checking is turned
950off.
951
Junio C Hamanod3452a02008-11-15 08:07:55952gui.fastcopyblame::
953If true, 'git gui blame' uses '-C' instead of '-C -C' for original
954location detection. It makes blame significantly faster on huge
955repositories at the expense of less thorough copy detection.
956
957gui.copyblamethreshold::
Junio C Hamano610d1762008-11-28 06:27:13958Specifies the threshold to use in 'git gui blame' original location
Junio C Hamanod3452a02008-11-15 08:07:55959detection, measured in alphanumeric characters. See the
960linkgit:git-blame[1] manual for more information on copy detection.
961
962gui.blamehistoryctx::
963Specifies the radius of history context in days to show in
964linkgit:gitk[1] for the selected commit, when the `Show History
965Context` menu item is invoked from 'git gui blame'. If this
966variable is set to zero, the whole history is shown.
967
Junio C Hamano92d312a2008-12-15 07:22:20968guitool.<name>.cmd::
969Specifies the shell command line to execute when the corresponding item
970of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
971mandatory for every tool. The command is executed from the root of
972the working directory, and in the environment it receives the name of
973the tool as 'GIT_GUITOOL', the name of the currently selected file as
974'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
975the head is detached, 'CUR_BRANCH' is empty).
976
977guitool.<name>.needsfile::
978Run the tool only if a diff is selected in the GUI. It guarantees
979that 'FILENAME' is not empty.
980
981guitool.<name>.noconsole::
982Run the command silently, without creating a window to display its
983output.
984
985guitool.<name>.norescan::
986Don't rescan the working directory for changes after the tool
987finishes execution.
988
989guitool.<name>.confirm::
990Show a confirmation dialog before actually running the tool.
991
992guitool.<name>.argprompt::
993Request a string argument from the user, and pass it to the tool
994through the 'ARGS' environment variable. Since requesting an
995argument implies confirmation, the 'confirm' option has no effect
996if this is enabled. If the option is set to 'true', 'yes', or '1',
997the dialog uses a built-in generic prompt; otherwise the exact
998value of the variable is used.
999
1000guitool.<name>.revprompt::
1001Request a single valid revision from the user, and set the
1002'REVISION' environment variable. In other aspects this option
1003is similar to 'argprompt', and can be used together with it.
1004
1005guitool.<name>.revunmerged::
1006Show only unmerged branches in the 'revprompt' subdialog.
1007This is useful for tools similar to merge or rebase, but not
1008for things like checkout or reset.
1009
1010guitool.<name>.title::
1011Specifies the title to use for the prompt dialog. The default
1012is the tool name.
1013
1014guitool.<name>.prompt::
1015Specifies the general prompt string to display at the top of
1016the dialog, before subsections for 'argprompt' and 'revprompt'.
1017The default value includes the actual command.
1018
Junio C Hamano4e272312008-01-08 09:13:211019help.browser::
1020Specify the browser that will be used to display help in the
1021'web' format. See linkgit:git-help[1].
1022
1023help.format::
1024Override the default help format used by linkgit:git-help[1].
1025Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1026the default. 'web' and 'html' are the same.
1027
Junio C Hamanof24b8062008-09-09 01:34:391028help.autocorrect::
1029Automatically correct and execute mistyped commands after
1030waiting for the given number of deciseconds (0.1 sec). If more
1031than one command can be deduced from the entered text, nothing
1032will be executed. If the value of this option is negative,
1033the corrected command will be executed immediately. If the
1034value is 0 - the command will be just shown but not executed.
1035This is the default.
1036
Junio C Hamano58256872007-12-04 08:31:131037http.proxy::
1038Override the HTTP proxy, normally configured using the 'http_proxy'
Junio C Hamano35738e82008-01-07 07:55:461039environment variable (see linkgit:curl[1]). This can be overridden
Junio C Hamano58256872007-12-04 08:31:131040on a per-remote basis; see remote.<name>.proxy
1041
Junio C Hamano07824ce2006-04-25 07:36:541042http.sslVerify::
1043Whether to verify the SSL certificate when fetching or pushing
Junio C Hamano33db4372006-06-07 19:51:451044over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
Junio C Hamano07824ce2006-04-25 07:36:541045variable.
1046
1047http.sslCert::
1048File containing the SSL certificate when fetching or pushing
Junio C Hamano33db4372006-06-07 19:51:451049over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
Junio C Hamano07824ce2006-04-25 07:36:541050variable.
1051
1052http.sslKey::
1053File containing the SSL private key when fetching or pushing
Junio C Hamano341071d2006-06-04 07:24:481054over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
Junio C Hamano07824ce2006-04-25 07:36:541055variable.
1056
Junio C Hamano48bc1ce2009-07-09 16:49:191057http.sslCertPasswordProtected::
1058Enable git's password prompt for the SSL certificate. Otherwise
1059OpenSSL will prompt the user, possibly many times, if the
1060certificate or private key is encrypted. Can be overridden by the
1061'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1062
Junio C Hamano07824ce2006-04-25 07:36:541063http.sslCAInfo::
1064File containing the certificates to verify the peer with when
Junio C Hamano341071d2006-06-04 07:24:481065fetching or pushing over HTTPS. Can be overridden by the
Junio C Hamano07824ce2006-04-25 07:36:541066'GIT_SSL_CAINFO' environment variable.
1067
1068http.sslCAPath::
1069Path containing files with the CA certificates to verify the peer
Junio C Hamano33db4372006-06-07 19:51:451070with when fetching or pushing over HTTPS. Can be overridden
Junio C Hamano07824ce2006-04-25 07:36:541071by the 'GIT_SSL_CAPATH' environment variable.
1072
1073http.maxRequests::
Junio C Hamano341071d2006-06-04 07:24:481074How many HTTP requests to launch in parallel. Can be overridden
Junio C Hamano07824ce2006-04-25 07:36:541075by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1076
1077http.lowSpeedLimit, http.lowSpeedTime::
1078If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1079for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
Junio C Hamano341071d2006-06-04 07:24:481080Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
Junio C Hamano07824ce2006-04-25 07:36:541081'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1082
Junio C Hamanof1dcdfe2006-09-29 08:10:511083http.noEPSV::
1084A boolean which disables using of EPSV ftp command by curl.
Junio C Hamanod9e0e5d2007-04-14 16:22:041085This can helpful with some "poor" ftp servers which don't
Junio C Hamanof1dcdfe2006-09-29 08:10:511086support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1087environment variable. Default is false (curl will use EPSV).
1088
Junio C Hamano07824ce2006-04-25 07:36:541089i18n.commitEncoding::
1090Character encoding the commit messages are stored in; git itself
1091does not care per se, but this information is necessary e.g. when
1092importing commits from emails or in the gitk graphical history
1093browser (and possibly at other places in the future or in other
Junio C Hamano35738e82008-01-07 07:55:461094porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
Junio C Hamano07824ce2006-04-25 07:36:541095
Junio C Hamano51f92e22006-12-29 05:18:281096i18n.logOutputEncoding::
1097Character encoding the commit messages are converted to when
Junio C Hamanoba4b9282008-07-06 05:20:311098running 'git-log' and friends.
Junio C Hamano51f92e22006-12-29 05:18:281099
Junio C Hamano4653c6f2008-11-26 22:50:201100imap::
1101The configuration variables in the 'imap' section are described
1102in linkgit:git-imap-send[1].
1103
Junio C Hamano4e272312008-01-08 09:13:211104instaweb.browser::
1105Specify the program that will be used to browse your working
1106repository in gitweb. See linkgit:git-instaweb[1].
1107
1108instaweb.httpd::
1109The HTTP daemon command-line to start gitweb on your working
1110repository. See linkgit:git-instaweb[1].
1111
1112instaweb.local::
1113If true the web server started by linkgit:git-instaweb[1] will
1114be bound to the local IP (127.0.0.1).
1115
1116instaweb.modulepath::
1117The module path for an apache httpd used by linkgit:git-instaweb[1].
1118
1119instaweb.port::
1120The port number to bind the gitweb httpd to. See
1121linkgit:git-instaweb[1].
1122
Junio C Hamanoe5bf6c12009-02-07 21:43:101123interactive.singlekey::
Junio C Hamano27a128b2009-08-13 01:23:001124In interactive commands, allow the user to provide one-letter
Junio C Hamanoe5bf6c12009-02-07 21:43:101125input with a single key (i.e., without hitting enter).
1126Currently this is used only by the `\--patch` mode of
1127linkgit:git-add[1]. Note that this setting is silently
1128ignored if portable keystroke input is not available.
1129
Junio C Hamanob713ff12008-05-24 01:12:301130log.date::
1131Set default date-time mode for the log command. Setting log.date
Junio C Hamanoba4b9282008-07-06 05:20:311132value is similar to using 'git-log'\'s --date option. The value is one of the
Junio C Hamanob713ff12008-05-24 01:12:301133following alternatives: {relative,local,default,iso,rfc,short}.
1134See linkgit:git-log[1].
1135
Junio C Hamanofe9acab2006-11-24 12:10:551136log.showroot::
1137If true, the initial commit will be shown as a big creation event.
1138This is equivalent to a diff against an empty tree.
Junio C Hamano35738e82008-01-07 07:55:461139Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
Junio C Hamanofe9acab2006-11-24 12:10:551140normally hide the root commit will now show it. True by default.
1141
Junio C Hamano8bc410e2009-02-15 10:38:191142mailmap.file::
1143The location of an augmenting mailmap file. The default
1144mailmap, located in the root of the repository, is loaded
1145first, then the mailmap file pointed to by this variable.
1146The location of the mailmap file may be in a repository
1147subdirectory, or somewhere outside of the repository itself.
1148See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1149
Junio C Hamano8b588d52008-03-15 09:48:371150man.viewer::
1151Specify the programs that may be used to display help in the
1152'man' format. See linkgit:git-help[1].
1153
Junio C Hamano6d76d612008-05-09 05:46:081154man.<tool>.cmd::
1155Specify the command to invoke the specified man viewer. The
1156specified command is evaluated in shell with the man page
1157passed as argument. (See linkgit:git-help[1].)
Junio C Hamano103ad7f2007-03-14 11:19:261158
Junio C Hamano6d76d612008-05-09 05:46:081159man.<tool>.path::
1160Override the path for the given tool that may be used to
1161display help in the 'man' format. See linkgit:git-help[1].
Junio C Hamanoe90436a2007-04-22 07:22:131162
Junio C Hamano4653c6f2008-11-26 22:50:201163include::merge-config.txt[]
Junio C Hamanoa476efa2008-10-10 15:31:421164
Junio C Hamano1fbbbc12007-12-18 07:01:271165mergetool.<tool>.path::
1166Override the path for the given tool. This is useful in case
1167your tool is not in the PATH.
1168
Junio C Hamano86bcccc2008-03-08 09:33:551169mergetool.<tool>.cmd::
1170Specify the command to invoke the specified merge tool. The
1171specified command is evaluated in shell with the following
1172variables available: 'BASE' is the name of a temporary file
1173containing the common base of the files to be merged, if available;
1174'LOCAL' is the name of a temporary file containing the contents of
1175the file on the current branch; 'REMOTE' is the name of a temporary
1176file containing the contents of the file from the branch being
1177merged; 'MERGED' contains the name of the file to which the merge
1178tool should write the results of a successful merge.
1179
1180mergetool.<tool>.trustExitCode::
1181For a custom merge command, specify whether the exit code of
1182the merge command can be used to determine whether the merge was
1183successful. If this is not set to true then the merge target file
1184timestamp is checked and the merge assumed to have been successful
1185if the file has been updated, otherwise the user is prompted to
1186indicate the success of the merge.
1187
1188mergetool.keepBackup::
1189After performing a merge, the original file with conflict markers
1190can be saved as a file with a `.orig` extension. If this variable
1191is set to `false` then this file is not preserved. Defaults to
1192`true` (i.e. keep the backup files).
1193
Junio C Hamano10b7a342009-01-01 22:05:171194mergetool.keepTemporaries::
1195When invoking a custom merge tool, git uses a set of temporary
1196files to pass to the tool. If the tool returns an error and this
1197variable is set to `true`, then these temporary files will be
1198preserved, otherwise they will be removed after the tool has
1199exited. Defaults to `false`.
1200
1201mergetool.prompt::
1202Prompt before each invocation of the merge resolution program.
1203
Junio C Hamano75cc4c92006-07-24 08:25:031204pack.window::
Junio C Hamano35738e82008-01-07 07:55:461205The size of the window used by linkgit:git-pack-objects[1] when no
Junio C Hamano75cc4c92006-07-24 08:25:031206window size is given on the command line. Defaults to 10.
1207
Junio C Hamano91d44c52007-05-09 07:16:071208pack.depth::
Junio C Hamano35738e82008-01-07 07:55:461209The maximum delta depth used by linkgit:git-pack-objects[1] when no
Junio C Hamano91d44c52007-05-09 07:16:071210maximum depth is given on the command line. Defaults to 50.
1211
Junio C Hamano235d53f2007-07-13 00:25:151212pack.windowMemory::
Junio C Hamano35738e82008-01-07 07:55:461213The window memory size limit used by linkgit:git-pack-objects[1]
Junio C Hamano235d53f2007-07-13 00:25:151214when no limit is given on the command line. The value can be
1215suffixed with "k", "m", or "g". Defaults to 0, meaning no
1216limit.
1217
Junio C Hamanof2ce2972007-05-20 19:12:091218pack.compression::
1219An integer -1..9, indicating the compression level for objects
1220in a pack file. -1 is the zlib default. 0 means no
1221compression, and 1..9 are various speed/size tradeoffs, 9 being
1222slowest. If not set, defaults to core.compression. If that is
Junio C Hamano2e72a942007-11-21 08:54:421223not set, defaults to -1, the zlib default, which is "a default
1224compromise between speed and compression (currently equivalent
1225to level 6)."
Junio C Hamanof2ce2972007-05-20 19:12:091226
Junio C Hamano679d22d2007-06-02 21:13:441227pack.deltaCacheSize::
Junio C Hamanoa6387422007-08-25 03:54:271228The maximum memory in bytes used for caching deltas in
Junio C Hamano9f883862009-08-11 06:23:521229linkgit:git-pack-objects[1] before writing them out to a pack.
1230This cache is used to speed up the writing object phase by not
1231having to recompute the final delta result once the best match
1232for all objects is found. Repacking large repositories on machines
1233which are tight with memory might be badly impacted by this though,
1234especially if this cache pushes the system into swapping.
1235A value of 0 means no limit. The smallest size of 1 byte may be
1236used to virtually disable this cache. Defaults to 256 MiB.
Junio C Hamano679d22d2007-06-02 21:13:441237
1238pack.deltaCacheLimit::
Junio C Hamano58155b42007-09-15 07:46:141239The maximum size of a delta, that is cached in
Junio C Hamano9f883862009-08-11 06:23:521240linkgit:git-pack-objects[1]. This cache is used to speed up the
1241writing object phase by not having to recompute the final delta
1242result once the best match for all objects is found. Defaults to 1000.
Junio C Hamano679d22d2007-06-02 21:13:441243
Junio C Hamano58155b42007-09-15 07:46:141244pack.threads::
1245Specifies the number of threads to spawn when searching for best
Junio C Hamano35738e82008-01-07 07:55:461246delta matches. This requires that linkgit:git-pack-objects[1]
Junio C Hamano58155b42007-09-15 07:46:141247be compiled with pthreads otherwise this option is ignored with a
1248warning. This is meant to reduce packing time on multiprocessor
1249machines. The required amount of memory for the delta search window
1250is however multiplied by the number of threads.
Junio C Hamano24bc09a2008-02-28 00:27:441251Specifying 0 will cause git to auto-detect the number of CPU's
1252and set the number of threads accordingly.
Junio C Hamano58155b42007-09-15 07:46:141253
Junio C Hamanod814b6d2007-11-04 11:13:491254pack.indexVersion::
1255Specify the default pack index version. Valid values are 1 for
1256legacy pack index used by Git versions prior to 1.5.2, and 2 for
1257the new pack index with capabilities for packs larger than 4 GB
1258as well as proper protection against the repacking of corrupted
Junio C Hamanofce7c7e2008-07-02 03:06:381259packs. Version 2 is the default. Note that version 2 is enforced
1260and this config option ignored whenever the corresponding pack is
1261larger than 2 GB.
1262+
1263If you have an old git that does not understand the version 2 `{asterisk}.idx` file,
1264cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1265that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the
1266other side may give you a repository that cannot be accessed with your
1267older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,
1268you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1269the `{asterisk}.idx` file.
Junio C Hamanod814b6d2007-11-04 11:13:491270
Junio C Hamano09a926d2008-03-13 07:55:291271pack.packSizeLimit::
Junio C Hamano49dccaf2008-02-10 10:48:011272The default maximum size of a pack. This setting only affects
1273packing to a file, i.e. the git:// protocol is unaffected. It
1274can be overridden by the `\--max-pack-size` option of
1275linkgit:git-repack[1].
1276
Junio C Hamano9e96a1a2008-08-16 10:23:181277pager.<cmd>::
Junio C Hamano0551f6a2008-08-25 00:33:331278Allows turning on or off pagination of the output of a
1279particular git subcommand when writing to a tty. If
1280`\--paginate` or `\--no-pager` is specified on the command line,
1281it takes precedence over this option. To disable pagination for
Junio C Hamanoea82cff2009-03-18 01:54:481282all commands, set `core.pager` or `GIT_PAGER` to `cat`.
Junio C Hamano9e96a1a2008-08-16 10:23:181283
Junio C Hamano07824ce2006-04-25 07:36:541284pull.octopus::
1285The default merge strategy to use when pulling multiple branches
1286at once.
1287
1288pull.twohead::
1289The default merge strategy to use when pulling a single branch.
1290
Junio C Hamano1de75722009-03-26 08:39:381291push.default::
1292Defines the action git push should take if no refspec is given
1293on the command line, no refspec is configured in the remote, and
1294no refspec is implied by any of the options given on the command
Junio C Hamano0706c802009-03-30 22:34:191295line. Possible values are:
Junio C Hamano1de75722009-03-26 08:39:381296+
1297* `nothing` do not push anything.
Junio C Hamano0706c802009-03-30 22:34:191298* `matching` push all matching branches.
Junio C Hamano1de75722009-03-26 08:39:381299 All branches having the same name in both ends are considered to be
Junio C Hamano0706c802009-03-30 22:34:191300 matching. This is the default.
Junio C Hamano98e32c32009-04-13 02:39:531301* `tracking` push the current branch to its upstream branch.
Junio C Hamano0706c802009-03-30 22:34:191302* `current` push the current branch to a branch of the same name.
Junio C Hamano1de75722009-03-26 08:39:381303
Junio C Hamanoea6a7642009-03-11 23:56:191304rebase.stat::
1305Whether to show a diffstat of what changed upstream since the last
1306rebase. False by default.
1307
Junio C Hamano4653c6f2008-11-26 22:50:201308receive.fsckObjects::
1309If it is set to true, git-receive-pack will check all received
1310objects. It will abort in the case of a malformed object or a
1311broken link. The result of an abort are only dangling objects.
1312Defaults to false.
1313
1314receive.unpackLimit::
1315If the number of objects received in a push is below this
1316limit then the objects will be unpacked into loose object
1317files. However if the number of received objects equals or
1318exceeds this limit then the received pack will be stored as
1319a pack, after adding any missing delta bases. Storing the
1320pack from a push can make the push operation complete faster,
1321especially on slow filesystems. If not set, the value of
1322`transfer.unpackLimit` is used instead.
1323
1324receive.denyDeletes::
1325If set to true, git-receive-pack will deny a ref update that deletes
1326the ref. Use this to prevent such a ref deletion via a push.
1327
1328receive.denyCurrentBranch::
1329If set to true or "refuse", receive-pack will deny a ref update
1330to the currently checked out branch of a non-bare repository.
1331Such a push is potentially dangerous because it brings the HEAD
1332out of sync with the index and working tree. If set to "warn",
1333print a warning of such a push to stderr, but allow the push to
1334proceed. If set to false or "ignore", allow such pushes with no
1335message. Defaults to "warn".
1336
1337receive.denyNonFastForwards::
1338If set to true, git-receive-pack will deny a ref update which is
1339not a fast forward. Use this to prevent such an update via a push,
1340even if that push is forced. This configuration variable is
1341set when initializing a shared repository.
1342
Junio C Hamano249572f2006-10-24 05:44:081343remote.<name>.url::
Junio C Hamano35738e82008-01-07 07:55:461344The URL of a remote repository. See linkgit:git-fetch[1] or
1345linkgit:git-push[1].
Junio C Hamano249572f2006-10-24 05:44:081346
Junio C Hamano0e88f3e2009-06-21 08:03:251347remote.<name>.pushurl::
1348The push URL of a remote repository. See linkgit:git-push[1].
1349
Junio C Hamano58256872007-12-04 08:31:131350remote.<name>.proxy::
1351For remotes that require curl (http, https and ftp), the URL to
1352the proxy to use for that remote. Set to the empty string to
1353disable proxying for that remote.
1354
Junio C Hamano249572f2006-10-24 05:44:081355remote.<name>.fetch::
Junio C Hamano35738e82008-01-07 07:55:461356The default set of "refspec" for linkgit:git-fetch[1]. See
1357linkgit:git-fetch[1].
Junio C Hamano249572f2006-10-24 05:44:081358
1359remote.<name>.push::
Junio C Hamano35738e82008-01-07 07:55:461360The default set of "refspec" for linkgit:git-push[1]. See
1361linkgit:git-push[1].
Junio C Hamano249572f2006-10-24 05:44:081362
Junio C Hamano47d68a52008-05-06 06:35:401363remote.<name>.mirror::
1364If true, pushing to this remote will automatically behave
1365as if the `\--mirror` option was given on the command line.
1366
Junio C Hamano118d2772007-02-21 20:24:101367remote.<name>.skipDefaultUpdate::
1368If true, this remote will be skipped by default when updating
Junio C Hamano35738e82008-01-07 07:55:461369using the update subcommand of linkgit:git-remote[1].
Junio C Hamano118d2772007-02-21 20:24:101370
Junio C Hamano4ad294b2007-01-20 02:22:501371remote.<name>.receivepack::
Junio C Hamano54ea8d32007-01-25 07:59:481372The default program to execute on the remote side when pushing. See
Junio C Hamano86bcccc2008-03-08 09:33:551373option \--receive-pack of linkgit:git-push[1].
Junio C Hamano4ad294b2007-01-20 02:22:501374
Junio C Hamano54ea8d32007-01-25 07:59:481375remote.<name>.uploadpack::
1376The default program to execute on the remote side when fetching. See
Junio C Hamano86bcccc2008-03-08 09:33:551377option \--upload-pack of linkgit:git-fetch-pack[1].
Junio C Hamano54ea8d32007-01-25 07:59:481378
Junio C Hamano17dde0e2007-02-26 09:50:211379remote.<name>.tagopt::
Junio C Hamano86bcccc2008-03-08 09:33:551380Setting this value to \--no-tags disables automatic tag following when
1381fetching from remote <name>
Junio C Hamano17dde0e2007-02-26 09:50:211382
Junio C Hamano118d2772007-02-21 20:24:101383remotes.<group>::
1384The list of remotes which are fetched by "git remote update
Junio C Hamano35738e82008-01-07 07:55:461385<group>". See linkgit:git-remote[1].
Junio C Hamano118d2772007-02-21 20:24:101386
Junio C Hamano77b7e902006-10-23 07:18:501387repack.usedeltabaseoffset::
Junio C Hamanofce7c7e2008-07-02 03:06:381388By default, linkgit:git-repack[1] creates packs that use
1389delta-base offset. If you need to share your repository with
1390git older than version 1.4.4, either directly or via a dumb
1391protocol such as http, then you need to set this option to
1392"false" and repack. Access from old git versions over the
1393native protocol are unaffected by this option.
Junio C Hamano77b7e902006-10-23 07:18:501394
Junio C Hamano4653c6f2008-11-26 22:50:201395rerere.autoupdate::
1396When set to true, `git-rerere` updates the index with the
1397resulting contents after it cleanly resolves conflicts using
1398previously recorded resolution. Defaults to false.
1399
1400rerere.enabled::
1401Activate recording of resolved conflicts, so that identical
1402conflict hunks can be resolved automatically, should they
1403be encountered again. linkgit:git-rerere[1] command is by
1404default enabled if you create `rr-cache` directory under
1405`$GIT_DIR`, but can be disabled by setting this option to false.
1406
Junio C Hamano1bbd0f42009-07-23 06:20:291407sendemail.identity::
1408A configuration identity. When given, causes values in the
1409'sendemail.<identity>' subsection to take precedence over
1410values in the 'sendemail' section. The default identity is
1411the value of 'sendemail.identity'.
1412
1413sendemail.smtpencryption::
1414See linkgit:git-send-email[1] for description. Note that this
1415setting is not subject to the 'identity' mechanism.
1416
1417sendemail.smtpssl::
1418Deprecated alias for 'sendemail.smtpencryption = ssl'.
1419
1420sendemail.<identity>.*::
1421Identity-specific versions of the 'sendemail.*' parameters
1422found below, taking precedence over those when the this
1423identity is selected, through command-line or
1424'sendemail.identity'.
1425
1426sendemail.aliasesfile::
1427sendemail.aliasfiletype::
1428sendemail.bcc::
1429sendemail.cc::
1430sendemail.cccmd::
1431sendemail.chainreplyto::
1432sendemail.confirm::
1433sendemail.envelopesender::
1434sendemail.from::
1435sendemail.multiedit::
1436sendemail.signedoffbycc::
1437sendemail.smtppass::
1438sendemail.suppresscc::
1439sendemail.suppressfrom::
1440sendemail.to::
1441sendemail.smtpserver::
1442sendemail.smtpserverport::
1443sendemail.smtpuser::
1444sendemail.thread::
1445sendemail.validate::
1446See linkgit:git-send-email[1] for description.
1447
1448sendemail.signedoffcc::
1449Deprecated alias for 'sendemail.signedoffbycc'.
1450
Junio C Hamano07824ce2006-04-25 07:36:541451showbranch.default::
Junio C Hamano35738e82008-01-07 07:55:461452The default set of branches for linkgit:git-show-branch[1].
1453See linkgit:git-show-branch[1].
Junio C Hamano07824ce2006-04-25 07:36:541454
Junio C Hamano942b35e2007-12-09 10:19:331455status.relativePaths::
Junio C Hamano35738e82008-01-07 07:55:461456By default, linkgit:git-status[1] shows paths relative to the
Junio C Hamano942b35e2007-12-09 10:19:331457current directory. Setting this variable to `false` shows paths
1458relative to the repository root (this was the default for git
1459prior to v1.5.4).
1460
Junio C Hamano4224f992008-06-23 07:14:081461status.showUntrackedFiles::
1462By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1463files which are not currently tracked by Git. Directories which
1464contain only untracked files, are shown with the directory name
1465only. Showing untracked files means that Git needs to lstat() all
1466all the files in the whole repository, which might be slow on some
1467systems. So, this variable controls how the commands displays
1468the untracked files. Possible values are:
1469+
1470--
1471- 'no' - Show no untracked files
1472- 'normal' - Shows untracked files and directories
1473- 'all' - Shows also individual files in untracked directories.
1474--
1475+
1476If this variable is not specified, it defaults to 'normal'.
1477This variable can be overridden with the -u|--untracked-files option
1478of linkgit:git-status[1] and linkgit:git-commit[1].
1479
Junio C Hamano75cc4c92006-07-24 08:25:031480tar.umask::
Junio C Hamanobdebabb2007-08-23 00:25:091481This variable can be used to restrict the permission bits of
1482tar archive entries. The default is 0002, which turns off the
1483world write bit. The special value "user" indicates that the
1484archiving user's umask will be used instead. See umask(2) and
Junio C Hamano35738e82008-01-07 07:55:461485linkgit:git-archive[1].
Junio C Hamano75cc4c92006-07-24 08:25:031486
Junio C Hamano4653c6f2008-11-26 22:50:201487transfer.unpackLimit::
1488When `fetch.unpackLimit` or `receive.unpackLimit` are
1489not set, the value of this variable is used instead.
1490The default value is 100.
1491
Junio C Hamano24bc09a2008-02-28 00:27:441492url.<base>.insteadOf::
1493Any URL that starts with this value will be rewritten to
1494start, instead, with <base>. In cases where some site serves a
1495large number of repositories, and serves them with multiple
1496access methods, and some users need to use different access
1497methods, this feature allows people to specify any of the
1498equivalent URLs and have git automatically rewrite the URL to
1499the best alternative for the particular user, even for a
1500never-before-seen repository on the site. When more than one
1501insteadOf strings match a given URL, the longest match is used.
1502
Junio C Hamano07824ce2006-04-25 07:36:541503user.email::
1504Your email address to be recorded in any newly created commits.
Junio C Hamano469d60e2007-04-29 18:30:341505Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
Junio C Hamano35738e82008-01-07 07:55:461506'EMAIL' environment variables. See linkgit:git-commit-tree[1].
Junio C Hamano07824ce2006-04-25 07:36:541507
1508user.name::
1509Your full name to be recorded in any newly created commits.
Junio C Hamano341071d2006-06-04 07:24:481510Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
Junio C Hamano35738e82008-01-07 07:55:461511environment variables. See linkgit:git-commit-tree[1].
Junio C Hamano07824ce2006-04-25 07:36:541512
Junio C Hamanoa890c4f2007-01-28 10:29:211513user.signingkey::
Junio C Hamano35738e82008-01-07 07:55:461514If linkgit:git-tag[1] is not selecting the key you want it to
Junio C Hamanoa890c4f2007-01-28 10:29:211515automatically when creating a signed tag, you can override the
1516default selection with this variable. This option is passed
1517unchanged to gpg's --local-user parameter, so you may specify a key
1518using any method that gpg supports.
1519
Junio C Hamano4e272312008-01-08 09:13:211520web.browser::
1521Specify a web browser that may be used by some commands.
1522Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
1523may use it.