blob: 922ac7b44da1c2cc04bf024307e9ccd54709580f [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
28characters, '`-`' and '`.`' are allowed in section names. Each variable
29must 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
42'`"`' 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
56characters and '`-`' are allowed. There can be more than one value
57for 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,
640/1 or true/false. Case is not significant in boolean values, when
65converting 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 ';').
72Double quote '`"`' and backslash '`\`' characters in variable value must
73be escaped: use '`\"`' for '`"`' and '`\\`' for '`\`'.
74
75The 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
78char sequences are valid.
79
80Variable value ending in a '`\`' is continued on the next line in the
81customary 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 Hamano90ccff32008-07-29 08:17:24120core.trustctime::
121If false, the ctime differences between the index and the
122working copy are ignored; useful when the inode change time
123is regularly modified by something outside Git (file system
124crawlers and some backup systems).
125See linkgit:git-update-index[1]. True by default.
126
Junio C Hamanod526ba92007-07-02 00:17:42127core.quotepath::
Junio C Hamanoba4b9282008-07-06 05:20:31128The commands that output paths (e.g. 'ls-files',
129'diff'), when not given the `-z` option, will quote
Junio C Hamanod526ba92007-07-02 00:17:42130"unusual" characters in the pathname by enclosing the
131pathname in a double-quote pair and with backslashes the
132same way strings in C source code are quoted. If this
133variable is set to false, the bytes higher than 0x80 are
134not quoted but output as verbatim. Note that double
135quote, backslash and control characters are always
136quoted without `-z` regardless of the setting of this
137variable.
138
Junio C Hamanod9e0e5d2007-04-14 16:22:04139core.autocrlf::
140If true, makes git convert `CRLF` at the end of lines in text files to
141`LF` when reading from the filesystem, and convert in reverse when
142writing to the filesystem. The variable can be set to
143'input', in which case the conversion happens only while
144reading from the filesystem but files are written out with
145`LF` at the end of lines. Currently, which paths to consider
146"text" (i.e. be subjected to the autocrlf mechanism) is
147decided purely based on the contents.
148
Junio C Hamano26e590a2008-02-17 03:53:51149core.safecrlf::
150If true, makes git check if converting `CRLF` as controlled by
151`core.autocrlf` is reversible. Git will verify if a command
152modifies a file in the work tree either directly or indirectly.
153For example, committing a file followed by checking out the
154same file should yield the original file in the work tree. If
155this is not the case for the current setting of
156`core.autocrlf`, git will reject the file. The variable can
157be set to "warn", in which case git will only warn about an
158irreversible conversion but continue the operation.
159+
160CRLF conversion bears a slight chance of corrupting data.
161autocrlf=true will convert CRLF to LF during commit and LF to
162CRLF during checkout. A file that contains a mixture of LF and
163CRLF before the commit cannot be recreated by git. For text
164files this is the right thing to do: it corrects line endings
165such that we have only LF line endings in the repository.
166But for binary files that are accidentally classified as text the
167conversion can corrupt data.
168+
169If you recognize such corruption early you can easily fix it by
170setting the conversion type explicitly in .gitattributes. Right
171after committing you still have the original file in your work
172tree and this file is not yet corrupted. You can explicitly tell
173git that this file is binary and git will handle the file
174appropriately.
175+
176Unfortunately, the desired effect of cleaning up text files with
177mixed line endings and the undesired effect of corrupting binary
178files cannot be distinguished. In both cases CRLFs are removed
179in an irreversible way. For text files this is the right thing
180to do because CRLFs are line endings, while for binary files
181converting CRLFs corrupts data.
182+
183Note, this safety check does not mean that a checkout will generate a
184file identical to the original file for a different setting of
185`core.autocrlf`, but only for the current one. For example, a text
186file with `LF` would be accepted with `core.autocrlf=input` and could
187later be checked out with `core.autocrlf=true`, in which case the
188resulting file would contain `CRLF`, although the original file
189contained `LF`. However, in both work trees the line endings would be
190consistent, that is either all `LF` or all `CRLF`, but never mixed. A
191file with mixed line endings would be reported by the `core.safecrlf`
192mechanism.
193
Junio C Hamanoaa83a7d2007-03-05 02:37:29194core.symlinks::
195If false, symbolic links are checked out as small plain files that
Junio C Hamano35738e82008-01-07 07:55:46196contain the link text. linkgit:git-update-index[1] and
197linkgit:git-add[1] will not change the recorded type to regular
Junio C Hamanoaa83a7d2007-03-05 02:37:29198file. Useful on filesystems like FAT that do not support
199symbolic links. True by default.
200
Junio C Hamano07824ce2006-04-25 07:36:54201core.gitProxy::
202A "proxy command" to execute (as 'command host port') instead
203of establishing direct connection to the remote server when
204using the git protocol for fetching. If the variable value is
205in the "COMMAND for DOMAIN" format, the command is applied only
206on hostnames ending with the specified domain string. This variable
207may be set multiple times and is matched in the given order;
208the first match wins.
Junio C Hamanof1d14802006-06-08 00:48:17209+
210Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
211(which always applies universally, without the special "for"
212handling).
Junio C Hamano07824ce2006-04-25 07:36:54213
214core.ignoreStat::
Junio C Hamano054ea082008-06-01 08:26:34215If true, commands which modify both the working tree and the index
216will mark the updated paths with the "assume unchanged" bit in the
217index. These marked files are then assumed to stay unchanged in the
218working copy, until you mark them otherwise manually - Git will not
219detect the file changes by lstat() calls. This is useful on systems
220where those are very slow, such as Microsoft Windows.
221See linkgit:git-update-index[1].
Junio C Hamano07824ce2006-04-25 07:36:54222False by default.
223
Junio C Hamano88a3a072006-05-04 08:01:43224core.preferSymlinkRefs::
225Instead of the default "symref" format for HEAD
226and other symbolic reference files, use symbolic links.
227This is sometimes needed to work with old scripts that
228expect HEAD to be a symbolic link.
Junio C Hamano07824ce2006-04-25 07:36:54229
Junio C Hamano1025e752007-02-23 07:21:26230core.bare::
231If true this repository is assumed to be 'bare' and has no
232working directory associated with it. If this is the case a
233number of commands that require a working directory will be
Junio C Hamano35738e82008-01-07 07:55:46234disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
Junio C Hamano1025e752007-02-23 07:21:26235+
Junio C Hamano35738e82008-01-07 07:55:46236This setting is automatically guessed by linkgit:git-clone[1] or
237linkgit:git-init[1] when the repository was created. By default a
Junio C Hamano1025e752007-02-23 07:21:26238repository that ends in "/.git" is assumed to be not bare (bare =
239false), while all other repositories are assumed to be bare (bare
240= true).
241
Junio C Hamanod526ba92007-07-02 00:17:42242core.worktree::
243Set the path to the working tree. The value will not be
244used in combination with repositories found automatically in
245a .git directory (i.e. $GIT_DIR is not set).
Junio C Hamano764a6672007-10-23 01:23:31246This can be overridden by the GIT_WORK_TREE environment
Junio C Hamano7d575a52008-04-30 08:45:27247variable and the '--work-tree' command line option. It can be
248a absolute path or relative path to the directory specified by
249--git-dir or GIT_DIR.
250Note: If --git-dir or GIT_DIR are specified but none of
251--work-tree, GIT_WORK_TREE and core.worktree is specified,
252the current working directory is regarded as the top directory
253of your working tree.
Junio C Hamanod526ba92007-07-02 00:17:42254
Junio C Hamano341071d2006-06-04 07:24:48255core.logAllRefUpdates::
Junio C Hamanocae86272007-08-21 02:20:49256Enable the reflog. Updates to a ref <ref> is logged to the file
Junio C Hamanoa2ec14f2006-11-02 00:22:48257"$GIT_DIR/logs/<ref>", by appending the new and old
258SHA1, the date/time and the reason of the update, but
259only when the file exists. If this configuration
260variable is set to true, missing "$GIT_DIR/logs/<ref>"
261file is automatically created for branch heads.
Junio C Hamano1caaf472006-12-31 08:29:35262+
263This information can be used to determine what commit
264was the tip of a branch "2 days ago".
265+
266This value is true by default in a repository that has
267a working directory associated with it, and false by
268default in a bare repository.
Junio C Hamano341071d2006-06-04 07:24:48269
Junio C Hamano07824ce2006-04-25 07:36:54270core.repositoryFormatVersion::
271Internal variable identifying the repository format and layout
272version.
273
274core.sharedRepository::
Junio C Hamano0ab78ae2006-08-09 01:00:42275When 'group' (or 'true'), the repository is made shareable between
276several users in a group (making sure all the files and objects are
277group-writable). When 'all' (or 'world' or 'everybody'), the
278repository will be readable by all users, additionally to being
279group-shareable. When 'umask' (or 'false'), git will use permissions
Junio C Hamano2f102bb2008-04-26 02:23:37280reported by umask(2). When '0xxx', where '0xxx' is an octal number,
281files in the repository will have this mode value. '0xxx' will override
282user's umask value, and thus, users with a safe umask (0077) can use
283this option. Examples: '0660' is equivalent to 'group'. '0640' is a
284repository that is group-readable but not group-writable.
285See linkgit:git-init[1]. False by default.
Junio C Hamano07824ce2006-04-25 07:36:54286
287core.warnAmbiguousRefs::
288If true, git will warn you if the ref name you passed it is ambiguous
289and might match multiple refs in the .git/refs/ tree. True by default.
290
Junio C Hamano7ec15722006-07-07 02:03:59291core.compression::
Junio C Hamanof2ce2972007-05-20 19:12:09292An integer -1..9, indicating a default compression level.
293-1 is the zlib default. 0 means no compression,
294and 1..9 are various speed/size tradeoffs, 9 being slowest.
Junio C Hamano2e72a942007-11-21 08:54:42295If set, this provides a default to other compression variables,
296such as 'core.loosecompression' and 'pack.compression'.
Junio C Hamanoa126a3b2006-07-04 04:55:26297
Junio C Hamanof2ce2972007-05-20 19:12:09298core.loosecompression::
299An integer -1..9, indicating the compression level for objects that
300are not in a pack file. -1 is the zlib default. 0 means no
301compression, and 1..9 are various speed/size tradeoffs, 9 being
302slowest. If not set, defaults to core.compression. If that is
Junio C Hamano2e72a942007-11-21 08:54:42303not set, defaults to 1 (best speed).
Junio C Hamano28d9dfe2006-07-25 03:50:49304
Junio C Hamanofc4d38c2007-01-08 06:53:32305core.packedGitWindowSize::
306Number of bytes of a pack file to map into memory in a
307single mapping operation. Larger window sizes may allow
308your system to process a smaller number of large pack files
309more quickly. Smaller window sizes will negatively affect
310performance due to increased calls to the operating system's
311memory manager, but may improve performance when accessing
312a large number of large pack files.
313+
314Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
315MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
316be reasonable for all users/operating systems. You probably do
317not need to adjust this value.
318+
319Common unit suffixes of 'k', 'm', or 'g' are supported.
320
321core.packedGitLimit::
322Maximum number of bytes to map simultaneously into memory
323from pack files. If Git needs to access more than this many
324bytes at once to complete an operation it will unmap existing
325regions to reclaim virtual address space within the process.
326+
327Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
328This should be reasonable for all users/operating systems, except on
329the largest projects. You probably do not need to adjust this value.
330+
331Common unit suffixes of 'k', 'm', or 'g' are supported.
332
Junio C Hamanob8c51282007-03-19 10:43:30333core.deltaBaseCacheLimit::
334Maximum number of bytes to reserve for caching base objects
335that multiple deltafied objects reference. By storing the
336entire decompressed base objects in a cache Git is able
337to avoid unpacking and decompressing frequently used base
338objects multiple times.
339+
340Default is 16 MiB on all platforms. This should be reasonable
341for all users/operating systems, except on the largest projects.
342You probably do not need to adjust this value.
343+
344Common unit suffixes of 'k', 'm', or 'g' are supported.
345
Junio C Hamano1d90cb02007-07-03 07:05:31346core.excludesfile::
Junio C Hamano5e284b42007-05-22 07:23:37347In addition to '.gitignore' (per-directory) and
348'.git/info/exclude', git looks into this file for patterns
Junio C Hamano679d22d2007-06-02 21:13:44349of files which are not meant to be tracked. See
Junio C Hamano35738e82008-01-07 07:55:46350linkgit:gitignore[5].
Junio C Hamano5e284b42007-05-22 07:23:37351
Junio C Hamanof6002a92007-07-20 10:28:22352core.editor::
353Commands such as `commit` and `tag` that lets you edit
Junio C Hamanoa6387422007-08-25 03:54:27354messages by launching an editor uses the value of this
Junio C Hamanof6002a92007-07-20 10:28:22355variable when it is set, and the environment variable
356`GIT_EDITOR` is not set. The order of preference is
Junio C Hamanode9879a2007-07-22 09:33:42357`GIT_EDITOR` environment, `core.editor`, `VISUAL` and
358`EDITOR` environment variables and then finally `vi`.
Junio C Hamanof6002a92007-07-20 10:28:22359
Junio C Hamano28d8ede2007-07-05 05:51:38360core.pager::
Junio C Hamano0551f6a2008-08-25 00:33:33361The command that git will use to paginate output. Can
362be overridden with the `GIT_PAGER` environment
363variable. Note that git sets the `LESS` environment
364variable to `FRSX` if it is unset when it runs the
365pager. One can change these settings by setting the
366`LESS` variable to some other value or by giving the
367`core.pager` option a value such as "`less -+FRSX`".
Junio C Hamano28d8ede2007-07-05 05:51:38368
Junio C Hamano942b35e2007-12-09 10:19:33369core.whitespace::
370A comma separated list of common whitespace problems to
Junio C Hamanoba4b9282008-07-06 05:20:31371notice. 'git-diff' will use `color.diff.whitespace` to
372highlight them, and 'git-apply --whitespace=error' will
Junio C Hamano3db8b412008-07-26 06:45:59373consider them as errors. You can prefix `-` to disable
374any of them (e.g. `-trailing-space`):
Junio C Hamano942b35e2007-12-09 10:19:33375+
376* `trailing-space` treats trailing whitespaces at the end of the line
377 as an error (enabled by default).
378* `space-before-tab` treats a space character that appears immediately
379 before a tab character in the initial indent part of the line as an
380 error (enabled by default).
381* `indent-with-non-tab` treats a line that is indented with 8 or more
Junio C Hamano42a2e2d2007-12-16 22:13:42382 space characters as an error (not enabled by default).
Junio C Hamano601f3e52008-02-25 08:40:42383* `cr-at-eol` treats a carriage-return at the end of line as
384 part of the line terminator, i.e. with it, `trailing-space`
385 does not trigger if the character before such a carriage-return
386 is not a whitespace (not enabled by default).
Junio C Hamano942b35e2007-12-09 10:19:33387
Junio C Hamano9eb57532008-06-26 06:33:46388core.fsyncobjectfiles::
389This boolean will enable 'fsync()' when writing object files.
390+
391This is a total waste of time and effort on a filesystem that orders
392data writes properly, but can be useful for filesystems that do not use
393journalling (traditional UNIX filesystems) or that only journal metadata
394and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
395
Junio C Hamano33db4372006-06-07 19:51:45396alias.*::
Junio C Hamano35738e82008-01-07 07:55:46397Command aliases for the linkgit:git[1] command wrapper - e.g.
Junio C Hamano33db4372006-06-07 19:51:45398after defining "alias.last = cat-file commit HEAD", the invocation
399"git last" is equivalent to "git cat-file commit HEAD". To avoid
Junio C Hamanof1d14802006-06-08 00:48:17400confusion and troubles with script usage, aliases that
401hide existing git commands are ignored. Arguments are split by
402spaces, the usual shell quoting and escaping is supported.
403quote pair and a backslash can be used to quote them.
Junio C Hamanodbb64592007-09-01 11:17:39404+
405If the alias expansion is prefixed with an exclamation point,
406it will be treated as a shell command. For example, defining
407"alias.new = !gitk --all --not ORIG_HEAD", the invocation
408"git new" is equivalent to running the shell command
409"gitk --all --not ORIG_HEAD".
Junio C Hamano9cb74f22007-02-12 04:15:05410
Junio C Hamano07824ce2006-04-25 07:36:54411apply.whitespace::
Junio C Hamanoba4b9282008-07-06 05:20:31412Tells 'git-apply' how to handle whitespaces, in the same way
Junio C Hamano35738e82008-01-07 07:55:46413as the '--whitespace' option. See linkgit:git-apply[1].
Junio C Hamano07824ce2006-04-25 07:36:54414
Junio C Hamano7fd84172007-05-24 07:00:32415branch.autosetupmerge::
Junio C Hamanoba4b9282008-07-06 05:20:31416Tells 'git-branch' and 'git-checkout' to setup new branches
Junio C Hamano24bc09a2008-02-28 00:27:44417so that linkgit:git-pull[1] will appropriately merge from the
418starting point branch. Note that even if this option is not set,
Junio C Hamano7fd84172007-05-24 07:00:32419this behavior can be chosen per-branch using the `--track`
Junio C Hamano24bc09a2008-02-28 00:27:44420and `--no-track` options. The valid settings are: `false` -- no
421automatic setup is done; `true` -- automatic setup is done when the
422starting point is a remote branch; `always` -- automatic setup is
423done when the starting point is either a local branch or remote
424branch. This option defaults to true.
Junio C Hamano7fd84172007-05-24 07:00:32425
Junio C Hamano869bb802008-05-12 00:29:47426branch.autosetuprebase::
Junio C Hamanoba4b9282008-07-06 05:20:31427When a new branch is created with 'git-branch' or 'git-checkout'
Junio C Hamano869bb802008-05-12 00:29:47428that tracks another branch, this variable tells git to set
429up pull to rebase instead of merge (see "branch.<name>.rebase").
430When `never`, rebase is never automatically set to true.
431When `local`, rebase is set to true for tracked branches of
432other local branches.
433When `remote`, rebase is set to true for tracked branches of
434remote branches.
435When `always`, rebase will be set to true for all tracking
436branches.
437See "branch.autosetupmerge" for details on how to set up a
438branch to track another branch.
439This option defaults to never.
440
Junio C Hamano47c1e3c2006-09-25 04:45:55441branch.<name>.remote::
Junio C Hamanoba4b9282008-07-06 05:20:31442When in branch <name>, it tells 'git-fetch' which remote to fetch.
443If this option is not given, 'git-fetch' defaults to remote "origin".
Junio C Hamano47c1e3c2006-09-25 04:45:55444
445branch.<name>.merge::
Junio C Hamanoba4b9282008-07-06 05:20:31446When in branch <name>, it tells 'git-fetch' the default
Junio C Hamanoc2b47092007-10-25 06:50:31447refspec to be marked for merging in FETCH_HEAD. The value is
448handled like the remote part of a refspec, and must match a
449ref which is fetched from the remote given by
450"branch.<name>.remote".
Junio C Hamanoba4b9282008-07-06 05:20:31451The merge information is used by 'git-pull' (which at first calls
452'git-fetch') to lookup the default branch for merging. Without
453this option, 'git-pull' defaults to merge the first refspec fetched.
Junio C Hamano96010b22006-12-09 21:15:46454Specify multiple values to get an octopus merge.
Junio C Hamanoba4b9282008-07-06 05:20:31455If you wish to setup 'git-pull' so that it merges into <name> from
Junio C Hamano6e149c02007-03-16 10:21:07456another branch in the local repository, you can point
457branch.<name>.merge to the desired branch, and use the special setting
458`.` (a period) for branch.<name>.remote.
Junio C Hamano47c1e3c2006-09-25 04:45:55459
Junio C Hamano1b50ce92007-10-03 12:05:53460branch.<name>.mergeoptions::
461Sets default options for merging into branch <name>. The syntax and
Junio C Hamano35738e82008-01-07 07:55:46462supported options are equal to that of linkgit:git-merge[1], but
Junio C Hamano1b50ce92007-10-03 12:05:53463option values containing whitespace characters are currently not
464supported.
465
Junio C Hamano0c999702007-12-03 09:57:55466branch.<name>.rebase::
467When true, rebase the branch <name> on top of the fetched branch,
Junio C Hamano6d76d612008-05-09 05:46:08468instead of merging the default branch from the default remote when
469"git pull" is run.
Junio C Hamano0c999702007-12-03 09:57:55470*NOTE*: this is a possibly dangerous operation; do *not* use
Junio C Hamano35738e82008-01-07 07:55:46471it unless you understand the implications (see linkgit:git-rebase[1]
Junio C Hamano0c999702007-12-03 09:57:55472for details).
473
Junio C Hamano8760ea62008-03-14 08:58:45474browser.<tool>.cmd::
475Specify the command to invoke the specified browser. The
476specified command is evaluated in shell with the URLs passed
477as arguments. (See linkgit:git-web--browse[1].)
478
Junio C Hamanoe35a6fc2008-01-29 09:46:27479browser.<tool>.path::
480Override the path for the given tool that may be used to
481browse HTML help (see '-w' option in linkgit:git-help[1]) or a
482working repository in gitweb (see linkgit:git-instaweb[1]).
483
Junio C Hamano47b9acd2007-04-24 07:34:34484clean.requireForce::
Junio C Hamano422cfec2007-11-08 08:07:45485A boolean to make git-clean do nothing unless given -f
486or -n. Defaults to true.
Junio C Hamano47b9acd2007-04-24 07:34:34487
Junio C Hamanoeb692952007-01-03 22:02:12488color.branch::
489A boolean to enable/disable color in the output of
Junio C Hamano35738e82008-01-07 07:55:46490linkgit:git-branch[1]. May be set to `always`,
Junio C Hamano0fc8cd92007-12-06 03:26:21491`false` (or `never`) or `auto` (or `true`), in which case colors are used
Junio C Hamanoeb692952007-01-03 22:02:12492only when the output is to a terminal. Defaults to false.
493
494color.branch.<slot>::
495Use customized color for branch coloration. `<slot>` is one of
496`current` (the current branch), `local` (a local branch),
497`remote` (a tracking branch in refs/remotes/), `plain` (other
Junio C Hamano5a702332007-01-28 20:55:22498refs).
499+
500The value for these configuration variables is a list of colors (at most
501two) and attributes (at most one), separated by spaces. The colors
502accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
503`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
504`blink` and `reverse`. The first color given is the foreground; the
505second is the background. The position of the attribute, if any,
506doesn't matter.
Junio C Hamanoeb692952007-01-03 22:02:12507
Junio C Hamano3f403b02006-12-13 10:14:13508color.diff::
Junio C Hamano0fc8cd92007-12-06 03:26:21509When set to `always`, always use colors in patch.
510When false (or `never`), never. When set to `true` or `auto`, use
511colors only when the output is to the terminal. Defaults to false.
Junio C Hamano9ae1a062006-07-10 08:12:34512
Junio C Hamano3f403b02006-12-13 10:14:13513color.diff.<slot>::
Junio C Hamano5a702332007-01-28 20:55:22514Use customized color for diff colorization. `<slot>` specifies
515which part of the patch to use the specified color, and is one
516of `plain` (context text), `meta` (metainformation), `frag`
517(hunk header), `old` (removed lines), `new` (added lines),
Junio C Hamano942b35e2007-12-09 10:19:33518`commit` (commit headers), or `whitespace` (highlighting
519whitespace errors). The values of these variables may be specified as
Junio C Hamano5a702332007-01-28 20:55:22520in color.branch.<slot>.
Junio C Hamano9ae1a062006-07-10 08:12:34521
Junio C Hamano00b8b632007-12-07 09:50:49522color.interactive::
Junio C Hamano35738e82008-01-07 07:55:46523When set to `always`, always use colors for interactive prompts
Junio C Hamanoba4b9282008-07-06 05:20:31524and displays (such as those used by "git-add --interactive").
Junio C Hamano00b8b632007-12-07 09:50:49525When false (or `never`), never. When set to `true` or `auto`, use
526colors only when the output is to the terminal. Defaults to false.
527
528color.interactive.<slot>::
Junio C Hamanoba4b9282008-07-06 05:20:31529Use customized color for 'git-add --interactive'
Junio C Hamano00b8b632007-12-07 09:50:49530output. `<slot>` may be `prompt`, `header`, or `help`, for
531three distinct types of normal output from interactive
532programs. The values of these variables may be specified as
533in color.branch.<slot>.
534
Junio C Hamanoe7935c42006-12-13 21:32:17535color.pager::
536A boolean to enable/disable colored output when the pager is in
537use (default is true).
538
539color.status::
540A boolean to enable/disable color in the output of
Junio C Hamano35738e82008-01-07 07:55:46541linkgit:git-status[1]. May be set to `always`,
Junio C Hamano0fc8cd92007-12-06 03:26:21542`false` (or `never`) or `auto` (or `true`), in which case colors are used
Junio C Hamanoe7935c42006-12-13 21:32:17543only when the output is to a terminal. Defaults to false.
544
545color.status.<slot>::
546Use customized color for status colorization. `<slot>` is
547one of `header` (the header text of the status message),
Junio C Hamano7d23f5e2006-12-16 07:44:04548`added` or `updated` (files which are added but not committed),
549`changed` (files which are changed but not added in the index),
Junio C Hamanob713ff12008-05-24 01:12:30550`untracked` (files which are not tracked by git), or
551`nobranch` (the color the 'no branch' warning is shown in, defaulting
552to red). The values of these variables may be specified as in
553color.branch.<slot>.
Junio C Hamanoe7935c42006-12-13 21:32:17554
Junio C Hamanob968dbb2007-07-27 07:26:40555commit.template::
556Specify a file to use as the template for new commit messages.
557
Junio C Hamano83d46a22008-02-21 02:29:42558color.ui::
559When set to `always`, always use colors in all git commands which
560are capable of colored output. When false (or `never`), never. When
561set to `true` or `auto`, use colors only when the output is to the
562terminal. When more specific variables of color.* are set, they always
563take precedence over this setting. Defaults to false.
564
Junio C Hamanodbb64592007-09-01 11:17:39565diff.autorefreshindex::
Junio C Hamanoba4b9282008-07-06 05:20:31566When using 'git-diff' to compare with work tree
Junio C Hamanodbb64592007-09-01 11:17:39567files, do not consider stat-only change as changed.
568Instead, silently run `git update-index --refresh` to
569update the cached stat information for paths whose
570contents in the work tree match the contents in the
571index. This option defaults to true. Note that this
Junio C Hamanoba4b9282008-07-06 05:20:31572affects only 'git-diff' Porcelain, and not lower level
573'diff' commands, such as 'git-diff-files'.
Junio C Hamanodbb64592007-09-01 11:17:39574
Junio C Hamano5cf43ca2008-08-20 09:14:14575diff.suppress-blank-empty::
576A boolean to inhibit the standard behavior of printing a space
577before each empty output line. Defaults to false.
578
Junio C Hamano1fbbbc12007-12-18 07:01:27579diff.external::
580If this config variable is set, diff generation is not
581performed using the internal diff machinery, but using the
Junio C Hamano85c71572008-07-28 00:03:31582given command. Can be overridden with the `GIT_EXTERNAL_DIFF'
583environment variable. The command is called with parameters
584as described under "git Diffs" in linkgit:git[1]. Note: if
585you want to use an external diff program only on a subset of
586your files, you might want to use linkgit:gitattributes[5] instead.
Junio C Hamano1fbbbc12007-12-18 07:01:27587
Junio C Hamano07824ce2006-04-25 07:36:54588diff.renameLimit::
589The number of files to consider when performing the copy/rename
Junio C Hamanoba4b9282008-07-06 05:20:31590detection; equivalent to the 'git-diff' option '-l'.
Junio C Hamano07824ce2006-04-25 07:36:54591
Junio C Hamano9ae1a062006-07-10 08:12:34592diff.renames::
593Tells git to detect renames. If set to any boolean value, it
594will enable basic rename detection. If set to "copies" or
595"copy", it will detect copies, as well.
596
Junio C Hamano54ea8d32007-01-25 07:59:48597fetch.unpackLimit::
598If the number of objects fetched over the git native
599transfer is below this
600limit, then the objects will be unpacked into loose object
601files. However if the number of received objects equals or
602exceeds this limit then the received pack will be stored as
603a pack, after adding any missing delta bases. Storing the
604pack from a push can make the push operation complete faster,
Junio C Hamanoe77b0152008-01-12 06:44:17605especially on slow filesystems. If not set, the value of
606`transfer.unpackLimit` is used instead.
Junio C Hamano54ea8d32007-01-25 07:59:48607
Junio C Hamano8c5802d2007-11-15 00:13:36608format.numbered::
609A boolean which can enable sequence numbers in patch subjects.
Junio C Hamanofe986052007-12-19 07:33:38610Setting this option to "auto" will enable it only if there is
Junio C Hamano8c5802d2007-11-15 00:13:36611more than one patch. See --numbered option in
Junio C Hamano35738e82008-01-07 07:55:46612linkgit:git-format-patch[1].
Junio C Hamano8c5802d2007-11-15 00:13:36613
Junio C Hamano07824ce2006-04-25 07:36:54614format.headers::
615Additional email headers to include in a patch to be submitted
Junio C Hamano35738e82008-01-07 07:55:46616by mail. See linkgit:git-format-patch[1].
Junio C Hamano07824ce2006-04-25 07:36:54617
Junio C Hamanod4c8e112007-03-04 10:32:38618format.suffix::
619The default for format-patch is to output files with the suffix
620`.patch`. Use this variable to change that suffix (make sure to
621include the dot if you want it).
622
Junio C Hamano86bcccc2008-03-08 09:33:55623format.pretty::
624The default pretty format for log/show/whatchanged command,
625See linkgit:git-log[1], linkgit:git-show[1],
626linkgit:git-whatchanged[1].
627
Junio C Hamanof2ce2972007-05-20 19:12:09628gc.aggressiveWindow::
629The window size parameter used in the delta compression
Junio C Hamanoba4b9282008-07-06 05:20:31630algorithm used by 'git-gc --aggressive'. This defaults
Junio C Hamanof2ce2972007-05-20 19:12:09631to 10.
632
Junio C Hamano1b50ce92007-10-03 12:05:53633gc.auto::
634When there are approximately more than this many loose
635objects in the repository, `git gc --auto` will pack them.
636Some Porcelain commands use this command to perform a
Junio C Hamanoe77b0152008-01-12 06:44:17637light-weight garbage collection from time to time. The
638default value is 6700. Setting this to 0 disables it.
Junio C Hamano1b50ce92007-10-03 12:05:53639
640gc.autopacklimit::
641When there are more than this many packs that are not
642marked with `*.keep` file in the repository, `git gc
Junio C Hamanoe77b0152008-01-12 06:44:17643--auto` consolidates them into one larger pack. The
Junio C Hamano25c0b702008-03-23 09:41:37644default value is 50. Setting this to 0 disables it.
Junio C Hamano1b50ce92007-10-03 12:05:53645
Junio C Hamano9d52e572007-02-13 23:48:20646gc.packrefs::
Junio C Hamanoba4b9282008-07-06 05:20:31647'git-gc' does not run `git pack-refs` in a bare repository by
Junio C Hamano9d52e572007-02-13 23:48:20648default so that older dumb-transport clients can still fetch
Junio C Hamanoba4b9282008-07-06 05:20:31649from the repository. Setting this to `true` lets 'git-gc'
650to run `git pack-refs`. Setting this to `false` tells
651'git-gc' never to run `git pack-refs`. The default setting is
Junio C Hamano9d52e572007-02-13 23:48:20652`notbare`. Enable it only when you know you do not have to
653support such clients. The default setting will change to `true`
654at some stage, and setting this to `false` will continue to
Junio C Hamanoba4b9282008-07-06 05:20:31655prevent `git pack-refs` from being run from 'git-gc'.
Junio C Hamano9d52e572007-02-13 23:48:20656
Junio C Hamano09a926d2008-03-13 07:55:29657gc.pruneexpire::
Junio C Hamanoba4b9282008-07-06 05:20:31658When 'git-gc' is run, it will call 'prune --expire 2.weeks.ago'.
Junio C Hamano09a926d2008-03-13 07:55:29659Override the grace period with this config variable.
660
Junio C Hamano74640642006-12-27 10:59:55661gc.reflogexpire::
Junio C Hamanoba4b9282008-07-06 05:20:31662'git-reflog expire' removes reflog entries older than
Junio C Hamano74640642006-12-27 10:59:55663this time; defaults to 90 days.
664
665gc.reflogexpireunreachable::
Junio C Hamanoba4b9282008-07-06 05:20:31666'git-reflog expire' removes reflog entries older than
Junio C Hamano74640642006-12-27 10:59:55667this time and are not reachable from the current tip;
668defaults to 30 days.
669
670gc.rerereresolved::
671Records of conflicted merge you resolved earlier are
Junio C Hamanoba4b9282008-07-06 05:20:31672kept for this many days when 'git-rerere gc' is run.
Junio C Hamano35738e82008-01-07 07:55:46673The default is 60 days. See linkgit:git-rerere[1].
Junio C Hamano74640642006-12-27 10:59:55674
675gc.rerereunresolved::
676Records of conflicted merge you have not resolved are
Junio C Hamanoba4b9282008-07-06 05:20:31677kept for this many days when 'git-rerere gc' is run.
Junio C Hamano35738e82008-01-07 07:55:46678The default is 15 days. See linkgit:git-rerere[1].
Junio C Hamano74640642006-12-27 10:59:55679
Junio C Hamano15048272008-07-07 22:10:48680rerere.autoupdate::
681When set to true, `git-rerere` updates the index with the
682resulting contents after it cleanly resolves conflicts using
683previously recorded resolution. Defaults to false.
684
Junio C Hamano7a4a2832007-07-07 21:53:22685rerere.enabled::
686Activate recording of resolved conflicts, so that identical
687conflict hunks can be resolved automatically, should they
Junio C Hamano35738e82008-01-07 07:55:46688be encountered again. linkgit:git-rerere[1] command is by
Junio C Hamano0e47b232008-01-15 08:31:10689default enabled if you create `rr-cache` directory under
690`$GIT_DIR`, but can be disabled by setting this option to false.
Junio C Hamano7a4a2832007-07-07 21:53:22691
Junio C Hamano07824ce2006-04-25 07:36:54692gitcvs.enabled::
Junio C Hamanoa6387422007-08-25 03:54:27693Whether the CVS server interface is enabled for this repository.
Junio C Hamano35738e82008-01-07 07:55:46694See linkgit:git-cvsserver[1].
Junio C Hamano07824ce2006-04-25 07:36:54695
696gitcvs.logfile::
Junio C Hamanoa6387422007-08-25 03:54:27697Path to a log file where the CVS server interface well... logs
Junio C Hamano35738e82008-01-07 07:55:46698various stuff. See linkgit:git-cvsserver[1].
Junio C Hamano07824ce2006-04-25 07:36:54699
Junio C Hamano17bd2272008-09-01 06:11:17700gitcvs.usecrlfattr::
Junio C Hamanodfccbb02008-05-26 01:16:14701If true, the server will look up the `crlf` attribute for
702files to determine the '-k' modes to use. If `crlf` is set,
703the '-k' mode will be left blank, so cvs clients will
704treat it as text. If `crlf` is explicitly unset, the file
Junio C Hamanocb1c44f2008-08-06 06:19:33705will be set with '-kb' mode, which suppresses any newline munging
Junio C Hamanodfccbb02008-05-26 01:16:14706the client might otherwise do. If `crlf` is not specified,
Junio C Hamanod32738e2008-07-09 19:53:42707then 'gitcvs.allbinary' is used. See linkgit:gitattributes[5].
Junio C Hamanodfccbb02008-05-26 01:16:14708
Junio C Hamanod9e0e5d2007-04-14 16:22:04709gitcvs.allbinary::
Junio C Hamanodfccbb02008-05-26 01:16:14710This is used if 'gitcvs.usecrlfattr' does not resolve
711the correct '-kb' mode to use. If true, all
712unresolved files are sent to the client in
713mode '-kb'. This causes the client to treat them
714as binary files, which suppresses any newline munging it
715otherwise might do. Alternatively, if it is set to "guess",
716then the contents of the file are examined to decide if
717it is binary, similar to 'core.autocrlf'.
Junio C Hamanoa2ad99e2007-04-18 09:57:04718
719gitcvs.dbname::
720Database used by git-cvsserver to cache revision information
721derived from the git repository. The exact meaning depends on the
722used database driver, for SQLite (which is the default driver) this
723is a filename. Supports variable substitution (see
Junio C Hamano35738e82008-01-07 07:55:46724linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
Junio C Hamanoa2ad99e2007-04-18 09:57:04725Default: '%Ggitcvs.%m.sqlite'
726
727gitcvs.dbdriver::
728Used Perl DBI driver. You can specify any available driver
729 for this here, but it might not work. git-cvsserver is tested
730with 'DBD::SQLite', reported to work with 'DBD::Pg', and
731reported *not* to work with 'DBD::mysql'. Experimental feature.
732May not contain double colons (`:`). Default: 'SQLite'.
Junio C Hamano35738e82008-01-07 07:55:46733See linkgit:git-cvsserver[1].
Junio C Hamanod9e0e5d2007-04-14 16:22:04734
Junio C Hamanoa2ad99e2007-04-18 09:57:04735gitcvs.dbuser, gitcvs.dbpass::
736Database user and password. Only useful if setting 'gitcvs.dbdriver',
737since SQLite has no concept of database users and/or passwords.
738'gitcvs.dbuser' supports variable substitution (see
Junio C Hamano35738e82008-01-07 07:55:46739linkgit:git-cvsserver[1] for details).
Junio C Hamanoa2ad99e2007-04-18 09:57:04740
Junio C Hamanoa74efce2008-04-02 08:39:08741gitcvs.dbTableNamePrefix::
742Database table name prefix. Prepended to the names of any
743database tables used, allowing a single database to be used
744for several repositories. Supports variable substitution (see
745linkgit:git-cvsserver[1] for details). Any non-alphabetic
746characters will be replaced with underscores.
747
Junio C Hamanodfccbb02008-05-26 01:16:14748All gitcvs variables except for 'gitcvs.usecrlfattr' and
749'gitcvs.allbinary' can also be specified as
750'gitcvs.<access_method>.<varname>' (where 'access_method'
Junio C Hamanoa6387422007-08-25 03:54:27751is one of "ext" and "pserver") to make them apply only for the given
752access method.
Junio C Hamanoa2ad99e2007-04-18 09:57:04753
Junio C Hamano6d76d612008-05-09 05:46:08754gui.commitmsgwidth::
755Defines how wide the commit message window is in the
756linkgit:git-gui[1]. "75" is the default.
757
758gui.diffcontext::
759Specifies how many context lines should be used in calls to diff
760made by the linkgit:git-gui[1]. The default is "5".
761
762gui.matchtrackingbranch::
763Determines if new branches created with linkgit:git-gui[1] should
764default to tracking remote branches with matching names or
765not. Default: "false".
766
767gui.newbranchtemplate::
768Is used as suggested name when creating new branches using the
769linkgit:git-gui[1].
770
771gui.pruneduringfetch::
772"true" if linkgit:git-gui[1] should prune tracking branches when
773performing a fetch. The default value is "false".
774
775gui.trustmtime::
776Determines if linkgit:git-gui[1] should trust the file modification
777timestamp or not. By default the timestamps are not trusted.
778
779gui.spellingdictionary::
780Specifies the dictionary used for spell checking commit messages in
781the linkgit:git-gui[1]. When set to "none" spell checking is turned
782off.
783
Junio C Hamano4e272312008-01-08 09:13:21784help.browser::
785Specify the browser that will be used to display help in the
786'web' format. See linkgit:git-help[1].
787
788help.format::
789Override the default help format used by linkgit:git-help[1].
790Values 'man', 'info', 'web' and 'html' are supported. 'man' is
791the default. 'web' and 'html' are the same.
792
Junio C Hamanof24b8062008-09-09 01:34:39793help.autocorrect::
794Automatically correct and execute mistyped commands after
795waiting for the given number of deciseconds (0.1 sec). If more
796than one command can be deduced from the entered text, nothing
797will be executed. If the value of this option is negative,
798the corrected command will be executed immediately. If the
799value is 0 - the command will be just shown but not executed.
800This is the default.
801
Junio C Hamano58256872007-12-04 08:31:13802http.proxy::
803Override the HTTP proxy, normally configured using the 'http_proxy'
Junio C Hamano35738e82008-01-07 07:55:46804environment variable (see linkgit:curl[1]). This can be overridden
Junio C Hamano58256872007-12-04 08:31:13805on a per-remote basis; see remote.<name>.proxy
806
Junio C Hamano07824ce2006-04-25 07:36:54807http.sslVerify::
808Whether to verify the SSL certificate when fetching or pushing
Junio C Hamano33db4372006-06-07 19:51:45809over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
Junio C Hamano07824ce2006-04-25 07:36:54810variable.
811
812http.sslCert::
813File containing the SSL certificate when fetching or pushing
Junio C Hamano33db4372006-06-07 19:51:45814over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
Junio C Hamano07824ce2006-04-25 07:36:54815variable.
816
817http.sslKey::
818File containing the SSL private key when fetching or pushing
Junio C Hamano341071d2006-06-04 07:24:48819over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
Junio C Hamano07824ce2006-04-25 07:36:54820variable.
821
822http.sslCAInfo::
823File containing the certificates to verify the peer with when
Junio C Hamano341071d2006-06-04 07:24:48824fetching or pushing over HTTPS. Can be overridden by the
Junio C Hamano07824ce2006-04-25 07:36:54825'GIT_SSL_CAINFO' environment variable.
826
827http.sslCAPath::
828Path containing files with the CA certificates to verify the peer
Junio C Hamano33db4372006-06-07 19:51:45829with when fetching or pushing over HTTPS. Can be overridden
Junio C Hamano07824ce2006-04-25 07:36:54830by the 'GIT_SSL_CAPATH' environment variable.
831
832http.maxRequests::
Junio C Hamano341071d2006-06-04 07:24:48833How many HTTP requests to launch in parallel. Can be overridden
Junio C Hamano07824ce2006-04-25 07:36:54834by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
835
836http.lowSpeedLimit, http.lowSpeedTime::
837If the HTTP transfer speed is less than 'http.lowSpeedLimit'
838for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
Junio C Hamano341071d2006-06-04 07:24:48839Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
Junio C Hamano07824ce2006-04-25 07:36:54840'GIT_HTTP_LOW_SPEED_TIME' environment variables.
841
Junio C Hamanof1dcdfe2006-09-29 08:10:51842http.noEPSV::
843A boolean which disables using of EPSV ftp command by curl.
Junio C Hamanod9e0e5d2007-04-14 16:22:04844This can helpful with some "poor" ftp servers which don't
Junio C Hamanof1dcdfe2006-09-29 08:10:51845support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
846environment variable. Default is false (curl will use EPSV).
847
Junio C Hamano07824ce2006-04-25 07:36:54848i18n.commitEncoding::
849Character encoding the commit messages are stored in; git itself
850does not care per se, but this information is necessary e.g. when
851importing commits from emails or in the gitk graphical history
852browser (and possibly at other places in the future or in other
Junio C Hamano35738e82008-01-07 07:55:46853porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
Junio C Hamano07824ce2006-04-25 07:36:54854
Junio C Hamano51f92e22006-12-29 05:18:28855i18n.logOutputEncoding::
856Character encoding the commit messages are converted to when
Junio C Hamanoba4b9282008-07-06 05:20:31857running 'git-log' and friends.
Junio C Hamano51f92e22006-12-29 05:18:28858
Junio C Hamano4e272312008-01-08 09:13:21859instaweb.browser::
860Specify the program that will be used to browse your working
861repository in gitweb. See linkgit:git-instaweb[1].
862
863instaweb.httpd::
864The HTTP daemon command-line to start gitweb on your working
865repository. See linkgit:git-instaweb[1].
866
867instaweb.local::
868If true the web server started by linkgit:git-instaweb[1] will
869be bound to the local IP (127.0.0.1).
870
871instaweb.modulepath::
872The module path for an apache httpd used by linkgit:git-instaweb[1].
873
874instaweb.port::
875The port number to bind the gitweb httpd to. See
876linkgit:git-instaweb[1].
877
Junio C Hamanob713ff12008-05-24 01:12:30878log.date::
879Set default date-time mode for the log command. Setting log.date
Junio C Hamanoba4b9282008-07-06 05:20:31880value is similar to using 'git-log'\'s --date option. The value is one of the
Junio C Hamanob713ff12008-05-24 01:12:30881following alternatives: {relative,local,default,iso,rfc,short}.
882See linkgit:git-log[1].
883
Junio C Hamanofe9acab2006-11-24 12:10:55884log.showroot::
885If true, the initial commit will be shown as a big creation event.
886This is equivalent to a diff against an empty tree.
Junio C Hamano35738e82008-01-07 07:55:46887Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
Junio C Hamanofe9acab2006-11-24 12:10:55888normally hide the root commit will now show it. True by default.
889
Junio C Hamano8b588d52008-03-15 09:48:37890man.viewer::
891Specify the programs that may be used to display help in the
892'man' format. See linkgit:git-help[1].
893
Junio C Hamano6d76d612008-05-09 05:46:08894include::merge-config.txt[]
Junio C Hamano07824ce2006-04-25 07:36:54895
Junio C Hamano6d76d612008-05-09 05:46:08896man.<tool>.cmd::
897Specify the command to invoke the specified man viewer. The
898specified command is evaluated in shell with the man page
899passed as argument. (See linkgit:git-help[1].)
Junio C Hamano103ad7f2007-03-14 11:19:26900
Junio C Hamano6d76d612008-05-09 05:46:08901man.<tool>.path::
902Override the path for the given tool that may be used to
903display help in the 'man' format. See linkgit:git-help[1].
Junio C Hamanoe90436a2007-04-22 07:22:13904
Junio C Hamano1fbbbc12007-12-18 07:01:27905mergetool.<tool>.path::
906Override the path for the given tool. This is useful in case
907your tool is not in the PATH.
908
Junio C Hamano86bcccc2008-03-08 09:33:55909mergetool.<tool>.cmd::
910Specify the command to invoke the specified merge tool. The
911specified command is evaluated in shell with the following
912variables available: 'BASE' is the name of a temporary file
913containing the common base of the files to be merged, if available;
914'LOCAL' is the name of a temporary file containing the contents of
915the file on the current branch; 'REMOTE' is the name of a temporary
916file containing the contents of the file from the branch being
917merged; 'MERGED' contains the name of the file to which the merge
918tool should write the results of a successful merge.
919
920mergetool.<tool>.trustExitCode::
921For a custom merge command, specify whether the exit code of
922the merge command can be used to determine whether the merge was
923successful. If this is not set to true then the merge target file
924timestamp is checked and the merge assumed to have been successful
925if the file has been updated, otherwise the user is prompted to
926indicate the success of the merge.
927
928mergetool.keepBackup::
929After performing a merge, the original file with conflict markers
930can be saved as a file with a `.orig` extension. If this variable
931is set to `false` then this file is not preserved. Defaults to
932`true` (i.e. keep the backup files).
933
Junio C Hamano75cc4c92006-07-24 08:25:03934pack.window::
Junio C Hamano35738e82008-01-07 07:55:46935The size of the window used by linkgit:git-pack-objects[1] when no
Junio C Hamano75cc4c92006-07-24 08:25:03936window size is given on the command line. Defaults to 10.
937
Junio C Hamano91d44c52007-05-09 07:16:07938pack.depth::
Junio C Hamano35738e82008-01-07 07:55:46939The maximum delta depth used by linkgit:git-pack-objects[1] when no
Junio C Hamano91d44c52007-05-09 07:16:07940maximum depth is given on the command line. Defaults to 50.
941
Junio C Hamano235d53f2007-07-13 00:25:15942pack.windowMemory::
Junio C Hamano35738e82008-01-07 07:55:46943The window memory size limit used by linkgit:git-pack-objects[1]
Junio C Hamano235d53f2007-07-13 00:25:15944when no limit is given on the command line. The value can be
945suffixed with "k", "m", or "g". Defaults to 0, meaning no
946limit.
947
Junio C Hamanof2ce2972007-05-20 19:12:09948pack.compression::
949An integer -1..9, indicating the compression level for objects
950in a pack file. -1 is the zlib default. 0 means no
951compression, and 1..9 are various speed/size tradeoffs, 9 being
952slowest. If not set, defaults to core.compression. If that is
Junio C Hamano2e72a942007-11-21 08:54:42953not set, defaults to -1, the zlib default, which is "a default
954compromise between speed and compression (currently equivalent
955to level 6)."
Junio C Hamanof2ce2972007-05-20 19:12:09956
Junio C Hamano679d22d2007-06-02 21:13:44957pack.deltaCacheSize::
Junio C Hamanoa6387422007-08-25 03:54:27958The maximum memory in bytes used for caching deltas in
Junio C Hamano35738e82008-01-07 07:55:46959linkgit:git-pack-objects[1].
Junio C Hamano679d22d2007-06-02 21:13:44960A value of 0 means no limit. Defaults to 0.
961
962pack.deltaCacheLimit::
Junio C Hamano58155b42007-09-15 07:46:14963The maximum size of a delta, that is cached in
Junio C Hamano35738e82008-01-07 07:55:46964linkgit:git-pack-objects[1]. Defaults to 1000.
Junio C Hamano679d22d2007-06-02 21:13:44965
Junio C Hamano58155b42007-09-15 07:46:14966pack.threads::
967Specifies the number of threads to spawn when searching for best
Junio C Hamano35738e82008-01-07 07:55:46968delta matches. This requires that linkgit:git-pack-objects[1]
Junio C Hamano58155b42007-09-15 07:46:14969be compiled with pthreads otherwise this option is ignored with a
970warning. This is meant to reduce packing time on multiprocessor
971machines. The required amount of memory for the delta search window
972is however multiplied by the number of threads.
Junio C Hamano24bc09a2008-02-28 00:27:44973Specifying 0 will cause git to auto-detect the number of CPU's
974and set the number of threads accordingly.
Junio C Hamano58155b42007-09-15 07:46:14975
Junio C Hamanod814b6d2007-11-04 11:13:49976pack.indexVersion::
977Specify the default pack index version. Valid values are 1 for
978legacy pack index used by Git versions prior to 1.5.2, and 2 for
979the new pack index with capabilities for packs larger than 4 GB
980as well as proper protection against the repacking of corrupted
Junio C Hamanofce7c7e2008-07-02 03:06:38981packs. Version 2 is the default. Note that version 2 is enforced
982and this config option ignored whenever the corresponding pack is
983larger than 2 GB.
984+
985If you have an old git that does not understand the version 2 `{asterisk}.idx` file,
986cloning or fetching over a non native protocol (e.g. "http" and "rsync")
987that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the
988other side may give you a repository that cannot be accessed with your
989older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,
990you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
991the `{asterisk}.idx` file.
Junio C Hamanod814b6d2007-11-04 11:13:49992
Junio C Hamano09a926d2008-03-13 07:55:29993pack.packSizeLimit::
Junio C Hamano49dccaf2008-02-10 10:48:01994The default maximum size of a pack. This setting only affects
995packing to a file, i.e. the git:// protocol is unaffected. It
996can be overridden by the `\--max-pack-size` option of
997linkgit:git-repack[1].
998
Junio C Hamano9e96a1a2008-08-16 10:23:18999pager.<cmd>::
Junio C Hamano0551f6a2008-08-25 00:33:331000Allows turning on or off pagination of the output of a
1001particular git subcommand when writing to a tty. If
1002`\--paginate` or `\--no-pager` is specified on the command line,
1003it takes precedence over this option. To disable pagination for
1004all commands, set `core.pager` or 'GIT_PAGER' to "`cat`".
Junio C Hamano9e96a1a2008-08-16 10:23:181005
Junio C Hamano07824ce2006-04-25 07:36:541006pull.octopus::
1007The default merge strategy to use when pulling multiple branches
1008at once.
1009
1010pull.twohead::
1011The default merge strategy to use when pulling a single branch.
1012
Junio C Hamano249572f2006-10-24 05:44:081013remote.<name>.url::
Junio C Hamano35738e82008-01-07 07:55:461014The URL of a remote repository. See linkgit:git-fetch[1] or
1015linkgit:git-push[1].
Junio C Hamano249572f2006-10-24 05:44:081016
Junio C Hamano58256872007-12-04 08:31:131017remote.<name>.proxy::
1018For remotes that require curl (http, https and ftp), the URL to
1019the proxy to use for that remote. Set to the empty string to
1020disable proxying for that remote.
1021
Junio C Hamano249572f2006-10-24 05:44:081022remote.<name>.fetch::
Junio C Hamano35738e82008-01-07 07:55:461023The default set of "refspec" for linkgit:git-fetch[1]. See
1024linkgit:git-fetch[1].
Junio C Hamano249572f2006-10-24 05:44:081025
1026remote.<name>.push::
Junio C Hamano35738e82008-01-07 07:55:461027The default set of "refspec" for linkgit:git-push[1]. See
1028linkgit:git-push[1].
Junio C Hamano249572f2006-10-24 05:44:081029
Junio C Hamano47d68a52008-05-06 06:35:401030remote.<name>.mirror::
1031If true, pushing to this remote will automatically behave
1032as if the `\--mirror` option was given on the command line.
1033
Junio C Hamano118d2772007-02-21 20:24:101034remote.<name>.skipDefaultUpdate::
1035If true, this remote will be skipped by default when updating
Junio C Hamano35738e82008-01-07 07:55:461036using the update subcommand of linkgit:git-remote[1].
Junio C Hamano118d2772007-02-21 20:24:101037
Junio C Hamano4ad294b2007-01-20 02:22:501038remote.<name>.receivepack::
Junio C Hamano54ea8d32007-01-25 07:59:481039The default program to execute on the remote side when pushing. See
Junio C Hamano86bcccc2008-03-08 09:33:551040option \--receive-pack of linkgit:git-push[1].
Junio C Hamano4ad294b2007-01-20 02:22:501041
Junio C Hamano54ea8d32007-01-25 07:59:481042remote.<name>.uploadpack::
1043The default program to execute on the remote side when fetching. See
Junio C Hamano86bcccc2008-03-08 09:33:551044option \--upload-pack of linkgit:git-fetch-pack[1].
Junio C Hamano54ea8d32007-01-25 07:59:481045
Junio C Hamano17dde0e2007-02-26 09:50:211046remote.<name>.tagopt::
Junio C Hamano86bcccc2008-03-08 09:33:551047Setting this value to \--no-tags disables automatic tag following when
1048fetching from remote <name>
Junio C Hamano17dde0e2007-02-26 09:50:211049
Junio C Hamano118d2772007-02-21 20:24:101050remotes.<group>::
1051The list of remotes which are fetched by "git remote update
Junio C Hamano35738e82008-01-07 07:55:461052<group>". See linkgit:git-remote[1].
Junio C Hamano118d2772007-02-21 20:24:101053
Junio C Hamano77b7e902006-10-23 07:18:501054repack.usedeltabaseoffset::
Junio C Hamanofce7c7e2008-07-02 03:06:381055By default, linkgit:git-repack[1] creates packs that use
1056delta-base offset. If you need to share your repository with
1057git older than version 1.4.4, either directly or via a dumb
1058protocol such as http, then you need to set this option to
1059"false" and repack. Access from old git versions over the
1060native protocol are unaffected by this option.
Junio C Hamano77b7e902006-10-23 07:18:501061
Junio C Hamano07824ce2006-04-25 07:36:541062showbranch.default::
Junio C Hamano35738e82008-01-07 07:55:461063The default set of branches for linkgit:git-show-branch[1].
1064See linkgit:git-show-branch[1].
Junio C Hamano07824ce2006-04-25 07:36:541065
Junio C Hamano942b35e2007-12-09 10:19:331066status.relativePaths::
Junio C Hamano35738e82008-01-07 07:55:461067By default, linkgit:git-status[1] shows paths relative to the
Junio C Hamano942b35e2007-12-09 10:19:331068current directory. Setting this variable to `false` shows paths
1069relative to the repository root (this was the default for git
1070prior to v1.5.4).
1071
Junio C Hamano4224f992008-06-23 07:14:081072status.showUntrackedFiles::
1073By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1074files which are not currently tracked by Git. Directories which
1075contain only untracked files, are shown with the directory name
1076only. Showing untracked files means that Git needs to lstat() all
1077all the files in the whole repository, which might be slow on some
1078systems. So, this variable controls how the commands displays
1079the untracked files. Possible values are:
1080+
1081--
1082- 'no' - Show no untracked files
1083- 'normal' - Shows untracked files and directories
1084- 'all' - Shows also individual files in untracked directories.
1085--
1086+
1087If this variable is not specified, it defaults to 'normal'.
1088This variable can be overridden with the -u|--untracked-files option
1089of linkgit:git-status[1] and linkgit:git-commit[1].
1090
Junio C Hamano75cc4c92006-07-24 08:25:031091tar.umask::
Junio C Hamanobdebabb2007-08-23 00:25:091092This variable can be used to restrict the permission bits of
1093tar archive entries. The default is 0002, which turns off the
1094world write bit. The special value "user" indicates that the
1095archiving user's umask will be used instead. See umask(2) and
Junio C Hamano35738e82008-01-07 07:55:461096linkgit:git-archive[1].
Junio C Hamano75cc4c92006-07-24 08:25:031097
Junio C Hamano24bc09a2008-02-28 00:27:441098url.<base>.insteadOf::
1099Any URL that starts with this value will be rewritten to
1100start, instead, with <base>. In cases where some site serves a
1101large number of repositories, and serves them with multiple
1102access methods, and some users need to use different access
1103methods, this feature allows people to specify any of the
1104equivalent URLs and have git automatically rewrite the URL to
1105the best alternative for the particular user, even for a
1106never-before-seen repository on the site. When more than one
1107insteadOf strings match a given URL, the longest match is used.
1108
Junio C Hamano07824ce2006-04-25 07:36:541109user.email::
1110Your email address to be recorded in any newly created commits.
Junio C Hamano469d60e2007-04-29 18:30:341111Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
Junio C Hamano35738e82008-01-07 07:55:461112'EMAIL' environment variables. See linkgit:git-commit-tree[1].
Junio C Hamano07824ce2006-04-25 07:36:541113
1114user.name::
1115Your full name to be recorded in any newly created commits.
Junio C Hamano341071d2006-06-04 07:24:481116Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
Junio C Hamano35738e82008-01-07 07:55:461117environment variables. See linkgit:git-commit-tree[1].
Junio C Hamano07824ce2006-04-25 07:36:541118
Junio C Hamanoa890c4f2007-01-28 10:29:211119user.signingkey::
Junio C Hamano35738e82008-01-07 07:55:461120If linkgit:git-tag[1] is not selecting the key you want it to
Junio C Hamanoa890c4f2007-01-28 10:29:211121automatically when creating a signed tag, you can override the
1122default selection with this variable. This option is passed
1123unchanged to gpg's --local-user parameter, so you may specify a key
1124using any method that gpg supports.
1125
Junio C Hamano07824ce2006-04-25 07:36:541126imap::
1127The configuration variables in the 'imap' section are described
Junio C Hamano35738e82008-01-07 07:55:461128in linkgit:git-imap-send[1].
Junio C Hamano459ee222006-09-21 08:13:281129
Junio C Hamanob78d2592008-04-09 09:39:081130receive.fsckObjects::
1131If it is set to true, git-receive-pack will check all received
1132objects. It will abort in the case of a malformed object or a
1133broken link. The result of an abort are only dangling objects.
1134Defaults to false.
1135
Junio C Hamano0d3c8152006-11-08 01:33:411136receive.unpackLimit::
1137If the number of objects received in a push is below this
1138limit then the objects will be unpacked into loose object
1139files. However if the number of received objects equals or
1140exceeds this limit then the received pack will be stored as
1141a pack, after adding any missing delta bases. Storing the
1142pack from a push can make the push operation complete faster,
Junio C Hamanoe77b0152008-01-12 06:44:171143especially on slow filesystems. If not set, the value of
1144`transfer.unpackLimit` is used instead.
Junio C Hamano0d3c8152006-11-08 01:33:411145
1146receive.denyNonFastForwards::
Junio C Hamano459ee222006-09-21 08:13:281147If set to true, git-receive-pack will deny a ref update which is
1148not a fast forward. Use this to prevent such an update via a push,
1149even if that push is forced. This configuration variable is
1150set when initializing a shared repository.
1151
Junio C Hamano54ea8d32007-01-25 07:59:481152transfer.unpackLimit::
1153When `fetch.unpackLimit` or `receive.unpackLimit` are
1154not set, the value of this variable is used instead.
Junio C Hamanoe77b0152008-01-12 06:44:171155The default value is 100.
Junio C Hamano4e272312008-01-08 09:13:211156
1157web.browser::
1158Specify a web browser that may be used by some commands.
1159Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
1160may use it.