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