Documentation/config.txt

   1 CONFIGURATION FILE
   2 ------------------
   3
   4 The git configuration file contains a number of variables that affect
   5 the git command's behavior. They can be used by both the git plumbing
   6 and the porcelains. The variables are divided into sections, where
   7 in the fully qualified variable name the variable itself is the last
   8 dot-separated segment and the section name is everything before the last
   9 dot. The variable names are case-insensitive and only alphanumeric
  10 characters are allowed. Some variables may appear multiple times.
  11
  12 The syntax is fairly flexible and permissive; whitespaces are mostly
  13 ignored. The '#' and ';' characters begin comments to the end of line,
  14 blank lines are ignored, lines containing strings enclosed in square
  15 brackets start sections and all the other lines are recognized
  16 as setting variables, in the form 'name = value'. If there is no equal
  17 sign on the line, the entire line is taken as 'name' and the variable
  18 is recognized as boolean "true". String values may be entirely or partially
  19 enclosed in double quotes; some variables may require special value format.
  20
  21 Example
  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
  39 Variables
  40 ~~~~~~~~~
  41
  42 Note that this list is non-comprehensive and not necessarily complete.
  43 For command-specific variables, you will find a more detailed description
  44 in the appropriate manual page. You will find a description of non-core
  45 porcelain configuration variables in the respective porcelain documentation.
  46
  47 core.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
  52 core.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 +
  61 Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
  62 (which always applies universally, without the special "for"
  63 handling).
  64
  65 core.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
  72 core.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
  78 core.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 +
  86 This information can be used to determine what commit
  87 was the tip of a branch "2 days ago".
  88 +
  89 This value is true by default in a repository that has
  90 a working directory associated with it, and false by
  91 default in a bare repository.
  92
  93 core.repositoryFormatVersion::
  94         Internal variable identifying the repository format and layout
  95         version.
  96
  97 core.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
 105 core.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
 109 core.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
 115 core.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
 121 core.packedGitWindowSize::
 122         Number of bytes of a pack file to map into memory in a
 123         single mapping operation.  Larger window sizes may allow
 124         your system to process a smaller number of large pack files
 125         more quickly.  Smaller window sizes will negatively affect
 126         performance due to increased calls to the operating system's
 127         memory manager, but may improve performance when accessing
 128         a large number of large pack files.
 129 +
 130 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
 131 MiB on 32 bit platforms and 1 GiB on 64 bit platforms.  This should
 132 be reasonable for all users/operating systems.  You probably do
 133 not need to adjust this value.
 134 +
 135 Common unit suffixes of 'k', 'm', or 'g' are supported.
 136
 137 core.packedGitLimit::
 138         Maximum number of bytes to map simultaneously into memory
 139         from pack files.  If Git needs to access more than this many
 140         bytes at once to complete an operation it will unmap existing
 141         regions to reclaim virtual address space within the process.
 142 +
 143 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
 144 This should be reasonable for all users/operating systems, except on
 145 the largest projects.  You probably do not need to adjust this value.
 146 +
 147 Common unit suffixes of 'k', 'm', or 'g' are supported.
 148
 149 alias.*::
 150         Command aliases for the gitlink:git[1] command wrapper - e.g.
 151         after defining "alias.last = cat-file commit HEAD", the invocation
 152         "git last" is equivalent to "git cat-file commit HEAD". To avoid
 153         confusion and troubles with script usage, aliases that
 154         hide existing git commands are ignored. Arguments are split by
 155         spaces, the usual shell quoting and escaping is supported.
 156         quote pair and a backslash can be used to quote them.
 157
 158 apply.whitespace::
 159         Tells `git-apply` how to handle whitespaces, in the same way
 160         as the '--whitespace' option. See gitlink:git-apply[1].
 161
 162 branch.<name>.remote::
 163         When in branch <name>, it tells `git fetch` which remote to fetch.
 164         If this option is not given, `git fetch` defaults to remote "origin".
 165
 166 branch.<name>.merge::
 167         When in branch <name>, it tells `git fetch` the default refspec to
 168         be marked for merging in FETCH_HEAD. The value has exactly to match
 169         a remote part of one of the refspecs which are fetched from the remote
 170         given by "branch.<name>.remote".
 171         The merge information is used by `git pull` (which at first calls
 172         `git fetch`) to lookup the default branch for merging. Without
 173         this option, `git pull` defaults to merge the first refspec fetched.
 174         Specify multiple values to get an octopus merge.
 175
 176 color.branch::
 177         A boolean to enable/disable color in the output of
 178         gitlink:git-branch[1]. May be set to `true` (or `always`),
 179         `false` (or `never`) or `auto`, in which case colors are used
 180         only when the output is to a terminal. Defaults to false.
 181
 182 color.branch.<slot>::
 183         Use customized color for branch coloration. `<slot>` is one of
 184         `current` (the current branch), `local` (a local branch),
 185         `remote` (a tracking branch in refs/remotes/), `plain` (other
 186         refs), or `reset` (the normal terminal color).  The value for
 187         these configuration variables can be one of: `normal`, `bold`,
 188         `dim`, `ul`, `blink`, `reverse`, `reset`, `black`, `red`,
 189         `green`, `yellow`, `blue`, `magenta`, `cyan`, or `white`.
 190
 191 color.diff::
 192         When true (or `always`), always use colors in patch.
 193         When false (or `never`), never.  When set to `auto`, use
 194         colors only when the output is to the terminal.
 195
 196 color.diff.<slot>::
 197         Use customized color for diff colorization.  `<slot>`
 198         specifies which part of the patch to use the specified
 199         color, and is one of `plain` (context text), `meta`
 200         (metainformation), `frag` (hunk header), `old` (removed
 201         lines), or `new` (added lines).  The values of these
 202         variables may be specified as in color.branch.<slot>.
 203
 204 color.pager::
 205         A boolean to enable/disable colored output when the pager is in
 206         use (default is true).
 207
 208 color.status::
 209         A boolean to enable/disable color in the output of
 210         gitlink:git-status[1]. May be set to `true` (or `always`),
 211         `false` (or `never`) or `auto`, in which case colors are used
 212         only when the output is to a terminal. Defaults to false.
 213
 214 color.status.<slot>::
 215         Use customized color for status colorization. `<slot>` is
 216         one of `header` (the header text of the status message),
 217         `added` or `updated` (files which are added but not committed),
 218         `changed` (files which are changed but not added in the index),
 219         or `untracked` (files which are not tracked by git). The values of
 220         these variables may be specified as in color.branch.<slot>.
 221
 222 diff.renameLimit::
 223         The number of files to consider when performing the copy/rename
 224         detection; equivalent to the git diff option '-l'.
 225
 226 diff.renames::
 227         Tells git to detect renames.  If set to any boolean value, it
 228         will enable basic rename detection.  If set to "copies" or
 229         "copy", it will detect copies, as well.
 230
 231 format.headers::
 232         Additional email headers to include in a patch to be submitted
 233         by mail.  See gitlink:git-format-patch[1].
 234
 235 gc.reflogexpire::
 236         `git reflog expire` removes reflog entries older than
 237         this time; defaults to 90 days.
 238
 239 gc.reflogexpireunreachable::
 240         `git reflog expire` removes reflog entries older than
 241         this time and are not reachable from the current tip;
 242         defaults to 30 days.
 243
 244 gc.rerereresolved::
 245         Records of conflicted merge you resolved earlier are
 246         kept for this many days when `git rerere gc` is run.
 247         The default is 60 days.  See gitlink:git-rerere[1].
 248
 249 gc.rerereunresolved::
 250         Records of conflicted merge you have not resolved are
 251         kept for this many days when `git rerere gc` is run.
 252         The default is 15 days.  See gitlink:git-rerere[1].
 253
 254 gitcvs.enabled::
 255         Whether the cvs pserver interface is enabled for this repository.
 256         See gitlink:git-cvsserver[1].
 257
 258 gitcvs.logfile::
 259         Path to a log file where the cvs pserver interface well... logs
 260         various stuff. See gitlink:git-cvsserver[1].
 261
 262 http.sslVerify::
 263         Whether to verify the SSL certificate when fetching or pushing
 264         over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
 265         variable.
 266
 267 http.sslCert::
 268         File containing the SSL certificate when fetching or pushing
 269         over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
 270         variable.
 271
 272 http.sslKey::
 273         File containing the SSL private key when fetching or pushing
 274         over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
 275         variable.
 276
 277 http.sslCAInfo::
 278         File containing the certificates to verify the peer with when
 279         fetching or pushing over HTTPS. Can be overridden by the
 280         'GIT_SSL_CAINFO' environment variable.
 281
 282 http.sslCAPath::
 283         Path containing files with the CA certificates to verify the peer
 284         with when fetching or pushing over HTTPS. Can be overridden
 285         by the 'GIT_SSL_CAPATH' environment variable.
 286
 287 http.maxRequests::
 288         How many HTTP requests to launch in parallel. Can be overridden
 289         by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
 290
 291 http.lowSpeedLimit, http.lowSpeedTime::
 292         If the HTTP transfer speed is less than 'http.lowSpeedLimit'
 293         for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
 294         Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
 295         'GIT_HTTP_LOW_SPEED_TIME' environment variables.
 296
 297 http.noEPSV::
 298         A boolean which disables using of EPSV ftp command by curl.
 299         This can helpful with some "poor" ftp servers which doesn't
 300         support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
 301         environment variable. Default is false (curl will use EPSV).
 302
 303 i18n.commitEncoding::
 304         Character encoding the commit messages are stored in; git itself
 305         does not care per se, but this information is necessary e.g. when
 306         importing commits from emails or in the gitk graphical history
 307         browser (and possibly at other places in the future or in other
 308         porcelains). See e.g. gitlink:git-mailinfo[1]. Defaults to 'utf-8'.
 309
 310 i18n.logOutputEncoding::
 311         Character encoding the commit messages are converted to when
 312         running `git-log` and friends.
 313
 314 log.showroot::
 315         If true, the initial commit will be shown as a big creation event.
 316         This is equivalent to a diff against an empty tree.
 317         Tools like gitlink:git-log[1] or gitlink:git-whatchanged[1], which
 318         normally hide the root commit will now show it. True by default.
 319
 320 merge.summary::
 321         Whether to include summaries of merged commits in newly created
 322         merge commit messages. False by default.
 323
 324 pack.window::
 325         The size of the window used by gitlink:git-pack-objects[1] when no
 326         window size is given on the command line. Defaults to 10.
 327
 328 pull.octopus::
 329         The default merge strategy to use when pulling multiple branches
 330         at once.
 331
 332 pull.twohead::
 333         The default merge strategy to use when pulling a single branch.
 334
 335 remote.<name>.url::
 336         The URL of a remote repository.  See gitlink:git-fetch[1] or
 337         gitlink:git-push[1].
 338
 339 remote.<name>.fetch::
 340         The default set of "refspec" for gitlink:git-fetch[1]. See
 341         gitlink:git-fetch[1].
 342
 343 remote.<name>.push::
 344         The default set of "refspec" for gitlink:git-push[1]. See
 345         gitlink:git-push[1].
 346
 347 repack.usedeltabaseoffset::
 348         Allow gitlink:git-repack[1] to create packs that uses
 349         delta-base offset.  Defaults to false.
 350
 351 show.difftree::
 352         The default gitlink:git-diff-tree[1] arguments to be used
 353         for gitlink:git-show[1].
 354
 355 showbranch.default::
 356         The default set of branches for gitlink:git-show-branch[1].
 357         See gitlink:git-show-branch[1].
 358
 359 tar.umask::
 360         By default, gitlink:git-tar-tree[1] sets file and directories modes
 361         to 0666 or 0777. While this is both useful and acceptable for projects
 362         such as the Linux Kernel, it might be excessive for other projects.
 363         With this variable, it becomes possible to tell
 364         gitlink:git-tar-tree[1] to apply a specific umask to the modes above.
 365         The special value "user" indicates that the user's current umask will
 366         be used. This should be enough for most projects, as it will lead to
 367         the same permissions as gitlink:git-checkout[1] would use. The default
 368         value remains 0, which means world read-write.
 369
 370 user.email::
 371         Your email address to be recorded in any newly created commits.
 372         Can be overridden by the 'GIT_AUTHOR_EMAIL' and 'GIT_COMMITTER_EMAIL'
 373         environment variables.  See gitlink:git-commit-tree[1].
 374
 375 user.name::
 376         Your full name to be recorded in any newly created commits.
 377         Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
 378         environment variables.  See gitlink:git-commit-tree[1].
 379
 380 whatchanged.difftree::
 381         The default gitlink:git-diff-tree[1] arguments to be used
 382         for gitlink:git-whatchanged[1].
 383
 384 imap::
 385         The configuration variables in the 'imap' section are described
 386         in gitlink:git-imap-send[1].
 387
 388 receive.unpackLimit::
 389         If the number of objects received in a push is below this
 390         limit then the objects will be unpacked into loose object
 391         files. However if the number of received objects equals or
 392         exceeds this limit then the received pack will be stored as
 393         a pack, after adding any missing delta bases.  Storing the
 394         pack from a push can make the push operation complete faster,
 395         especially on slow filesystems.
 396
 397 receive.denyNonFastForwards::
 398         If set to true, git-receive-pack will deny a ref update which is
 399         not a fast forward. Use this to prevent such an update via a push,
 400         even if that push is forced. This configuration variable is
 401         set when initializing a shared repository.
 402