blob: 561ff645f96af3a53a6d43c4d9320090aef623e8 [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 Hamano7ad22dc2007-01-29 02:55:4866`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]
95external = "/usr/local/bin/gnu-diff -u"
96renames = 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 Hamanod526ba92007-07-02 00:17:42120core.quotepath::
121The commands that output paths (e.g. `ls-files`,
122`diff`), when not given the `-z` option, will quote
123"unusual" characters in the pathname by enclosing the
124pathname in a double-quote pair and with backslashes the
125same way strings in C source code are quoted. If this
126variable is set to false, the bytes higher than 0x80 are
127not quoted but output as verbatim. Note that double
128quote, backslash and control characters are always
129quoted without `-z` regardless of the setting of this
130variable.
131
Junio C Hamanod9e0e5d2007-04-14 16:22:04132core.autocrlf::
133If true, makes git convert `CRLF` at the end of lines in text files to
134`LF` when reading from the filesystem, and convert in reverse when
135writing to the filesystem. The variable can be set to
136'input', in which case the conversion happens only while
137reading from the filesystem but files are written out with
138`LF` at the end of lines. Currently, which paths to consider
139"text" (i.e. be subjected to the autocrlf mechanism) is
140decided purely based on the contents.
141
Junio C Hamano26e590a2008-02-17 03:53:51142core.safecrlf::
143If true, makes git check if converting `CRLF` as controlled by
144`core.autocrlf` is reversible. Git will verify if a command
145modifies a file in the work tree either directly or indirectly.
146For example, committing a file followed by checking out the
147same file should yield the original file in the work tree. If
148this is not the case for the current setting of
149`core.autocrlf`, git will reject the file. The variable can
150be set to "warn", in which case git will only warn about an
151irreversible conversion but continue the operation.
152+
153CRLF conversion bears a slight chance of corrupting data.
154autocrlf=true will convert CRLF to LF during commit and LF to
155CRLF during checkout. A file that contains a mixture of LF and
156CRLF before the commit cannot be recreated by git. For text
157files this is the right thing to do: it corrects line endings
158such that we have only LF line endings in the repository.
159But for binary files that are accidentally classified as text the
160conversion can corrupt data.
161+
162If you recognize such corruption early you can easily fix it by
163setting the conversion type explicitly in .gitattributes. Right
164after committing you still have the original file in your work
165tree and this file is not yet corrupted. You can explicitly tell
166git that this file is binary and git will handle the file
167appropriately.
168+
169Unfortunately, the desired effect of cleaning up text files with
170mixed line endings and the undesired effect of corrupting binary
171files cannot be distinguished. In both cases CRLFs are removed
172in an irreversible way. For text files this is the right thing
173to do because CRLFs are line endings, while for binary files
174converting CRLFs corrupts data.
175+
176Note, this safety check does not mean that a checkout will generate a
177file identical to the original file for a different setting of
178`core.autocrlf`, but only for the current one. For example, a text
179file with `LF` would be accepted with `core.autocrlf=input` and could
180later be checked out with `core.autocrlf=true`, in which case the
181resulting file would contain `CRLF`, although the original file
182contained `LF`. However, in both work trees the line endings would be
183consistent, that is either all `LF` or all `CRLF`, but never mixed. A
184file with mixed line endings would be reported by the `core.safecrlf`
185mechanism.
186
Junio C Hamanoaa83a7d2007-03-05 02:37:29187core.symlinks::
188If false, symbolic links are checked out as small plain files that
Junio C Hamano35738e82008-01-07 07:55:46189contain the link text. linkgit:git-update-index[1] and
190linkgit:git-add[1] will not change the recorded type to regular
Junio C Hamanoaa83a7d2007-03-05 02:37:29191file. Useful on filesystems like FAT that do not support
192symbolic links. True by default.
193
Junio C Hamano07824ce2006-04-25 07:36:54194core.gitProxy::
195A "proxy command" to execute (as 'command host port') instead
196of establishing direct connection to the remote server when
197using the git protocol for fetching. If the variable value is
198in the "COMMAND for DOMAIN" format, the command is applied only
199on hostnames ending with the specified domain string. This variable
200may be set multiple times and is matched in the given order;
201the first match wins.
Junio C Hamanof1d14802006-06-08 00:48:17202+
203Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
204(which always applies universally, without the special "for"
205handling).
Junio C Hamano07824ce2006-04-25 07:36:54206
207core.ignoreStat::
Junio C Hamano054ea082008-06-01 08:26:34208If true, commands which modify both the working tree and the index
209will mark the updated paths with the "assume unchanged" bit in the
210index. These marked files are then assumed to stay unchanged in the
211working copy, until you mark them otherwise manually - Git will not
212detect the file changes by lstat() calls. This is useful on systems
213where those are very slow, such as Microsoft Windows.
214See linkgit:git-update-index[1].
Junio C Hamano07824ce2006-04-25 07:36:54215False by default.
216
Junio C Hamano88a3a072006-05-04 08:01:43217core.preferSymlinkRefs::
218Instead of the default "symref" format for HEAD
219and other symbolic reference files, use symbolic links.
220This is sometimes needed to work with old scripts that
221expect HEAD to be a symbolic link.
Junio C Hamano07824ce2006-04-25 07:36:54222
Junio C Hamano1025e752007-02-23 07:21:26223core.bare::
224If true this repository is assumed to be 'bare' and has no
225working directory associated with it. If this is the case a
226number of commands that require a working directory will be
Junio C Hamano35738e82008-01-07 07:55:46227disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
Junio C Hamano1025e752007-02-23 07:21:26228+
Junio C Hamano35738e82008-01-07 07:55:46229This setting is automatically guessed by linkgit:git-clone[1] or
230linkgit:git-init[1] when the repository was created. By default a
Junio C Hamano1025e752007-02-23 07:21:26231repository that ends in "/.git" is assumed to be not bare (bare =
232false), while all other repositories are assumed to be bare (bare
233= true).
234
Junio C Hamanod526ba92007-07-02 00:17:42235core.worktree::
236Set the path to the working tree. The value will not be
237used in combination with repositories found automatically in
238a .git directory (i.e. $GIT_DIR is not set).
Junio C Hamano764a6672007-10-23 01:23:31239This can be overridden by the GIT_WORK_TREE environment
Junio C Hamano7d575a52008-04-30 08:45:27240variable and the '--work-tree' command line option. It can be
241a absolute path or relative path to the directory specified by
242--git-dir or GIT_DIR.
243Note: If --git-dir or GIT_DIR are specified but none of
244--work-tree, GIT_WORK_TREE and core.worktree is specified,
245the current working directory is regarded as the top directory
246of your working tree.
Junio C Hamanod526ba92007-07-02 00:17:42247
Junio C Hamano341071d2006-06-04 07:24:48248core.logAllRefUpdates::
Junio C Hamanocae86272007-08-21 02:20:49249Enable the reflog. Updates to a ref <ref> is logged to the file
Junio C Hamanoa2ec14f2006-11-02 00:22:48250"$GIT_DIR/logs/<ref>", by appending the new and old
251SHA1, the date/time and the reason of the update, but
252only when the file exists. If this configuration
253variable is set to true, missing "$GIT_DIR/logs/<ref>"
254file is automatically created for branch heads.
Junio C Hamano1caaf472006-12-31 08:29:35255+
256This information can be used to determine what commit
257was the tip of a branch "2 days ago".
258+
259This value is true by default in a repository that has
260a working directory associated with it, and false by
261default in a bare repository.
Junio C Hamano341071d2006-06-04 07:24:48262
Junio C Hamano07824ce2006-04-25 07:36:54263core.repositoryFormatVersion::
264Internal variable identifying the repository format and layout
265version.
266
267core.sharedRepository::
Junio C Hamano0ab78ae2006-08-09 01:00:42268When 'group' (or 'true'), the repository is made shareable between
269several users in a group (making sure all the files and objects are
270group-writable). When 'all' (or 'world' or 'everybody'), the
271repository will be readable by all users, additionally to being
272group-shareable. When 'umask' (or 'false'), git will use permissions
Junio C Hamano2f102bb2008-04-26 02:23:37273reported by umask(2). When '0xxx', where '0xxx' is an octal number,
274files in the repository will have this mode value. '0xxx' will override
275user's umask value, and thus, users with a safe umask (0077) can use
276this option. Examples: '0660' is equivalent to 'group'. '0640' is a
277repository that is group-readable but not group-writable.
278See linkgit:git-init[1]. False by default.
Junio C Hamano07824ce2006-04-25 07:36:54279
280core.warnAmbiguousRefs::
281If true, git will warn you if the ref name you passed it is ambiguous
282and might match multiple refs in the .git/refs/ tree. True by default.
283
Junio C Hamano7ec15722006-07-07 02:03:59284core.compression::
Junio C Hamanof2ce2972007-05-20 19:12:09285An integer -1..9, indicating a default compression level.
286-1 is the zlib default. 0 means no compression,
287and 1..9 are various speed/size tradeoffs, 9 being slowest.
Junio C Hamano2e72a942007-11-21 08:54:42288If set, this provides a default to other compression variables,
289such as 'core.loosecompression' and 'pack.compression'.
Junio C Hamanoa126a3b2006-07-04 04:55:26290
Junio C Hamanof2ce2972007-05-20 19:12:09291core.loosecompression::
292An integer -1..9, indicating the compression level for objects that
293are not in a pack file. -1 is the zlib default. 0 means no
294compression, and 1..9 are various speed/size tradeoffs, 9 being
295slowest. If not set, defaults to core.compression. If that is
Junio C Hamano2e72a942007-11-21 08:54:42296not set, defaults to 1 (best speed).
Junio C Hamano28d9dfe2006-07-25 03:50:49297
Junio C Hamanofc4d38c2007-01-08 06:53:32298core.packedGitWindowSize::
299Number of bytes of a pack file to map into memory in a
300single mapping operation. Larger window sizes may allow
301your system to process a smaller number of large pack files
302more quickly. Smaller window sizes will negatively affect
303performance due to increased calls to the operating system's
304memory manager, but may improve performance when accessing
305a large number of large pack files.
306+
307Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
308MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
309be reasonable for all users/operating systems. You probably do
310not need to adjust this value.
311+
312Common unit suffixes of 'k', 'm', or 'g' are supported.
313
314core.packedGitLimit::
315Maximum number of bytes to map simultaneously into memory
316from pack files. If Git needs to access more than this many
317bytes at once to complete an operation it will unmap existing
318regions to reclaim virtual address space within the process.
319+
320Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
321This should be reasonable for all users/operating systems, except on
322the largest projects. You probably do not need to adjust this value.
323+
324Common unit suffixes of 'k', 'm', or 'g' are supported.
325
Junio C Hamanob8c51282007-03-19 10:43:30326core.deltaBaseCacheLimit::
327Maximum number of bytes to reserve for caching base objects
328that multiple deltafied objects reference. By storing the
329entire decompressed base objects in a cache Git is able
330to avoid unpacking and decompressing frequently used base
331objects multiple times.
332+
333Default is 16 MiB on all platforms. This should be reasonable
334for all users/operating systems, except on the largest projects.
335You probably do not need to adjust this value.
336+
337Common unit suffixes of 'k', 'm', or 'g' are supported.
338
Junio C Hamano1d90cb02007-07-03 07:05:31339core.excludesfile::
Junio C Hamano5e284b42007-05-22 07:23:37340In addition to '.gitignore' (per-directory) and
341'.git/info/exclude', git looks into this file for patterns
Junio C Hamano679d22d2007-06-02 21:13:44342of files which are not meant to be tracked. See
Junio C Hamano35738e82008-01-07 07:55:46343linkgit:gitignore[5].
Junio C Hamano5e284b42007-05-22 07:23:37344
Junio C Hamanof6002a92007-07-20 10:28:22345core.editor::
346Commands such as `commit` and `tag` that lets you edit
Junio C Hamanoa6387422007-08-25 03:54:27347messages by launching an editor uses the value of this
Junio C Hamanof6002a92007-07-20 10:28:22348variable when it is set, and the environment variable
349`GIT_EDITOR` is not set. The order of preference is
Junio C Hamanode9879a2007-07-22 09:33:42350`GIT_EDITOR` environment, `core.editor`, `VISUAL` and
351`EDITOR` environment variables and then finally `vi`.
Junio C Hamanof6002a92007-07-20 10:28:22352
Junio C Hamano28d8ede2007-07-05 05:51:38353core.pager::
354The command that git will use to paginate output. Can be overridden
355with the `GIT_PAGER` environment variable.
356
Junio C Hamano942b35e2007-12-09 10:19:33357core.whitespace::
358A comma separated list of common whitespace problems to
359notice. `git diff` will use `color.diff.whitespace` to
360highlight them, and `git apply --whitespace=error` will
361consider them as errors:
362+
363* `trailing-space` treats trailing whitespaces at the end of the line
364 as an error (enabled by default).
365* `space-before-tab` treats a space character that appears immediately
366 before a tab character in the initial indent part of the line as an
367 error (enabled by default).
368* `indent-with-non-tab` treats a line that is indented with 8 or more
Junio C Hamano42a2e2d2007-12-16 22:13:42369 space characters as an error (not enabled by default).
Junio C Hamano601f3e52008-02-25 08:40:42370* `cr-at-eol` treats a carriage-return at the end of line as
371 part of the line terminator, i.e. with it, `trailing-space`
372 does not trigger if the character before such a carriage-return
373 is not a whitespace (not enabled by default).
Junio C Hamano942b35e2007-12-09 10:19:33374
Junio C Hamano9eb57532008-06-26 06:33:46375core.fsyncobjectfiles::
376This boolean will enable 'fsync()' when writing object files.
377+
378This is a total waste of time and effort on a filesystem that orders
379data writes properly, but can be useful for filesystems that do not use
380journalling (traditional UNIX filesystems) or that only journal metadata
381and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
382
Junio C Hamano33db4372006-06-07 19:51:45383alias.*::
Junio C Hamano35738e82008-01-07 07:55:46384Command aliases for the linkgit:git[1] command wrapper - e.g.
Junio C Hamano33db4372006-06-07 19:51:45385after defining "alias.last = cat-file commit HEAD", the invocation
386"git last" is equivalent to "git cat-file commit HEAD". To avoid
Junio C Hamanof1d14802006-06-08 00:48:17387confusion and troubles with script usage, aliases that
388hide existing git commands are ignored. Arguments are split by
389spaces, the usual shell quoting and escaping is supported.
390quote pair and a backslash can be used to quote them.
Junio C Hamanodbb64592007-09-01 11:17:39391+
392If the alias expansion is prefixed with an exclamation point,
393it will be treated as a shell command. For example, defining
394"alias.new = !gitk --all --not ORIG_HEAD", the invocation
395"git new" is equivalent to running the shell command
396"gitk --all --not ORIG_HEAD".
Junio C Hamano9cb74f22007-02-12 04:15:05397
Junio C Hamano07824ce2006-04-25 07:36:54398apply.whitespace::
399Tells `git-apply` how to handle whitespaces, in the same way
Junio C Hamano35738e82008-01-07 07:55:46400as the '--whitespace' option. See linkgit:git-apply[1].
Junio C Hamano07824ce2006-04-25 07:36:54401
Junio C Hamano7fd84172007-05-24 07:00:32402branch.autosetupmerge::
403Tells `git-branch` and `git-checkout` to setup new branches
Junio C Hamano24bc09a2008-02-28 00:27:44404so that linkgit:git-pull[1] will appropriately merge from the
405starting point branch. Note that even if this option is not set,
Junio C Hamano7fd84172007-05-24 07:00:32406this behavior can be chosen per-branch using the `--track`
Junio C Hamano24bc09a2008-02-28 00:27:44407and `--no-track` options. The valid settings are: `false` -- no
408automatic setup is done; `true` -- automatic setup is done when the
409starting point is a remote branch; `always` -- automatic setup is
410done when the starting point is either a local branch or remote
411branch. This option defaults to true.
Junio C Hamano7fd84172007-05-24 07:00:32412
Junio C Hamano869bb802008-05-12 00:29:47413branch.autosetuprebase::
414When a new branch is created with `git-branch` or `git-checkout`
415that tracks another branch, this variable tells git to set
416up pull to rebase instead of merge (see "branch.<name>.rebase").
417When `never`, rebase is never automatically set to true.
418When `local`, rebase is set to true for tracked branches of
419other local branches.
420When `remote`, rebase is set to true for tracked branches of
421remote branches.
422When `always`, rebase will be set to true for all tracking
423branches.
424See "branch.autosetupmerge" for details on how to set up a
425branch to track another branch.
426This option defaults to never.
427
Junio C Hamano47c1e3c2006-09-25 04:45:55428branch.<name>.remote::
429When in branch <name>, it tells `git fetch` which remote to fetch.
Junio C Hamano96010b22006-12-09 21:15:46430If this option is not given, `git fetch` defaults to remote "origin".
Junio C Hamano47c1e3c2006-09-25 04:45:55431
432branch.<name>.merge::
Junio C Hamanoc2b47092007-10-25 06:50:31433When in branch <name>, it tells `git fetch` the default
434refspec to be marked for merging in FETCH_HEAD. The value is
435handled like the remote part of a refspec, and must match a
436ref which is fetched from the remote given by
437"branch.<name>.remote".
Junio C Hamano96010b22006-12-09 21:15:46438The merge information is used by `git pull` (which at first calls
439`git fetch`) to lookup the default branch for merging. Without
440this option, `git pull` defaults to merge the first refspec fetched.
441Specify multiple values to get an octopus merge.
Junio C Hamano6e149c02007-03-16 10:21:07442If you wish to setup `git pull` so that it merges into <name> from
443another branch in the local repository, you can point
444branch.<name>.merge to the desired branch, and use the special setting
445`.` (a period) for branch.<name>.remote.
Junio C Hamano47c1e3c2006-09-25 04:45:55446
Junio C Hamano1b50ce92007-10-03 12:05:53447branch.<name>.mergeoptions::
448Sets default options for merging into branch <name>. The syntax and
Junio C Hamano35738e82008-01-07 07:55:46449supported options are equal to that of linkgit:git-merge[1], but
Junio C Hamano1b50ce92007-10-03 12:05:53450option values containing whitespace characters are currently not
451supported.
452
Junio C Hamano0c999702007-12-03 09:57:55453branch.<name>.rebase::
454When true, rebase the branch <name> on top of the fetched branch,
Junio C Hamano6d76d612008-05-09 05:46:08455instead of merging the default branch from the default remote when
456"git pull" is run.
Junio C Hamano0c999702007-12-03 09:57:55457*NOTE*: this is a possibly dangerous operation; do *not* use
Junio C Hamano35738e82008-01-07 07:55:46458it unless you understand the implications (see linkgit:git-rebase[1]
Junio C Hamano0c999702007-12-03 09:57:55459for details).
460
Junio C Hamano8760ea62008-03-14 08:58:45461browser.<tool>.cmd::
462Specify the command to invoke the specified browser. The
463specified command is evaluated in shell with the URLs passed
464as arguments. (See linkgit:git-web--browse[1].)
465
Junio C Hamanoe35a6fc2008-01-29 09:46:27466browser.<tool>.path::
467Override the path for the given tool that may be used to
468browse HTML help (see '-w' option in linkgit:git-help[1]) or a
469working repository in gitweb (see linkgit:git-instaweb[1]).
470
Junio C Hamano47b9acd2007-04-24 07:34:34471clean.requireForce::
Junio C Hamano422cfec2007-11-08 08:07:45472A boolean to make git-clean do nothing unless given -f
473or -n. Defaults to true.
Junio C Hamano47b9acd2007-04-24 07:34:34474
Junio C Hamanoeb692952007-01-03 22:02:12475color.branch::
476A boolean to enable/disable color in the output of
Junio C Hamano35738e82008-01-07 07:55:46477linkgit:git-branch[1]. May be set to `always`,
Junio C Hamano0fc8cd92007-12-06 03:26:21478`false` (or `never`) or `auto` (or `true`), in which case colors are used
Junio C Hamanoeb692952007-01-03 22:02:12479only when the output is to a terminal. Defaults to false.
480
481color.branch.<slot>::
482Use customized color for branch coloration. `<slot>` is one of
483`current` (the current branch), `local` (a local branch),
484`remote` (a tracking branch in refs/remotes/), `plain` (other
Junio C Hamano5a702332007-01-28 20:55:22485refs).
486+
487The value for these configuration variables is a list of colors (at most
488two) and attributes (at most one), separated by spaces. The colors
489accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
490`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
491`blink` and `reverse`. The first color given is the foreground; the
492second is the background. The position of the attribute, if any,
493doesn't matter.
Junio C Hamanoeb692952007-01-03 22:02:12494
Junio C Hamano3f403b02006-12-13 10:14:13495color.diff::
Junio C Hamano0fc8cd92007-12-06 03:26:21496When set to `always`, always use colors in patch.
497When false (or `never`), never. When set to `true` or `auto`, use
498colors only when the output is to the terminal. Defaults to false.
Junio C Hamano9ae1a062006-07-10 08:12:34499
Junio C Hamano3f403b02006-12-13 10:14:13500color.diff.<slot>::
Junio C Hamano5a702332007-01-28 20:55:22501Use customized color for diff colorization. `<slot>` specifies
502which part of the patch to use the specified color, and is one
503of `plain` (context text), `meta` (metainformation), `frag`
504(hunk header), `old` (removed lines), `new` (added lines),
Junio C Hamano942b35e2007-12-09 10:19:33505`commit` (commit headers), or `whitespace` (highlighting
506whitespace errors). The values of these variables may be specified as
Junio C Hamano5a702332007-01-28 20:55:22507in color.branch.<slot>.
Junio C Hamano9ae1a062006-07-10 08:12:34508
Junio C Hamano00b8b632007-12-07 09:50:49509color.interactive::
Junio C Hamano35738e82008-01-07 07:55:46510When set to `always`, always use colors for interactive prompts
511and displays (such as those used by "git add --interactive").
Junio C Hamano00b8b632007-12-07 09:50:49512When false (or `never`), never. When set to `true` or `auto`, use
513colors only when the output is to the terminal. Defaults to false.
514
515color.interactive.<slot>::
516Use customized color for `git add --interactive`
517output. `<slot>` may be `prompt`, `header`, or `help`, for
518three distinct types of normal output from interactive
519programs. The values of these variables may be specified as
520in color.branch.<slot>.
521
Junio C Hamanoe7935c42006-12-13 21:32:17522color.pager::
523A boolean to enable/disable colored output when the pager is in
524use (default is true).
525
526color.status::
527A boolean to enable/disable color in the output of
Junio C Hamano35738e82008-01-07 07:55:46528linkgit:git-status[1]. May be set to `always`,
Junio C Hamano0fc8cd92007-12-06 03:26:21529`false` (or `never`) or `auto` (or `true`), in which case colors are used
Junio C Hamanoe7935c42006-12-13 21:32:17530only when the output is to a terminal. Defaults to false.
531
532color.status.<slot>::
533Use customized color for status colorization. `<slot>` is
534one of `header` (the header text of the status message),
Junio C Hamano7d23f5e2006-12-16 07:44:04535`added` or `updated` (files which are added but not committed),
536`changed` (files which are changed but not added in the index),
Junio C Hamanob713ff12008-05-24 01:12:30537`untracked` (files which are not tracked by git), or
538`nobranch` (the color the 'no branch' warning is shown in, defaulting
539to red). The values of these variables may be specified as in
540color.branch.<slot>.
Junio C Hamanoe7935c42006-12-13 21:32:17541
Junio C Hamanob968dbb2007-07-27 07:26:40542commit.template::
543Specify a file to use as the template for new commit messages.
544
Junio C Hamano83d46a22008-02-21 02:29:42545color.ui::
546When set to `always`, always use colors in all git commands which
547are capable of colored output. When false (or `never`), never. When
548set to `true` or `auto`, use colors only when the output is to the
549terminal. When more specific variables of color.* are set, they always
550take precedence over this setting. Defaults to false.
551
Junio C Hamanodbb64592007-09-01 11:17:39552diff.autorefreshindex::
553When using `git diff` to compare with work tree
554files, do not consider stat-only change as changed.
555Instead, silently run `git update-index --refresh` to
556update the cached stat information for paths whose
557contents in the work tree match the contents in the
558index. This option defaults to true. Note that this
559affects only `git diff` Porcelain, and not lower level
560`diff` commands, such as `git diff-files`.
561
Junio C Hamano1fbbbc12007-12-18 07:01:27562diff.external::
563If this config variable is set, diff generation is not
564performed using the internal diff machinery, but using the
565given command. Note: if you want to use an external diff
566program only on a subset of your files, you might want to
Junio C Hamano35738e82008-01-07 07:55:46567use linkgit:gitattributes[5] instead.
Junio C Hamano1fbbbc12007-12-18 07:01:27568
Junio C Hamano07824ce2006-04-25 07:36:54569diff.renameLimit::
570The number of files to consider when performing the copy/rename
571detection; equivalent to the git diff option '-l'.
572
Junio C Hamano9ae1a062006-07-10 08:12:34573diff.renames::
574Tells git to detect renames. If set to any boolean value, it
575will enable basic rename detection. If set to "copies" or
576"copy", it will detect copies, as well.
577
Junio C Hamano54ea8d32007-01-25 07:59:48578fetch.unpackLimit::
579If the number of objects fetched over the git native
580transfer is below this
581limit, then the objects will be unpacked into loose object
582files. However if the number of received objects equals or
583exceeds this limit then the received pack will be stored as
584a pack, after adding any missing delta bases. Storing the
585pack from a push can make the push operation complete faster,
Junio C Hamanoe77b0152008-01-12 06:44:17586especially on slow filesystems. If not set, the value of
587`transfer.unpackLimit` is used instead.
Junio C Hamano54ea8d32007-01-25 07:59:48588
Junio C Hamano8c5802d2007-11-15 00:13:36589format.numbered::
590A boolean which can enable sequence numbers in patch subjects.
Junio C Hamanofe986052007-12-19 07:33:38591Setting this option to "auto" will enable it only if there is
Junio C Hamano8c5802d2007-11-15 00:13:36592more than one patch. See --numbered option in
Junio C Hamano35738e82008-01-07 07:55:46593linkgit:git-format-patch[1].
Junio C Hamano8c5802d2007-11-15 00:13:36594
Junio C Hamano07824ce2006-04-25 07:36:54595format.headers::
596Additional email headers to include in a patch to be submitted
Junio C Hamano35738e82008-01-07 07:55:46597by mail. See linkgit:git-format-patch[1].
Junio C Hamano07824ce2006-04-25 07:36:54598
Junio C Hamanod4c8e112007-03-04 10:32:38599format.suffix::
600The default for format-patch is to output files with the suffix
601`.patch`. Use this variable to change that suffix (make sure to
602include the dot if you want it).
603
Junio C Hamano86bcccc2008-03-08 09:33:55604format.pretty::
605The default pretty format for log/show/whatchanged command,
606See linkgit:git-log[1], linkgit:git-show[1],
607linkgit:git-whatchanged[1].
608
Junio C Hamanof2ce2972007-05-20 19:12:09609gc.aggressiveWindow::
610The window size parameter used in the delta compression
611algorithm used by 'git gc --aggressive'. This defaults
612to 10.
613
Junio C Hamano1b50ce92007-10-03 12:05:53614gc.auto::
615When there are approximately more than this many loose
616objects in the repository, `git gc --auto` will pack them.
617Some Porcelain commands use this command to perform a
Junio C Hamanoe77b0152008-01-12 06:44:17618light-weight garbage collection from time to time. The
619default value is 6700. Setting this to 0 disables it.
Junio C Hamano1b50ce92007-10-03 12:05:53620
621gc.autopacklimit::
622When there are more than this many packs that are not
623marked with `*.keep` file in the repository, `git gc
Junio C Hamanoe77b0152008-01-12 06:44:17624--auto` consolidates them into one larger pack. The
Junio C Hamano25c0b702008-03-23 09:41:37625default value is 50. Setting this to 0 disables it.
Junio C Hamano1b50ce92007-10-03 12:05:53626
Junio C Hamano9d52e572007-02-13 23:48:20627gc.packrefs::
628`git gc` does not run `git pack-refs` in a bare repository by
629default so that older dumb-transport clients can still fetch
630from the repository. Setting this to `true` lets `git
631gc` to run `git pack-refs`. Setting this to `false` tells
632`git gc` never to run `git pack-refs`. The default setting is
633`notbare`. Enable it only when you know you do not have to
634support such clients. The default setting will change to `true`
635at some stage, and setting this to `false` will continue to
636prevent `git pack-refs` from being run from `git gc`.
637
Junio C Hamano09a926d2008-03-13 07:55:29638gc.pruneexpire::
639When `git gc` is run, it will call `prune --expire 2.weeks.ago`.
640Override the grace period with this config variable.
641
Junio C Hamano74640642006-12-27 10:59:55642gc.reflogexpire::
643`git reflog expire` removes reflog entries older than
644this time; defaults to 90 days.
645
646gc.reflogexpireunreachable::
647`git reflog expire` removes reflog entries older than
648this time and are not reachable from the current tip;
649defaults to 30 days.
650
651gc.rerereresolved::
652Records of conflicted merge you resolved earlier are
653kept for this many days when `git rerere gc` is run.
Junio C Hamano35738e82008-01-07 07:55:46654The default is 60 days. See linkgit:git-rerere[1].
Junio C Hamano74640642006-12-27 10:59:55655
656gc.rerereunresolved::
657Records of conflicted merge you have not resolved are
658kept for this many days when `git rerere gc` is run.
Junio C Hamano35738e82008-01-07 07:55:46659The default is 15 days. See linkgit:git-rerere[1].
Junio C Hamano74640642006-12-27 10:59:55660
Junio C Hamano7a4a2832007-07-07 21:53:22661rerere.enabled::
662Activate recording of resolved conflicts, so that identical
663conflict hunks can be resolved automatically, should they
Junio C Hamano35738e82008-01-07 07:55:46664be encountered again. linkgit:git-rerere[1] command is by
Junio C Hamano0e47b232008-01-15 08:31:10665default enabled if you create `rr-cache` directory under
666`$GIT_DIR`, but can be disabled by setting this option to false.
Junio C Hamano7a4a2832007-07-07 21:53:22667
Junio C Hamano07824ce2006-04-25 07:36:54668gitcvs.enabled::
Junio C Hamanoa6387422007-08-25 03:54:27669Whether the CVS server interface is enabled for this repository.
Junio C Hamano35738e82008-01-07 07:55:46670See linkgit:git-cvsserver[1].
Junio C Hamano07824ce2006-04-25 07:36:54671
672gitcvs.logfile::
Junio C Hamanoa6387422007-08-25 03:54:27673Path to a log file where the CVS server interface well... logs
Junio C Hamano35738e82008-01-07 07:55:46674various stuff. See linkgit:git-cvsserver[1].
Junio C Hamano07824ce2006-04-25 07:36:54675
Junio C Hamanodfccbb02008-05-26 01:16:14676gitcvs.usecrlfattr
677If true, the server will look up the `crlf` attribute for
678files to determine the '-k' modes to use. If `crlf` is set,
679the '-k' mode will be left blank, so cvs clients will
680treat it as text. If `crlf` is explicitly unset, the file
681will be set with '-kb' mode, which supresses any newline munging
682the client might otherwise do. If `crlf` is not specified,
683then 'gitcvs.allbinary' is used. See linkgit:gitattribute[5].
684
Junio C Hamanod9e0e5d2007-04-14 16:22:04685gitcvs.allbinary::
Junio C Hamanodfccbb02008-05-26 01:16:14686This is used if 'gitcvs.usecrlfattr' does not resolve
687the correct '-kb' mode to use. If true, all
688unresolved files are sent to the client in
689mode '-kb'. This causes the client to treat them
690as binary files, which suppresses any newline munging it
691otherwise might do. Alternatively, if it is set to "guess",
692then the contents of the file are examined to decide if
693it is binary, similar to 'core.autocrlf'.
Junio C Hamanoa2ad99e2007-04-18 09:57:04694
695gitcvs.dbname::
696Database used by git-cvsserver to cache revision information
697derived from the git repository. The exact meaning depends on the
698used database driver, for SQLite (which is the default driver) this
699is a filename. Supports variable substitution (see
Junio C Hamano35738e82008-01-07 07:55:46700linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
Junio C Hamanoa2ad99e2007-04-18 09:57:04701Default: '%Ggitcvs.%m.sqlite'
702
703gitcvs.dbdriver::
704Used Perl DBI driver. You can specify any available driver
705 for this here, but it might not work. git-cvsserver is tested
706with 'DBD::SQLite', reported to work with 'DBD::Pg', and
707reported *not* to work with 'DBD::mysql'. Experimental feature.
708May not contain double colons (`:`). Default: 'SQLite'.
Junio C Hamano35738e82008-01-07 07:55:46709See linkgit:git-cvsserver[1].
Junio C Hamanod9e0e5d2007-04-14 16:22:04710
Junio C Hamanoa2ad99e2007-04-18 09:57:04711gitcvs.dbuser, gitcvs.dbpass::
712Database user and password. Only useful if setting 'gitcvs.dbdriver',
713since SQLite has no concept of database users and/or passwords.
714'gitcvs.dbuser' supports variable substitution (see
Junio C Hamano35738e82008-01-07 07:55:46715linkgit:git-cvsserver[1] for details).
Junio C Hamanoa2ad99e2007-04-18 09:57:04716
Junio C Hamanoa74efce2008-04-02 08:39:08717gitcvs.dbTableNamePrefix::
718Database table name prefix. Prepended to the names of any
719database tables used, allowing a single database to be used
720for several repositories. Supports variable substitution (see
721linkgit:git-cvsserver[1] for details). Any non-alphabetic
722characters will be replaced with underscores.
723
Junio C Hamanodfccbb02008-05-26 01:16:14724All gitcvs variables except for 'gitcvs.usecrlfattr' and
725'gitcvs.allbinary' can also be specified as
726'gitcvs.<access_method>.<varname>' (where 'access_method'
Junio C Hamanoa6387422007-08-25 03:54:27727is one of "ext" and "pserver") to make them apply only for the given
728access method.
Junio C Hamanoa2ad99e2007-04-18 09:57:04729
Junio C Hamano6d76d612008-05-09 05:46:08730gui.commitmsgwidth::
731Defines how wide the commit message window is in the
732linkgit:git-gui[1]. "75" is the default.
733
734gui.diffcontext::
735Specifies how many context lines should be used in calls to diff
736made by the linkgit:git-gui[1]. The default is "5".
737
738gui.matchtrackingbranch::
739Determines if new branches created with linkgit:git-gui[1] should
740default to tracking remote branches with matching names or
741not. Default: "false".
742
743gui.newbranchtemplate::
744Is used as suggested name when creating new branches using the
745linkgit:git-gui[1].
746
747gui.pruneduringfetch::
748"true" if linkgit:git-gui[1] should prune tracking branches when
749performing a fetch. The default value is "false".
750
751gui.trustmtime::
752Determines if linkgit:git-gui[1] should trust the file modification
753timestamp or not. By default the timestamps are not trusted.
754
755gui.spellingdictionary::
756Specifies the dictionary used for spell checking commit messages in
757the linkgit:git-gui[1]. When set to "none" spell checking is turned
758off.
759
Junio C Hamano4e272312008-01-08 09:13:21760help.browser::
761Specify the browser that will be used to display help in the
762'web' format. See linkgit:git-help[1].
763
764help.format::
765Override the default help format used by linkgit:git-help[1].
766Values 'man', 'info', 'web' and 'html' are supported. 'man' is
767the default. 'web' and 'html' are the same.
768
Junio C Hamano58256872007-12-04 08:31:13769http.proxy::
770Override the HTTP proxy, normally configured using the 'http_proxy'
Junio C Hamano35738e82008-01-07 07:55:46771environment variable (see linkgit:curl[1]). This can be overridden
Junio C Hamano58256872007-12-04 08:31:13772on a per-remote basis; see remote.<name>.proxy
773
Junio C Hamano07824ce2006-04-25 07:36:54774http.sslVerify::
775Whether to verify the SSL certificate when fetching or pushing
Junio C Hamano33db4372006-06-07 19:51:45776over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
Junio C Hamano07824ce2006-04-25 07:36:54777variable.
778
779http.sslCert::
780File containing the SSL certificate when fetching or pushing
Junio C Hamano33db4372006-06-07 19:51:45781over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
Junio C Hamano07824ce2006-04-25 07:36:54782variable.
783
784http.sslKey::
785File containing the SSL private key when fetching or pushing
Junio C Hamano341071d2006-06-04 07:24:48786over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
Junio C Hamano07824ce2006-04-25 07:36:54787variable.
788
789http.sslCAInfo::
790File containing the certificates to verify the peer with when
Junio C Hamano341071d2006-06-04 07:24:48791fetching or pushing over HTTPS. Can be overridden by the
Junio C Hamano07824ce2006-04-25 07:36:54792'GIT_SSL_CAINFO' environment variable.
793
794http.sslCAPath::
795Path containing files with the CA certificates to verify the peer
Junio C Hamano33db4372006-06-07 19:51:45796with when fetching or pushing over HTTPS. Can be overridden
Junio C Hamano07824ce2006-04-25 07:36:54797by the 'GIT_SSL_CAPATH' environment variable.
798
799http.maxRequests::
Junio C Hamano341071d2006-06-04 07:24:48800How many HTTP requests to launch in parallel. Can be overridden
Junio C Hamano07824ce2006-04-25 07:36:54801by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
802
803http.lowSpeedLimit, http.lowSpeedTime::
804If the HTTP transfer speed is less than 'http.lowSpeedLimit'
805for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
Junio C Hamano341071d2006-06-04 07:24:48806Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
Junio C Hamano07824ce2006-04-25 07:36:54807'GIT_HTTP_LOW_SPEED_TIME' environment variables.
808
Junio C Hamanof1dcdfe2006-09-29 08:10:51809http.noEPSV::
810A boolean which disables using of EPSV ftp command by curl.
Junio C Hamanod9e0e5d2007-04-14 16:22:04811This can helpful with some "poor" ftp servers which don't
Junio C Hamanof1dcdfe2006-09-29 08:10:51812support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
813environment variable. Default is false (curl will use EPSV).
814
Junio C Hamano07824ce2006-04-25 07:36:54815i18n.commitEncoding::
816Character encoding the commit messages are stored in; git itself
817does not care per se, but this information is necessary e.g. when
818importing commits from emails or in the gitk graphical history
819browser (and possibly at other places in the future or in other
Junio C Hamano35738e82008-01-07 07:55:46820porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
Junio C Hamano07824ce2006-04-25 07:36:54821
Junio C Hamano51f92e22006-12-29 05:18:28822i18n.logOutputEncoding::
823Character encoding the commit messages are converted to when
824running `git-log` and friends.
825
Junio C Hamano4e272312008-01-08 09:13:21826instaweb.browser::
827Specify the program that will be used to browse your working
828repository in gitweb. See linkgit:git-instaweb[1].
829
830instaweb.httpd::
831The HTTP daemon command-line to start gitweb on your working
832repository. See linkgit:git-instaweb[1].
833
834instaweb.local::
835If true the web server started by linkgit:git-instaweb[1] will
836be bound to the local IP (127.0.0.1).
837
838instaweb.modulepath::
839The module path for an apache httpd used by linkgit:git-instaweb[1].
840
841instaweb.port::
842The port number to bind the gitweb httpd to. See
843linkgit:git-instaweb[1].
844
Junio C Hamanob713ff12008-05-24 01:12:30845log.date::
846Set default date-time mode for the log command. Setting log.date
847value is similar to using git log's --date option. The value is one of
848following alternatives: {relative,local,default,iso,rfc,short}.
849See linkgit:git-log[1].
850
Junio C Hamanofe9acab2006-11-24 12:10:55851log.showroot::
852If true, the initial commit will be shown as a big creation event.
853This is equivalent to a diff against an empty tree.
Junio C Hamano35738e82008-01-07 07:55:46854Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
Junio C Hamanofe9acab2006-11-24 12:10:55855normally hide the root commit will now show it. True by default.
856
Junio C Hamano8b588d52008-03-15 09:48:37857man.viewer::
858Specify the programs that may be used to display help in the
859'man' format. See linkgit:git-help[1].
860
Junio C Hamano6d76d612008-05-09 05:46:08861include::merge-config.txt[]
Junio C Hamano07824ce2006-04-25 07:36:54862
Junio C Hamano6d76d612008-05-09 05:46:08863man.<tool>.cmd::
864Specify the command to invoke the specified man viewer. The
865specified command is evaluated in shell with the man page
866passed as argument. (See linkgit:git-help[1].)
Junio C Hamano103ad7f2007-03-14 11:19:26867
Junio C Hamano6d76d612008-05-09 05:46:08868man.<tool>.path::
869Override the path for the given tool that may be used to
870display help in the 'man' format. See linkgit:git-help[1].
Junio C Hamanoe90436a2007-04-22 07:22:13871
Junio C Hamano1fbbbc12007-12-18 07:01:27872mergetool.<tool>.path::
873Override the path for the given tool. This is useful in case
874your tool is not in the PATH.
875
Junio C Hamano86bcccc2008-03-08 09:33:55876mergetool.<tool>.cmd::
877Specify the command to invoke the specified merge tool. The
878specified command is evaluated in shell with the following
879variables available: 'BASE' is the name of a temporary file
880containing the common base of the files to be merged, if available;
881'LOCAL' is the name of a temporary file containing the contents of
882the file on the current branch; 'REMOTE' is the name of a temporary
883file containing the contents of the file from the branch being
884merged; 'MERGED' contains the name of the file to which the merge
885tool should write the results of a successful merge.
886
887mergetool.<tool>.trustExitCode::
888For a custom merge command, specify whether the exit code of
889the merge command can be used to determine whether the merge was
890successful. If this is not set to true then the merge target file
891timestamp is checked and the merge assumed to have been successful
892if the file has been updated, otherwise the user is prompted to
893indicate the success of the merge.
894
895mergetool.keepBackup::
896After performing a merge, the original file with conflict markers
897can be saved as a file with a `.orig` extension. If this variable
898is set to `false` then this file is not preserved. Defaults to
899`true` (i.e. keep the backup files).
900
Junio C Hamano75cc4c92006-07-24 08:25:03901pack.window::
Junio C Hamano35738e82008-01-07 07:55:46902The size of the window used by linkgit:git-pack-objects[1] when no
Junio C Hamano75cc4c92006-07-24 08:25:03903window size is given on the command line. Defaults to 10.
904
Junio C Hamano91d44c52007-05-09 07:16:07905pack.depth::
Junio C Hamano35738e82008-01-07 07:55:46906The maximum delta depth used by linkgit:git-pack-objects[1] when no
Junio C Hamano91d44c52007-05-09 07:16:07907maximum depth is given on the command line. Defaults to 50.
908
Junio C Hamano235d53f2007-07-13 00:25:15909pack.windowMemory::
Junio C Hamano35738e82008-01-07 07:55:46910The window memory size limit used by linkgit:git-pack-objects[1]
Junio C Hamano235d53f2007-07-13 00:25:15911when no limit is given on the command line. The value can be
912suffixed with "k", "m", or "g". Defaults to 0, meaning no
913limit.
914
Junio C Hamanof2ce2972007-05-20 19:12:09915pack.compression::
916An integer -1..9, indicating the compression level for objects
917in a pack file. -1 is the zlib default. 0 means no
918compression, and 1..9 are various speed/size tradeoffs, 9 being
919slowest. If not set, defaults to core.compression. If that is
Junio C Hamano2e72a942007-11-21 08:54:42920not set, defaults to -1, the zlib default, which is "a default
921compromise between speed and compression (currently equivalent
922to level 6)."
Junio C Hamanof2ce2972007-05-20 19:12:09923
Junio C Hamano679d22d2007-06-02 21:13:44924pack.deltaCacheSize::
Junio C Hamanoa6387422007-08-25 03:54:27925The maximum memory in bytes used for caching deltas in
Junio C Hamano35738e82008-01-07 07:55:46926linkgit:git-pack-objects[1].
Junio C Hamano679d22d2007-06-02 21:13:44927A value of 0 means no limit. Defaults to 0.
928
929pack.deltaCacheLimit::
Junio C Hamano58155b42007-09-15 07:46:14930The maximum size of a delta, that is cached in
Junio C Hamano35738e82008-01-07 07:55:46931linkgit:git-pack-objects[1]. Defaults to 1000.
Junio C Hamano679d22d2007-06-02 21:13:44932
Junio C Hamano58155b42007-09-15 07:46:14933pack.threads::
934Specifies the number of threads to spawn when searching for best
Junio C Hamano35738e82008-01-07 07:55:46935delta matches. This requires that linkgit:git-pack-objects[1]
Junio C Hamano58155b42007-09-15 07:46:14936be compiled with pthreads otherwise this option is ignored with a
937warning. This is meant to reduce packing time on multiprocessor
938machines. The required amount of memory for the delta search window
939is however multiplied by the number of threads.
Junio C Hamano24bc09a2008-02-28 00:27:44940Specifying 0 will cause git to auto-detect the number of CPU's
941and set the number of threads accordingly.
Junio C Hamano58155b42007-09-15 07:46:14942
Junio C Hamanod814b6d2007-11-04 11:13:49943pack.indexVersion::
944Specify the default pack index version. Valid values are 1 for
945legacy pack index used by Git versions prior to 1.5.2, and 2 for
946the new pack index with capabilities for packs larger than 4 GB
947as well as proper protection against the repacking of corrupted
Junio C Hamanofce7c7e2008-07-02 03:06:38948packs. Version 2 is the default. Note that version 2 is enforced
949and this config option ignored whenever the corresponding pack is
950larger than 2 GB.
951+
952If you have an old git that does not understand the version 2 `{asterisk}.idx` file,
953cloning or fetching over a non native protocol (e.g. "http" and "rsync")
954that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the
955other side may give you a repository that cannot be accessed with your
956older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,
957you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
958the `{asterisk}.idx` file.
Junio C Hamanod814b6d2007-11-04 11:13:49959
Junio C Hamano09a926d2008-03-13 07:55:29960pack.packSizeLimit::
Junio C Hamano49dccaf2008-02-10 10:48:01961The default maximum size of a pack. This setting only affects
962packing to a file, i.e. the git:// protocol is unaffected. It
963can be overridden by the `\--max-pack-size` option of
964linkgit:git-repack[1].
965
Junio C Hamano07824ce2006-04-25 07:36:54966pull.octopus::
967The default merge strategy to use when pulling multiple branches
968at once.
969
970pull.twohead::
971The default merge strategy to use when pulling a single branch.
972
Junio C Hamano249572f2006-10-24 05:44:08973remote.<name>.url::
Junio C Hamano35738e82008-01-07 07:55:46974The URL of a remote repository. See linkgit:git-fetch[1] or
975linkgit:git-push[1].
Junio C Hamano249572f2006-10-24 05:44:08976
Junio C Hamano58256872007-12-04 08:31:13977remote.<name>.proxy::
978For remotes that require curl (http, https and ftp), the URL to
979the proxy to use for that remote. Set to the empty string to
980disable proxying for that remote.
981
Junio C Hamano249572f2006-10-24 05:44:08982remote.<name>.fetch::
Junio C Hamano35738e82008-01-07 07:55:46983The default set of "refspec" for linkgit:git-fetch[1]. See
984linkgit:git-fetch[1].
Junio C Hamano249572f2006-10-24 05:44:08985
986remote.<name>.push::
Junio C Hamano35738e82008-01-07 07:55:46987The default set of "refspec" for linkgit:git-push[1]. See
988linkgit:git-push[1].
Junio C Hamano249572f2006-10-24 05:44:08989
Junio C Hamano47d68a52008-05-06 06:35:40990remote.<name>.mirror::
991If true, pushing to this remote will automatically behave
992as if the `\--mirror` option was given on the command line.
993
Junio C Hamano118d2772007-02-21 20:24:10994remote.<name>.skipDefaultUpdate::
995If true, this remote will be skipped by default when updating
Junio C Hamano35738e82008-01-07 07:55:46996using the update subcommand of linkgit:git-remote[1].
Junio C Hamano118d2772007-02-21 20:24:10997
Junio C Hamano4ad294b2007-01-20 02:22:50998remote.<name>.receivepack::
Junio C Hamano54ea8d32007-01-25 07:59:48999The default program to execute on the remote side when pushing. See
Junio C Hamano86bcccc2008-03-08 09:33:551000option \--receive-pack of linkgit:git-push[1].
Junio C Hamano4ad294b2007-01-20 02:22:501001
Junio C Hamano54ea8d32007-01-25 07:59:481002remote.<name>.uploadpack::
1003The default program to execute on the remote side when fetching. See
Junio C Hamano86bcccc2008-03-08 09:33:551004option \--upload-pack of linkgit:git-fetch-pack[1].
Junio C Hamano54ea8d32007-01-25 07:59:481005
Junio C Hamano17dde0e2007-02-26 09:50:211006remote.<name>.tagopt::
Junio C Hamano86bcccc2008-03-08 09:33:551007Setting this value to \--no-tags disables automatic tag following when
1008fetching from remote <name>
Junio C Hamano17dde0e2007-02-26 09:50:211009
Junio C Hamano118d2772007-02-21 20:24:101010remotes.<group>::
1011The list of remotes which are fetched by "git remote update
Junio C Hamano35738e82008-01-07 07:55:461012<group>". See linkgit:git-remote[1].
Junio C Hamano118d2772007-02-21 20:24:101013
Junio C Hamano77b7e902006-10-23 07:18:501014repack.usedeltabaseoffset::
Junio C Hamanofce7c7e2008-07-02 03:06:381015By default, linkgit:git-repack[1] creates packs that use
1016delta-base offset. If you need to share your repository with
1017git older than version 1.4.4, either directly or via a dumb
1018protocol such as http, then you need to set this option to
1019"false" and repack. Access from old git versions over the
1020native protocol are unaffected by this option.
Junio C Hamano77b7e902006-10-23 07:18:501021
Junio C Hamano07824ce2006-04-25 07:36:541022showbranch.default::
Junio C Hamano35738e82008-01-07 07:55:461023The default set of branches for linkgit:git-show-branch[1].
1024See linkgit:git-show-branch[1].
Junio C Hamano07824ce2006-04-25 07:36:541025
Junio C Hamano942b35e2007-12-09 10:19:331026status.relativePaths::
Junio C Hamano35738e82008-01-07 07:55:461027By default, linkgit:git-status[1] shows paths relative to the
Junio C Hamano942b35e2007-12-09 10:19:331028current directory. Setting this variable to `false` shows paths
1029relative to the repository root (this was the default for git
1030prior to v1.5.4).
1031
Junio C Hamano4224f992008-06-23 07:14:081032status.showUntrackedFiles::
1033By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1034files which are not currently tracked by Git. Directories which
1035contain only untracked files, are shown with the directory name
1036only. Showing untracked files means that Git needs to lstat() all
1037all the files in the whole repository, which might be slow on some
1038systems. So, this variable controls how the commands displays
1039the untracked files. Possible values are:
1040+
1041--
1042- 'no' - Show no untracked files
1043- 'normal' - Shows untracked files and directories
1044- 'all' - Shows also individual files in untracked directories.
1045--
1046+
1047If this variable is not specified, it defaults to 'normal'.
1048This variable can be overridden with the -u|--untracked-files option
1049of linkgit:git-status[1] and linkgit:git-commit[1].
1050
Junio C Hamano75cc4c92006-07-24 08:25:031051tar.umask::
Junio C Hamanobdebabb2007-08-23 00:25:091052This variable can be used to restrict the permission bits of
1053tar archive entries. The default is 0002, which turns off the
1054world write bit. The special value "user" indicates that the
1055archiving user's umask will be used instead. See umask(2) and
Junio C Hamano35738e82008-01-07 07:55:461056linkgit:git-archive[1].
Junio C Hamano75cc4c92006-07-24 08:25:031057
Junio C Hamano24bc09a2008-02-28 00:27:441058url.<base>.insteadOf::
1059Any URL that starts with this value will be rewritten to
1060start, instead, with <base>. In cases where some site serves a
1061large number of repositories, and serves them with multiple
1062access methods, and some users need to use different access
1063methods, this feature allows people to specify any of the
1064equivalent URLs and have git automatically rewrite the URL to
1065the best alternative for the particular user, even for a
1066never-before-seen repository on the site. When more than one
1067insteadOf strings match a given URL, the longest match is used.
1068
Junio C Hamano07824ce2006-04-25 07:36:541069user.email::
1070Your email address to be recorded in any newly created commits.
Junio C Hamano469d60e2007-04-29 18:30:341071Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
Junio C Hamano35738e82008-01-07 07:55:461072'EMAIL' environment variables. See linkgit:git-commit-tree[1].
Junio C Hamano07824ce2006-04-25 07:36:541073
1074user.name::
1075Your full name to be recorded in any newly created commits.
Junio C Hamano341071d2006-06-04 07:24:481076Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
Junio C Hamano35738e82008-01-07 07:55:461077environment variables. See linkgit:git-commit-tree[1].
Junio C Hamano07824ce2006-04-25 07:36:541078
Junio C Hamanoa890c4f2007-01-28 10:29:211079user.signingkey::
Junio C Hamano35738e82008-01-07 07:55:461080If linkgit:git-tag[1] is not selecting the key you want it to
Junio C Hamanoa890c4f2007-01-28 10:29:211081automatically when creating a signed tag, you can override the
1082default selection with this variable. This option is passed
1083unchanged to gpg's --local-user parameter, so you may specify a key
1084using any method that gpg supports.
1085
Junio C Hamano07824ce2006-04-25 07:36:541086imap::
1087The configuration variables in the 'imap' section are described
Junio C Hamano35738e82008-01-07 07:55:461088in linkgit:git-imap-send[1].
Junio C Hamano459ee222006-09-21 08:13:281089
Junio C Hamanob78d2592008-04-09 09:39:081090receive.fsckObjects::
1091If it is set to true, git-receive-pack will check all received
1092objects. It will abort in the case of a malformed object or a
1093broken link. The result of an abort are only dangling objects.
1094Defaults to false.
1095
Junio C Hamano0d3c8152006-11-08 01:33:411096receive.unpackLimit::
1097If the number of objects received in a push is below this
1098limit then the objects will be unpacked into loose object
1099files. However if the number of received objects equals or
1100exceeds this limit then the received pack will be stored as
1101a pack, after adding any missing delta bases. Storing the
1102pack from a push can make the push operation complete faster,
Junio C Hamanoe77b0152008-01-12 06:44:171103especially on slow filesystems. If not set, the value of
1104`transfer.unpackLimit` is used instead.
Junio C Hamano0d3c8152006-11-08 01:33:411105
1106receive.denyNonFastForwards::
Junio C Hamano459ee222006-09-21 08:13:281107If set to true, git-receive-pack will deny a ref update which is
1108not a fast forward. Use this to prevent such an update via a push,
1109even if that push is forced. This configuration variable is
1110set when initializing a shared repository.
1111
Junio C Hamano54ea8d32007-01-25 07:59:481112transfer.unpackLimit::
1113When `fetch.unpackLimit` or `receive.unpackLimit` are
1114not set, the value of this variable is used instead.
Junio C Hamanoe77b0152008-01-12 06:44:171115The default value is 100.
Junio C Hamano4e272312008-01-08 09:13:211116
1117web.browser::
1118Specify a web browser that may be used by some commands.
1119Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
1120may use it.