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 Variables
  35 ~~~~~~~~~
  36
  37 Note that this list is non-comprehensive and not necessarily complete.
  38 For command-specific variables, you will find a more detailed description
  39 in the appropriate manual page. You will find a description of non-core
  40 porcelain configuration variables in the respective porcelain documentation.
  41
  42 core.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
  47 core.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 overridden by the 'GIT_PROXY_COMMAND' environment variable
  57 (which always applies universally, without the special "for"
  58 handling).
  59
  60 core.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
  67 core.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
  73 core.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
  81 core.repositoryFormatVersion::
  82         Internal variable identifying the repository format and layout
  83         version.
  84
  85 core.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
  90 core.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
  94 alias.*::
  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, aliases that hide existing git commands are ignored.
  99         Arguments are split at whitespaces, but single or double
 100         quote pair can be used to quote them.
 101
 102 apply.whitespace::
 103         Tells `git-apply` how to handle whitespaces, in the same way
 104         as the '--whitespace' option. See gitlink:git-apply[1].
 105
 106 diff.renameLimit::
 107         The number of files to consider when performing the copy/rename
 108         detection; equivalent to the git diff option '-l'.
 109
 110 format.headers::
 111         Additional email headers to include in a patch to be submitted
 112         by mail.  See gitlink:git-format-patch[1].
 113
 114 gitcvs.enabled::
 115         Whether the cvs pserver interface is enabled for this repository.
 116         See gitlink:git-cvsserver[1].
 117
 118 gitcvs.logfile::
 119         Path to a log file where the cvs pserver interface well... logs
 120         various stuff. See gitlink:git-cvsserver[1].
 121
 122 http.sslVerify::
 123         Whether to verify the SSL certificate when fetching or pushing
 124         over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
 125         variable.
 126
 127 http.sslCert::
 128         File containing the SSL certificate when fetching or pushing
 129         over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
 130         variable.
 131
 132 http.sslKey::
 133         File containing the SSL private key when fetching or pushing
 134         over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
 135         variable.
 136
 137 http.sslCAInfo::
 138         File containing the certificates to verify the peer with when
 139         fetching or pushing over HTTPS. Can be overridden by the
 140         'GIT_SSL_CAINFO' environment variable.
 141
 142 http.sslCAPath::
 143         Path containing files with the CA certificates to verify the peer
 144         with when fetching or pushing over HTTPS. Can be overridden
 145         by the 'GIT_SSL_CAPATH' environment variable.
 146
 147 http.maxRequests::
 148         How many HTTP requests to launch in parallel. Can be overridden
 149         by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
 150
 151 http.lowSpeedLimit, http.lowSpeedTime::
 152         If the HTTP transfer speed is less than 'http.lowSpeedLimit'
 153         for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
 154         Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
 155         'GIT_HTTP_LOW_SPEED_TIME' environment variables.
 156
 157 i18n.commitEncoding::
 158         Character encoding the commit messages are stored in; git itself
 159         does not care per se, but this information is necessary e.g. when
 160         importing commits from emails or in the gitk graphical history
 161         browser (and possibly at other places in the future or in other
 162         porcelains). See e.g. gitlink:git-mailinfo[1]. Defaults to 'utf-8'.
 163
 164 merge.summary::
 165         Whether to include summaries of merged commits in newly created
 166         merge commit messages. False by default.
 167
 168 pull.octopus::
 169         The default merge strategy to use when pulling multiple branches
 170         at once.
 171
 172 pull.twohead::
 173         The default merge strategy to use when pulling a single branch.
 174
 175 show.difftree::
 176         The default gitlink:git-diff-tree[1] arguments to be used
 177         for gitlink:git-show[1].
 178
 179 showbranch.default::
 180         The default set of branches for gitlink:git-show-branch[1].
 181         See gitlink:git-show-branch[1].
 182
 183 user.email::
 184         Your email address to be recorded in any newly created commits.
 185         Can be overridden by the 'GIT_AUTHOR_EMAIL' and 'GIT_COMMITTER_EMAIL'
 186         environment variables.  See gitlink:git-commit-tree[1].
 187
 188 user.name::
 189         Your full name to be recorded in any newly created commits.
 190         Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
 191         environment variables.  See gitlink:git-commit-tree[1].
 192
 193 whatchanged.difftree::
 194         The default gitlink:git-diff-tree[1] arguments to be used
 195         for gitlink:git-whatchanged[1].
 196
 197 imap::
 198         The configuration variables in the 'imap' section are described
 199         in gitlink:git-imap-send[1].