1CONFIGURATION FILE 2------------------ 3 4The git configuration file contains a number of variables that affect 5the git command's behavior. They can be used by both the git plumbing 6and the porcelains. The variables are divided into 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 comments 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 a more detailed description 39in the appropriate manual page. You will find a 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+ 56Can be overridden by the 'GIT_PROXY_COMMAND' environment variable 57(which always applies universally, without the special "for" 58handling). 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 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. 72 73core.logAllRefUpdates:: 74 If true, `git-update-ref` will append a line to 75 "$GIT_DIR/logs/<ref>" listing the new SHA1 and the date/time 76 of the update. If the file does not exist it will be 77 created automatically. This information can be used to 78 determine what commit was the tip of a branch "2 days ago". 79 This value is false by default (no logging). 80 81core.repositoryFormatVersion:: 82 Internal variable identifying the repository format and layout 83 version. 84 85core.sharedRepository:: 86 If true, the repository is made shareable between several users 87 in a group (making sure all the files and objects are group-writable). 88 See gitlink:git-init-db[1]. False by default. 89 90core.warnAmbiguousRefs:: 91 If true, git will warn you if the ref name you passed it is ambiguous 92 and might match multiple refs in the .git/refs/ tree. True by default. 93 94alias.*:: 95 Command aliases for the gitlink:git[1] command wrapper - e.g. 96 after defining "alias.last = cat-file commit HEAD", the invocation 97 "git last" is equivalent to "git cat-file commit HEAD". To avoid 98 confusion and troubles with script usage, aliases that 99 hide existing git commands are ignored. Arguments are split by 100 spaces, the usual shell quoting and escaping is supported. 101 quote pair and a backslash can be used to quote them. 102 103apply.whitespace:: 104 Tells `git-apply` how to handle whitespaces, in the same way 105 as the '--whitespace' option. See gitlink:git-apply[1]. 106 107diff.renameLimit:: 108 The number of files to consider when performing the copy/rename 109 detection; equivalent to the git diff option '-l'. 110 111format.headers:: 112 Additional email headers to include in a patch to be submitted 113 by mail. See gitlink:git-format-patch[1]. 114 115gitcvs.enabled:: 116 Whether the cvs pserver interface is enabled for this repository. 117 See gitlink:git-cvsserver[1]. 118 119gitcvs.logfile:: 120 Path to a log file where the cvs pserver interface well... logs 121 various stuff. See gitlink:git-cvsserver[1]. 122 123http.sslVerify:: 124 Whether to verify the SSL certificate when fetching or pushing 125 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment 126 variable. 127 128http.sslCert:: 129 File containing the SSL certificate when fetching or pushing 130 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment 131 variable. 132 133http.sslKey:: 134 File containing the SSL private key when fetching or pushing 135 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment 136 variable. 137 138http.sslCAInfo:: 139 File containing the certificates to verify the peer with when 140 fetching or pushing over HTTPS. Can be overridden by the 141 'GIT_SSL_CAINFO' environment variable. 142 143http.sslCAPath:: 144 Path containing files with the CA certificates to verify the peer 145 with when fetching or pushing over HTTPS. Can be overridden 146 by the 'GIT_SSL_CAPATH' environment variable. 147 148http.maxRequests:: 149 How many HTTP requests to launch in parallel. Can be overridden 150 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5. 151 152http.lowSpeedLimit, http.lowSpeedTime:: 153 If the HTTP transfer speed is less than 'http.lowSpeedLimit' 154 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted. 155 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and 156 'GIT_HTTP_LOW_SPEED_TIME' environment variables. 157 158i18n.commitEncoding:: 159 Character encoding the commit messages are stored in; git itself 160 does not care per se, but this information is necessary e.g. when 161 importing commits from emails or in the gitk graphical history 162 browser (and possibly at other places in the future or in other 163 porcelains). See e.g. gitlink:git-mailinfo[1]. Defaults to 'utf-8'. 164 165merge.summary:: 166 Whether to include summaries of merged commits in newly created 167 merge commit messages. False by default. 168 169pull.octopus:: 170 The default merge strategy to use when pulling multiple branches 171 at once. 172 173pull.twohead:: 174 The default merge strategy to use when pulling a single branch. 175 176show.difftree:: 177 The default gitlink:git-diff-tree[1] arguments to be used 178 for gitlink:git-show[1]. 179 180showbranch.default:: 181 The default set of branches for gitlink:git-show-branch[1]. 182 See gitlink:git-show-branch[1]. 183 184user.email:: 185 Your email address to be recorded in any newly created commits. 186 Can be overridden by the 'GIT_AUTHOR_EMAIL' and 'GIT_COMMITTER_EMAIL' 187 environment variables. See gitlink:git-commit-tree[1]. 188 189user.name:: 190 Your full name to be recorded in any newly created commits. 191 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME' 192 environment variables. See gitlink:git-commit-tree[1]. 193 194whatchanged.difftree:: 195 The default gitlink:git-diff-tree[1] arguments to be used 196 for gitlink:git-whatchanged[1]. 197 198imap:: 199 The configuration variables in the 'imap' section are described 200 in gitlink:git-imap-send[1].