Documentation / config.txton commit Sync with maint (8963314)
   1CONFIGURATION FILE
   2------------------
   3
   4The git configuration file contains a number of variables that affect
   5the git command's behavior. The `.git/config` file in each repository
   6is used to store the configuration for that repository, and
   7`$HOME/.gitconfig` is used to store a per-user configuration as
   8fallback values for the `.git/config` file. The file `/etc/gitconfig`
   9can be used to store a system-wide default configuration.
  10
  11The configuration variables are used by both the git plumbing
  12and the porcelains. The variables are divided into sections, wherein
  13the fully qualified variable name of the variable itself is the last
  14dot-separated segment and the section name is everything before the last
  15dot. The variable names are case-insensitive and only alphanumeric
  16characters are allowed. Some variables may appear multiple times.
  17
  18Syntax
  19~~~~~~
  20
  21The syntax is fairly flexible and permissive; whitespaces are mostly
  22ignored.  The '#' and ';' characters begin comments to the end of line,
  23blank lines are ignored.
  24
  25The file consists of sections and variables.  A section begins with
  26the name of the section in square brackets and continues until the next
  27section begins.  Section names are not case sensitive.  Only alphanumeric
  28characters, `-` and `.` are allowed in section names.  Each variable
  29must belong to some section, which means that there must be a section
  30header before the first setting of a variable.
  31
  32Sections can be further divided into subsections.  To begin a subsection
  33put its name in double quotes, separated by space from the section name,
  34in the section header, like in the example below:
  35
  36--------
  37        [section "subsection"]
  38
  39--------
  40
  41Subsection names are case sensitive and can contain any characters except
  42newline (doublequote `"` and backslash have to be escaped as `\"` and `\\`,
  43respectively).  Section headers cannot span multiple
  44lines.  Variables may belong directly to a section or to a given subsection.
  45You can have `[section]` if you have `[section "subsection"]`, but you
  46don't need to.
  47
  48There is also a case insensitive alternative `[section.subsection]` syntax.
  49In this syntax, subsection names follow the same restrictions as for section
  50names.
  51
  52All the other lines (and the remainder of the line after the section
  53header) are recognized as setting variables, in the form
  54'name = value'.  If there is no equal sign on the line, the entire line
  55is taken as 'name' and the variable is recognized as boolean "true".
  56The variable names are case-insensitive and only alphanumeric
  57characters and `-` are allowed.  There can be more than one value
  58for a given variable; we say then that variable is multivalued.
  59
  60Leading and trailing whitespace in a variable value is discarded.
  61Internal whitespace within a variable value is retained verbatim.
  62
  63The values following the equals sign in variable assign are all either
  64a string, an integer, or a boolean.  Boolean values may be given as yes/no,
  651/0, true/false or on/off.  Case is not significant in boolean values, when
  66converting value to the canonical form using '--bool' type specifier;
  67'git config' will ensure that the output is "true" or "false".
  68
  69String values may be entirely or partially enclosed in double quotes.
  70You need to enclose variable values in double quotes if you want to
  71preserve leading or trailing whitespace, or if the variable value contains
  72comment characters (i.e. it contains '#' or ';').
  73Double quote `"` and backslash `\` characters in variable values must
  74be escaped: use `\"` for `"` and `\\` for `\`.
  75
  76The following escape sequences (beside `\"` and `\\`) are recognized:
  77`\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
  78and `\b` for backspace (BS).  No other char escape sequence, nor octal
  79char sequences are valid.
  80
  81Variable values ending in a `\` are continued on the next line in the
  82customary UNIX fashion.
  83
  84Some variables may require a special value format.
  85
  86Example
  87~~~~~~~
  88
  89        # Core variables
  90        [core]
  91                ; Don't trust file modes
  92                filemode = false
  93
  94        # Our diff algorithm
  95        [diff]
  96                external = /usr/local/bin/diff-wrapper
  97                renames = true
  98
  99        [branch "devel"]
 100                remote = origin
 101                merge = refs/heads/devel
 102
 103        # Proxy settings
 104        [core]
 105                gitProxy="ssh" for "kernel.org"
 106                gitProxy=default-proxy ; for the rest
 107
 108Variables
 109~~~~~~~~~
 110
 111Note that this list is non-comprehensive and not necessarily complete.
 112For command-specific variables, you will find a more detailed description
 113in the appropriate manual page. You will find a description of non-core
 114porcelain configuration variables in the respective porcelain documentation.
 115
 116advice.*::
 117        When set to 'true', display the given optional help message.
 118        When set to 'false', do not display. The configuration variables
 119        are:
 120+
 121--
 122        pushNonFastForward::
 123                Advice shown when linkgit:git-push[1] refuses
 124                non-fast-forward refs. Default: true.
 125        statusHints::
 126                Directions on how to stage/unstage/add shown in the
 127                output of linkgit:git-status[1] and the template shown
 128                when writing commit messages. Default: true.
 129        commitBeforeMerge::
 130                Advice shown when linkgit:git-merge[1] refuses to
 131                merge to avoid overwriting local changes.
 132                Default: true.
 133        resolveConflict::
 134                Advices shown by various commands when conflicts
 135                prevent the operation from being performed.
 136                Default: true.
 137        implicitIdentity::
 138                Advice on how to set your identity configuration when
 139                your information is guessed from the system username and
 140                domain name. Default: true.
 141
 142        detachedHead::
 143                Advice shown when you used linkgit::git-checkout[1] to
 144                move to the detach HEAD state, to instruct how to create
 145                a local branch after the fact.  Default: true.
 146--
 147
 148core.fileMode::
 149        If false, the executable bit differences between the index and
 150        the working tree are ignored; useful on broken filesystems like FAT.
 151        See linkgit:git-update-index[1].
 152+
 153The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
 154will probe and set core.fileMode false if appropriate when the
 155repository is created.
 156
 157core.ignoreCygwinFSTricks::
 158        This option is only used by Cygwin implementation of Git. If false,
 159        the Cygwin stat() and lstat() functions are used. This may be useful
 160        if your repository consists of a few separate directories joined in
 161        one hierarchy using Cygwin mount. If true, Git uses native Win32 API
 162        whenever it is possible and falls back to Cygwin functions only to
 163        handle symbol links. The native mode is more than twice faster than
 164        normal Cygwin l/stat() functions. True by default, unless core.filemode
 165        is true, in which case ignoreCygwinFSTricks is ignored as Cygwin's
 166        POSIX emulation is required to support core.filemode.
 167
 168core.ignorecase::
 169        If true, this option enables various workarounds to enable
 170        git to work better on filesystems that are not case sensitive,
 171        like FAT. For example, if a directory listing finds
 172        "makefile" when git expects "Makefile", git will assume
 173        it is really the same file, and continue to remember it as
 174        "Makefile".
 175+
 176The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
 177will probe and set core.ignorecase true if appropriate when the repository
 178is created.
 179
 180core.trustctime::
 181        If false, the ctime differences between the index and the
 182        working tree are ignored; useful when the inode change time
 183        is regularly modified by something outside Git (file system
 184        crawlers and some backup systems).
 185        See linkgit:git-update-index[1]. True by default.
 186
 187core.quotepath::
 188        The commands that output paths (e.g. 'ls-files',
 189        'diff'), when not given the `-z` option, will quote
 190        "unusual" characters in the pathname by enclosing the
 191        pathname in a double-quote pair and with backslashes the
 192        same way strings in C source code are quoted.  If this
 193        variable is set to false, the bytes higher than 0x80 are
 194        not quoted but output as verbatim.  Note that double
 195        quote, backslash and control characters are always
 196        quoted without `-z` regardless of the setting of this
 197        variable.
 198
 199core.eol::
 200        Sets the line ending type to use in the working directory for
 201        files that have the `text` property set.  Alternatives are
 202        'lf', 'crlf' and 'native', which uses the platform's native
 203        line ending.  The default value is `native`.  See
 204        linkgit:gitattributes[5] for more information on end-of-line
 205        conversion.
 206
 207core.safecrlf::
 208        If true, makes git check if converting `CRLF` is reversible when
 209        end-of-line conversion is active.  Git will verify if a command
 210        modifies a file in the work tree either directly or indirectly.
 211        For example, committing a file followed by checking out the
 212        same file should yield the original file in the work tree.  If
 213        this is not the case for the current setting of
 214        `core.autocrlf`, git will reject the file.  The variable can
 215        be set to "warn", in which case git will only warn about an
 216        irreversible conversion but continue the operation.
 217+
 218CRLF conversion bears a slight chance of corrupting data.
 219When it is enabled, git will convert CRLF to LF during commit and LF to
 220CRLF during checkout.  A file that contains a mixture of LF and
 221CRLF before the commit cannot be recreated by git.  For text
 222files this is the right thing to do: it corrects line endings
 223such that we have only LF line endings in the repository.
 224But for binary files that are accidentally classified as text the
 225conversion can corrupt data.
 226+
 227If you recognize such corruption early you can easily fix it by
 228setting the conversion type explicitly in .gitattributes.  Right
 229after committing you still have the original file in your work
 230tree and this file is not yet corrupted.  You can explicitly tell
 231git that this file is binary and git will handle the file
 232appropriately.
 233+
 234Unfortunately, the desired effect of cleaning up text files with
 235mixed line endings and the undesired effect of corrupting binary
 236files cannot be distinguished.  In both cases CRLFs are removed
 237in an irreversible way.  For text files this is the right thing
 238to do because CRLFs are line endings, while for binary files
 239converting CRLFs corrupts data.
 240+
 241Note, this safety check does not mean that a checkout will generate a
 242file identical to the original file for a different setting of
 243`core.eol` and `core.autocrlf`, but only for the current one.  For
 244example, a text file with `LF` would be accepted with `core.eol=lf`
 245and could later be checked out with `core.eol=crlf`, in which case the
 246resulting file would contain `CRLF`, although the original file
 247contained `LF`.  However, in both work trees the line endings would be
 248consistent, that is either all `LF` or all `CRLF`, but never mixed.  A
 249file with mixed line endings would be reported by the `core.safecrlf`
 250mechanism.
 251
 252core.autocrlf::
 253        Setting this variable to "true" is almost the same as setting
 254        the `text` attribute to "auto" on all files except that text
 255        files are not guaranteed to be normalized: files that contain
 256        `CRLF` in the repository will not be touched.  Use this
 257        setting if you want to have `CRLF` line endings in your
 258        working directory even though the repository does not have
 259        normalized line endings.  This variable can be set to 'input',
 260        in which case no output conversion is performed.
 261
 262core.symlinks::
 263        If false, symbolic links are checked out as small plain files that
 264        contain the link text. linkgit:git-update-index[1] and
 265        linkgit:git-add[1] will not change the recorded type to regular
 266        file. Useful on filesystems like FAT that do not support
 267        symbolic links.
 268+
 269The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
 270will probe and set core.symlinks false if appropriate when the repository
 271is created.
 272
 273core.gitProxy::
 274        A "proxy command" to execute (as 'command host port') instead
 275        of establishing direct connection to the remote server when
 276        using the git protocol for fetching. If the variable value is
 277        in the "COMMAND for DOMAIN" format, the command is applied only
 278        on hostnames ending with the specified domain string. This variable
 279        may be set multiple times and is matched in the given order;
 280        the first match wins.
 281+
 282Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
 283(which always applies universally, without the special "for"
 284handling).
 285+
 286The special string `none` can be used as the proxy command to
 287specify that no proxy be used for a given domain pattern.
 288This is useful for excluding servers inside a firewall from
 289proxy use, while defaulting to a common proxy for external domains.
 290
 291core.ignoreStat::
 292        If true, commands which modify both the working tree and the index
 293        will mark the updated paths with the "assume unchanged" bit in the
 294        index. These marked files are then assumed to stay unchanged in the
 295        working tree, until you mark them otherwise manually - Git will not
 296        detect the file changes by lstat() calls. This is useful on systems
 297        where those are very slow, such as Microsoft Windows.
 298        See linkgit:git-update-index[1].
 299        False by default.
 300
 301core.preferSymlinkRefs::
 302        Instead of the default "symref" format for HEAD
 303        and other symbolic reference files, use symbolic links.
 304        This is sometimes needed to work with old scripts that
 305        expect HEAD to be a symbolic link.
 306
 307core.bare::
 308        If true this repository is assumed to be 'bare' and has no
 309        working directory associated with it.  If this is the case a
 310        number of commands that require a working directory will be
 311        disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
 312+
 313This setting is automatically guessed by linkgit:git-clone[1] or
 314linkgit:git-init[1] when the repository was created.  By default a
 315repository that ends in "/.git" is assumed to be not bare (bare =
 316false), while all other repositories are assumed to be bare (bare
 317= true).
 318
 319core.worktree::
 320        Set the path to the root of the working tree.
 321        This can be overridden by the GIT_WORK_TREE environment
 322        variable and the '--work-tree' command line option.
 323        The value can be an absolute path or relative to the path to
 324        the .git directory, which is either specified by --git-dir
 325        or GIT_DIR, or automatically discovered.
 326        If --git-dir or GIT_DIR is specified but none of
 327        --work-tree, GIT_WORK_TREE and core.worktree is specified,
 328        the current working directory is regarded as the top level
 329        of your working tree.
 330+
 331Note that this variable is honored even when set in a configuration
 332file in a ".git" subdirectory of a directory and its value differs
 333from the latter directory (e.g. "/path/to/.git/config" has
 334core.worktree set to "/different/path"), which is most likely a
 335misconfiguration.  Running git commands in the "/path/to" directory will
 336still use "/different/path" as the root of the work tree and can cause
 337confusion unless you know what you are doing (e.g. you are creating a
 338read-only snapshot of the same index to a location different from the
 339repository's usual working tree).
 340
 341core.logAllRefUpdates::
 342        Enable the reflog. Updates to a ref <ref> is logged to the file
 343        "$GIT_DIR/logs/<ref>", by appending the new and old
 344        SHA1, the date/time and the reason of the update, but
 345        only when the file exists.  If this configuration
 346        variable is set to true, missing "$GIT_DIR/logs/<ref>"
 347        file is automatically created for branch heads (i.e. under
 348        refs/heads/), remote refs (i.e. under refs/remotes/),
 349        note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
 350+
 351This information can be used to determine what commit
 352was the tip of a branch "2 days ago".
 353+
 354This value is true by default in a repository that has
 355a working directory associated with it, and false by
 356default in a bare repository.
 357
 358core.repositoryFormatVersion::
 359        Internal variable identifying the repository format and layout
 360        version.
 361
 362core.sharedRepository::
 363        When 'group' (or 'true'), the repository is made shareable between
 364        several users in a group (making sure all the files and objects are
 365        group-writable). When 'all' (or 'world' or 'everybody'), the
 366        repository will be readable by all users, additionally to being
 367        group-shareable. When 'umask' (or 'false'), git will use permissions
 368        reported by umask(2). When '0xxx', where '0xxx' is an octal number,
 369        files in the repository will have this mode value. '0xxx' will override
 370        user's umask value (whereas the other options will only override
 371        requested parts of the user's umask value). Examples: '0660' will make
 372        the repo read/write-able for the owner and group, but inaccessible to
 373        others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
 374        repository that is group-readable but not group-writable.
 375        See linkgit:git-init[1]. False by default.
 376
 377core.warnAmbiguousRefs::
 378        If true, git will warn you if the ref name you passed it is ambiguous
 379        and might match multiple refs in the .git/refs/ tree. True by default.
 380
 381core.compression::
 382        An integer -1..9, indicating a default compression level.
 383        -1 is the zlib default. 0 means no compression,
 384        and 1..9 are various speed/size tradeoffs, 9 being slowest.
 385        If set, this provides a default to other compression variables,
 386        such as 'core.loosecompression' and 'pack.compression'.
 387
 388core.loosecompression::
 389        An integer -1..9, indicating the compression level for objects that
 390        are not in a pack file. -1 is the zlib default. 0 means no
 391        compression, and 1..9 are various speed/size tradeoffs, 9 being
 392        slowest.  If not set,  defaults to core.compression.  If that is
 393        not set,  defaults to 1 (best speed).
 394
 395core.packedGitWindowSize::
 396        Number of bytes of a pack file to map into memory in a
 397        single mapping operation.  Larger window sizes may allow
 398        your system to process a smaller number of large pack files
 399        more quickly.  Smaller window sizes will negatively affect
 400        performance due to increased calls to the operating system's
 401        memory manager, but may improve performance when accessing
 402        a large number of large pack files.
 403+
 404Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
 405MiB on 32 bit platforms and 1 GiB on 64 bit platforms.  This should
 406be reasonable for all users/operating systems.  You probably do
 407not need to adjust this value.
 408+
 409Common unit suffixes of 'k', 'm', or 'g' are supported.
 410
 411core.packedGitLimit::
 412        Maximum number of bytes to map simultaneously into memory
 413        from pack files.  If Git needs to access more than this many
 414        bytes at once to complete an operation it will unmap existing
 415        regions to reclaim virtual address space within the process.
 416+
 417Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
 418This should be reasonable for all users/operating systems, except on
 419the largest projects.  You probably do not need to adjust this value.
 420+
 421Common unit suffixes of 'k', 'm', or 'g' are supported.
 422
 423core.deltaBaseCacheLimit::
 424        Maximum number of bytes to reserve for caching base objects
 425        that may be referenced by multiple deltified objects.  By storing the
 426        entire decompressed base objects in a cache Git is able
 427        to avoid unpacking and decompressing frequently used base
 428        objects multiple times.
 429+
 430Default is 16 MiB on all platforms.  This should be reasonable
 431for all users/operating systems, except on the largest projects.
 432You probably do not need to adjust this value.
 433+
 434Common unit suffixes of 'k', 'm', or 'g' are supported.
 435
 436core.bigFileThreshold::
 437        Files larger than this size are stored deflated, without
 438        attempting delta compression.  Storing large files without
 439        delta compression avoids excessive memory usage, at the
 440        slight expense of increased disk usage.
 441+
 442Default is 512 MiB on all platforms.  This should be reasonable
 443for most projects as source code and other text files can still
 444be delta compressed, but larger binary media files won't be.
 445+
 446Common unit suffixes of 'k', 'm', or 'g' are supported.
 447
 448core.excludesfile::
 449        In addition to '.gitignore' (per-directory) and
 450        '.git/info/exclude', git looks into this file for patterns
 451        of files which are not meant to be tracked.  "{tilde}/" is expanded
 452        to the value of `$HOME` and "{tilde}user/" to the specified user's
 453        home directory.  See linkgit:gitignore[5].
 454
 455core.askpass::
 456        Some commands (e.g. svn and http interfaces) that interactively
 457        ask for a password can be told to use an external program given
 458        via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
 459        environment variable. If not set, fall back to the value of the
 460        'SSH_ASKPASS' environment variable or, failing that, a simple password
 461        prompt. The external program shall be given a suitable prompt as
 462        command line argument and write the password on its STDOUT.
 463
 464core.attributesfile::
 465        In addition to '.gitattributes' (per-directory) and
 466        '.git/info/attributes', git looks into this file for attributes
 467        (see linkgit:gitattributes[5]). Path expansions are made the same
 468        way as for `core.excludesfile`.
 469
 470core.editor::
 471        Commands such as `commit` and `tag` that lets you edit
 472        messages by launching an editor uses the value of this
 473        variable when it is set, and the environment variable
 474        `GIT_EDITOR` is not set.  See linkgit:git-var[1].
 475
 476core.pager::
 477        The command that git will use to paginate output.  Can
 478        be overridden with the `GIT_PAGER` environment
 479        variable.  Note that git sets the `LESS` environment
 480        variable to `FRSX` if it is unset when it runs the
 481        pager.  One can change these settings by setting the
 482        `LESS` variable to some other value.  Alternately,
 483        these settings can be overridden on a project or
 484        global basis by setting the `core.pager` option.
 485        Setting `core.pager` has no affect on the `LESS`
 486        environment variable behaviour above, so if you want
 487        to override git's default settings this way, you need
 488        to be explicit.  For example, to disable the S option
 489        in a backward compatible manner, set `core.pager`
 490        to `less -+$LESS -FRX`.  This will be passed to the
 491        shell by git, which will translate the final command to
 492        `LESS=FRSX less -+FRSX -FRX`.
 493
 494core.whitespace::
 495        A comma separated list of common whitespace problems to
 496        notice.  'git diff' will use `color.diff.whitespace` to
 497        highlight them, and 'git apply --whitespace=error' will
 498        consider them as errors.  You can prefix `-` to disable
 499        any of them (e.g. `-trailing-space`):
 500+
 501* `blank-at-eol` treats trailing whitespaces at the end of the line
 502  as an error (enabled by default).
 503* `space-before-tab` treats a space character that appears immediately
 504  before a tab character in the initial indent part of the line as an
 505  error (enabled by default).
 506* `indent-with-non-tab` treats a line that is indented with 8 or more
 507  space characters as an error (not enabled by default).
 508* `tab-in-indent` treats a tab character in the initial indent part of
 509  the line as an error (not enabled by default).
 510* `blank-at-eof` treats blank lines added at the end of file as an error
 511  (enabled by default).
 512* `trailing-space` is a short-hand to cover both `blank-at-eol` and
 513  `blank-at-eof`.
 514* `cr-at-eol` treats a carriage-return at the end of line as
 515  part of the line terminator, i.e. with it, `trailing-space`
 516  does not trigger if the character before such a carriage-return
 517  is not a whitespace (not enabled by default).
 518* `tabwidth=<n>` tells how many character positions a tab occupies; this
 519  is relevant for `indent-with-non-tab` and when git fixes `tab-in-indent`
 520  errors. The default tab width is 8. Allowed values are 1 to 63.
 521
 522core.fsyncobjectfiles::
 523        This boolean will enable 'fsync()' when writing object files.
 524+
 525This is a total waste of time and effort on a filesystem that orders
 526data writes properly, but can be useful for filesystems that do not use
 527journalling (traditional UNIX filesystems) or that only journal metadata
 528and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
 529
 530core.preloadindex::
 531        Enable parallel index preload for operations like 'git diff'
 532+
 533This can speed up operations like 'git diff' and 'git status' especially
 534on filesystems like NFS that have weak caching semantics and thus
 535relatively high IO latencies.  With this set to 'true', git will do the
 536index comparison to the filesystem data in parallel, allowing
 537overlapping IO's.
 538
 539core.createObject::
 540        You can set this to 'link', in which case a hardlink followed by
 541        a delete of the source are used to make sure that object creation
 542        will not overwrite existing objects.
 543+
 544On some file system/operating system combinations, this is unreliable.
 545Set this config setting to 'rename' there; However, This will remove the
 546check that makes sure that existing object files will not get overwritten.
 547
 548core.notesRef::
 549        When showing commit messages, also show notes which are stored in
 550        the given ref.  The ref must be fully qualified.  If the given
 551        ref does not exist, it is not an error but means that no
 552        notes should be printed.
 553+
 554This setting defaults to "refs/notes/commits", and it can be overridden by
 555the 'GIT_NOTES_REF' environment variable.  See linkgit:git-notes[1].
 556
 557core.sparseCheckout::
 558        Enable "sparse checkout" feature. See section "Sparse checkout" in
 559        linkgit:git-read-tree[1] for more information.
 560
 561core.abbrev::
 562        Set the length object names are abbreviated to.  If unspecified,
 563        many commands abbreviate to 7 hexdigits, which may not be enough
 564        for abbreviated object names to stay unique for sufficiently long
 565        time.
 566
 567add.ignore-errors::
 568add.ignoreErrors::
 569        Tells 'git add' to continue adding files when some files cannot be
 570        added due to indexing errors. Equivalent to the '--ignore-errors'
 571        option of linkgit:git-add[1].  Older versions of git accept only
 572        `add.ignore-errors`, which does not follow the usual naming
 573        convention for configuration variables.  Newer versions of git
 574        honor `add.ignoreErrors` as well.
 575
 576alias.*::
 577        Command aliases for the linkgit:git[1] command wrapper - e.g.
 578        after defining "alias.last = cat-file commit HEAD", the invocation
 579        "git last" is equivalent to "git cat-file commit HEAD". To avoid
 580        confusion and troubles with script usage, aliases that
 581        hide existing git commands are ignored. Arguments are split by
 582        spaces, the usual shell quoting and escaping is supported.
 583        quote pair and a backslash can be used to quote them.
 584+
 585If the alias expansion is prefixed with an exclamation point,
 586it will be treated as a shell command.  For example, defining
 587"alias.new = !gitk --all --not ORIG_HEAD", the invocation
 588"git new" is equivalent to running the shell command
 589"gitk --all --not ORIG_HEAD".  Note that shell commands will be
 590executed from the top-level directory of a repository, which may
 591not necessarily be the current directory.
 592'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
 593from the original current directory. See linkgit:git-rev-parse[1].
 594
 595am.keepcr::
 596        If true, git-am will call git-mailsplit for patches in mbox format
 597        with parameter '--keep-cr'. In this case git-mailsplit will
 598        not remove `\r` from lines ending with `\r\n`. Can be overridden
 599        by giving '--no-keep-cr' from the command line.
 600        See linkgit:git-am[1], linkgit:git-mailsplit[1].
 601
 602apply.ignorewhitespace::
 603        When set to 'change', tells 'git apply' to ignore changes in
 604        whitespace, in the same way as the '--ignore-space-change'
 605        option.
 606        When set to one of: no, none, never, false tells 'git apply' to
 607        respect all whitespace differences.
 608        See linkgit:git-apply[1].
 609
 610apply.whitespace::
 611        Tells 'git apply' how to handle whitespaces, in the same way
 612        as the '--whitespace' option. See linkgit:git-apply[1].
 613
 614branch.autosetupmerge::
 615        Tells 'git branch' and 'git checkout' to set up new branches
 616        so that linkgit:git-pull[1] will appropriately merge from the
 617        starting point branch. Note that even if this option is not set,
 618        this behavior can be chosen per-branch using the `--track`
 619        and `--no-track` options. The valid settings are: `false` -- no
 620        automatic setup is done; `true` -- automatic setup is done when the
 621        starting point is a remote-tracking branch; `always` --
 622        automatic setup is done when the starting point is either a
 623        local branch or remote-tracking
 624        branch. This option defaults to true.
 625
 626branch.autosetuprebase::
 627        When a new branch is created with 'git branch' or 'git checkout'
 628        that tracks another branch, this variable tells git to set
 629        up pull to rebase instead of merge (see "branch.<name>.rebase").
 630        When `never`, rebase is never automatically set to true.
 631        When `local`, rebase is set to true for tracked branches of
 632        other local branches.
 633        When `remote`, rebase is set to true for tracked branches of
 634        remote-tracking branches.
 635        When `always`, rebase will be set to true for all tracking
 636        branches.
 637        See "branch.autosetupmerge" for details on how to set up a
 638        branch to track another branch.
 639        This option defaults to never.
 640
 641branch.<name>.remote::
 642        When in branch <name>, it tells 'git fetch' and 'git push' which
 643        remote to fetch from/push to.  It defaults to `origin` if no remote is
 644        configured. `origin` is also used if you are not on any branch.
 645
 646branch.<name>.merge::
 647        Defines, together with branch.<name>.remote, the upstream branch
 648        for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
 649        branch to merge and can also affect 'git push' (see push.default).
 650        When in branch <name>, it tells 'git fetch' the default
 651        refspec to be marked for merging in FETCH_HEAD. The value is
 652        handled like the remote part of a refspec, and must match a
 653        ref which is fetched from the remote given by
 654        "branch.<name>.remote".
 655        The merge information is used by 'git pull' (which at first calls
 656        'git fetch') to lookup the default branch for merging. Without
 657        this option, 'git pull' defaults to merge the first refspec fetched.
 658        Specify multiple values to get an octopus merge.
 659        If you wish to setup 'git pull' so that it merges into <name> from
 660        another branch in the local repository, you can point
 661        branch.<name>.merge to the desired branch, and use the special setting
 662        `.` (a period) for branch.<name>.remote.
 663
 664branch.<name>.mergeoptions::
 665        Sets default options for merging into branch <name>. The syntax and
 666        supported options are the same as those of linkgit:git-merge[1], but
 667        option values containing whitespace characters are currently not
 668        supported.
 669
 670branch.<name>.rebase::
 671        When true, rebase the branch <name> on top of the fetched branch,
 672        instead of merging the default branch from the default remote when
 673        "git pull" is run.
 674        *NOTE*: this is a possibly dangerous operation; do *not* use
 675        it unless you understand the implications (see linkgit:git-rebase[1]
 676        for details).
 677
 678browser.<tool>.cmd::
 679        Specify the command to invoke the specified browser. The
 680        specified command is evaluated in shell with the URLs passed
 681        as arguments. (See linkgit:git-web{litdd}browse[1].)
 682
 683browser.<tool>.path::
 684        Override the path for the given tool that may be used to
 685        browse HTML help (see '-w' option in linkgit:git-help[1]) or a
 686        working repository in gitweb (see linkgit:git-instaweb[1]).
 687
 688clean.requireForce::
 689        A boolean to make git-clean do nothing unless given -f
 690        or -n.   Defaults to true.
 691
 692color.branch::
 693        A boolean to enable/disable color in the output of
 694        linkgit:git-branch[1]. May be set to `always`,
 695        `false` (or `never`) or `auto` (or `true`), in which case colors are used
 696        only when the output is to a terminal. Defaults to false.
 697
 698color.branch.<slot>::
 699        Use customized color for branch coloration. `<slot>` is one of
 700        `current` (the current branch), `local` (a local branch),
 701        `remote` (a remote-tracking branch in refs/remotes/), `plain` (other
 702        refs).
 703+
 704The value for these configuration variables is a list of colors (at most
 705two) and attributes (at most one), separated by spaces.  The colors
 706accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
 707`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
 708`blink` and `reverse`.  The first color given is the foreground; the
 709second is the background.  The position of the attribute, if any,
 710doesn't matter.
 711
 712color.diff::
 713        Whether to use ANSI escape sequences to add color to patches.
 714        If this is set to `always`, linkgit:git-diff[1],
 715        linkgit:git-log[1], and linkgit:git-show[1] will use color
 716        for all patches.  If it is set to `true` or `auto`, those
 717        commands will only use color when output is to the terminal.
 718        Defaults to false.
 719+
 720This does not affect linkgit:git-format-patch[1] nor the
 721'git-diff-{asterisk}' plumbing commands.  Can be overridden on the
 722command line with the `--color[=<when>]` option.
 723
 724color.diff.<slot>::
 725        Use customized color for diff colorization.  `<slot>` specifies
 726        which part of the patch to use the specified color, and is one
 727        of `plain` (context text), `meta` (metainformation), `frag`
 728        (hunk header), 'func' (function in hunk header), `old` (removed lines),
 729        `new` (added lines), `commit` (commit headers), or `whitespace`
 730        (highlighting whitespace errors). The values of these variables may be
 731        specified as in color.branch.<slot>.
 732
 733color.decorate.<slot>::
 734        Use customized color for 'git log --decorate' output.  `<slot>` is one
 735        of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
 736        branches, remote-tracking branches, tags, stash and HEAD, respectively.
 737
 738color.grep::
 739        When set to `always`, always highlight matches.  When `false` (or
 740        `never`), never.  When set to `true` or `auto`, use color only
 741        when the output is written to the terminal.  Defaults to `false`.
 742
 743color.grep.<slot>::
 744        Use customized color for grep colorization.  `<slot>` specifies which
 745        part of the line to use the specified color, and is one of
 746+
 747--
 748`context`;;
 749        non-matching text in context lines (when using `-A`, `-B`, or `-C`)
 750`filename`;;
 751        filename prefix (when not using `-h`)
 752`function`;;
 753        function name lines (when using `-p`)
 754`linenumber`;;
 755        line number prefix (when using `-n`)
 756`match`;;
 757        matching text
 758`selected`;;
 759        non-matching text in selected lines
 760`separator`;;
 761        separators between fields on a line (`:`, `-`, and `=`)
 762        and between hunks (`--`)
 763--
 764+
 765The values of these variables may be specified as in color.branch.<slot>.
 766
 767color.interactive::
 768        When set to `always`, always use colors for interactive prompts
 769        and displays (such as those used by "git-add --interactive").
 770        When false (or `never`), never.  When set to `true` or `auto`, use
 771        colors only when the output is to the terminal. Defaults to false.
 772
 773color.interactive.<slot>::
 774        Use customized color for 'git add --interactive'
 775        output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
 776        four distinct types of normal output from interactive
 777        commands.  The values of these variables may be specified as
 778        in color.branch.<slot>.
 779
 780color.pager::
 781        A boolean to enable/disable colored output when the pager is in
 782        use (default is true).
 783
 784color.showbranch::
 785        A boolean to enable/disable color in the output of
 786        linkgit:git-show-branch[1]. May be set to `always`,
 787        `false` (or `never`) or `auto` (or `true`), in which case colors are used
 788        only when the output is to a terminal. Defaults to false.
 789
 790color.status::
 791        A boolean to enable/disable color in the output of
 792        linkgit:git-status[1]. May be set to `always`,
 793        `false` (or `never`) or `auto` (or `true`), in which case colors are used
 794        only when the output is to a terminal. Defaults to false.
 795
 796color.status.<slot>::
 797        Use customized color for status colorization. `<slot>` is
 798        one of `header` (the header text of the status message),
 799        `added` or `updated` (files which are added but not committed),
 800        `changed` (files which are changed but not added in the index),
 801        `untracked` (files which are not tracked by git),
 802        `branch` (the current branch), or
 803        `nobranch` (the color the 'no branch' warning is shown in, defaulting
 804        to red). The values of these variables may be specified as in
 805        color.branch.<slot>.
 806
 807color.ui::
 808        This variable determines the default value for variables such
 809        as `color.diff` and `color.grep` that control the use of color
 810        per command family. Its scope will expand as more commands learn
 811        configuration to set a default for the `--color` option.  Set it
 812        to `always` if you want all output not intended for machine
 813        consumption to use color, to `true` or `auto` if you want such
 814        output to use color when written to the terminal, or to `false` or
 815        `never` if you prefer git commands not to use color unless enabled
 816        explicitly with some other configuration or the `--color` option.
 817
 818commit.status::
 819        A boolean to enable/disable inclusion of status information in the
 820        commit message template when using an editor to prepare the commit
 821        message.  Defaults to true.
 822
 823commit.template::
 824        Specify a file to use as the template for new commit messages.
 825        "{tilde}/" is expanded to the value of `$HOME` and "{tilde}user/" to the
 826        specified user's home directory.
 827
 828include::diff-config.txt[]
 829
 830difftool.<tool>.path::
 831        Override the path for the given tool.  This is useful in case
 832        your tool is not in the PATH.
 833
 834difftool.<tool>.cmd::
 835        Specify the command to invoke the specified diff tool.
 836        The specified command is evaluated in shell with the following
 837        variables available:  'LOCAL' is set to the name of the temporary
 838        file containing the contents of the diff pre-image and 'REMOTE'
 839        is set to the name of the temporary file containing the contents
 840        of the diff post-image.
 841
 842difftool.prompt::
 843        Prompt before each invocation of the diff tool.
 844
 845diff.wordRegex::
 846        A POSIX Extended Regular Expression used to determine what is a "word"
 847        when performing word-by-word difference calculations.  Character
 848        sequences that match the regular expression are "words", all other
 849        characters are *ignorable* whitespace.
 850
 851fetch.recurseSubmodules::
 852        This option can be either set to a boolean value or to 'on-demand'.
 853        Setting it to a boolean changes the behavior of fetch and pull to
 854        unconditionally recurse into submodules when set to true or to not
 855        recurse at all when set to false. When set to 'on-demand' (the default
 856        value), fetch and pull will only recurse into a populated submodule
 857        when its superproject retrieves a commit that updates the submodule's
 858        reference.
 859
 860fetch.fsckObjects::
 861        If it is set to true, git-fetch-pack will check all fetched
 862        objects. It will abort in the case of a malformed object or a
 863        broken link. The result of an abort are only dangling objects.
 864        Defaults to false. If not set, the value of `transfer.fsckObjects`
 865        is used instead.
 866
 867fetch.unpackLimit::
 868        If the number of objects fetched over the git native
 869        transfer is below this
 870        limit, then the objects will be unpacked into loose object
 871        files. However if the number of received objects equals or
 872        exceeds this limit then the received pack will be stored as
 873        a pack, after adding any missing delta bases.  Storing the
 874        pack from a push can make the push operation complete faster,
 875        especially on slow filesystems.  If not set, the value of
 876        `transfer.unpackLimit` is used instead.
 877
 878format.attach::
 879        Enable multipart/mixed attachments as the default for
 880        'format-patch'.  The value can also be a double quoted string
 881        which will enable attachments as the default and set the
 882        value as the boundary.  See the --attach option in
 883        linkgit:git-format-patch[1].
 884
 885format.numbered::
 886        A boolean which can enable or disable sequence numbers in patch
 887        subjects.  It defaults to "auto" which enables it only if there
 888        is more than one patch.  It can be enabled or disabled for all
 889        messages by setting it to "true" or "false".  See --numbered
 890        option in linkgit:git-format-patch[1].
 891
 892format.headers::
 893        Additional email headers to include in a patch to be submitted
 894        by mail.  See linkgit:git-format-patch[1].
 895
 896format.to::
 897format.cc::
 898        Additional recipients to include in a patch to be submitted
 899        by mail.  See the --to and --cc options in
 900        linkgit:git-format-patch[1].
 901
 902format.subjectprefix::
 903        The default for format-patch is to output files with the '[PATCH]'
 904        subject prefix. Use this variable to change that prefix.
 905
 906format.signature::
 907        The default for format-patch is to output a signature containing
 908        the git version number. Use this variable to change that default.
 909        Set this variable to the empty string ("") to suppress
 910        signature generation.
 911
 912format.suffix::
 913        The default for format-patch is to output files with the suffix
 914        `.patch`. Use this variable to change that suffix (make sure to
 915        include the dot if you want it).
 916
 917format.pretty::
 918        The default pretty format for log/show/whatchanged command,
 919        See linkgit:git-log[1], linkgit:git-show[1],
 920        linkgit:git-whatchanged[1].
 921
 922format.thread::
 923        The default threading style for 'git format-patch'.  Can be
 924        a boolean value, or `shallow` or `deep`.  `shallow` threading
 925        makes every mail a reply to the head of the series,
 926        where the head is chosen from the cover letter, the
 927        `\--in-reply-to`, and the first patch mail, in this order.
 928        `deep` threading makes every mail a reply to the previous one.
 929        A true boolean value is the same as `shallow`, and a false
 930        value disables threading.
 931
 932format.signoff::
 933    A boolean value which lets you enable the `-s/--signoff` option of
 934    format-patch by default. *Note:* Adding the Signed-off-by: line to a
 935    patch should be a conscious act and means that you certify you have
 936    the rights to submit this work under the same open source license.
 937    Please see the 'SubmittingPatches' document for further discussion.
 938
 939filter.<driver>.clean::
 940        The command which is used to convert the content of a worktree
 941        file to a blob upon checkin.  See linkgit:gitattributes[5] for
 942        details.
 943
 944filter.<driver>.smudge::
 945        The command which is used to convert the content of a blob
 946        object to a worktree file upon checkout.  See
 947        linkgit:gitattributes[5] for details.
 948
 949gc.aggressiveWindow::
 950        The window size parameter used in the delta compression
 951        algorithm used by 'git gc --aggressive'.  This defaults
 952        to 250.
 953
 954gc.auto::
 955        When there are approximately more than this many loose
 956        objects in the repository, `git gc --auto` will pack them.
 957        Some Porcelain commands use this command to perform a
 958        light-weight garbage collection from time to time.  The
 959        default value is 6700.  Setting this to 0 disables it.
 960
 961gc.autopacklimit::
 962        When there are more than this many packs that are not
 963        marked with `*.keep` file in the repository, `git gc
 964        --auto` consolidates them into one larger pack.  The
 965        default value is 50.  Setting this to 0 disables it.
 966
 967gc.packrefs::
 968        Running `git pack-refs` in a repository renders it
 969        unclonable by Git versions prior to 1.5.1.2 over dumb
 970        transports such as HTTP.  This variable determines whether
 971        'git gc' runs `git pack-refs`. This can be set to `notbare`
 972        to enable it within all non-bare repos or it can be set to a
 973        boolean value.  The default is `true`.
 974
 975gc.pruneexpire::
 976        When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
 977        Override the grace period with this config variable.  The value
 978        "now" may be used to disable this  grace period and always prune
 979        unreachable objects immediately.
 980
 981gc.reflogexpire::
 982gc.<pattern>.reflogexpire::
 983        'git reflog expire' removes reflog entries older than
 984        this time; defaults to 90 days.  With "<pattern>" (e.g.
 985        "refs/stash") in the middle the setting applies only to
 986        the refs that match the <pattern>.
 987
 988gc.reflogexpireunreachable::
 989gc.<ref>.reflogexpireunreachable::
 990        'git reflog expire' removes reflog entries older than
 991        this time and are not reachable from the current tip;
 992        defaults to 30 days.  With "<pattern>" (e.g. "refs/stash")
 993        in the middle, the setting applies only to the refs that
 994        match the <pattern>.
 995
 996gc.rerereresolved::
 997        Records of conflicted merge you resolved earlier are
 998        kept for this many days when 'git rerere gc' is run.
 999        The default is 60 days.  See linkgit:git-rerere[1].
1000
1001gc.rerereunresolved::
1002        Records of conflicted merge you have not resolved are
1003        kept for this many days when 'git rerere gc' is run.
1004        The default is 15 days.  See linkgit:git-rerere[1].
1005
1006gitcvs.commitmsgannotation::
1007        Append this string to each commit message. Set to empty string
1008        to disable this feature. Defaults to "via git-CVS emulator".
1009
1010gitcvs.enabled::
1011        Whether the CVS server interface is enabled for this repository.
1012        See linkgit:git-cvsserver[1].
1013
1014gitcvs.logfile::
1015        Path to a log file where the CVS server interface well... logs
1016        various stuff. See linkgit:git-cvsserver[1].
1017
1018gitcvs.usecrlfattr::
1019        If true, the server will look up the end-of-line conversion
1020        attributes for files to determine the '-k' modes to use. If
1021        the attributes force git to treat a file as text,
1022        the '-k' mode will be left blank so CVS clients will
1023        treat it as text. If they suppress text conversion, the file
1024        will be set with '-kb' mode, which suppresses any newline munging
1025        the client might otherwise do. If the attributes do not allow
1026        the file type to be determined, then 'gitcvs.allbinary' is
1027        used. See linkgit:gitattributes[5].
1028
1029gitcvs.allbinary::
1030        This is used if 'gitcvs.usecrlfattr' does not resolve
1031        the correct '-kb' mode to use. If true, all
1032        unresolved files are sent to the client in
1033        mode '-kb'. This causes the client to treat them
1034        as binary files, which suppresses any newline munging it
1035        otherwise might do. Alternatively, if it is set to "guess",
1036        then the contents of the file are examined to decide if
1037        it is binary, similar to 'core.autocrlf'.
1038
1039gitcvs.dbname::
1040        Database used by git-cvsserver to cache revision information
1041        derived from the git repository. The exact meaning depends on the
1042        used database driver, for SQLite (which is the default driver) this
1043        is a filename. Supports variable substitution (see
1044        linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1045        Default: '%Ggitcvs.%m.sqlite'
1046
1047gitcvs.dbdriver::
1048        Used Perl DBI driver. You can specify any available driver
1049        for this here, but it might not work. git-cvsserver is tested
1050        with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1051        reported *not* to work with 'DBD::mysql'. Experimental feature.
1052        May not contain double colons (`:`). Default: 'SQLite'.
1053        See linkgit:git-cvsserver[1].
1054
1055gitcvs.dbuser, gitcvs.dbpass::
1056        Database user and password. Only useful if setting 'gitcvs.dbdriver',
1057        since SQLite has no concept of database users and/or passwords.
1058        'gitcvs.dbuser' supports variable substitution (see
1059        linkgit:git-cvsserver[1] for details).
1060
1061gitcvs.dbTableNamePrefix::
1062        Database table name prefix.  Prepended to the names of any
1063        database tables used, allowing a single database to be used
1064        for several repositories.  Supports variable substitution (see
1065        linkgit:git-cvsserver[1] for details).  Any non-alphabetic
1066        characters will be replaced with underscores.
1067
1068All gitcvs variables except for 'gitcvs.usecrlfattr' and
1069'gitcvs.allbinary' can also be specified as
1070'gitcvs.<access_method>.<varname>' (where 'access_method'
1071is one of "ext" and "pserver") to make them apply only for the given
1072access method.
1073
1074gitweb.category::
1075gitweb.description::
1076gitweb.owner::
1077gitweb.url::
1078        See linkgit:gitweb[1] for description.
1079
1080gitweb.avatar::
1081gitweb.blame::
1082gitweb.grep::
1083gitweb.highlight::
1084gitweb.patches::
1085gitweb.pickaxe::
1086gitweb.remote_heads::
1087gitweb.showsizes::
1088gitweb.snapshot::
1089        See linkgit:gitweb.conf[5] for description.
1090
1091grep.lineNumber::
1092        If set to true, enable '-n' option by default.
1093
1094grep.extendedRegexp::
1095        If set to true, enable '--extended-regexp' option by default.
1096
1097gui.commitmsgwidth::
1098        Defines how wide the commit message window is in the
1099        linkgit:git-gui[1]. "75" is the default.
1100
1101gui.diffcontext::
1102        Specifies how many context lines should be used in calls to diff
1103        made by the linkgit:git-gui[1]. The default is "5".
1104
1105gui.encoding::
1106        Specifies the default encoding to use for displaying of
1107        file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1108        It can be overridden by setting the 'encoding' attribute
1109        for relevant files (see linkgit:gitattributes[5]).
1110        If this option is not set, the tools default to the
1111        locale encoding.
1112
1113gui.matchtrackingbranch::
1114        Determines if new branches created with linkgit:git-gui[1] should
1115        default to tracking remote branches with matching names or
1116        not. Default: "false".
1117
1118gui.newbranchtemplate::
1119        Is used as suggested name when creating new branches using the
1120        linkgit:git-gui[1].
1121
1122gui.pruneduringfetch::
1123        "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1124        performing a fetch. The default value is "false".
1125
1126gui.trustmtime::
1127        Determines if linkgit:git-gui[1] should trust the file modification
1128        timestamp or not. By default the timestamps are not trusted.
1129
1130gui.spellingdictionary::
1131        Specifies the dictionary used for spell checking commit messages in
1132        the linkgit:git-gui[1]. When set to "none" spell checking is turned
1133        off.
1134
1135gui.fastcopyblame::
1136        If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1137        location detection. It makes blame significantly faster on huge
1138        repositories at the expense of less thorough copy detection.
1139
1140gui.copyblamethreshold::
1141        Specifies the threshold to use in 'git gui blame' original location
1142        detection, measured in alphanumeric characters. See the
1143        linkgit:git-blame[1] manual for more information on copy detection.
1144
1145gui.blamehistoryctx::
1146        Specifies the radius of history context in days to show in
1147        linkgit:gitk[1] for the selected commit, when the `Show History
1148        Context` menu item is invoked from 'git gui blame'. If this
1149        variable is set to zero, the whole history is shown.
1150
1151guitool.<name>.cmd::
1152        Specifies the shell command line to execute when the corresponding item
1153        of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1154        mandatory for every tool. The command is executed from the root of
1155        the working directory, and in the environment it receives the name of
1156        the tool as 'GIT_GUITOOL', the name of the currently selected file as
1157        'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1158        the head is detached, 'CUR_BRANCH' is empty).
1159
1160guitool.<name>.needsfile::
1161        Run the tool only if a diff is selected in the GUI. It guarantees
1162        that 'FILENAME' is not empty.
1163
1164guitool.<name>.noconsole::
1165        Run the command silently, without creating a window to display its
1166        output.
1167
1168guitool.<name>.norescan::
1169        Don't rescan the working directory for changes after the tool
1170        finishes execution.
1171
1172guitool.<name>.confirm::
1173        Show a confirmation dialog before actually running the tool.
1174
1175guitool.<name>.argprompt::
1176        Request a string argument from the user, and pass it to the tool
1177        through the 'ARGS' environment variable. Since requesting an
1178        argument implies confirmation, the 'confirm' option has no effect
1179        if this is enabled. If the option is set to 'true', 'yes', or '1',
1180        the dialog uses a built-in generic prompt; otherwise the exact
1181        value of the variable is used.
1182
1183guitool.<name>.revprompt::
1184        Request a single valid revision from the user, and set the
1185        'REVISION' environment variable. In other aspects this option
1186        is similar to 'argprompt', and can be used together with it.
1187
1188guitool.<name>.revunmerged::
1189        Show only unmerged branches in the 'revprompt' subdialog.
1190        This is useful for tools similar to merge or rebase, but not
1191        for things like checkout or reset.
1192
1193guitool.<name>.title::
1194        Specifies the title to use for the prompt dialog. The default
1195        is the tool name.
1196
1197guitool.<name>.prompt::
1198        Specifies the general prompt string to display at the top of
1199        the dialog, before subsections for 'argprompt' and 'revprompt'.
1200        The default value includes the actual command.
1201
1202help.browser::
1203        Specify the browser that will be used to display help in the
1204        'web' format. See linkgit:git-help[1].
1205
1206help.format::
1207        Override the default help format used by linkgit:git-help[1].
1208        Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1209        the default. 'web' and 'html' are the same.
1210
1211help.autocorrect::
1212        Automatically correct and execute mistyped commands after
1213        waiting for the given number of deciseconds (0.1 sec). If more
1214        than one command can be deduced from the entered text, nothing
1215        will be executed.  If the value of this option is negative,
1216        the corrected command will be executed immediately. If the
1217        value is 0 - the command will be just shown but not executed.
1218        This is the default.
1219
1220http.proxy::
1221        Override the HTTP proxy, normally configured using the 'http_proxy'
1222        environment variable (see linkgit:curl[1]).  This can be overridden
1223        on a per-remote basis; see remote.<name>.proxy
1224
1225http.cookiefile::
1226        File containing previously stored cookie lines which should be used
1227        in the git http session, if they match the server. The file format
1228        of the file to read cookies from should be plain HTTP headers or
1229        the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
1230        NOTE that the file specified with http.cookiefile is only used as
1231        input. No cookies will be stored in the file.
1232
1233http.sslVerify::
1234        Whether to verify the SSL certificate when fetching or pushing
1235        over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1236        variable.
1237
1238http.sslCert::
1239        File containing the SSL certificate when fetching or pushing
1240        over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1241        variable.
1242
1243http.sslKey::
1244        File containing the SSL private key when fetching or pushing
1245        over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1246        variable.
1247
1248http.sslCertPasswordProtected::
1249        Enable git's password prompt for the SSL certificate.  Otherwise
1250        OpenSSL will prompt the user, possibly many times, if the
1251        certificate or private key is encrypted.  Can be overridden by the
1252        'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1253
1254http.sslCAInfo::
1255        File containing the certificates to verify the peer with when
1256        fetching or pushing over HTTPS. Can be overridden by the
1257        'GIT_SSL_CAINFO' environment variable.
1258
1259http.sslCAPath::
1260        Path containing files with the CA certificates to verify the peer
1261        with when fetching or pushing over HTTPS. Can be overridden
1262        by the 'GIT_SSL_CAPATH' environment variable.
1263
1264http.maxRequests::
1265        How many HTTP requests to launch in parallel. Can be overridden
1266        by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1267
1268http.minSessions::
1269        The number of curl sessions (counted across slots) to be kept across
1270        requests. They will not be ended with curl_easy_cleanup() until
1271        http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1272        value will be capped at 1. Defaults to 1.
1273
1274http.postBuffer::
1275        Maximum size in bytes of the buffer used by smart HTTP
1276        transports when POSTing data to the remote system.
1277        For requests larger than this buffer size, HTTP/1.1 and
1278        Transfer-Encoding: chunked is used to avoid creating a
1279        massive pack file locally.  Default is 1 MiB, which is
1280        sufficient for most requests.
1281
1282http.lowSpeedLimit, http.lowSpeedTime::
1283        If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1284        for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1285        Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1286        'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1287
1288http.noEPSV::
1289        A boolean which disables using of EPSV ftp command by curl.
1290        This can helpful with some "poor" ftp servers which don't
1291        support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1292        environment variable. Default is false (curl will use EPSV).
1293
1294http.useragent::
1295        The HTTP USER_AGENT string presented to an HTTP server.  The default
1296        value represents the version of the client git such as git/1.7.1.
1297        This option allows you to override this value to a more common value
1298        such as Mozilla/4.0.  This may be necessary, for instance, if
1299        connecting through a firewall that restricts HTTP connections to a set
1300        of common USER_AGENT strings (but not including those like git/1.7.1).
1301        Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1302
1303i18n.commitEncoding::
1304        Character encoding the commit messages are stored in; git itself
1305        does not care per se, but this information is necessary e.g. when
1306        importing commits from emails or in the gitk graphical history
1307        browser (and possibly at other places in the future or in other
1308        porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1309
1310i18n.logOutputEncoding::
1311        Character encoding the commit messages are converted to when
1312        running 'git log' and friends.
1313
1314imap::
1315        The configuration variables in the 'imap' section are described
1316        in linkgit:git-imap-send[1].
1317
1318init.templatedir::
1319        Specify the directory from which templates will be copied.
1320        (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1321
1322instaweb.browser::
1323        Specify the program that will be used to browse your working
1324        repository in gitweb. See linkgit:git-instaweb[1].
1325
1326instaweb.httpd::
1327        The HTTP daemon command-line to start gitweb on your working
1328        repository. See linkgit:git-instaweb[1].
1329
1330instaweb.local::
1331        If true the web server started by linkgit:git-instaweb[1] will
1332        be bound to the local IP (127.0.0.1).
1333
1334instaweb.modulepath::
1335        The default module path for linkgit:git-instaweb[1] to use
1336        instead of /usr/lib/apache2/modules.  Only used if httpd
1337        is Apache.
1338
1339instaweb.port::
1340        The port number to bind the gitweb httpd to. See
1341        linkgit:git-instaweb[1].
1342
1343interactive.singlekey::
1344        In interactive commands, allow the user to provide one-letter
1345        input with a single key (i.e., without hitting enter).
1346        Currently this is used by the `\--patch` mode of
1347        linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1348        linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1349        setting is silently ignored if portable keystroke input
1350        is not available.
1351
1352log.abbrevCommit::
1353        If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1354        linkgit:git-whatchanged[1] assume `\--abbrev-commit`. You may
1355        override this option with `\--no-abbrev-commit`.
1356
1357log.date::
1358        Set the default date-time mode for the 'log' command.
1359        Setting a value for log.date is similar to using 'git log''s
1360        `\--date` option.  Possible values are `relative`, `local`,
1361        `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1362        for details.
1363
1364log.decorate::
1365        Print out the ref names of any commits that are shown by the log
1366        command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1367        'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1368        specified, the full ref name (including prefix) will be printed.
1369        This is the same as the log commands '--decorate' option.
1370
1371log.showroot::
1372        If true, the initial commit will be shown as a big creation event.
1373        This is equivalent to a diff against an empty tree.
1374        Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1375        normally hide the root commit will now show it. True by default.
1376
1377mailmap.file::
1378        The location of an augmenting mailmap file. The default
1379        mailmap, located in the root of the repository, is loaded
1380        first, then the mailmap file pointed to by this variable.
1381        The location of the mailmap file may be in a repository
1382        subdirectory, or somewhere outside of the repository itself.
1383        See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1384
1385man.viewer::
1386        Specify the programs that may be used to display help in the
1387        'man' format. See linkgit:git-help[1].
1388
1389man.<tool>.cmd::
1390        Specify the command to invoke the specified man viewer. The
1391        specified command is evaluated in shell with the man page
1392        passed as argument. (See linkgit:git-help[1].)
1393
1394man.<tool>.path::
1395        Override the path for the given tool that may be used to
1396        display help in the 'man' format. See linkgit:git-help[1].
1397
1398include::merge-config.txt[]
1399
1400mergetool.<tool>.path::
1401        Override the path for the given tool.  This is useful in case
1402        your tool is not in the PATH.
1403
1404mergetool.<tool>.cmd::
1405        Specify the command to invoke the specified merge tool.  The
1406        specified command is evaluated in shell with the following
1407        variables available: 'BASE' is the name of a temporary file
1408        containing the common base of the files to be merged, if available;
1409        'LOCAL' is the name of a temporary file containing the contents of
1410        the file on the current branch; 'REMOTE' is the name of a temporary
1411        file containing the contents of the file from the branch being
1412        merged; 'MERGED' contains the name of the file to which the merge
1413        tool should write the results of a successful merge.
1414
1415mergetool.<tool>.trustExitCode::
1416        For a custom merge command, specify whether the exit code of
1417        the merge command can be used to determine whether the merge was
1418        successful.  If this is not set to true then the merge target file
1419        timestamp is checked and the merge assumed to have been successful
1420        if the file has been updated, otherwise the user is prompted to
1421        indicate the success of the merge.
1422
1423mergetool.keepBackup::
1424        After performing a merge, the original file with conflict markers
1425        can be saved as a file with a `.orig` extension.  If this variable
1426        is set to `false` then this file is not preserved.  Defaults to
1427        `true` (i.e. keep the backup files).
1428
1429mergetool.keepTemporaries::
1430        When invoking a custom merge tool, git uses a set of temporary
1431        files to pass to the tool. If the tool returns an error and this
1432        variable is set to `true`, then these temporary files will be
1433        preserved, otherwise they will be removed after the tool has
1434        exited. Defaults to `false`.
1435
1436mergetool.prompt::
1437        Prompt before each invocation of the merge resolution program.
1438
1439notes.displayRef::
1440        The (fully qualified) refname from which to show notes when
1441        showing commit messages.  The value of this variable can be set
1442        to a glob, in which case notes from all matching refs will be
1443        shown.  You may also specify this configuration variable
1444        several times.  A warning will be issued for refs that do not
1445        exist, but a glob that does not match any refs is silently
1446        ignored.
1447+
1448This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1449environment variable, which must be a colon separated list of refs or
1450globs.
1451+
1452The effective value of "core.notesRef" (possibly overridden by
1453GIT_NOTES_REF) is also implicitly added to the list of refs to be
1454displayed.
1455
1456notes.rewrite.<command>::
1457        When rewriting commits with <command> (currently `amend` or
1458        `rebase`) and this variable is set to `true`, git
1459        automatically copies your notes from the original to the
1460        rewritten commit.  Defaults to `true`, but see
1461        "notes.rewriteRef" below.
1462
1463notes.rewriteMode::
1464        When copying notes during a rewrite (see the
1465        "notes.rewrite.<command>" option), determines what to do if
1466        the target commit already has a note.  Must be one of
1467        `overwrite`, `concatenate`, or `ignore`.  Defaults to
1468        `concatenate`.
1469+
1470This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1471environment variable.
1472
1473notes.rewriteRef::
1474        When copying notes during a rewrite, specifies the (fully
1475        qualified) ref whose notes should be copied.  The ref may be a
1476        glob, in which case notes in all matching refs will be copied.
1477        You may also specify this configuration several times.
1478+
1479Does not have a default value; you must configure this variable to
1480enable note rewriting.  Set it to `refs/notes/commits` to enable
1481rewriting for the default commit notes.
1482+
1483This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1484environment variable, which must be a colon separated list of refs or
1485globs.
1486
1487pack.window::
1488        The size of the window used by linkgit:git-pack-objects[1] when no
1489        window size is given on the command line. Defaults to 10.
1490
1491pack.depth::
1492        The maximum delta depth used by linkgit:git-pack-objects[1] when no
1493        maximum depth is given on the command line. Defaults to 50.
1494
1495pack.windowMemory::
1496        The window memory size limit used by linkgit:git-pack-objects[1]
1497        when no limit is given on the command line.  The value can be
1498        suffixed with "k", "m", or "g".  Defaults to 0, meaning no
1499        limit.
1500
1501pack.compression::
1502        An integer -1..9, indicating the compression level for objects
1503        in a pack file. -1 is the zlib default. 0 means no
1504        compression, and 1..9 are various speed/size tradeoffs, 9 being
1505        slowest.  If not set,  defaults to core.compression.  If that is
1506        not set,  defaults to -1, the zlib default, which is "a default
1507        compromise between speed and compression (currently equivalent
1508        to level 6)."
1509+
1510Note that changing the compression level will not automatically recompress
1511all existing objects. You can force recompression by passing the -F option
1512to linkgit:git-repack[1].
1513
1514pack.deltaCacheSize::
1515        The maximum memory in bytes used for caching deltas in
1516        linkgit:git-pack-objects[1] before writing them out to a pack.
1517        This cache is used to speed up the writing object phase by not
1518        having to recompute the final delta result once the best match
1519        for all objects is found.  Repacking large repositories on machines
1520        which are tight with memory might be badly impacted by this though,
1521        especially if this cache pushes the system into swapping.
1522        A value of 0 means no limit. The smallest size of 1 byte may be
1523        used to virtually disable this cache. Defaults to 256 MiB.
1524
1525pack.deltaCacheLimit::
1526        The maximum size of a delta, that is cached in
1527        linkgit:git-pack-objects[1]. This cache is used to speed up the
1528        writing object phase by not having to recompute the final delta
1529        result once the best match for all objects is found. Defaults to 1000.
1530
1531pack.threads::
1532        Specifies the number of threads to spawn when searching for best
1533        delta matches.  This requires that linkgit:git-pack-objects[1]
1534        be compiled with pthreads otherwise this option is ignored with a
1535        warning. This is meant to reduce packing time on multiprocessor
1536        machines. The required amount of memory for the delta search window
1537        is however multiplied by the number of threads.
1538        Specifying 0 will cause git to auto-detect the number of CPU's
1539        and set the number of threads accordingly.
1540
1541pack.indexVersion::
1542        Specify the default pack index version.  Valid values are 1 for
1543        legacy pack index used by Git versions prior to 1.5.2, and 2 for
1544        the new pack index with capabilities for packs larger than 4 GB
1545        as well as proper protection against the repacking of corrupted
1546        packs.  Version 2 is the default.  Note that version 2 is enforced
1547        and this config option ignored whenever the corresponding pack is
1548        larger than 2 GB.
1549+
1550If you have an old git that does not understand the version 2 `{asterisk}.idx` file,
1551cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1552that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the
1553other side may give you a repository that cannot be accessed with your
1554older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,
1555you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1556the `{asterisk}.idx` file.
1557
1558pack.packSizeLimit::
1559        The maximum size of a pack.  This setting only affects
1560        packing to a file when repacking, i.e. the git:// protocol
1561        is unaffected.  It can be overridden by the `\--max-pack-size`
1562        option of linkgit:git-repack[1]. The minimum size allowed is
1563        limited to 1 MiB. The default is unlimited.
1564        Common unit suffixes of 'k', 'm', or 'g' are
1565        supported.
1566
1567pager.<cmd>::
1568        If the value is boolean, turns on or off pagination of the
1569        output of a particular git subcommand when writing to a tty.
1570        Otherwise, turns on pagination for the subcommand using the
1571        pager specified by the value of `pager.<cmd>`.  If `\--paginate`
1572        or `\--no-pager` is specified on the command line, it takes
1573        precedence over this option.  To disable pagination for all
1574        commands, set `core.pager` or `GIT_PAGER` to `cat`.
1575
1576pretty.<name>::
1577        Alias for a --pretty= format string, as specified in
1578        linkgit:git-log[1]. Any aliases defined here can be used just
1579        as the built-in pretty formats could. For example,
1580        running `git config pretty.changelog "format:{asterisk} %H %s"`
1581        would cause the invocation `git log --pretty=changelog`
1582        to be equivalent to running `git log "--pretty=format:{asterisk} %H %s"`.
1583        Note that an alias with the same name as a built-in format
1584        will be silently ignored.
1585
1586pull.octopus::
1587        The default merge strategy to use when pulling multiple branches
1588        at once.
1589
1590pull.twohead::
1591        The default merge strategy to use when pulling a single branch.
1592
1593push.default::
1594        Defines the action git push should take if no refspec is given
1595        on the command line, no refspec is configured in the remote, and
1596        no refspec is implied by any of the options given on the command
1597        line. Possible values are:
1598+
1599* `nothing` - do not push anything.
1600* `matching` - push all matching branches.
1601  All branches having the same name in both ends are considered to be
1602  matching. This is the default.
1603* `upstream` - push the current branch to its upstream branch.
1604* `tracking` - deprecated synonym for `upstream`.
1605* `current` - push the current branch to a branch of the same name.
1606
1607rebase.stat::
1608        Whether to show a diffstat of what changed upstream since the last
1609        rebase. False by default.
1610
1611rebase.autosquash::
1612        If set to true enable '--autosquash' option by default.
1613
1614receive.autogc::
1615        By default, git-receive-pack will run "git-gc --auto" after
1616        receiving data from git-push and updating refs.  You can stop
1617        it by setting this variable to false.
1618
1619receive.fsckObjects::
1620        If it is set to true, git-receive-pack will check all received
1621        objects. It will abort in the case of a malformed object or a
1622        broken link. The result of an abort are only dangling objects.
1623        Defaults to false. If not set, the value of `transfer.fsckObjects`
1624        is used instead.
1625
1626receive.unpackLimit::
1627        If the number of objects received in a push is below this
1628        limit then the objects will be unpacked into loose object
1629        files. However if the number of received objects equals or
1630        exceeds this limit then the received pack will be stored as
1631        a pack, after adding any missing delta bases.  Storing the
1632        pack from a push can make the push operation complete faster,
1633        especially on slow filesystems.  If not set, the value of
1634        `transfer.unpackLimit` is used instead.
1635
1636receive.denyDeletes::
1637        If set to true, git-receive-pack will deny a ref update that deletes
1638        the ref. Use this to prevent such a ref deletion via a push.
1639
1640receive.denyDeleteCurrent::
1641        If set to true, git-receive-pack will deny a ref update that
1642        deletes the currently checked out branch of a non-bare repository.
1643
1644receive.denyCurrentBranch::
1645        If set to true or "refuse", git-receive-pack will deny a ref update
1646        to the currently checked out branch of a non-bare repository.
1647        Such a push is potentially dangerous because it brings the HEAD
1648        out of sync with the index and working tree. If set to "warn",
1649        print a warning of such a push to stderr, but allow the push to
1650        proceed. If set to false or "ignore", allow such pushes with no
1651        message. Defaults to "refuse".
1652
1653receive.denyNonFastForwards::
1654        If set to true, git-receive-pack will deny a ref update which is
1655        not a fast-forward. Use this to prevent such an update via a push,
1656        even if that push is forced. This configuration variable is
1657        set when initializing a shared repository.
1658
1659receive.updateserverinfo::
1660        If set to true, git-receive-pack will run git-update-server-info
1661        after receiving data from git-push and updating refs.
1662
1663remote.<name>.url::
1664        The URL of a remote repository.  See linkgit:git-fetch[1] or
1665        linkgit:git-push[1].
1666
1667remote.<name>.pushurl::
1668        The push URL of a remote repository.  See linkgit:git-push[1].
1669
1670remote.<name>.proxy::
1671        For remotes that require curl (http, https and ftp), the URL to
1672        the proxy to use for that remote.  Set to the empty string to
1673        disable proxying for that remote.
1674
1675remote.<name>.fetch::
1676        The default set of "refspec" for linkgit:git-fetch[1]. See
1677        linkgit:git-fetch[1].
1678
1679remote.<name>.push::
1680        The default set of "refspec" for linkgit:git-push[1]. See
1681        linkgit:git-push[1].
1682
1683remote.<name>.mirror::
1684        If true, pushing to this remote will automatically behave
1685        as if the `\--mirror` option was given on the command line.
1686
1687remote.<name>.skipDefaultUpdate::
1688        If true, this remote will be skipped by default when updating
1689        using linkgit:git-fetch[1] or the `update` subcommand of
1690        linkgit:git-remote[1].
1691
1692remote.<name>.skipFetchAll::
1693        If true, this remote will be skipped by default when updating
1694        using linkgit:git-fetch[1] or the `update` subcommand of
1695        linkgit:git-remote[1].
1696
1697remote.<name>.receivepack::
1698        The default program to execute on the remote side when pushing.  See
1699        option \--receive-pack of linkgit:git-push[1].
1700
1701remote.<name>.uploadpack::
1702        The default program to execute on the remote side when fetching.  See
1703        option \--upload-pack of linkgit:git-fetch-pack[1].
1704
1705remote.<name>.tagopt::
1706        Setting this value to \--no-tags disables automatic tag following when
1707        fetching from remote <name>. Setting it to \--tags will fetch every
1708        tag from remote <name>, even if they are not reachable from remote
1709        branch heads. Passing these flags directly to linkgit:git-fetch[1] can
1710        override this setting. See options \--tags and \--no-tags of
1711        linkgit:git-fetch[1].
1712
1713remote.<name>.vcs::
1714        Setting this to a value <vcs> will cause git to interact with
1715        the remote with the git-remote-<vcs> helper.
1716
1717remotes.<group>::
1718        The list of remotes which are fetched by "git remote update
1719        <group>".  See linkgit:git-remote[1].
1720
1721repack.usedeltabaseoffset::
1722        By default, linkgit:git-repack[1] creates packs that use
1723        delta-base offset. If you need to share your repository with
1724        git older than version 1.4.4, either directly or via a dumb
1725        protocol such as http, then you need to set this option to
1726        "false" and repack. Access from old git versions over the
1727        native protocol are unaffected by this option.
1728
1729rerere.autoupdate::
1730        When set to true, `git-rerere` updates the index with the
1731        resulting contents after it cleanly resolves conflicts using
1732        previously recorded resolution.  Defaults to false.
1733
1734rerere.enabled::
1735        Activate recording of resolved conflicts, so that identical
1736        conflict hunks can be resolved automatically, should they
1737        be encountered again.  linkgit:git-rerere[1] command is by
1738        default enabled if you create `rr-cache` directory under
1739        `$GIT_DIR`, but can be disabled by setting this option to false.
1740
1741sendemail.identity::
1742        A configuration identity. When given, causes values in the
1743        'sendemail.<identity>' subsection to take precedence over
1744        values in the 'sendemail' section. The default identity is
1745        the value of 'sendemail.identity'.
1746
1747sendemail.smtpencryption::
1748        See linkgit:git-send-email[1] for description.  Note that this
1749        setting is not subject to the 'identity' mechanism.
1750
1751sendemail.smtpssl::
1752        Deprecated alias for 'sendemail.smtpencryption = ssl'.
1753
1754sendemail.<identity>.*::
1755        Identity-specific versions of the 'sendemail.*' parameters
1756        found below, taking precedence over those when the this
1757        identity is selected, through command-line or
1758        'sendemail.identity'.
1759
1760sendemail.aliasesfile::
1761sendemail.aliasfiletype::
1762sendemail.bcc::
1763sendemail.cc::
1764sendemail.cccmd::
1765sendemail.chainreplyto::
1766sendemail.confirm::
1767sendemail.envelopesender::
1768sendemail.from::
1769sendemail.multiedit::
1770sendemail.signedoffbycc::
1771sendemail.smtppass::
1772sendemail.suppresscc::
1773sendemail.suppressfrom::
1774sendemail.to::
1775sendemail.smtpdomain::
1776sendemail.smtpserver::
1777sendemail.smtpserverport::
1778sendemail.smtpserveroption::
1779sendemail.smtpuser::
1780sendemail.thread::
1781sendemail.validate::
1782        See linkgit:git-send-email[1] for description.
1783
1784sendemail.signedoffcc::
1785        Deprecated alias for 'sendemail.signedoffbycc'.
1786
1787showbranch.default::
1788        The default set of branches for linkgit:git-show-branch[1].
1789        See linkgit:git-show-branch[1].
1790
1791status.relativePaths::
1792        By default, linkgit:git-status[1] shows paths relative to the
1793        current directory. Setting this variable to `false` shows paths
1794        relative to the repository root (this was the default for git
1795        prior to v1.5.4).
1796
1797status.showUntrackedFiles::
1798        By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1799        files which are not currently tracked by Git. Directories which
1800        contain only untracked files, are shown with the directory name
1801        only. Showing untracked files means that Git needs to lstat() all
1802        all the files in the whole repository, which might be slow on some
1803        systems. So, this variable controls how the commands displays
1804        the untracked files. Possible values are:
1805+
1806--
1807* `no` - Show no untracked files.
1808* `normal` - Show untracked files and directories.
1809* `all` - Show also individual files in untracked directories.
1810--
1811+
1812If this variable is not specified, it defaults to 'normal'.
1813This variable can be overridden with the -u|--untracked-files option
1814of linkgit:git-status[1] and linkgit:git-commit[1].
1815
1816status.submodulesummary::
1817        Defaults to false.
1818        If this is set to a non zero number or true (identical to -1 or an
1819        unlimited number), the submodule summary will be enabled and a
1820        summary of commits for modified submodules will be shown (see
1821        --summary-limit option of linkgit:git-submodule[1]).
1822
1823submodule.<name>.path::
1824submodule.<name>.url::
1825submodule.<name>.update::
1826        The path within this project, URL, and the updating strategy
1827        for a submodule.  These variables are initially populated
1828        by 'git submodule init'; edit them to override the
1829        URL and other values found in the `.gitmodules` file.  See
1830        linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
1831
1832submodule.<name>.fetchRecurseSubmodules::
1833        This option can be used to control recursive fetching of this
1834        submodule. It can be overridden by using the --[no-]recurse-submodules
1835        command line option to "git fetch" and "git pull".
1836        This setting will override that from in the linkgit:gitmodules[5]
1837        file.
1838
1839submodule.<name>.ignore::
1840        Defines under what circumstances "git status" and the diff family show
1841        a submodule as modified. When set to "all", it will never be considered
1842        modified, "dirty" will ignore all changes to the submodules work tree and
1843        takes only differences between the HEAD of the submodule and the commit
1844        recorded in the superproject into account. "untracked" will additionally
1845        let submodules with modified tracked files in their work tree show up.
1846        Using "none" (the default when this option is not set) also shows
1847        submodules that have untracked files in their work tree as changed.
1848        This setting overrides any setting made in .gitmodules for this submodule,
1849        both settings can be overridden on the command line by using the
1850        "--ignore-submodules" option.
1851
1852tar.umask::
1853        This variable can be used to restrict the permission bits of
1854        tar archive entries.  The default is 0002, which turns off the
1855        world write bit.  The special value "user" indicates that the
1856        archiving user's umask will be used instead.  See umask(2) and
1857        linkgit:git-archive[1].
1858
1859transfer.fsckObjects::
1860        When `fetch.fsckObjects` or `receive.fsckObjects` are
1861        not set, the value of this variable is used instead.
1862        Defaults to false.
1863
1864transfer.unpackLimit::
1865        When `fetch.unpackLimit` or `receive.unpackLimit` are
1866        not set, the value of this variable is used instead.
1867        The default value is 100.
1868
1869url.<base>.insteadOf::
1870        Any URL that starts with this value will be rewritten to
1871        start, instead, with <base>. In cases where some site serves a
1872        large number of repositories, and serves them with multiple
1873        access methods, and some users need to use different access
1874        methods, this feature allows people to specify any of the
1875        equivalent URLs and have git automatically rewrite the URL to
1876        the best alternative for the particular user, even for a
1877        never-before-seen repository on the site.  When more than one
1878        insteadOf strings match a given URL, the longest match is used.
1879
1880url.<base>.pushInsteadOf::
1881        Any URL that starts with this value will not be pushed to;
1882        instead, it will be rewritten to start with <base>, and the
1883        resulting URL will be pushed to. In cases where some site serves
1884        a large number of repositories, and serves them with multiple
1885        access methods, some of which do not allow push, this feature
1886        allows people to specify a pull-only URL and have git
1887        automatically use an appropriate URL to push, even for a
1888        never-before-seen repository on the site.  When more than one
1889        pushInsteadOf strings match a given URL, the longest match is
1890        used.  If a remote has an explicit pushurl, git will ignore this
1891        setting for that remote.
1892
1893user.email::
1894        Your email address to be recorded in any newly created commits.
1895        Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
1896        'EMAIL' environment variables.  See linkgit:git-commit-tree[1].
1897
1898user.name::
1899        Your full name to be recorded in any newly created commits.
1900        Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
1901        environment variables.  See linkgit:git-commit-tree[1].
1902
1903user.signingkey::
1904        If linkgit:git-tag[1] is not selecting the key you want it to
1905        automatically when creating a signed tag, you can override the
1906        default selection with this variable.  This option is passed
1907        unchanged to gpg's --local-user parameter, so you may specify a key
1908        using any method that gpg supports.
1909
1910web.browser::
1911        Specify a web browser that may be used by some commands.
1912        Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
1913        may use it.