Documentation / config.txton commit git-cvsexportcommit: Add -f(orce) and -m(essage prefix) flags, small cleanups. (992793c)
   1CONFIGURATION FILE
   2------------------
   3
   4The git configuration file contains a number of variables that affect
   5the git commands behaviour. They can be used by both the git plumbing
   6and the porcelains. The variables are divided to 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 commends 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 more detailed description
  39in the appropriate manual page. You will find 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
  56        Can be overriden by the 'GIT_PROXY_COMMAND' environment variable
  57        (which always applies universally, without the special "for"
  58        handling).
  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.onlyUseSymrefs::
  68        Always use the "symref" format instead of symbolic links for HEAD
  69        and other symbolic reference files. True by default.
  70
  71core.repositoryFormatVersion::
  72        Internal variable identifying the repository format and layout
  73        version.
  74
  75core.sharedRepository::
  76        If true, the repository is made shareable between several users
  77        in a group (making sure all the files and objects are group-writable).
  78        See gitlink:git-init-db[1]. False by default.
  79
  80core.warnAmbiguousRefs::
  81        If true, git will warn you if the ref name you passed it is ambiguous
  82        and might match multiple refs in the .git/refs/ tree. True by default.
  83
  84apply.whitespace::
  85        Tells `git-apply` how to handle whitespaces, in the same way
  86        as the '--whitespace' option. See gitlink:git-apply[1].
  87
  88diff.renameLimit::
  89        The number of files to consider when performing the copy/rename
  90        detection; equivalent to the git diff option '-l'.
  91
  92format.headers::
  93        Additional email headers to include in a patch to be submitted
  94        by mail.  See gitlink:git-format-patch[1].
  95
  96gitcvs.enabled::
  97        Whether the cvs pserver interface is enabled for this repository.
  98        See gitlink:git-cvsserver[1].
  99
 100gitcvs.logfile::
 101        Path to a log file where the cvs pserver interface well... logs
 102        various stuff. See gitlink:git-cvsserver[1].
 103
 104http.sslVerify::
 105        Whether to verify the SSL certificate when fetching or pushing
 106        over HTTPS. Can be overriden by the 'GIT_SSL_NO_VERIFY' environment
 107        variable.
 108
 109http.sslCert::
 110        File containing the SSL certificate when fetching or pushing
 111        over HTTPS. Can be overriden by the 'GIT_SSL_CERT' environment
 112        variable.
 113
 114http.sslKey::
 115        File containing the SSL private key when fetching or pushing
 116        over HTTPS. Can be overriden by the 'GIT_SSL_KEY' environment
 117        variable.
 118
 119http.sslCAInfo::
 120        File containing the certificates to verify the peer with when
 121        fetching or pushing over HTTPS. Can be overriden by the
 122        'GIT_SSL_CAINFO' environment variable.
 123
 124http.sslCAPath::
 125        Path containing files with the CA certificates to verify the peer
 126        with when fetching or pushing over HTTPS. Can be overriden
 127        by the 'GIT_SSL_CAPATH' environment variable.
 128
 129http.maxRequests::
 130        How many HTTP requests to launch in parallel. Can be overriden
 131        by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
 132
 133http.lowSpeedLimit, http.lowSpeedTime::
 134        If the HTTP transfer speed is less than 'http.lowSpeedLimit'
 135        for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
 136        Can be overriden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
 137        'GIT_HTTP_LOW_SPEED_TIME' environment variables.
 138
 139i18n.commitEncoding::
 140        Character encoding the commit messages are stored in; git itself
 141        does not care per se, but this information is necessary e.g. when
 142        importing commits from emails or in the gitk graphical history
 143        browser (and possibly at other places in the future or in other
 144        porcelains). See e.g. gitlink:git-mailinfo[1]. Defaults to 'utf-8'.
 145
 146merge.summary::
 147        Whether to include summaries of merged commits in newly created
 148        merge commit messages. False by default.
 149
 150pull.octopus::
 151        The default merge strategy to use when pulling multiple branches
 152        at once.
 153
 154pull.twohead::
 155        The default merge strategy to use when pulling a single branch.
 156
 157show.difftree::
 158        The default gitlink:git-diff-tree[1] arguments to be used
 159        for gitlink:git-show[1].
 160
 161showbranch.default::
 162        The default set of branches for gitlink:git-show-branch[1].
 163        See gitlink:git-show-branch[1].
 164
 165user.email::
 166        Your email address to be recorded in any newly created commits.
 167        Can be overriden by the 'GIT_AUTHOR_EMAIL' and 'GIT_COMMITTER_EMAIL'
 168        environment variables.  See gitlink:git-commit-tree[1].
 169
 170user.name::
 171        Your full name to be recorded in any newly created commits.
 172        Can be overriden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
 173        environment variables.  See gitlink:git-commit-tree[1].
 174
 175whatchanged.difftree::
 176        The default gitlink:git-diff-tree[1] arguments to be used
 177        for gitlink:git-whatchanged[1].
 178
 179imap::
 180        The configuration variables in the 'imap' section are described
 181        in gitlink:git-imap-send[1].