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 34 [branch "devel"] 35 remote = origin 36 merge = refs/heads/devel 37 38 39Variables 40~~~~~~~~~ 41 42Note that this list is non-comprehensive and not necessarily complete. 43For command-specific variables, you will find a more detailed description 44in the appropriate manual page. You will find a description of non-core 45porcelain configuration variables in the respective porcelain documentation. 46 47core.fileMode:: 48 If false, the executable bit differences between the index and 49 the working copy are ignored; useful on broken filesystems like FAT. 50 See gitlink:git-update-index[1]. True by default. 51 52core.gitProxy:: 53 A "proxy command" to execute (as 'command host port') instead 54 of establishing direct connection to the remote server when 55 using the git protocol for fetching. If the variable value is 56 in the "COMMAND for DOMAIN" format, the command is applied only 57 on hostnames ending with the specified domain string. This variable 58 may be set multiple times and is matched in the given order; 59 the first match wins. 60+ 61Can be overridden by the 'GIT_PROXY_COMMAND' environment variable 62(which always applies universally, without the special "for" 63handling). 64 65core.ignoreStat:: 66 The working copy files are assumed to stay unchanged until you 67 mark them otherwise manually - Git will not detect the file changes 68 by lstat() calls. This is useful on systems where those are very 69 slow, such as Microsoft Windows. See gitlink:git-update-index[1]. 70 False by default. 71 72core.preferSymlinkRefs:: 73 Instead of the default "symref" format for HEAD 74 and other symbolic reference files, use symbolic links. 75 This is sometimes needed to work with old scripts that 76 expect HEAD to be a symbolic link. 77 78core.logAllRefUpdates:: 79 Updates to a ref <ref> is logged to the file 80 "$GIT_DIR/logs/<ref>", by appending the new and old 81 SHA1, the date/time and the reason of the update, but 82 only when the file exists. If this configuration 83 variable is set to true, missing "$GIT_DIR/logs/<ref>" 84 file is automatically created for branch heads. 85+ 86This information can be used to determine what commit 87was the tip of a branch "2 days ago". 88+ 89This value is true by default in a repository that has 90a working directory associated with it, and false by 91default in a bare repository. 92 93core.repositoryFormatVersion:: 94 Internal variable identifying the repository format and layout 95 version. 96 97core.sharedRepository:: 98 When 'group' (or 'true'), the repository is made shareable between 99 several users in a group (making sure all the files and objects are 100 group-writable). When 'all' (or 'world' or 'everybody'), the 101 repository will be readable by all users, additionally to being 102 group-shareable. When 'umask' (or 'false'), git will use permissions 103 reported by umask(2). See gitlink:git-init-db[1]. False by default. 104 105core.warnAmbiguousRefs:: 106 If true, git will warn you if the ref name you passed it is ambiguous 107 and might match multiple refs in the .git/refs/ tree. True by default. 108 109core.compression:: 110 An integer -1..9, indicating the compression level for objects that 111 are not in a pack file. -1 is the zlib and git default. 0 means no 112 compression, and 1..9 are various speed/size tradeoffs, 9 being 113 slowest. 114 115core.legacyheaders:: 116 A boolean which enables the legacy object header format in case 117 you want to interoperate with old clients accessing the object 118 database directly (where the "http://" and "rsync://" protocols 119 count as direct access). 120 121alias.*:: 122 Command aliases for the gitlink:git[1] command wrapper - e.g. 123 after defining "alias.last = cat-file commit HEAD", the invocation 124 "git last" is equivalent to "git cat-file commit HEAD". To avoid 125 confusion and troubles with script usage, aliases that 126 hide existing git commands are ignored. Arguments are split by 127 spaces, the usual shell quoting and escaping is supported. 128 quote pair and a backslash can be used to quote them. 129 130apply.whitespace:: 131 Tells `git-apply` how to handle whitespaces, in the same way 132 as the '--whitespace' option. See gitlink:git-apply[1]. 133 134branch.<name>.remote:: 135 When in branch <name>, it tells `git fetch` which remote to fetch. 136 If this option is not given, `git fetch` defaults to remote "origin". 137 138branch.<name>.merge:: 139 When in branch <name>, it tells `git fetch` the default refspec to 140 be marked for merging in FETCH_HEAD. The value has exactly to match 141 a remote part of one of the refspecs which are fetched from the remote 142 given by "branch.<name>.remote". 143 The merge information is used by `git pull` (which at first calls 144 `git fetch`) to lookup the default branch for merging. Without 145 this option, `git pull` defaults to merge the first refspec fetched. 146 Specify multiple values to get an octopus merge. 147 148color.branch:: 149 A boolean to enable/disable color in the output of 150 gitlink:git-branch[1]. May be set to `true` (or `always`), 151 `false` (or `never`) or `auto`, in which case colors are used 152 only when the output is to a terminal. Defaults to false. 153 154color.branch.<slot>:: 155 Use customized color for branch coloration. `<slot>` is one of 156 `current` (the current branch), `local` (a local branch), 157 `remote` (a tracking branch in refs/remotes/), `plain` (other 158 refs), or `reset` (the normal terminal color). The value for 159 these configuration variables can be one of: `normal`, `bold`, 160 `dim`, `ul`, `blink`, `reverse`, `reset`, `black`, `red`, 161 `green`, `yellow`, `blue`, `magenta`, `cyan`, or `white`. 162 163color.diff:: 164 When true (or `always`), always use colors in patch. 165 When false (or `never`), never. When set to `auto`, use 166 colors only when the output is to the terminal. 167 168color.diff.<slot>:: 169 Use customized color for diff colorization. `<slot>` 170 specifies which part of the patch to use the specified 171 color, and is one of `plain` (context text), `meta` 172 (metainformation), `frag` (hunk header), `old` (removed 173 lines), or `new` (added lines). The values of these 174 variables may be specified as in color.branch.<slot>. 175 176color.pager:: 177 A boolean to enable/disable colored output when the pager is in 178 use (default is true). 179 180color.status:: 181 A boolean to enable/disable color in the output of 182 gitlink:git-status[1]. May be set to `true` (or `always`), 183 `false` (or `never`) or `auto`, in which case colors are used 184 only when the output is to a terminal. Defaults to false. 185 186color.status.<slot>:: 187 Use customized color for status colorization. `<slot>` is 188 one of `header` (the header text of the status message), 189 `added` or `updated` (files which are added but not committed), 190 `changed` (files which are changed but not added in the index), 191 or `untracked` (files which are not tracked by git). The values of 192 these variables may be specified as in color.branch.<slot>. 193 194diff.renameLimit:: 195 The number of files to consider when performing the copy/rename 196 detection; equivalent to the git diff option '-l'. 197 198diff.renames:: 199 Tells git to detect renames. If set to any boolean value, it 200 will enable basic rename detection. If set to "copies" or 201 "copy", it will detect copies, as well. 202 203format.headers:: 204 Additional email headers to include in a patch to be submitted 205 by mail. See gitlink:git-format-patch[1]. 206 207gc.reflogexpire:: 208 `git reflog expire` removes reflog entries older than 209 this time; defaults to 90 days. 210 211gc.reflogexpireunreachable:: 212 `git reflog expire` removes reflog entries older than 213 this time and are not reachable from the current tip; 214 defaults to 30 days. 215 216gc.rerereresolved:: 217 Records of conflicted merge you resolved earlier are 218 kept for this many days when `git rerere gc` is run. 219 The default is 60 days. See gitlink:git-rerere[1]. 220 221gc.rerereunresolved:: 222 Records of conflicted merge you have not resolved are 223 kept for this many days when `git rerere gc` is run. 224 The default is 15 days. See gitlink:git-rerere[1]. 225 226gitcvs.enabled:: 227 Whether the cvs pserver interface is enabled for this repository. 228 See gitlink:git-cvsserver[1]. 229 230gitcvs.logfile:: 231 Path to a log file where the cvs pserver interface well... logs 232 various stuff. See gitlink:git-cvsserver[1]. 233 234http.sslVerify:: 235 Whether to verify the SSL certificate when fetching or pushing 236 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment 237 variable. 238 239http.sslCert:: 240 File containing the SSL certificate when fetching or pushing 241 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment 242 variable. 243 244http.sslKey:: 245 File containing the SSL private key when fetching or pushing 246 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment 247 variable. 248 249http.sslCAInfo:: 250 File containing the certificates to verify the peer with when 251 fetching or pushing over HTTPS. Can be overridden by the 252 'GIT_SSL_CAINFO' environment variable. 253 254http.sslCAPath:: 255 Path containing files with the CA certificates to verify the peer 256 with when fetching or pushing over HTTPS. Can be overridden 257 by the 'GIT_SSL_CAPATH' environment variable. 258 259http.maxRequests:: 260 How many HTTP requests to launch in parallel. Can be overridden 261 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5. 262 263http.lowSpeedLimit, http.lowSpeedTime:: 264 If the HTTP transfer speed is less than 'http.lowSpeedLimit' 265 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted. 266 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and 267 'GIT_HTTP_LOW_SPEED_TIME' environment variables. 268 269http.noEPSV:: 270 A boolean which disables using of EPSV ftp command by curl. 271 This can helpful with some "poor" ftp servers which doesn't 272 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV' 273 environment variable. Default is false (curl will use EPSV). 274 275i18n.commitEncoding:: 276 Character encoding the commit messages are stored in; git itself 277 does not care per se, but this information is necessary e.g. when 278 importing commits from emails or in the gitk graphical history 279 browser (and possibly at other places in the future or in other 280 porcelains). See e.g. gitlink:git-mailinfo[1]. Defaults to 'utf-8'. 281 282i18n.logOutputEncoding:: 283 Character encoding the commit messages are converted to when 284 running `git-log` and friends. 285 286log.showroot:: 287 If true, the initial commit will be shown as a big creation event. 288 This is equivalent to a diff against an empty tree. 289 Tools like gitlink:git-log[1] or gitlink:git-whatchanged[1], which 290 normally hide the root commit will now show it. True by default. 291 292merge.summary:: 293 Whether to include summaries of merged commits in newly created 294 merge commit messages. False by default. 295 296pack.window:: 297 The size of the window used by gitlink:git-pack-objects[1] when no 298 window size is given on the command line. Defaults to 10. 299 300pull.octopus:: 301 The default merge strategy to use when pulling multiple branches 302 at once. 303 304pull.twohead:: 305 The default merge strategy to use when pulling a single branch. 306 307remote.<name>.url:: 308 The URL of a remote repository. See gitlink:git-fetch[1] or 309 gitlink:git-push[1]. 310 311remote.<name>.fetch:: 312 The default set of "refspec" for gitlink:git-fetch[1]. See 313 gitlink:git-fetch[1]. 314 315remote.<name>.push:: 316 The default set of "refspec" for gitlink:git-push[1]. See 317 gitlink:git-push[1]. 318 319repack.usedeltabaseoffset:: 320 Allow gitlink:git-repack[1] to create packs that uses 321 delta-base offset. Defaults to false. 322 323show.difftree:: 324 The default gitlink:git-diff-tree[1] arguments to be used 325 for gitlink:git-show[1]. 326 327showbranch.default:: 328 The default set of branches for gitlink:git-show-branch[1]. 329 See gitlink:git-show-branch[1]. 330 331tar.umask:: 332 By default, gitlink:git-tar-tree[1] sets file and directories modes 333 to 0666 or 0777. While this is both useful and acceptable for projects 334 such as the Linux Kernel, it might be excessive for other projects. 335 With this variable, it becomes possible to tell 336 gitlink:git-tar-tree[1] to apply a specific umask to the modes above. 337 The special value "user" indicates that the user's current umask will 338 be used. This should be enough for most projects, as it will lead to 339 the same permissions as gitlink:git-checkout[1] would use. The default 340 value remains 0, which means world read-write. 341 342user.email:: 343 Your email address to be recorded in any newly created commits. 344 Can be overridden by the 'GIT_AUTHOR_EMAIL' and 'GIT_COMMITTER_EMAIL' 345 environment variables. See gitlink:git-commit-tree[1]. 346 347user.name:: 348 Your full name to be recorded in any newly created commits. 349 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME' 350 environment variables. See gitlink:git-commit-tree[1]. 351 352whatchanged.difftree:: 353 The default gitlink:git-diff-tree[1] arguments to be used 354 for gitlink:git-whatchanged[1]. 355 356imap:: 357 The configuration variables in the 'imap' section are described 358 in gitlink:git-imap-send[1]. 359 360receive.unpackLimit:: 361 If the number of objects received in a push is below this 362 limit then the objects will be unpacked into loose object 363 files. However if the number of received objects equals or 364 exceeds this limit then the received pack will be stored as 365 a pack, after adding any missing delta bases. Storing the 366 pack from a push can make the push operation complete faster, 367 especially on slow filesystems. 368 369receive.denyNonFastForwards:: 370 If set to true, git-receive-pack will deny a ref update which is 371 not a fast forward. Use this to prevent such an update via a push, 372 even if that push is forced. This configuration variable is 373 set when initializing a shared repository. 374