Documentation / config.txton commit git-rm: update to saner semantics (9f95069)
   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
  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
  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.diff::
 149        When true (or `always`), always use colors in patch.
 150        When false (or `never`), never.  When set to `auto`, use
 151        colors only when the output is to the terminal.
 152
 153color.diff.<slot>::
 154        Use customized color for diff colorization.  `<slot>`
 155        specifies which part of the patch to use the specified
 156        color, and is one of `plain` (context text), `meta`
 157        (metainformation), `frag` (hunk header), `old` (removed
 158        lines), or `new` (added lines).  The value for these
 159        configuration variables can be one of: `normal`, `bold`,
 160        `dim`, `ul`, `blink`, `reverse`, `reset`, `black`,
 161        `red`, `green`, `yellow`, `blue`, `magenta`, `cyan`, or
 162        `white`.
 163
 164color.pager::
 165        A boolean to enable/disable colored output when the pager is in
 166        use (default is true).
 167
 168color.status::
 169        A boolean to enable/disable color in the output of
 170        gitlink:git-status[1]. May be set to `true` (or `always`),
 171        `false` (or `never`) or `auto`, in which case colors are used
 172        only when the output is to a terminal. Defaults to false.
 173
 174color.status.<slot>::
 175        Use customized color for status colorization. `<slot>` is
 176        one of `header` (the header text of the status message),
 177        `added` or `updated` (files which are added but not committed),
 178        `changed` (files which are changed but not added in the index),
 179        or `untracked` (files which are not tracked by git). The values of
 180        these variables may be specified as in color.diff.<slot>.
 181
 182diff.renameLimit::
 183        The number of files to consider when performing the copy/rename
 184        detection; equivalent to the git diff option '-l'.
 185
 186diff.renames::
 187        Tells git to detect renames.  If set to any boolean value, it
 188        will enable basic rename detection.  If set to "copies" or
 189        "copy", it will detect copies, as well.
 190
 191format.headers::
 192        Additional email headers to include in a patch to be submitted
 193        by mail.  See gitlink:git-format-patch[1].
 194
 195gitcvs.enabled::
 196        Whether the cvs pserver interface is enabled for this repository.
 197        See gitlink:git-cvsserver[1].
 198
 199gitcvs.logfile::
 200        Path to a log file where the cvs pserver interface well... logs
 201        various stuff. See gitlink:git-cvsserver[1].
 202
 203http.sslVerify::
 204        Whether to verify the SSL certificate when fetching or pushing
 205        over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
 206        variable.
 207
 208http.sslCert::
 209        File containing the SSL certificate when fetching or pushing
 210        over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
 211        variable.
 212
 213http.sslKey::
 214        File containing the SSL private key when fetching or pushing
 215        over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
 216        variable.
 217
 218http.sslCAInfo::
 219        File containing the certificates to verify the peer with when
 220        fetching or pushing over HTTPS. Can be overridden by the
 221        'GIT_SSL_CAINFO' environment variable.
 222
 223http.sslCAPath::
 224        Path containing files with the CA certificates to verify the peer
 225        with when fetching or pushing over HTTPS. Can be overridden
 226        by the 'GIT_SSL_CAPATH' environment variable.
 227
 228http.maxRequests::
 229        How many HTTP requests to launch in parallel. Can be overridden
 230        by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
 231
 232http.lowSpeedLimit, http.lowSpeedTime::
 233        If the HTTP transfer speed is less than 'http.lowSpeedLimit'
 234        for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
 235        Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
 236        'GIT_HTTP_LOW_SPEED_TIME' environment variables.
 237
 238http.noEPSV::
 239        A boolean which disables using of EPSV ftp command by curl.
 240        This can helpful with some "poor" ftp servers which doesn't
 241        support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
 242        environment variable. Default is false (curl will use EPSV).
 243
 244i18n.commitEncoding::
 245        Character encoding the commit messages are stored in; git itself
 246        does not care per se, but this information is necessary e.g. when
 247        importing commits from emails or in the gitk graphical history
 248        browser (and possibly at other places in the future or in other
 249        porcelains). See e.g. gitlink:git-mailinfo[1]. Defaults to 'utf-8'.
 250
 251log.showroot::
 252        If true, the initial commit will be shown as a big creation event.
 253        This is equivalent to a diff against an empty tree.
 254        Tools like gitlink:git-log[1] or gitlink:git-whatchanged[1], which
 255        normally hide the root commit will now show it. True by default.
 256
 257merge.summary::
 258        Whether to include summaries of merged commits in newly created
 259        merge commit messages. False by default.
 260
 261pack.window::
 262        The size of the window used by gitlink:git-pack-objects[1] when no
 263        window size is given on the command line. Defaults to 10.
 264
 265pull.octopus::
 266        The default merge strategy to use when pulling multiple branches
 267        at once.
 268
 269pull.twohead::
 270        The default merge strategy to use when pulling a single branch.
 271
 272remote.<name>.url::
 273        The URL of a remote repository.  See gitlink:git-fetch[1] or
 274        gitlink:git-push[1].
 275
 276remote.<name>.fetch::
 277        The default set of "refspec" for gitlink:git-fetch[1]. See
 278        gitlink:git-fetch[1].
 279
 280remote.<name>.push::
 281        The default set of "refspec" for gitlink:git-push[1]. See
 282        gitlink:git-push[1].
 283
 284repack.usedeltabaseoffset::
 285        Allow gitlink:git-repack[1] to create packs that uses
 286        delta-base offset.  Defaults to false.
 287
 288show.difftree::
 289        The default gitlink:git-diff-tree[1] arguments to be used
 290        for gitlink:git-show[1].
 291
 292showbranch.default::
 293        The default set of branches for gitlink:git-show-branch[1].
 294        See gitlink:git-show-branch[1].
 295
 296tar.umask::
 297        By default, gitlink:git-tar-tree[1] sets file and directories modes
 298        to 0666 or 0777. While this is both useful and acceptable for projects
 299        such as the Linux Kernel, it might be excessive for other projects.
 300        With this variable, it becomes possible to tell
 301        gitlink:git-tar-tree[1] to apply a specific umask to the modes above.
 302        The special value "user" indicates that the user's current umask will
 303        be used. This should be enough for most projects, as it will lead to
 304        the same permissions as gitlink:git-checkout[1] would use. The default
 305        value remains 0, which means world read-write.
 306
 307user.email::
 308        Your email address to be recorded in any newly created commits.
 309        Can be overridden by the 'GIT_AUTHOR_EMAIL' and 'GIT_COMMITTER_EMAIL'
 310        environment variables.  See gitlink:git-commit-tree[1].
 311
 312user.name::
 313        Your full name to be recorded in any newly created commits.
 314        Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
 315        environment variables.  See gitlink:git-commit-tree[1].
 316
 317whatchanged.difftree::
 318        The default gitlink:git-diff-tree[1] arguments to be used
 319        for gitlink:git-whatchanged[1].
 320
 321imap::
 322        The configuration variables in the 'imap' section are described
 323        in gitlink:git-imap-send[1].
 324
 325receive.unpackLimit::
 326        If the number of objects received in a push is below this
 327        limit then the objects will be unpacked into loose object
 328        files. However if the number of received objects equals or
 329        exceeds this limit then the received pack will be stored as
 330        a pack, after adding any missing delta bases.  Storing the
 331        pack from a push can make the push operation complete faster,
 332        especially on slow filesystems.
 333
 334receive.denyNonFastForwards::
 335        If set to true, git-receive-pack will deny a ref update which is
 336        not a fast forward. Use this to prevent such an update via a push,
 337        even if that push is forced. This configuration variable is
 338        set when initializing a shared repository.
 339