core.prefersymlinkrefs: use symlinks for .git/HEAD
[git/git.git] / Documentation / config.txt
CommitLineData
1ab661dd
PB
1CONFIGURATION FILE
2------------------
3
4The git configuration file contains a number of variables that affect
5the git commands behaviour. They can be used by both the git plumbing
6and the porcelains. The variables are divided to sections, where
7in the fully qualified variable name the variable itself is the last
8dot-separated segment and the section name is everything before the last
9dot. The variable names are case-insensitive and only alphanumeric
10characters are allowed. Some variables may appear multiple times.
11
12The syntax is fairly flexible and permissive; whitespaces are mostly
13ignored. The '#' and ';' characters begin commends to the end of line,
14blank lines are ignored, lines containing strings enclosed in square
15brackets start sections and all the other lines are recognized
16as setting variables, in the form 'name = value'. If there is no equal
17sign on the line, the entire line is taken as 'name' and the variable
18is recognized as boolean "true". String values may be entirely or partially
19enclosed in double quotes; some variables may require special value format.
20
21Example
22~~~~~~~
23
24 # Core variables
25 [core]
26 ; Don't trust file modes
27 filemode = false
28
29 # Our diff algorithm
30 [diff]
31 external = "/usr/local/bin/gnu-diff -u"
32 renames = true
33
34Variables
35~~~~~~~~~
36
37Note that this list is non-comprehensive and not necessarily complete.
38For command-specific variables, you will find more detailed description
39in the appropriate manual page. You will find description of non-core
40porcelain configuration variables in the respective porcelain documentation.
41
42core.fileMode::
43 If false, the executable bit differences between the index and
44 the working copy are ignored; useful on broken filesystems like FAT.
45 See gitlink:git-update-index[1]. True by default.
46
47core.gitProxy::
48 A "proxy command" to execute (as 'command host port') instead
49 of establishing direct connection to the remote server when
50 using the git protocol for fetching. If the variable value is
51 in the "COMMAND for DOMAIN" format, the command is applied only
52 on hostnames ending with the specified domain string. This variable
53 may be set multiple times and is matched in the given order;
54 the first match wins.
55
56 Can be overriden by the 'GIT_PROXY_COMMAND' environment variable
57 (which always applies universally, without the special "for"
58 handling).
59
60core.ignoreStat::
61 The working copy files are assumed to stay unchanged until you
62 mark them otherwise manually - Git will not detect the file changes
63 by lstat() calls. This is useful on systems where those are very
64 slow, such as Microsoft Windows. See gitlink:git-update-index[1].
65 False by default.
66
e388c738
JH
67core.preferSymlinkRefs::
68 Instead of the default "symref" format for HEAD
69 and other symbolic reference files, use symbolic links.
70 This is sometimes needed to work with old scripts that
71 expect HEAD to be a symbolic link.
1ab661dd
PB
72
73core.repositoryFormatVersion::
74 Internal variable identifying the repository format and layout
75 version.
76
77core.sharedRepository::
78 If true, the repository is made shareable between several users
79 in a group (making sure all the files and objects are group-writable).
80 See gitlink:git-init-db[1]. False by default.
81
82core.warnAmbiguousRefs::
83 If true, git will warn you if the ref name you passed it is ambiguous
84 and might match multiple refs in the .git/refs/ tree. True by default.
85
86apply.whitespace::
87 Tells `git-apply` how to handle whitespaces, in the same way
88 as the '--whitespace' option. See gitlink:git-apply[1].
89
90diff.renameLimit::
91 The number of files to consider when performing the copy/rename
92 detection; equivalent to the git diff option '-l'.
93
94format.headers::
95 Additional email headers to include in a patch to be submitted
96 by mail. See gitlink:git-format-patch[1].
97
98gitcvs.enabled::
99 Whether the cvs pserver interface is enabled for this repository.
100 See gitlink:git-cvsserver[1].
101
102gitcvs.logfile::
103 Path to a log file where the cvs pserver interface well... logs
104 various stuff. See gitlink:git-cvsserver[1].
105
106http.sslVerify::
107 Whether to verify the SSL certificate when fetching or pushing
108 over HTTPS. Can be overriden by the 'GIT_SSL_NO_VERIFY' environment
109 variable.
110
111http.sslCert::
112 File containing the SSL certificate when fetching or pushing
113 over HTTPS. Can be overriden by the 'GIT_SSL_CERT' environment
114 variable.
115
116http.sslKey::
117 File containing the SSL private key when fetching or pushing
118 over HTTPS. Can be overriden by the 'GIT_SSL_KEY' environment
119 variable.
120
121http.sslCAInfo::
122 File containing the certificates to verify the peer with when
123 fetching or pushing over HTTPS. Can be overriden by the
124 'GIT_SSL_CAINFO' environment variable.
125
126http.sslCAPath::
127 Path containing files with the CA certificates to verify the peer
128 with when fetching or pushing over HTTPS. Can be overriden
129 by the 'GIT_SSL_CAPATH' environment variable.
130
131http.maxRequests::
132 How many HTTP requests to launch in parallel. Can be overriden
133 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
134
135http.lowSpeedLimit, http.lowSpeedTime::
136 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
137 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
138 Can be overriden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
139 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
140
141i18n.commitEncoding::
142 Character encoding the commit messages are stored in; git itself
143 does not care per se, but this information is necessary e.g. when
144 importing commits from emails or in the gitk graphical history
145 browser (and possibly at other places in the future or in other
146 porcelains). See e.g. gitlink:git-mailinfo[1]. Defaults to 'utf-8'.
147
148merge.summary::
149 Whether to include summaries of merged commits in newly created
150 merge commit messages. False by default.
151
152pull.octopus::
153 The default merge strategy to use when pulling multiple branches
154 at once.
155
156pull.twohead::
157 The default merge strategy to use when pulling a single branch.
158
159show.difftree::
160 The default gitlink:git-diff-tree[1] arguments to be used
161 for gitlink:git-show[1].
162
163showbranch.default::
164 The default set of branches for gitlink:git-show-branch[1].
165 See gitlink:git-show-branch[1].
166
167user.email::
168 Your email address to be recorded in any newly created commits.
169 Can be overriden by the 'GIT_AUTHOR_EMAIL' and 'GIT_COMMITTER_EMAIL'
170 environment variables. See gitlink:git-commit-tree[1].
171
172user.name::
173 Your full name to be recorded in any newly created commits.
174 Can be overriden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
175 environment variables. See gitlink:git-commit-tree[1].
176
177whatchanged.difftree::
178 The default gitlink:git-diff-tree[1] arguments to be used
179 for gitlink:git-whatchanged[1].
180
181imap::
182 The configuration variables in the 'imap' section are described
183 in gitlink:git-imap-send[1].