Add Git official document to help

[TortoiseGit.git] / doc / source / en / TortoiseGit / git_doc / git-config.html.xml

<?xml version="1.0" encoding="UTF-8"?>\r
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">\r
\r
<article lang="en" id="git-config(1)">\r
<articleinfo>\r
    <title>git-config(1)</title>\r
        <indexterm>\r
                <primary>git-config(1)</primary>\r
        </indexterm>\r
</articleinfo>\r
<simplesect id="_name">\r
<title>NAME</title>\r
<simpara>git-config - Get and set repository or global options</simpara>\r
</simplesect>\r
<simplesect id="_synopsis">\r
<title>SYNOPSIS</title>\r
<blockquote>\r
<literallayout><emphasis>git config</emphasis> [&lt;file-option&gt;] [type] [-z|--null] name [value [value_regex]]\r
<emphasis>git config</emphasis> [&lt;file-option&gt;] [type] --add name value\r
<emphasis>git config</emphasis> [&lt;file-option&gt;] [type] --replace-all name [value [value_regex]]\r
<emphasis>git config</emphasis> [&lt;file-option&gt;] [type] [-z|--null] --get name [value_regex]\r
<emphasis>git config</emphasis> [&lt;file-option&gt;] [type] [-z|--null] --get-all name [value_regex]\r
<emphasis>git config</emphasis> [&lt;file-option&gt;] [type] [-z|--null] --get-regexp name_regex [value_regex]\r
<emphasis>git config</emphasis> [&lt;file-option&gt;] --unset name [value_regex]\r
<emphasis>git config</emphasis> [&lt;file-option&gt;] --unset-all name [value_regex]\r
<emphasis>git config</emphasis> [&lt;file-option&gt;] --rename-section old_name new_name\r
<emphasis>git config</emphasis> [&lt;file-option&gt;] --remove-section name\r
<emphasis>git config</emphasis> [&lt;file-option&gt;] [-z|--null] -l | --list\r
<emphasis>git config</emphasis> [&lt;file-option&gt;] --get-color name [default]\r
<emphasis>git config</emphasis> [&lt;file-option&gt;] --get-colorbool name [stdout-is-tty]</literallayout>\r
</blockquote>\r
</simplesect>\r
<simplesect id="_description">\r
<title>DESCRIPTION</title>\r
<simpara>You can query/set/replace/unset options with this command. The name is\r
actually the section and the key separated by a dot, and the value will be\r
escaped.</simpara>\r
<simpara>Multiple lines can be added to an option by using the <emphasis>--add</emphasis> option.\r
If you want to update or unset an option which can occur on multiple\r
lines, a POSIX regexp <literal>value_regex</literal> needs to be given.  Only the\r
existing values that match the regexp are updated or unset.  If\r
you want to handle the lines that do <emphasis role="strong">not</emphasis> match the regex, just\r
prepend a single exclamation mark in front (see also <xref linkend="EXAMPLES"/>).</simpara>\r
<simpara>The type specifier can be either <emphasis>--int</emphasis> or <emphasis>--bool</emphasis>, which will make\r
<emphasis>git-config</emphasis> ensure that the variable(s) are of the given type and\r
convert the value to the canonical form (simple decimal number for int,\r
a "true" or "false" string for bool).  If no type specifier is passed,\r
no checks or transformations are performed on the value.</simpara>\r
<simpara>The file-option can be one of <emphasis>--system</emphasis>, <emphasis>--global</emphasis> or <emphasis>--file</emphasis>\r
which specify where the values will be read from or written to.\r
The default is to assume the config file of the current repository,\r
.git/config unless defined otherwise with GIT_DIR and GIT_CONFIG\r
(see <xref linkend="FILES"/>).</simpara>\r
<simpara>This command will fail if:</simpara>\r
<orderedlist numeration="arabic">\r
<listitem>\r
<simpara>\r
The config file is invalid,\r
</simpara>\r
</listitem>\r
<listitem>\r
<simpara>\r
Can not write to the config file,\r
</simpara>\r
</listitem>\r
<listitem>\r
<simpara>\r
no section was provided,\r
</simpara>\r
</listitem>\r
<listitem>\r
<simpara>\r
the section or key is invalid,\r
</simpara>\r
</listitem>\r
<listitem>\r
<simpara>\r
you try to unset an option which does not exist,\r
</simpara>\r
</listitem>\r
<listitem>\r
<simpara>\r
you try to unset/set an option for which multiple lines match, or\r
</simpara>\r
</listitem>\r
<listitem>\r
<simpara>\r
you use <emphasis>--global</emphasis> option without $HOME being properly set.\r
</simpara>\r
</listitem>\r
</orderedlist>\r
</simplesect>\r
<simplesect id="_options">\r
<title>OPTIONS</title>\r
<variablelist>\r
<varlistentry>\r
<term>\r
--replace-all\r
</term>\r
<listitem>\r
<simpara>\r
        Default behavior is to replace at most one line. This replaces\r
        all lines matching the key (and optionally the value_regex).\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
--add\r
</term>\r
<listitem>\r
<simpara>\r
        Adds a new line to the option without altering any existing\r
        values.  This is the same as providing <emphasis>^$</emphasis> as the value_regex.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
--get\r
</term>\r
<listitem>\r
<simpara>\r
        Get the value for a given key (optionally filtered by a regex\r
        matching the value). Returns error code 1 if the key was not\r
        found and error code 2 if multiple key values were found.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
--get-all\r
</term>\r
<listitem>\r
<simpara>\r
        Like get, but does not fail if the number of values for the key\r
        is not exactly one.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
--get-regexp\r
</term>\r
<listitem>\r
<simpara>\r
        Like --get-all, but interprets the name as a regular expression.\r
        Also outputs the key names.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
--global\r
</term>\r
<listitem>\r
<simpara>\r
        For writing options: write to global ~/.gitconfig file rather than\r
        the repository .git/config.\r
</simpara>\r
<simpara>For reading options: read only from global ~/.gitconfig rather than\r
from all available files.</simpara>\r
<simpara>See also <xref linkend="FILES"/>.</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
--system\r
</term>\r
<listitem>\r
<simpara>\r
        For writing options: write to system-wide $(prefix)/etc/gitconfig\r
        rather than the repository .git/config.\r
</simpara>\r
<simpara>For reading options: read only from system-wide $(prefix)/etc/gitconfig\r
rather than from all available files.</simpara>\r
<simpara>See also <xref linkend="FILES"/>.</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
-f config-file\r
</term>\r
<term>\r
--file config-file\r
</term>\r
<listitem>\r
<simpara>\r
        Use the given config file instead of the one specified by GIT_CONFIG.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
--remove-section\r
</term>\r
<listitem>\r
<simpara>\r
        Remove the given section from the configuration file.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
--rename-section\r
</term>\r
<listitem>\r
<simpara>\r
        Rename the given section to a new name.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
--unset\r
</term>\r
<listitem>\r
<simpara>\r
        Remove the line matching the key from config file.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
--unset-all\r
</term>\r
<listitem>\r
<simpara>\r
        Remove all lines matching the key from config file.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
-l\r
</term>\r
<term>\r
--list\r
</term>\r
<listitem>\r
<simpara>\r
        List all variables set in config file.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
--bool\r
</term>\r
<listitem>\r
<simpara>\r
        <emphasis>git-config</emphasis> will ensure that the output is "true" or "false"\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
--int\r
</term>\r
<listitem>\r
<simpara>\r
        <emphasis>git-config</emphasis> will ensure that the output is a simple\r
        decimal number.  An optional value suffix of <emphasis>k</emphasis>, <emphasis>m</emphasis>, or <emphasis>g</emphasis>\r
        in the config file will cause the value to be multiplied\r
        by 1024, 1048576, or 1073741824 prior to output.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
-z\r
</term>\r
<term>\r
--null\r
</term>\r
<listitem>\r
<simpara>\r
        For all options that output values and/or keys, always\r
        end values with the null character (instead of a\r
        newline). Use newline instead as a delimiter between\r
        key and value. This allows for secure parsing of the\r
        output without getting confused e.g. by values that\r
        contain line breaks.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
--get-colorbool name [stdout-is-tty]\r
</term>\r
<listitem>\r
<simpara>\r
        Find the color setting for <literal>name</literal> (e.g. <literal>color.diff</literal>) and output\r
        "true" or "false".  <literal>stdout-is-tty</literal> should be either "true" or\r
        "false", and is taken into account when configuration says\r
        "auto".  If <literal>stdout-is-tty</literal> is missing, then checks the standard\r
        output of the command itself, and exits with status 0 if color\r
        is to be used, or exits with status 1 otherwise.\r
        When the color setting for <literal>name</literal> is undefined, the command uses\r
        <literal>color.ui</literal> as fallback.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
--get-color name default\r
</term>\r
<listitem>\r
<simpara>\r
        Find the color configured for <literal>name</literal> (e.g. <literal>color.diff.new</literal>) and\r
        output it as the ANSI color escape sequence to the standard\r
        output.  The optional <literal>default</literal> parameter is used instead, if\r
        there is no color configured for <literal>name</literal>.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
</variablelist>\r
</simplesect>\r
<simplesect id="FILES">\r
<title>FILES</title>\r
<simpara>If not set explicitly with <emphasis>--file</emphasis>, there are three files where\r
<emphasis>git-config</emphasis> will search for configuration options:</simpara>\r
<variablelist>\r
<varlistentry>\r
<term>\r
$GIT_DIR/config\r
</term>\r
<listitem>\r
<simpara>\r
        Repository specific configuration file. (The filename is\r
        of course relative to the repository root, not the working\r
        directory.)\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
~/.gitconfig\r
</term>\r
<listitem>\r
<simpara>\r
        User-specific configuration file. Also called "global"\r
        configuration file.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
$(prefix)/etc/gitconfig\r
</term>\r
<listitem>\r
<simpara>\r
        System-wide configuration file.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
</variablelist>\r
<simpara>If no further options are given, all reading options will read all of these\r
files that are available. If the global or the system-wide configuration\r
file are not available they will be ignored. If the repository configuration\r
file is not available or readable, <emphasis>git-config</emphasis> will exit with a non-zero\r
error code. However, in neither case will an error message be issued.</simpara>\r
<simpara>All writing options will per default write to the repository specific\r
configuration file. Note that this also affects options like <emphasis>--replace-all</emphasis>\r
and <emphasis>--unset</emphasis>. <emphasis role="strong"><emphasis>git-config</emphasis> will only ever change one file at a time</emphasis>.</simpara>\r
<simpara>You can override these rules either by command line options or by environment\r
variables. The <emphasis>--global</emphasis> and the <emphasis>--system</emphasis> options will limit the file used\r
to the global or system-wide file respectively. The GIT_CONFIG environment\r
variable has a similar effect, but you can specify any filename you want.</simpara>\r
</simplesect>\r
<simplesect id="_environment">\r
<title>ENVIRONMENT</title>\r
<variablelist>\r
<varlistentry>\r
<term>\r
GIT_CONFIG\r
</term>\r
<listitem>\r
<simpara>\r
        Take the configuration from the given file instead of .git/config.\r
        Using the "--global" option forces this to ~/.gitconfig. Using the\r
        "--system" option forces this to $(prefix)/etc/gitconfig.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
</variablelist>\r
<simpara>See also <xref linkend="FILES"/>.</simpara>\r
</simplesect>\r
<simplesect id="EXAMPLES">\r
<title>EXAMPLES</title>\r
<simpara>Given a .git/config like this:</simpara>\r
<literallayout class="monospaced">#\r
# This is the config file, and\r
# a '#' or ';' character indicates\r
# a comment\r
#</literallayout>\r
<literallayout class="monospaced">; core variables\r
[core]\r
        ; Don't trust file modes\r
        filemode = false</literallayout>\r
<literallayout class="monospaced">; Our diff algorithm\r
[diff]\r
        external = /usr/local/bin/diff-wrapper\r
        renames = true</literallayout>\r
<literallayout class="monospaced">; Proxy settings\r
[core]\r
        gitproxy="proxy-command" for kernel.org\r
        gitproxy=default-proxy ; for all the rest</literallayout>\r
<simpara>you can set the filemode to true with</simpara>\r
<literallayout>% git config core.filemode true</literallayout>\r
<simpara>The hypothetical proxy command entries actually have a postfix to discern\r
what URL they apply to. Here is how to change the entry for kernel.org\r
to "ssh".</simpara>\r
<literallayout>% git config core.gitproxy '"ssh" for kernel.org' 'for kernel.org$'</literallayout>\r
<simpara>This makes sure that only the key/value pair for kernel.org is replaced.</simpara>\r
<simpara>To delete the entry for renames, do</simpara>\r
<literallayout>% git config --unset diff.renames</literallayout>\r
<simpara>If you want to delete an entry for a multivar (like core.gitproxy above),\r
you have to provide a regex matching the value of exactly one line.</simpara>\r
<simpara>To query the value for a given key, do</simpara>\r
<literallayout>% git config --get core.filemode</literallayout>\r
<simpara>or</simpara>\r
<literallayout>% git config core.filemode</literallayout>\r
<simpara>or, to query a multivar:</simpara>\r
<literallayout>% git config --get core.gitproxy "for kernel.org$"</literallayout>\r
<simpara>If you want to know all the values for a multivar, do:</simpara>\r
<literallayout>% git config --get-all core.gitproxy</literallayout>\r
<simpara>If you like to live dangerously, you can replace <emphasis role="strong">all</emphasis> core.gitproxy by a\r
new one with</simpara>\r
<literallayout>% git config --replace-all core.gitproxy ssh</literallayout>\r
<simpara>However, if you really only want to replace the line for the default proxy,\r
i.e. the one without a "for &#8230;" postfix, do something like this:</simpara>\r
<literallayout>% git config core.gitproxy ssh '! for '</literallayout>\r
<simpara>To actually match only values with an exclamation mark, you have to</simpara>\r
<literallayout>% git config section.key value '[!]'</literallayout>\r
<simpara>To add a new proxy, without altering any of the existing ones, use</simpara>\r
<literallayout>% git config core.gitproxy '"proxy-command" for example.com'</literallayout>\r
<simpara>An example to use customized color from the configuration in your\r
script:</simpara>\r
<literallayout>#!/bin/sh\r
WS=$(git config --get-color color.diff.whitespace "blue reverse")\r
RESET=$(git config --get-color "" "reset")\r
echo "${WS}your whitespace color or blue reverse${RESET}"</literallayout>\r
</simplesect>\r
<simplesect id="_configuration_file">\r
<title>CONFIGURATION FILE</title>\r
<simpara>The git configuration file contains a number of variables that affect\r
the git command&#8217;s behavior. <literal>.git/config</literal> file for each repository\r
is used to store the information for that repository, and\r
<literal>$HOME/.gitconfig</literal> is used to store per user information to give\r
fallback values for <literal>.git/config</literal> file. The file <literal>/etc/gitconfig</literal>\r
can be used to store system-wide defaults.</simpara>\r
<simpara>They can be used by both the git plumbing\r
and the porcelains. The variables are divided into sections, where\r
in the fully qualified variable name the variable itself is the last\r
dot-separated segment and the section name is everything before the last\r
dot. The variable names are case-insensitive and only alphanumeric\r
characters are allowed. Some variables may appear multiple times.</simpara>\r
<simplesect id="_syntax">\r
<title>Syntax</title>\r
<simpara>The syntax is fairly flexible and permissive; whitespaces are mostly\r
ignored.  The <emphasis>#</emphasis> and <emphasis>;</emphasis> characters begin comments to the end of line,\r
blank lines are ignored.</simpara>\r
<simpara>The file consists of sections and variables.  A section begins with\r
the name of the section in square brackets and continues until the next\r
section begins.  Section names are not case sensitive.  Only alphanumeric\r
characters, <emphasis><literal>-</literal></emphasis> and <emphasis><literal>.</literal></emphasis> are allowed in section names.  Each variable\r
must belong to some section, which means that there must be section\r
header before first setting of a variable.</simpara>\r
<simpara>Sections can be further divided into subsections.  To begin a subsection\r
put its name in double quotes, separated by space from the section name,\r
in the section header, like in example below:</simpara>\r
<literallayout>        [section "subsection"]</literallayout>\r
<simpara>Subsection names can contain any characters except newline (doublequote\r
<emphasis><literal>"</literal></emphasis> and backslash have to be escaped as <emphasis><literal>\"</literal></emphasis> and <emphasis><literal>\\</literal></emphasis>,\r
respectively) and are case sensitive.  Section header cannot span multiple\r
lines.  Variables may belong directly to a section or to a given subsection.\r
You can have <literal>[section]</literal> if you have <literal>[section "subsection"]</literal>, but you\r
don&#8217;t need to.</simpara>\r
<simpara>There is also (case insensitive) alternative <literal>[section.subsection]</literal> syntax.\r
In this syntax subsection names follow the same restrictions as for section\r
name.</simpara>\r
<simpara>All the other lines are recognized as setting variables, in the form\r
<emphasis>name = value</emphasis>.  If there is no equal sign on the line, the entire line\r
is taken as <emphasis>name</emphasis> and the variable is recognized as boolean "true".\r
The variable names are case-insensitive and only alphanumeric\r
characters and <emphasis><literal>-</literal></emphasis> are allowed.  There can be more than one value\r
for a given variable; we say then that variable is multivalued.</simpara>\r
<simpara>Leading and trailing whitespace in a variable value is discarded.\r
Internal whitespace within a variable value is retained verbatim.</simpara>\r
<simpara>The values following the equals sign in variable assign are all either\r
a string, an integer, or a boolean.  Boolean values may be given as yes/no,\r
0/1 or true/false.  Case is not significant in boolean values, when\r
converting value to the canonical form using <emphasis>--bool</emphasis> type specifier;\r
<emphasis>git-config</emphasis> will ensure that the output is "true" or "false".</simpara>\r
<simpara>String values may be entirely or partially enclosed in double quotes.\r
You need to enclose variable value in double quotes if you want to\r
preserve leading or trailing whitespace, or if variable value contains\r
beginning of comment characters (if it contains <emphasis>#</emphasis> or <emphasis>;</emphasis>).\r
Double quote <emphasis><literal>"</literal></emphasis> and backslash <emphasis><literal>\</literal></emphasis> characters in variable value must\r
be escaped: use <emphasis><literal>\"</literal></emphasis> for <emphasis><literal>"</literal></emphasis> and <emphasis><literal>\\</literal></emphasis> for <emphasis><literal>\</literal></emphasis>.</simpara>\r
<simpara>The following escape sequences (beside <emphasis><literal>\"</literal></emphasis> and <emphasis><literal>\\</literal></emphasis>) are recognized:\r
<emphasis><literal>\n</literal></emphasis> for newline character (NL), <emphasis><literal>\t</literal></emphasis> for horizontal tabulation (HT, TAB)\r
and <emphasis><literal>\b</literal></emphasis> for backspace (BS).  No other char escape sequence, nor octal\r
char sequences are valid.</simpara>\r
<simpara>Variable value ending in a <emphasis><literal>\</literal></emphasis> is continued on the next line in the\r
customary UNIX fashion.</simpara>\r
<simpara>Some variables may require special value format.</simpara>\r
</simplesect>\r
<simplesect id="_example">\r
<title>Example</title>\r
<literallayout class="monospaced"># Core variables\r
[core]\r
        ; Don't trust file modes\r
        filemode = false</literallayout>\r
<literallayout class="monospaced"># Our diff algorithm\r
[diff]\r
        external = /usr/local/bin/diff-wrapper\r
        renames = true</literallayout>\r
<literallayout class="monospaced">[branch "devel"]\r
        remote = origin\r
        merge = refs/heads/devel</literallayout>\r
<literallayout class="monospaced"># Proxy settings\r
[core]\r
        gitProxy="ssh" for "kernel.org"\r
        gitProxy=default-proxy ; for the rest</literallayout>\r
</simplesect>\r
<simplesect id="_variables">\r
<title>Variables</title>\r
<simpara>Note that this list is non-comprehensive and not necessarily complete.\r
For command-specific variables, you will find a more detailed description\r
in the appropriate manual page. You will find a description of non-core\r
porcelain configuration variables in the respective porcelain documentation.</simpara>\r
<variablelist>\r
<varlistentry>\r
<term>\r
core.fileMode\r
</term>\r
<listitem>\r
<simpara>\r
        If false, the executable bit differences between the index and\r
        the working copy are ignored; useful on broken filesystems like FAT.\r
        See <xref linkend="git-update-index(1)"/>. True by default.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
core.ignoreCygwinFSTricks\r
</term>\r
<listitem>\r
<simpara>\r
        This option is only used by Cygwin implementation of Git. If false,\r
        the Cygwin stat() and lstat() functions are used. This may be useful\r
        if your repository consists of a few separate directories joined in\r
        one hierarchy using Cygwin mount. If true, Git uses native Win32 API\r
        whenever it is possible and falls back to Cygwin functions only to\r
        handle symbol links. The native mode is more than twice faster than\r
        normal Cygwin l/stat() functions. True by default, unless core.filemode\r
        is true, in which case ignoreCygwinFSTricks is ignored as Cygwin&#8217;s\r
        POSIX emulation is required to support core.filemode.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
core.trustctime\r
</term>\r
<listitem>\r
<simpara>\r
        If false, the ctime differences between the index and the\r
        working copy are ignored; useful when the inode change time\r
        is regularly modified by something outside Git (file system\r
        crawlers and some backup systems).\r
        See <xref linkend="git-update-index(1)"/>. True by default.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
core.quotepath\r
</term>\r
<listitem>\r
<simpara>\r
        The commands that output paths (e.g. <emphasis>ls-files</emphasis>,\r
        <emphasis>diff</emphasis>), when not given the <literal>-z</literal> option, will quote\r
        "unusual" characters in the pathname by enclosing the\r
        pathname in a double-quote pair and with backslashes the\r
        same way strings in C source code are quoted.  If this\r
        variable is set to false, the bytes higher than 0x80 are\r
        not quoted but output as verbatim.  Note that double\r
        quote, backslash and control characters are always\r
        quoted without <literal>-z</literal> regardless of the setting of this\r
        variable.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
core.autocrlf\r
</term>\r
<listitem>\r
<simpara>\r
        If true, makes git convert <literal>CRLF</literal> at the end of lines in text files to\r
        <literal>LF</literal> when reading from the filesystem, and convert in reverse when\r
        writing to the filesystem.  The variable can be set to\r
        <emphasis>input</emphasis>, in which case the conversion happens only while\r
        reading from the filesystem but files are written out with\r
        <literal>LF</literal> at the end of lines.  Currently, which paths to consider\r
        "text" (i.e. be subjected to the autocrlf mechanism) is\r
        decided purely based on the contents.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
core.safecrlf\r
</term>\r
<listitem>\r
<simpara>\r
        If true, makes git check if converting <literal>CRLF</literal> as controlled by\r
        <literal>core.autocrlf</literal> is reversible.  Git will verify if a command\r
        modifies a file in the work tree either directly or indirectly.\r
        For example, committing a file followed by checking out the\r
        same file should yield the original file in the work tree.  If\r
        this is not the case for the current setting of\r
        <literal>core.autocrlf</literal>, git will reject the file.  The variable can\r
        be set to "warn", in which case git will only warn about an\r
        irreversible conversion but continue the operation.\r
</simpara>\r
<simpara>CRLF conversion bears a slight chance of corrupting data.\r
autocrlf=true will convert CRLF to LF during commit and LF to\r
CRLF during checkout.  A file that contains a mixture of LF and\r
CRLF before the commit cannot be recreated by git.  For text\r
files this is the right thing to do: it corrects line endings\r
such that we have only LF line endings in the repository.\r
But for binary files that are accidentally classified as text the\r
conversion can corrupt data.</simpara>\r
<simpara>If you recognize such corruption early you can easily fix it by\r
setting the conversion type explicitly in .gitattributes.  Right\r
after committing you still have the original file in your work\r
tree and this file is not yet corrupted.  You can explicitly tell\r
git that this file is binary and git will handle the file\r
appropriately.</simpara>\r
<simpara>Unfortunately, the desired effect of cleaning up text files with\r
mixed line endings and the undesired effect of corrupting binary\r
files cannot be distinguished.  In both cases CRLFs are removed\r
in an irreversible way.  For text files this is the right thing\r
to do because CRLFs are line endings, while for binary files\r
converting CRLFs corrupts data.</simpara>\r
<simpara>Note, this safety check does not mean that a checkout will generate a\r
file identical to the original file for a different setting of\r
<literal>core.autocrlf</literal>, but only for the current one.  For example, a text\r
file with <literal>LF</literal> would be accepted with <literal>core.autocrlf=input</literal> and could\r
later be checked out with <literal>core.autocrlf=true</literal>, in which case the\r
resulting file would contain <literal>CRLF</literal>, although the original file\r
contained <literal>LF</literal>.  However, in both work trees the line endings would be\r
consistent, that is either all <literal>LF</literal> or all <literal>CRLF</literal>, but never mixed.  A\r
file with mixed line endings would be reported by the <literal>core.safecrlf</literal>\r
mechanism.</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
core.symlinks\r
</term>\r
<listitem>\r
<simpara>\r
        If false, symbolic links are checked out as small plain files that\r
        contain the link text. <xref linkend="git-update-index(1)"/> and\r
        <xref linkend="git-add(1)"/> will not change the recorded type to regular\r
        file. Useful on filesystems like FAT that do not support\r
        symbolic links. True by default.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
core.gitProxy\r
</term>\r
<listitem>\r
<simpara>\r
        A "proxy command" to execute (as <emphasis>command host port</emphasis>) instead\r
        of establishing direct connection to the remote server when\r
        using the git protocol for fetching. If the variable value is\r
        in the "COMMAND for DOMAIN" format, the command is applied only\r
        on hostnames ending with the specified domain string. This variable\r
        may be set multiple times and is matched in the given order;\r
        the first match wins.\r
</simpara>\r
<simpara>Can be overridden by the <emphasis>GIT_PROXY_COMMAND</emphasis> environment variable\r
(which always applies universally, without the special "for"\r
handling).</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
core.ignoreStat\r
</term>\r
<listitem>\r
<simpara>\r
        If true, commands which modify both the working tree and the index\r
        will mark the updated paths with the "assume unchanged" bit in the\r
        index. These marked files are then assumed to stay unchanged in the\r
        working copy, until you mark them otherwise manually - Git will not\r
        detect the file changes by lstat() calls. This is useful on systems\r
        where those are very slow, such as Microsoft Windows.\r
        See <xref linkend="git-update-index(1)"/>.\r
        False by default.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
core.preferSymlinkRefs\r
</term>\r
<listitem>\r
<simpara>\r
        Instead of the default "symref" format for HEAD\r
        and other symbolic reference files, use symbolic links.\r
        This is sometimes needed to work with old scripts that\r
        expect HEAD to be a symbolic link.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
core.bare\r
</term>\r
<listitem>\r
<simpara>\r
        If true this repository is assumed to be <emphasis>bare</emphasis> and has no\r
        working directory associated with it.  If this is the case a\r
        number of commands that require a working directory will be\r
        disabled, such as <xref linkend="git-add(1)"/> or <xref linkend="git-merge(1)"/>.\r
</simpara>\r
<simpara>This setting is automatically guessed by <xref linkend="git-clone(1)"/> or\r
<xref linkend="git-init(1)"/> when the repository was created.  By default a\r
repository that ends in "/.git" is assumed to be not bare (bare =\r
false), while all other repositories are assumed to be bare (bare\r
= true).</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
core.worktree\r
</term>\r
<listitem>\r
<simpara>\r
        Set the path to the working tree.  The value will not be\r
        used in combination with repositories found automatically in\r
        a .git directory (i.e. $GIT_DIR is not set).\r
        This can be overridden by the GIT_WORK_TREE environment\r
        variable and the <emphasis>--work-tree</emphasis> command line option. It can be\r
        a absolute path or relative path to the directory specified by\r
        --git-dir or GIT_DIR.\r
        Note: If --git-dir or GIT_DIR are specified but none of\r
        --work-tree, GIT_WORK_TREE and core.worktree is specified,\r
        the current working directory is regarded as the top directory\r
        of your working tree.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
core.logAllRefUpdates\r
</term>\r
<listitem>\r
<simpara>\r
        Enable the reflog. Updates to a ref &lt;ref&gt; is logged to the file\r
        "$GIT_DIR/logs/&lt;ref&gt;", by appending the new and old\r
        SHA1, the date/time and the reason of the update, but\r
        only when the file exists.  If this configuration\r
        variable is set to true, missing "$GIT_DIR/logs/&lt;ref&gt;"\r
        file is automatically created for branch heads.\r
</simpara>\r
<simpara>This information can be used to determine what commit\r
was the tip of a branch "2 days ago".</simpara>\r
<simpara>This value is true by default in a repository that has\r
a working directory associated with it, and false by\r
default in a bare repository.</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
core.repositoryFormatVersion\r
</term>\r
<listitem>\r
<simpara>\r
        Internal variable identifying the repository format and layout\r
        version.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
core.sharedRepository\r
</term>\r
<listitem>\r
<simpara>\r
        When <emphasis>group</emphasis> (or <emphasis>true</emphasis>), the repository is made shareable between\r
        several users in a group (making sure all the files and objects are\r
        group-writable). When <emphasis>all</emphasis> (or <emphasis>world</emphasis> or <emphasis>everybody</emphasis>), the\r
        repository will be readable by all users, additionally to being\r
        group-shareable. When <emphasis>umask</emphasis> (or <emphasis>false</emphasis>), git will use permissions\r
        reported by umask(2). When <emphasis>0xxx</emphasis>, where <emphasis>0xxx</emphasis> is an octal number,\r
        files in the repository will have this mode value. <emphasis>0xxx</emphasis> will override\r
        user&#8217;s umask value, and thus, users with a safe umask (0077) can use\r
        this option. Examples: <emphasis>0660</emphasis> is equivalent to <emphasis>group</emphasis>. <emphasis>0640</emphasis> is a\r
        repository that is group-readable but not group-writable.\r
        See <xref linkend="git-init(1)"/>. False by default.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
core.warnAmbiguousRefs\r
</term>\r
<listitem>\r
<simpara>\r
        If true, git will warn you if the ref name you passed it is ambiguous\r
        and might match multiple refs in the .git/refs/ tree. True by default.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
core.compression\r
</term>\r
<listitem>\r
<simpara>\r
        An integer -1..9, indicating a default compression level.\r
        -1 is the zlib default. 0 means no compression,\r
        and 1..9 are various speed/size tradeoffs, 9 being slowest.\r
        If set, this provides a default to other compression variables,\r
        such as <emphasis>core.loosecompression</emphasis> and <emphasis>pack.compression</emphasis>.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
core.loosecompression\r
</term>\r
<listitem>\r
<simpara>\r
        An integer -1..9, indicating the compression level for objects that\r
        are not in a pack file. -1 is the zlib default. 0 means no\r
        compression, and 1..9 are various speed/size tradeoffs, 9 being\r
        slowest.  If not set,  defaults to core.compression.  If that is\r
        not set,  defaults to 1 (best speed).\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
core.packedGitWindowSize\r
</term>\r
<listitem>\r
<simpara>\r
        Number of bytes of a pack file to map into memory in a\r
        single mapping operation.  Larger window sizes may allow\r
        your system to process a smaller number of large pack files\r
        more quickly.  Smaller window sizes will negatively affect\r
        performance due to increased calls to the operating system&#8217;s\r
        memory manager, but may improve performance when accessing\r
        a large number of large pack files.\r
</simpara>\r
<simpara>Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32\r
MiB on 32 bit platforms and 1 GiB on 64 bit platforms.  This should\r
be reasonable for all users/operating systems.  You probably do\r
not need to adjust this value.</simpara>\r
<simpara>Common unit suffixes of <emphasis>k</emphasis>, <emphasis>m</emphasis>, or <emphasis>g</emphasis> are supported.</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
core.packedGitLimit\r
</term>\r
<listitem>\r
<simpara>\r
        Maximum number of bytes to map simultaneously into memory\r
        from pack files.  If Git needs to access more than this many\r
        bytes at once to complete an operation it will unmap existing\r
        regions to reclaim virtual address space within the process.\r
</simpara>\r
<simpara>Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.\r
This should be reasonable for all users/operating systems, except on\r
the largest projects.  You probably do not need to adjust this value.</simpara>\r
<simpara>Common unit suffixes of <emphasis>k</emphasis>, <emphasis>m</emphasis>, or <emphasis>g</emphasis> are supported.</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
core.deltaBaseCacheLimit\r
</term>\r
<listitem>\r
<simpara>\r
        Maximum number of bytes to reserve for caching base objects\r
        that multiple deltafied objects reference.  By storing the\r
        entire decompressed base objects in a cache Git is able\r
        to avoid unpacking and decompressing frequently used base\r
        objects multiple times.\r
</simpara>\r
<simpara>Default is 16 MiB on all platforms.  This should be reasonable\r
for all users/operating systems, except on the largest projects.\r
You probably do not need to adjust this value.</simpara>\r
<simpara>Common unit suffixes of <emphasis>k</emphasis>, <emphasis>m</emphasis>, or <emphasis>g</emphasis> are supported.</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
core.excludesfile\r
</term>\r
<listitem>\r
<simpara>\r
        In addition to <emphasis>.gitignore</emphasis> (per-directory) and\r
        <emphasis>.git/info/exclude</emphasis>, git looks into this file for patterns\r
        of files which are not meant to be tracked.  See\r
        <xref linkend="gitignore(5)"/>.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
core.editor\r
</term>\r
<listitem>\r
<simpara>\r
        Commands such as <literal>commit</literal> and <literal>tag</literal> that lets you edit\r
        messages by launching an editor uses the value of this\r
        variable when it is set, and the environment variable\r
        <literal>GIT_EDITOR</literal> is not set.  The order of preference is\r
        <literal>GIT_EDITOR</literal> environment, <literal>core.editor</literal>, <literal>VISUAL</literal> and\r
        <literal>EDITOR</literal> environment variables and then finally <literal>vi</literal>.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
core.pager\r
</term>\r
<listitem>\r
<simpara>\r
        The command that git will use to paginate output.  Can\r
        be overridden with the <literal>GIT_PAGER</literal> environment\r
        variable.  Note that git sets the <literal>LESS</literal> environment\r
        variable to <literal>FRSX</literal> if it is unset when it runs the\r
        pager.  One can change these settings by setting the\r
        <literal>LESS</literal> variable to some other value.  Alternately,\r
        these settings can be overridden on a project or\r
        global basis by setting the <literal>core.pager</literal> option.\r
        Setting <literal>core.pager</literal> has no affect on the <literal>LESS</literal>\r
        environment variable behaviour above, so if you want\r
        to override git&#8217;s default settings this way, you need\r
        to be explicit.  For example, to disable the S option\r
        in a backward compatible manner, set <literal>core.pager</literal>\r
        to "<literal>less -+$LESS -FRX</literal>".  This will be passed to the\r
        shell by git, which will translate the final command to\r
        "<literal>LESS=FRSX less -+FRSX -FRX</literal>".\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
core.whitespace\r
</term>\r
<listitem>\r
<simpara>\r
        A comma separated list of common whitespace problems to\r
        notice.  <emphasis>git-diff</emphasis> will use <literal>color.diff.whitespace</literal> to\r
        highlight them, and <emphasis>git-apply --whitespace=error</emphasis> will\r
        consider them as errors.  You can prefix <literal>-</literal> to disable\r
        any of them (e.g. <literal>-trailing-space</literal>):\r
</simpara>\r
<itemizedlist>\r
<listitem>\r
<simpara>\r
<literal>trailing-space</literal> treats trailing whitespaces at the end of the line\r
  as an error (enabled by default).\r
</simpara>\r
</listitem>\r
<listitem>\r
<simpara>\r
<literal>space-before-tab</literal> treats a space character that appears immediately\r
  before a tab character in the initial indent part of the line as an\r
  error (enabled by default).\r
</simpara>\r
</listitem>\r
<listitem>\r
<simpara>\r
<literal>indent-with-non-tab</literal> treats a line that is indented with 8 or more\r
  space characters as an error (not enabled by default).\r
</simpara>\r
</listitem>\r
<listitem>\r
<simpara>\r
<literal>cr-at-eol</literal> treats a carriage-return at the end of line as\r
  part of the line terminator, i.e. with it, <literal>trailing-space</literal>\r
  does not trigger if the character before such a carriage-return\r
  is not a whitespace (not enabled by default).\r
</simpara>\r
</listitem>\r
</itemizedlist>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
core.fsyncobjectfiles\r
</term>\r
<listitem>\r
<simpara>\r
        This boolean will enable <emphasis>fsync()</emphasis> when writing object files.\r
</simpara>\r
<simpara>This is a total waste of time and effort on a filesystem that orders\r
data writes properly, but can be useful for filesystems that do not use\r
journalling (traditional UNIX filesystems) or that only journal metadata\r
and not file contents (OS X&#8217;s HFS+, or Linux ext3 with "data=writeback").</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
core.preloadindex\r
</term>\r
<listitem>\r
<simpara>\r
        Enable parallel index preload for operations like <emphasis>git diff</emphasis>\r
</simpara>\r
<simpara>This can speed up operations like <emphasis>git diff</emphasis> and <emphasis>git status</emphasis> especially\r
on filesystems like NFS that have weak caching semantics and thus\r
relatively high IO latencies.  With this set to <emphasis>true</emphasis>, git will do the\r
index comparison to the filesystem data in parallel, allowing\r
overlapping IO&#8217;s.</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
core.notesRef\r
</term>\r
<listitem>\r
<simpara>\r
        When showing commit messages, also show notes which are stored in\r
        the given ref.  This ref is expected to contain files named\r
        after the full SHA-1 of the commit they annotate.\r
</simpara>\r
<simpara>If such a file exists in the given ref, the referenced blob is read, and\r
appended to the commit message, separated by a "Notes:" line.  If the\r
given ref itself does not exist, it is not an error, but means that no\r
notes should be printed.</simpara>\r
<simpara>This setting defaults to "refs/notes/commits", and can be overridden by\r
the <literal>GIT_NOTES_REF</literal> environment variable.</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
alias.*\r
</term>\r
<listitem>\r
<simpara>\r
        Command aliases for the <xref linkend="git(1)"/> command wrapper - e.g.\r
        after defining "alias.last = cat-file commit HEAD", the invocation\r
        "git last" is equivalent to "git cat-file commit HEAD". To avoid\r
        confusion and troubles with script usage, aliases that\r
        hide existing git commands are ignored. Arguments are split by\r
        spaces, the usual shell quoting and escaping is supported.\r
        quote pair and a backslash can be used to quote them.\r
</simpara>\r
<simpara>If the alias expansion is prefixed with an exclamation point,\r
it will be treated as a shell command.  For example, defining\r
"alias.new = !gitk --all --not ORIG_HEAD", the invocation\r
"git new" is equivalent to running the shell command\r
"gitk --all --not ORIG_HEAD".</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
apply.whitespace\r
</term>\r
<listitem>\r
<simpara>\r
        Tells <emphasis>git-apply</emphasis> how to handle whitespaces, in the same way\r
        as the <emphasis>--whitespace</emphasis> option. See <xref linkend="git-apply(1)"/>.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
branch.autosetupmerge\r
</term>\r
<listitem>\r
<simpara>\r
        Tells <emphasis>git-branch</emphasis> and <emphasis>git-checkout</emphasis> to setup new branches\r
        so that <xref linkend="git-pull(1)"/> will appropriately merge from the\r
        starting point branch. Note that even if this option is not set,\r
        this behavior can be chosen per-branch using the <literal>--track</literal>\r
        and <literal>--no-track</literal> options. The valid settings are: <literal>false</literal>&#8201;&#8212;&#8201;no\r
        automatic setup is done; <literal>true</literal>&#8201;&#8212;&#8201;automatic setup is done when the\r
        starting point is a remote branch; <literal>always</literal>&#8201;&#8212;&#8201;automatic setup is\r
        done when the starting point is either a local branch or remote\r
        branch. This option defaults to true.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
branch.autosetuprebase\r
</term>\r
<listitem>\r
<simpara>\r
        When a new branch is created with <emphasis>git-branch</emphasis> or <emphasis>git-checkout</emphasis>\r
        that tracks another branch, this variable tells git to set\r
        up pull to rebase instead of merge (see "branch.&lt;name&gt;.rebase").\r
        When <literal>never</literal>, rebase is never automatically set to true.\r
        When <literal>local</literal>, rebase is set to true for tracked branches of\r
        other local branches.\r
        When <literal>remote</literal>, rebase is set to true for tracked branches of\r
        remote branches.\r
        When <literal>always</literal>, rebase will be set to true for all tracking\r
        branches.\r
        See "branch.autosetupmerge" for details on how to set up a\r
        branch to track another branch.\r
        This option defaults to never.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
branch.&lt;name&gt;.remote\r
</term>\r
<listitem>\r
<simpara>\r
        When in branch &lt;name&gt;, it tells <emphasis>git-fetch</emphasis> which remote to fetch.\r
        If this option is not given, <emphasis>git-fetch</emphasis> defaults to remote "origin".\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
branch.&lt;name&gt;.merge\r
</term>\r
<listitem>\r
<simpara>\r
        When in branch &lt;name&gt;, it tells <emphasis>git-fetch</emphasis> the default\r
        refspec to be marked for merging in FETCH_HEAD. The value is\r
        handled like the remote part of a refspec, and must match a\r
        ref which is fetched from the remote given by\r
        "branch.&lt;name&gt;.remote".\r
        The merge information is used by <emphasis>git-pull</emphasis> (which at first calls\r
        <emphasis>git-fetch</emphasis>) to lookup the default branch for merging. Without\r
        this option, <emphasis>git-pull</emphasis> defaults to merge the first refspec fetched.\r
        Specify multiple values to get an octopus merge.\r
        If you wish to setup <emphasis>git-pull</emphasis> so that it merges into &lt;name&gt; from\r
        another branch in the local repository, you can point\r
        branch.&lt;name&gt;.merge to the desired branch, and use the special setting\r
        <literal>.</literal> (a period) for branch.&lt;name&gt;.remote.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
branch.&lt;name&gt;.mergeoptions\r
</term>\r
<listitem>\r
<simpara>\r
        Sets default options for merging into branch &lt;name&gt;. The syntax and\r
        supported options are equal to that of <xref linkend="git-merge(1)"/>, but\r
        option values containing whitespace characters are currently not\r
        supported.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
branch.&lt;name&gt;.rebase\r
</term>\r
<listitem>\r
<simpara>\r
        When true, rebase the branch &lt;name&gt; on top of the fetched branch,\r
        instead of merging the default branch from the default remote when\r
        "git pull" is run.\r
        <emphasis role="strong">NOTE</emphasis>: this is a possibly dangerous operation; do <emphasis role="strong">not</emphasis> use\r
        it unless you understand the implications (see <xref linkend="git-rebase(1)"/>\r
        for details).\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
browser.&lt;tool&gt;.cmd\r
</term>\r
<listitem>\r
<simpara>\r
        Specify the command to invoke the specified browser. The\r
        specified command is evaluated in shell with the URLs passed\r
        as arguments. (See <xref linkend="git-web&#8212;browse(1)"/>.)\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
browser.&lt;tool&gt;.path\r
</term>\r
<listitem>\r
<simpara>\r
        Override the path for the given tool that may be used to\r
        browse HTML help (see <emphasis>-w</emphasis> option in <xref linkend="git-help(1)"/>) or a\r
        working repository in gitweb (see <xref linkend="git-instaweb(1)"/>).\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
clean.requireForce\r
</term>\r
<listitem>\r
<simpara>\r
        A boolean to make git-clean do nothing unless given -f\r
        or -n.   Defaults to true.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
color.branch\r
</term>\r
<listitem>\r
<simpara>\r
        A boolean to enable/disable color in the output of\r
        <xref linkend="git-branch(1)"/>. May be set to <literal>always</literal>,\r
        <literal>false</literal> (or <literal>never</literal>) or <literal>auto</literal> (or <literal>true</literal>), in which case colors are used\r
        only when the output is to a terminal. Defaults to false.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
color.branch.&lt;slot&gt;\r
</term>\r
<listitem>\r
<simpara>\r
        Use customized color for branch coloration. <literal>&lt;slot&gt;</literal> is one of\r
        <literal>current</literal> (the current branch), <literal>local</literal> (a local branch),\r
        <literal>remote</literal> (a tracking branch in refs/remotes/), <literal>plain</literal> (other\r
        refs).\r
</simpara>\r
<simpara>The value for these configuration variables is a list of colors (at most\r
two) and attributes (at most one), separated by spaces.  The colors\r
accepted are <literal>normal</literal>, <literal>black</literal>, <literal>red</literal>, <literal>green</literal>, <literal>yellow</literal>, <literal>blue</literal>,\r
<literal>magenta</literal>, <literal>cyan</literal> and <literal>white</literal>; the attributes are <literal>bold</literal>, <literal>dim</literal>, <literal>ul</literal>,\r
<literal>blink</literal> and <literal>reverse</literal>.  The first color given is the foreground; the\r
second is the background.  The position of the attribute, if any,\r
doesn&#8217;t matter.</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
color.diff\r
</term>\r
<listitem>\r
<simpara>\r
        When set to <literal>always</literal>, always use colors in patch.\r
        When false (or <literal>never</literal>), never.  When set to <literal>true</literal> or <literal>auto</literal>, use\r
        colors only when the output is to the terminal. Defaults to false.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
color.diff.&lt;slot&gt;\r
</term>\r
<listitem>\r
<simpara>\r
        Use customized color for diff colorization.  <literal>&lt;slot&gt;</literal> specifies\r
        which part of the patch to use the specified color, and is one\r
        of <literal>plain</literal> (context text), <literal>meta</literal> (metainformation), <literal>frag</literal>\r
        (hunk header), <literal>old</literal> (removed lines), <literal>new</literal> (added lines),\r
        <literal>commit</literal> (commit headers), or <literal>whitespace</literal> (highlighting\r
        whitespace errors). The values of these variables may be specified as\r
        in color.branch.&lt;slot&gt;.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
color.interactive\r
</term>\r
<listitem>\r
<simpara>\r
        When set to <literal>always</literal>, always use colors for interactive prompts\r
        and displays (such as those used by "git-add --interactive").\r
        When false (or <literal>never</literal>), never.  When set to <literal>true</literal> or <literal>auto</literal>, use\r
        colors only when the output is to the terminal. Defaults to false.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
color.interactive.&lt;slot&gt;\r
</term>\r
<listitem>\r
<simpara>\r
        Use customized color for <emphasis>git-add --interactive</emphasis>\r
        output. <literal>&lt;slot&gt;</literal> may be <literal>prompt</literal>, <literal>header</literal>, <literal>help</literal> or <literal>error</literal>, for\r
        four distinct types of normal output from interactive\r
        programs.  The values of these variables may be specified as\r
        in color.branch.&lt;slot&gt;.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
color.pager\r
</term>\r
<listitem>\r
<simpara>\r
        A boolean to enable/disable colored output when the pager is in\r
        use (default is true).\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
color.status\r
</term>\r
<listitem>\r
<simpara>\r
        A boolean to enable/disable color in the output of\r
        <xref linkend="git-status(1)"/>. May be set to <literal>always</literal>,\r
        <literal>false</literal> (or <literal>never</literal>) or <literal>auto</literal> (or <literal>true</literal>), in which case colors are used\r
        only when the output is to a terminal. Defaults to false.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
color.status.&lt;slot&gt;\r
</term>\r
<listitem>\r
<simpara>\r
        Use customized color for status colorization. <literal>&lt;slot&gt;</literal> is\r
        one of <literal>header</literal> (the header text of the status message),\r
        <literal>added</literal> or <literal>updated</literal> (files which are added but not committed),\r
        <literal>changed</literal> (files which are changed but not added in the index),\r
        <literal>untracked</literal> (files which are not tracked by git), or\r
        <literal>nobranch</literal> (the color the <emphasis>no branch</emphasis> warning is shown in, defaulting\r
        to red). The values of these variables may be specified as in\r
        color.branch.&lt;slot&gt;.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
color.ui\r
</term>\r
<listitem>\r
<simpara>\r
        When set to <literal>always</literal>, always use colors in all git commands which\r
        are capable of colored output. When false (or <literal>never</literal>), never. When\r
        set to <literal>true</literal> or <literal>auto</literal>, use colors only when the output is to the\r
        terminal. When more specific variables of color.* are set, they always\r
        take precedence over this setting. Defaults to false.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
commit.template\r
</term>\r
<listitem>\r
<simpara>\r
        Specify a file to use as the template for new commit messages.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
diff.autorefreshindex\r
</term>\r
<listitem>\r
<simpara>\r
        When using <emphasis>git-diff</emphasis> to compare with work tree\r
        files, do not consider stat-only change as changed.\r
        Instead, silently run <literal>git update-index --refresh</literal> to\r
        update the cached stat information for paths whose\r
        contents in the work tree match the contents in the\r
        index.  This option defaults to true.  Note that this\r
        affects only <emphasis>git-diff</emphasis> Porcelain, and not lower level\r
        <emphasis>diff</emphasis> commands, such as <emphasis>git-diff-files</emphasis>.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
diff.external\r
</term>\r
<listitem>\r
<simpara>\r
        If this config variable is set, diff generation is not\r
        performed using the internal diff machinery, but using the\r
        given command.  Can be overridden with the &#8216;GIT_EXTERNAL_DIFF&#8217;\r
        environment variable.  The command is called with parameters\r
        as described under "git Diffs" in <xref linkend="git(1)"/>.  Note: if\r
        you want to use an external diff program only on a subset of\r
        your files, you might want to use <xref linkend="gitattributes(5)"/> instead.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
diff.mnemonicprefix\r
</term>\r
<listitem>\r
<simpara>\r
        If set, <emphasis>git-diff</emphasis> uses a prefix pair that is different from the\r
        standard "a/" and "b/" depending on what is being compared.  When\r
        this configuration is in effect, reverse diff output also swaps\r
        the order of the prefixes:\r
</simpara>\r
<variablelist>\r
<varlistentry>\r
<term>\r
<emphasis>git-diff</emphasis>\r
</term>\r
<listitem>\r
<simpara>\r
        compares the (i)ndex and the (w)ork tree;\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
<emphasis>git-diff HEAD</emphasis>\r
</term>\r
<listitem>\r
<simpara>\r
         compares a (c)ommit and the (w)ork tree;\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
<emphasis>git diff --cached</emphasis>\r
</term>\r
<listitem>\r
<simpara>\r
        compares a (c)ommit and the (i)ndex;\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
<emphasis>git-diff HEAD:file1 file2</emphasis>\r
</term>\r
<listitem>\r
<simpara>\r
        compares an (o)bject and a (w)ork tree entity;\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
<emphasis>git diff --no-index a b</emphasis>\r
</term>\r
<listitem>\r
<simpara>\r
        compares two non-git things (1) and (2).\r
</simpara>\r
</listitem>\r
</varlistentry>\r
</variablelist>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
diff.renameLimit\r
</term>\r
<listitem>\r
<simpara>\r
        The number of files to consider when performing the copy/rename\r
        detection; equivalent to the <emphasis>git-diff</emphasis> option <emphasis>-l</emphasis>.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
diff.renames\r
</term>\r
<listitem>\r
<simpara>\r
        Tells git to detect renames.  If set to any boolean value, it\r
        will enable basic rename detection.  If set to "copies" or\r
        "copy", it will detect copies, as well.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
diff.suppressBlankEmpty\r
</term>\r
<listitem>\r
<simpara>\r
        A boolean to inhibit the standard behavior of printing a space\r
        before each empty output line. Defaults to false.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
diff.wordRegex\r
</term>\r
<listitem>\r
<simpara>\r
        A POSIX Extended Regular Expression used to determine what is a "word"\r
        when performing word-by-word difference calculations.  Character\r
        sequences that match the regular expression are "words", all other\r
        characters are <emphasis role="strong">ignorable</emphasis> whitespace.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
fetch.unpackLimit\r
</term>\r
<listitem>\r
<simpara>\r
        If the number of objects fetched over the git native\r
        transfer is below this\r
        limit, then the objects will be unpacked into loose object\r
        files. However if the number of received objects equals or\r
        exceeds this limit then the received pack will be stored as\r
        a pack, after adding any missing delta bases.  Storing the\r
        pack from a push can make the push operation complete faster,\r
        especially on slow filesystems.  If not set, the value of\r
        <literal>transfer.unpackLimit</literal> is used instead.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
format.numbered\r
</term>\r
<listitem>\r
<simpara>\r
        A boolean which can enable or disable sequence numbers in patch\r
        subjects.  It defaults to "auto" which enables it only if there\r
        is more than one patch.  It can be enabled or disabled for all\r
        messages by setting it to "true" or "false".  See --numbered\r
        option in <xref linkend="git-format-patch(1)"/>.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
format.headers\r
</term>\r
<listitem>\r
<simpara>\r
        Additional email headers to include in a patch to be submitted\r
        by mail.  See <xref linkend="git-format-patch(1)"/>.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
format.suffix\r
</term>\r
<listitem>\r
<simpara>\r
        The default for format-patch is to output files with the suffix\r
        <literal>.patch</literal>. Use this variable to change that suffix (make sure to\r
        include the dot if you want it).\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
format.pretty\r
</term>\r
<listitem>\r
<simpara>\r
        The default pretty format for log/show/whatchanged command,\r
        See <xref linkend="git-log(1)"/>, <xref linkend="git-show(1)"/>,\r
        <xref linkend="git-whatchanged(1)"/>.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
gc.aggressiveWindow\r
</term>\r
<listitem>\r
<simpara>\r
        The window size parameter used in the delta compression\r
        algorithm used by <emphasis>git-gc --aggressive</emphasis>.  This defaults\r
        to 10.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
gc.auto\r
</term>\r
<listitem>\r
<simpara>\r
        When there are approximately more than this many loose\r
        objects in the repository, <literal>git gc --auto</literal> will pack them.\r
        Some Porcelain commands use this command to perform a\r
        light-weight garbage collection from time to time.  The\r
        default value is 6700.  Setting this to 0 disables it.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
gc.autopacklimit\r
</term>\r
<listitem>\r
<simpara>\r
        When there are more than this many packs that are not\r
        marked with <literal>*.keep</literal> file in the repository, <literal>git gc\r
        --auto</literal> consolidates them into one larger pack.  The\r
        default value is 50.  Setting this to 0 disables it.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
gc.packrefs\r
</term>\r
<listitem>\r
<simpara>\r
        <emphasis>git-gc</emphasis> does not run <literal>git pack-refs</literal> in a bare repository by\r
        default so that older dumb-transport clients can still fetch\r
        from the repository.  Setting this to <literal>true</literal> lets <emphasis>git-gc</emphasis>\r
        to run <literal>git pack-refs</literal>.  Setting this to <literal>false</literal> tells\r
        <emphasis>git-gc</emphasis> never to run <literal>git pack-refs</literal>. The default setting is\r
        <literal>notbare</literal>. Enable it only when you know you do not have to\r
        support such clients.  The default setting will change to <literal>true</literal>\r
        at some stage, and setting this to <literal>false</literal> will continue to\r
        prevent <literal>git pack-refs</literal> from being run from <emphasis>git-gc</emphasis>.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
gc.pruneexpire\r
</term>\r
<listitem>\r
<simpara>\r
        When <emphasis>git-gc</emphasis> is run, it will call <emphasis>prune --expire 2.weeks.ago</emphasis>.\r
        Override the grace period with this config variable.  The value\r
        "now" may be used to disable this  grace period and always prune\r
        unreachable objects immediately.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
gc.reflogexpire\r
</term>\r
<listitem>\r
<simpara>\r
        <emphasis>git-reflog expire</emphasis> removes reflog entries older than\r
        this time; defaults to 90 days.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
gc.reflogexpireunreachable\r
</term>\r
<listitem>\r
<simpara>\r
        <emphasis>git-reflog expire</emphasis> removes reflog entries older than\r
        this time and are not reachable from the current tip;\r
        defaults to 30 days.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
gc.rerereresolved\r
</term>\r
<listitem>\r
<simpara>\r
        Records of conflicted merge you resolved earlier are\r
        kept for this many days when <emphasis>git-rerere gc</emphasis> is run.\r
        The default is 60 days.  See <xref linkend="git-rerere(1)"/>.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
gc.rerereunresolved\r
</term>\r
<listitem>\r
<simpara>\r
        Records of conflicted merge you have not resolved are\r
        kept for this many days when <emphasis>git-rerere gc</emphasis> is run.\r
        The default is 15 days.  See <xref linkend="git-rerere(1)"/>.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
gitcvs.commitmsgannotation\r
</term>\r
<listitem>\r
<simpara>\r
        Append this string to each commit message. Set to empty string\r
        to disable this feature. Defaults to "via git-CVS emulator".\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
gitcvs.enabled\r
</term>\r
<listitem>\r
<simpara>\r
        Whether the CVS server interface is enabled for this repository.\r
        See <xref linkend="git-cvsserver(1)"/>.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
gitcvs.logfile\r
</term>\r
<listitem>\r
<simpara>\r
        Path to a log file where the CVS server interface well&#8230; logs\r
        various stuff. See <xref linkend="git-cvsserver(1)"/>.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
gitcvs.usecrlfattr\r
</term>\r
<listitem>\r
<simpara>\r
        If true, the server will look up the <literal>crlf</literal> attribute for\r
        files to determine the <emphasis>-k</emphasis> modes to use. If <literal>crlf</literal> is set,\r
        the <emphasis>-k</emphasis> mode will be left blank, so cvs clients will\r
        treat it as text. If <literal>crlf</literal> is explicitly unset, the file\r
        will be set with <emphasis>-kb</emphasis> mode, which suppresses any newline munging\r
        the client might otherwise do. If <literal>crlf</literal> is not specified,\r
        then <emphasis>gitcvs.allbinary</emphasis> is used. See <xref linkend="gitattributes(5)"/>.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
gitcvs.allbinary\r
</term>\r
<listitem>\r
<simpara>\r
        This is used if <emphasis>gitcvs.usecrlfattr</emphasis> does not resolve\r
        the correct <emphasis>-kb</emphasis> mode to use. If true, all\r
        unresolved files are sent to the client in\r
        mode <emphasis>-kb</emphasis>. This causes the client to treat them\r
        as binary files, which suppresses any newline munging it\r
        otherwise might do. Alternatively, if it is set to "guess",\r
        then the contents of the file are examined to decide if\r
        it is binary, similar to <emphasis>core.autocrlf</emphasis>.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
gitcvs.dbname\r
</term>\r
<listitem>\r
<simpara>\r
        Database used by git-cvsserver to cache revision information\r
        derived from the git repository. The exact meaning depends on the\r
        used database driver, for SQLite (which is the default driver) this\r
        is a filename. Supports variable substitution (see\r
        <xref linkend="git-cvsserver(1)"/> for details). May not contain semicolons (<literal>;</literal>).\r
        Default: <emphasis>%Ggitcvs.%m.sqlite</emphasis>\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
gitcvs.dbdriver\r
</term>\r
<listitem>\r
<simpara>\r
        Used Perl DBI driver. You can specify any available driver\r
        for this here, but it might not work. git-cvsserver is tested\r
        with <emphasis>DBD::SQLite</emphasis>, reported to work with <emphasis>DBD::Pg</emphasis>, and\r
        reported <emphasis role="strong">not</emphasis> to work with <emphasis>DBD::mysql</emphasis>. Experimental feature.\r
        May not contain double colons (<literal>:</literal>). Default: <emphasis>SQLite</emphasis>.\r
        See <xref linkend="git-cvsserver(1)"/>.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
gitcvs.dbuser, gitcvs.dbpass\r
</term>\r
<listitem>\r
<simpara>\r
        Database user and password. Only useful if setting <emphasis>gitcvs.dbdriver</emphasis>,\r
        since SQLite has no concept of database users and/or passwords.\r
        <emphasis>gitcvs.dbuser</emphasis> supports variable substitution (see\r
        <xref linkend="git-cvsserver(1)"/> for details).\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
gitcvs.dbTableNamePrefix\r
</term>\r
<listitem>\r
<simpara>\r
        Database table name prefix.  Prepended to the names of any\r
        database tables used, allowing a single database to be used\r
        for several repositories.  Supports variable substitution (see\r
        <xref linkend="git-cvsserver(1)"/> for details).  Any non-alphabetic\r
        characters will be replaced with underscores.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
</variablelist>\r
<simpara>All gitcvs variables except for <emphasis>gitcvs.usecrlfattr</emphasis> and\r
<emphasis>gitcvs.allbinary</emphasis> can also be specified as\r
<emphasis>gitcvs.&lt;access_method&gt;.&lt;varname&gt;</emphasis> (where <emphasis>access_method</emphasis>\r
is one of "ext" and "pserver") to make them apply only for the given\r
access method.</simpara>\r
<variablelist>\r
<varlistentry>\r
<term>\r
gui.commitmsgwidth\r
</term>\r
<listitem>\r
<simpara>\r
        Defines how wide the commit message window is in the\r
        <xref linkend="git-gui(1)"/>. "75" is the default.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
gui.diffcontext\r
</term>\r
<listitem>\r
<simpara>\r
        Specifies how many context lines should be used in calls to diff\r
        made by the <xref linkend="git-gui(1)"/>. The default is "5".\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
gui.encoding\r
</term>\r
<listitem>\r
<simpara>\r
        Specifies the default encoding to use for displaying of\r
        file contents in <xref linkend="git-gui(1)"/> and <xref linkend="gitk(1)"/>.\r
        It can be overridden by setting the <emphasis>encoding</emphasis> attribute\r
        for relevant files (see <xref linkend="gitattributes(5)"/>).\r
        If this option is not set, the tools default to the\r
        locale encoding.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
gui.matchtrackingbranch\r
</term>\r
<listitem>\r
<simpara>\r
        Determines if new branches created with <xref linkend="git-gui(1)"/> should\r
        default to tracking remote branches with matching names or\r
        not. Default: "false".\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
gui.newbranchtemplate\r
</term>\r
<listitem>\r
<simpara>\r
        Is used as suggested name when creating new branches using the\r
        <xref linkend="git-gui(1)"/>.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
gui.pruneduringfetch\r
</term>\r
<listitem>\r
<simpara>\r
        "true" if <xref linkend="git-gui(1)"/> should prune tracking branches when\r
        performing a fetch. The default value is "false".\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
gui.trustmtime\r
</term>\r
<listitem>\r
<simpara>\r
        Determines if <xref linkend="git-gui(1)"/> should trust the file modification\r
        timestamp or not. By default the timestamps are not trusted.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
gui.spellingdictionary\r
</term>\r
<listitem>\r
<simpara>\r
        Specifies the dictionary used for spell checking commit messages in\r
        the <xref linkend="git-gui(1)"/>. When set to "none" spell checking is turned\r
        off.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
gui.fastcopyblame\r
</term>\r
<listitem>\r
<simpara>\r
        If true, <emphasis>git gui blame</emphasis> uses <emphasis>-C</emphasis> instead of <emphasis>-C -C</emphasis> for original\r
        location detection. It makes blame significantly faster on huge\r
        repositories at the expense of less thorough copy detection.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
gui.copyblamethreshold\r
</term>\r
<listitem>\r
<simpara>\r
        Specifies the threshold to use in <emphasis>git gui blame</emphasis> original location\r
        detection, measured in alphanumeric characters. See the\r
        <xref linkend="git-blame(1)"/> manual for more information on copy detection.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
gui.blamehistoryctx\r
</term>\r
<listitem>\r
<simpara>\r
        Specifies the radius of history context in days to show in\r
        <xref linkend="gitk(1)"/> for the selected commit, when the <literal>Show History\r
        Context</literal> menu item is invoked from <emphasis>git gui blame</emphasis>. If this\r
        variable is set to zero, the whole history is shown.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
guitool.&lt;name&gt;.cmd\r
</term>\r
<listitem>\r
<simpara>\r
        Specifies the shell command line to execute when the corresponding item\r
        of the <xref linkend="git-gui(1)"/> <literal>Tools</literal> menu is invoked. This option is\r
        mandatory for every tool. The command is executed from the root of\r
        the working directory, and in the environment it receives the name of\r
        the tool as <emphasis>GIT_GUITOOL</emphasis>, the name of the currently selected file as\r
        <emphasis>FILENAME</emphasis>, and the name of the current branch as <emphasis>CUR_BRANCH</emphasis> (if\r
        the head is detached, <emphasis>CUR_BRANCH</emphasis> is empty).\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
guitool.&lt;name&gt;.needsfile\r
</term>\r
<listitem>\r
<simpara>\r
        Run the tool only if a diff is selected in the GUI. It guarantees\r
        that <emphasis>FILENAME</emphasis> is not empty.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
guitool.&lt;name&gt;.noconsole\r
</term>\r
<listitem>\r
<simpara>\r
        Run the command silently, without creating a window to display its\r
        output.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
guitool.&lt;name&gt;.norescan\r
</term>\r
<listitem>\r
<simpara>\r
        Don&#8217;t rescan the working directory for changes after the tool\r
        finishes execution.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
guitool.&lt;name&gt;.confirm\r
</term>\r
<listitem>\r
<simpara>\r
        Show a confirmation dialog before actually running the tool.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
guitool.&lt;name&gt;.argprompt\r
</term>\r
<listitem>\r
<simpara>\r
        Request a string argument from the user, and pass it to the tool\r
        through the <emphasis>ARGS</emphasis> environment variable. Since requesting an\r
        argument implies confirmation, the <emphasis>confirm</emphasis> option has no effect\r
        if this is enabled. If the option is set to <emphasis>true</emphasis>, <emphasis>yes</emphasis>, or <emphasis>1</emphasis>,\r
        the dialog uses a built-in generic prompt; otherwise the exact\r
        value of the variable is used.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
guitool.&lt;name&gt;.revprompt\r
</term>\r
<listitem>\r
<simpara>\r
        Request a single valid revision from the user, and set the\r
        <emphasis>REVISION</emphasis> environment variable. In other aspects this option\r
        is similar to <emphasis>argprompt</emphasis>, and can be used together with it.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
guitool.&lt;name&gt;.revunmerged\r
</term>\r
<listitem>\r
<simpara>\r
        Show only unmerged branches in the <emphasis>revprompt</emphasis> subdialog.\r
        This is useful for tools similar to merge or rebase, but not\r
        for things like checkout or reset.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
guitool.&lt;name&gt;.title\r
</term>\r
<listitem>\r
<simpara>\r
        Specifies the title to use for the prompt dialog. The default\r
        is the tool name.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
guitool.&lt;name&gt;.prompt\r
</term>\r
<listitem>\r
<simpara>\r
        Specifies the general prompt string to display at the top of\r
        the dialog, before subsections for <emphasis>argprompt</emphasis> and <emphasis>revprompt</emphasis>.\r
        The default value includes the actual command.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
help.browser\r
</term>\r
<listitem>\r
<simpara>\r
        Specify the browser that will be used to display help in the\r
        <emphasis>web</emphasis> format. See <xref linkend="git-help(1)"/>.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
help.format\r
</term>\r
<listitem>\r
<simpara>\r
        Override the default help format used by <xref linkend="git-help(1)"/>.\r
        Values <emphasis>man</emphasis>, <emphasis>info</emphasis>, <emphasis>web</emphasis> and <emphasis>html</emphasis> are supported. <emphasis>man</emphasis> is\r
        the default. <emphasis>web</emphasis> and <emphasis>html</emphasis> are the same.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
help.autocorrect\r
</term>\r
<listitem>\r
<simpara>\r
        Automatically correct and execute mistyped commands after\r
        waiting for the given number of deciseconds (0.1 sec). If more\r
        than one command can be deduced from the entered text, nothing\r
        will be executed.  If the value of this option is negative,\r
        the corrected command will be executed immediately. If the\r
        value is 0 - the command will be just shown but not executed.\r
        This is the default.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
http.proxy\r
</term>\r
<listitem>\r
<simpara>\r
        Override the HTTP proxy, normally configured using the <emphasis>http_proxy</emphasis>\r
        environment variable (see <xref linkend="curl(1)"/>).  This can be overridden\r
        on a per-remote basis; see remote.&lt;name&gt;.proxy\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
http.sslVerify\r
</term>\r
<listitem>\r
<simpara>\r
        Whether to verify the SSL certificate when fetching or pushing\r
        over HTTPS. Can be overridden by the <emphasis>GIT_SSL_NO_VERIFY</emphasis> environment\r
        variable.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
http.sslCert\r
</term>\r
<listitem>\r
<simpara>\r
        File containing the SSL certificate when fetching or pushing\r
        over HTTPS. Can be overridden by the <emphasis>GIT_SSL_CERT</emphasis> environment\r
        variable.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
http.sslKey\r
</term>\r
<listitem>\r
<simpara>\r
        File containing the SSL private key when fetching or pushing\r
        over HTTPS. Can be overridden by the <emphasis>GIT_SSL_KEY</emphasis> environment\r
        variable.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
http.sslCAInfo\r
</term>\r
<listitem>\r
<simpara>\r
        File containing the certificates to verify the peer with when\r
        fetching or pushing over HTTPS. Can be overridden by the\r
        <emphasis>GIT_SSL_CAINFO</emphasis> environment variable.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
http.sslCAPath\r
</term>\r
<listitem>\r
<simpara>\r
        Path containing files with the CA certificates to verify the peer\r
        with when fetching or pushing over HTTPS. Can be overridden\r
        by the <emphasis>GIT_SSL_CAPATH</emphasis> environment variable.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
http.maxRequests\r
</term>\r
<listitem>\r
<simpara>\r
        How many HTTP requests to launch in parallel. Can be overridden\r
        by the <emphasis>GIT_HTTP_MAX_REQUESTS</emphasis> environment variable. Default is 5.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
http.lowSpeedLimit, http.lowSpeedTime\r
</term>\r
<listitem>\r
<simpara>\r
        If the HTTP transfer speed is less than <emphasis>http.lowSpeedLimit</emphasis>\r
        for longer than <emphasis>http.lowSpeedTime</emphasis> seconds, the transfer is aborted.\r
        Can be overridden by the <emphasis>GIT_HTTP_LOW_SPEED_LIMIT</emphasis> and\r
        <emphasis>GIT_HTTP_LOW_SPEED_TIME</emphasis> environment variables.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
http.noEPSV\r
</term>\r
<listitem>\r
<simpara>\r
        A boolean which disables using of EPSV ftp command by curl.\r
        This can helpful with some "poor" ftp servers which don&#8217;t\r
        support EPSV mode. Can be overridden by the <emphasis>GIT_CURL_FTP_NO_EPSV</emphasis>\r
        environment variable. Default is false (curl will use EPSV).\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
i18n.commitEncoding\r
</term>\r
<listitem>\r
<simpara>\r
        Character encoding the commit messages are stored in; git itself\r
        does not care per se, but this information is necessary e.g. when\r
        importing commits from emails or in the gitk graphical history\r
        browser (and possibly at other places in the future or in other\r
        porcelains). See e.g. <xref linkend="git-mailinfo(1)"/>. Defaults to <emphasis>utf-8</emphasis>.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
i18n.logOutputEncoding\r
</term>\r
<listitem>\r
<simpara>\r
        Character encoding the commit messages are converted to when\r
        running <emphasis>git-log</emphasis> and friends.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
imap\r
</term>\r
<listitem>\r
<simpara>\r
        The configuration variables in the <emphasis>imap</emphasis> section are described\r
        in <xref linkend="git-imap-send(1)"/>.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
instaweb.browser\r
</term>\r
<listitem>\r
<simpara>\r
        Specify the program that will be used to browse your working\r
        repository in gitweb. See <xref linkend="git-instaweb(1)"/>.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
instaweb.httpd\r
</term>\r
<listitem>\r
<simpara>\r
        The HTTP daemon command-line to start gitweb on your working\r
        repository. See <xref linkend="git-instaweb(1)"/>.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
instaweb.local\r
</term>\r
<listitem>\r
<simpara>\r
        If true the web server started by <xref linkend="git-instaweb(1)"/> will\r
        be bound to the local IP (127.0.0.1).\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
instaweb.modulepath\r
</term>\r
<listitem>\r
<simpara>\r
        The module path for an apache httpd used by <xref linkend="git-instaweb(1)"/>.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
instaweb.port\r
</term>\r
<listitem>\r
<simpara>\r
        The port number to bind the gitweb httpd to. See\r
        <xref linkend="git-instaweb(1)"/>.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
interactive.singlekey\r
</term>\r
<listitem>\r
<simpara>\r
        In interactive programs, allow the user to provide one-letter\r
        input with a single key (i.e., without hitting enter).\r
        Currently this is used only by the <literal>--patch</literal> mode of\r
        <xref linkend="git-add(1)"/>.  Note that this setting is silently\r
        ignored if portable keystroke input is not available.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
log.date\r
</term>\r
<listitem>\r
<simpara>\r
        Set default date-time mode for the log command. Setting log.date\r
        value is similar to using <emphasis>git-log</emphasis>\'s --date option. The value is one of the\r
        following alternatives: {relative,local,default,iso,rfc,short}.\r
        See <xref linkend="git-log(1)"/>.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
log.showroot\r
</term>\r
<listitem>\r
<simpara>\r
        If true, the initial commit will be shown as a big creation event.\r
        This is equivalent to a diff against an empty tree.\r
        Tools like <xref linkend="git-log(1)"/> or <xref linkend="git-whatchanged(1)"/>, which\r
        normally hide the root commit will now show it. True by default.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
log.mailmap\r
</term>\r
<listitem>\r
<simpara>\r
        The location of an augmenting mailmap file. The default\r
        mailmap, located in the root of the repository, is loaded\r
        first, then the mailmap file pointed to by this variable.\r
        The location of the mailmap file may be in a repository\r
        subdirectory, or somewhere outside of the repository itself.\r
        See <xref linkend="git-shortlog(1)"/> and <xref linkend="git-blame(1)"/>.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
man.viewer\r
</term>\r
<listitem>\r
<simpara>\r
        Specify the programs that may be used to display help in the\r
        <emphasis>man</emphasis> format. See <xref linkend="git-help(1)"/>.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
man.&lt;tool&gt;.cmd\r
</term>\r
<listitem>\r
<simpara>\r
        Specify the command to invoke the specified man viewer. The\r
        specified command is evaluated in shell with the man page\r
        passed as argument. (See <xref linkend="git-help(1)"/>.)\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
man.&lt;tool&gt;.path\r
</term>\r
<listitem>\r
<simpara>\r
        Override the path for the given tool that may be used to\r
        display help in the <emphasis>man</emphasis> format. See <xref linkend="git-help(1)"/>.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
merge.conflictstyle\r
</term>\r
<listitem>\r
<simpara>\r
        Specify the style in which conflicted hunks are written out to\r
        working tree files upon merge.  The default is "merge", which\r
        shows a <literal>&lt;&lt;&lt;&lt;&lt;&lt;&lt;</literal> conflict marker, changes made by one side,\r
        a <literal>=======</literal> marker, changes made by the other side, and then\r
        a <literal>&gt;&gt;&gt;&gt;&gt;&gt;&gt;</literal> marker.  An alternate style, "diff3", adds a <literal>|||||||</literal>\r
        marker and the original text before the <literal>=======</literal> marker.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
merge.log\r
</term>\r
<listitem>\r
<simpara>\r
        Whether to include summaries of merged commits in newly created\r
        merge commit messages. False by default.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
merge.renameLimit\r
</term>\r
<listitem>\r
<simpara>\r
        The number of files to consider when performing rename detection\r
        during a merge; if not specified, defaults to the value of\r
        diff.renameLimit.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
merge.stat\r
</term>\r
<listitem>\r
<simpara>\r
        Whether to print the diffstat between ORIG_HEAD and the merge result\r
        at the end of the merge.  True by default.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
merge.tool\r
</term>\r
<listitem>\r
<simpara>\r
        Controls which merge resolution program is used by\r
        <xref linkend="git-mergetool(1)"/>.  Valid built-in values are: "kdiff3",\r
        "tkdiff", "meld", "xxdiff", "emerge", "vimdiff", "gvimdiff", and\r
        "opendiff".  Any other value is treated is custom merge tool\r
        and there must be a corresponding mergetool.&lt;tool&gt;.cmd option.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
merge.verbosity\r
</term>\r
<listitem>\r
<simpara>\r
        Controls the amount of output shown by the recursive merge\r
        strategy.  Level 0 outputs nothing except a final error\r
        message if conflicts were detected. Level 1 outputs only\r
        conflicts, 2 outputs conflicts and file changes.  Level 5 and\r
        above outputs debugging information.  The default is level 2.\r
        Can be overridden by the <emphasis>GIT_MERGE_VERBOSITY</emphasis> environment variable.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
merge.&lt;driver&gt;.name\r
</term>\r
<listitem>\r
<simpara>\r
        Defines a human-readable name for a custom low-level\r
        merge driver.  See <xref linkend="gitattributes(5)"/> for details.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
merge.&lt;driver&gt;.driver\r
</term>\r
<listitem>\r
<simpara>\r
        Defines the command that implements a custom low-level\r
        merge driver.  See <xref linkend="gitattributes(5)"/> for details.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
merge.&lt;driver&gt;.recursive\r
</term>\r
<listitem>\r
<simpara>\r
        Names a low-level merge driver to be used when\r
        performing an internal merge between common ancestors.\r
        See <xref linkend="gitattributes(5)"/> for details.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
mergetool.&lt;tool&gt;.path\r
</term>\r
<listitem>\r
<simpara>\r
        Override the path for the given tool.  This is useful in case\r
        your tool is not in the PATH.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
mergetool.&lt;tool&gt;.cmd\r
</term>\r
<listitem>\r
<simpara>\r
        Specify the command to invoke the specified merge tool.  The\r
        specified command is evaluated in shell with the following\r
        variables available: <emphasis>BASE</emphasis> is the name of a temporary file\r
        containing the common base of the files to be merged, if available;\r
        <emphasis>LOCAL</emphasis> is the name of a temporary file containing the contents of\r
        the file on the current branch; <emphasis>REMOTE</emphasis> is the name of a temporary\r
        file containing the contents of the file from the branch being\r
        merged; <emphasis>MERGED</emphasis> contains the name of the file to which the merge\r
        tool should write the results of a successful merge.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
mergetool.&lt;tool&gt;.trustExitCode\r
</term>\r
<listitem>\r
<simpara>\r
        For a custom merge command, specify whether the exit code of\r
        the merge command can be used to determine whether the merge was\r
        successful.  If this is not set to true then the merge target file\r
        timestamp is checked and the merge assumed to have been successful\r
        if the file has been updated, otherwise the user is prompted to\r
        indicate the success of the merge.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
mergetool.keepBackup\r
</term>\r
<listitem>\r
<simpara>\r
        After performing a merge, the original file with conflict markers\r
        can be saved as a file with a <literal>.orig</literal> extension.  If this variable\r
        is set to <literal>false</literal> then this file is not preserved.  Defaults to\r
        <literal>true</literal> (i.e. keep the backup files).\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
mergetool.keepTemporaries\r
</term>\r
<listitem>\r
<simpara>\r
        When invoking a custom merge tool, git uses a set of temporary\r
        files to pass to the tool. If the tool returns an error and this\r
        variable is set to <literal>true</literal>, then these temporary files will be\r
        preserved, otherwise they will be removed after the tool has\r
        exited. Defaults to <literal>false</literal>.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
mergetool.prompt\r
</term>\r
<listitem>\r
<simpara>\r
        Prompt before each invocation of the merge resolution program.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
pack.window\r
</term>\r
<listitem>\r
<simpara>\r
        The size of the window used by <xref linkend="git-pack-objects(1)"/> when no\r
        window size is given on the command line. Defaults to 10.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
pack.depth\r
</term>\r
<listitem>\r
<simpara>\r
        The maximum delta depth used by <xref linkend="git-pack-objects(1)"/> when no\r
        maximum depth is given on the command line. Defaults to 50.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
pack.windowMemory\r
</term>\r
<listitem>\r
<simpara>\r
        The window memory size limit used by <xref linkend="git-pack-objects(1)"/>\r
        when no limit is given on the command line.  The value can be\r
        suffixed with "k", "m", or "g".  Defaults to 0, meaning no\r
        limit.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
pack.compression\r
</term>\r
<listitem>\r
<simpara>\r
        An integer -1..9, indicating the compression level for objects\r
        in a pack file. -1 is the zlib default. 0 means no\r
        compression, and 1..9 are various speed/size tradeoffs, 9 being\r
        slowest.  If not set,  defaults to core.compression.  If that is\r
        not set,  defaults to -1, the zlib default, which is "a default\r
        compromise between speed and compression (currently equivalent\r
        to level 6)."\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
pack.deltaCacheSize\r
</term>\r
<listitem>\r
<simpara>\r
        The maximum memory in bytes used for caching deltas in\r
        <xref linkend="git-pack-objects(1)"/>.\r
        A value of 0 means no limit. Defaults to 0.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
pack.deltaCacheLimit\r
</term>\r
<listitem>\r
<simpara>\r
        The maximum size of a delta, that is cached in\r
        <xref linkend="git-pack-objects(1)"/>. Defaults to 1000.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
pack.threads\r
</term>\r
<listitem>\r
<simpara>\r
        Specifies the number of threads to spawn when searching for best\r
        delta matches.  This requires that <xref linkend="git-pack-objects(1)"/>\r
        be compiled with pthreads otherwise this option is ignored with a\r
        warning. This is meant to reduce packing time on multiprocessor\r
        machines. The required amount of memory for the delta search window\r
        is however multiplied by the number of threads.\r
        Specifying 0 will cause git to auto-detect the number of CPU&#8217;s\r
        and set the number of threads accordingly.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
pack.indexVersion\r
</term>\r
<listitem>\r
<simpara>\r
        Specify the default pack index version.  Valid values are 1 for\r
        legacy pack index used by Git versions prior to 1.5.2, and 2 for\r
        the new pack index with capabilities for packs larger than 4 GB\r
        as well as proper protection against the repacking of corrupted\r
        packs.  Version 2 is the default.  Note that version 2 is enforced\r
        and this config option ignored whenever the corresponding pack is\r
        larger than 2 GB.\r
</simpara>\r
<simpara>If you have an old git that does not understand the version 2 <literal>&#42;.idx</literal> file,\r
cloning or fetching over a non native protocol (e.g. "http" and "rsync")\r
that will copy both <literal>&#42;.pack</literal> file and corresponding <literal>&#42;.idx</literal> file from the\r
other side may give you a repository that cannot be accessed with your\r
older version of git. If the <literal>&#42;.pack</literal> file is smaller than 2 GB, however,\r
you can use <xref linkend="git-index-pack(1)"/> on the *.pack file to regenerate\r
the <literal>&#42;.idx</literal> file.</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
pack.packSizeLimit\r
</term>\r
<listitem>\r
<simpara>\r
        The default maximum size of a pack.  This setting only affects\r
        packing to a file, i.e. the git:// protocol is unaffected.  It\r
        can be overridden by the <literal>--max-pack-size</literal> option of\r
        <xref linkend="git-repack(1)"/>.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
pager.&lt;cmd&gt;\r
</term>\r
<listitem>\r
<simpara>\r
        Allows turning on or off pagination of the output of a\r
        particular git subcommand when writing to a tty.  If\r
        <literal>--paginate</literal> or <literal>--no-pager</literal> is specified on the command line,\r
        it takes precedence over this option.  To disable pagination for\r
        all commands, set <literal>core.pager</literal> or <emphasis>GIT_PAGER</emphasis> to "<literal>cat</literal>".\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
pull.octopus\r
</term>\r
<listitem>\r
<simpara>\r
        The default merge strategy to use when pulling multiple branches\r
        at once.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
pull.twohead\r
</term>\r
<listitem>\r
<simpara>\r
        The default merge strategy to use when pulling a single branch.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
receive.fsckObjects\r
</term>\r
<listitem>\r
<simpara>\r
        If it is set to true, git-receive-pack will check all received\r
        objects. It will abort in the case of a malformed object or a\r
        broken link. The result of an abort are only dangling objects.\r
        Defaults to false.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
receive.unpackLimit\r
</term>\r
<listitem>\r
<simpara>\r
        If the number of objects received in a push is below this\r
        limit then the objects will be unpacked into loose object\r
        files. However if the number of received objects equals or\r
        exceeds this limit then the received pack will be stored as\r
        a pack, after adding any missing delta bases.  Storing the\r
        pack from a push can make the push operation complete faster,\r
        especially on slow filesystems.  If not set, the value of\r
        <literal>transfer.unpackLimit</literal> is used instead.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
receive.denyDeletes\r
</term>\r
<listitem>\r
<simpara>\r
        If set to true, git-receive-pack will deny a ref update that deletes\r
        the ref. Use this to prevent such a ref deletion via a push.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
receive.denyCurrentBranch\r
</term>\r
<listitem>\r
<simpara>\r
        If set to true or "refuse", receive-pack will deny a ref update\r
        to the currently checked out branch of a non-bare repository.\r
        Such a push is potentially dangerous because it brings the HEAD\r
        out of sync with the index and working tree. If set to "warn",\r
        print a warning of such a push to stderr, but allow the push to\r
        proceed. If set to false or "ignore", allow such pushes with no\r
        message. Defaults to "warn".\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
receive.denyNonFastForwards\r
</term>\r
<listitem>\r
<simpara>\r
        If set to true, git-receive-pack will deny a ref update which is\r
        not a fast forward. Use this to prevent such an update via a push,\r
        even if that push is forced. This configuration variable is\r
        set when initializing a shared repository.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
remote.&lt;name&gt;.url\r
</term>\r
<listitem>\r
<simpara>\r
        The URL of a remote repository.  See <xref linkend="git-fetch(1)"/> or\r
        <xref linkend="git-push(1)"/>.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
remote.&lt;name&gt;.proxy\r
</term>\r
<listitem>\r
<simpara>\r
        For remotes that require curl (http, https and ftp), the URL to\r
        the proxy to use for that remote.  Set to the empty string to\r
        disable proxying for that remote.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
remote.&lt;name&gt;.fetch\r
</term>\r
<listitem>\r
<simpara>\r
        The default set of "refspec" for <xref linkend="git-fetch(1)"/>. See\r
        <xref linkend="git-fetch(1)"/>.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
remote.&lt;name&gt;.push\r
</term>\r
<listitem>\r
<simpara>\r
        The default set of "refspec" for <xref linkend="git-push(1)"/>. See\r
        <xref linkend="git-push(1)"/>.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
remote.&lt;name&gt;.mirror\r
</term>\r
<listitem>\r
<simpara>\r
        If true, pushing to this remote will automatically behave\r
        as if the <literal>--mirror</literal> option was given on the command line.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
remote.&lt;name&gt;.skipDefaultUpdate\r
</term>\r
<listitem>\r
<simpara>\r
        If true, this remote will be skipped by default when updating\r
        using the update subcommand of <xref linkend="git-remote(1)"/>.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
remote.&lt;name&gt;.receivepack\r
</term>\r
<listitem>\r
<simpara>\r
        The default program to execute on the remote side when pushing.  See\r
        option --receive-pack of <xref linkend="git-push(1)"/>.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
remote.&lt;name&gt;.uploadpack\r
</term>\r
<listitem>\r
<simpara>\r
        The default program to execute on the remote side when fetching.  See\r
        option --upload-pack of <xref linkend="git-fetch-pack(1)"/>.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
remote.&lt;name&gt;.tagopt\r
</term>\r
<listitem>\r
<simpara>\r
        Setting this value to --no-tags disables automatic tag following when\r
        fetching from remote &lt;name&gt;\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
remote.&lt;name&gt;.vcs\r
</term>\r
<listitem>\r
<simpara>\r
        Setting this to a value &lt;vcs&gt; will cause git to interact with\r
        the remote with the git-vcs-&lt;vcs&gt; helper.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
remotes.&lt;group&gt;\r
</term>\r
<listitem>\r
<simpara>\r
        The list of remotes which are fetched by "git remote update\r
        &lt;group&gt;".  See <xref linkend="git-remote(1)"/>.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
repack.usedeltabaseoffset\r
</term>\r
<listitem>\r
<simpara>\r
        By default, <xref linkend="git-repack(1)"/> creates packs that use\r
        delta-base offset. If you need to share your repository with\r
        git older than version 1.4.4, either directly or via a dumb\r
        protocol such as http, then you need to set this option to\r
        "false" and repack. Access from old git versions over the\r
        native protocol are unaffected by this option.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
rerere.autoupdate\r
</term>\r
<listitem>\r
<simpara>\r
        When set to true, <literal>git-rerere</literal> updates the index with the\r
        resulting contents after it cleanly resolves conflicts using\r
        previously recorded resolution.  Defaults to false.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
rerere.enabled\r
</term>\r
<listitem>\r
<simpara>\r
        Activate recording of resolved conflicts, so that identical\r
        conflict hunks can be resolved automatically, should they\r
        be encountered again.  <xref linkend="git-rerere(1)"/> command is by\r
        default enabled if you create <literal>rr-cache</literal> directory under\r
        <literal>$GIT_DIR</literal>, but can be disabled by setting this option to false.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
showbranch.default\r
</term>\r
<listitem>\r
<simpara>\r
        The default set of branches for <xref linkend="git-show-branch(1)"/>.\r
        See <xref linkend="git-show-branch(1)"/>.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
status.relativePaths\r
</term>\r
<listitem>\r
<simpara>\r
        By default, <xref linkend="git-status(1)"/> shows paths relative to the\r
        current directory. Setting this variable to <literal>false</literal> shows paths\r
        relative to the repository root (this was the default for git\r
        prior to v1.5.4).\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
status.showUntrackedFiles\r
</term>\r
<listitem>\r
<simpara>\r
        By default, <xref linkend="git-status(1)"/> and <xref linkend="git-commit(1)"/> show\r
        files which are not currently tracked by Git. Directories which\r
        contain only untracked files, are shown with the directory name\r
        only. Showing untracked files means that Git needs to lstat() all\r
        all the files in the whole repository, which might be slow on some\r
        systems. So, this variable controls how the commands displays\r
        the untracked files. Possible values are:\r
</simpara>\r
<itemizedlist>\r
<listitem>\r
<simpara>\r
<emphasis>no</emphasis>     - Show no untracked files\r
</simpara>\r
</listitem>\r
<listitem>\r
<simpara>\r
<emphasis>normal</emphasis> - Shows untracked files and directories\r
</simpara>\r
</listitem>\r
<listitem>\r
<simpara>\r
<emphasis>all</emphasis>    - Shows also individual files in untracked directories.\r
</simpara>\r
</listitem>\r
</itemizedlist>\r
<simpara>If this variable is not specified, it defaults to <emphasis>normal</emphasis>.\r
This variable can be overridden with the -u|--untracked-files option\r
of <xref linkend="git-status(1)"/> and <xref linkend="git-commit(1)"/>.</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
tar.umask\r
</term>\r
<listitem>\r
<simpara>\r
        This variable can be used to restrict the permission bits of\r
        tar archive entries.  The default is 0002, which turns off the\r
        world write bit.  The special value "user" indicates that the\r
        archiving user&#8217;s umask will be used instead.  See umask(2) and\r
        <xref linkend="git-archive(1)"/>.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
transfer.unpackLimit\r
</term>\r
<listitem>\r
<simpara>\r
        When <literal>fetch.unpackLimit</literal> or <literal>receive.unpackLimit</literal> are\r
        not set, the value of this variable is used instead.\r
        The default value is 100.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
url.&lt;base&gt;.insteadOf\r
</term>\r
<listitem>\r
<simpara>\r
        Any URL that starts with this value will be rewritten to\r
        start, instead, with &lt;base&gt;. In cases where some site serves a\r
        large number of repositories, and serves them with multiple\r
        access methods, and some users need to use different access\r
        methods, this feature allows people to specify any of the\r
        equivalent URLs and have git automatically rewrite the URL to\r
        the best alternative for the particular user, even for a\r
        never-before-seen repository on the site.  When more than one\r
        insteadOf strings match a given URL, the longest match is used.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
user.email\r
</term>\r
<listitem>\r
<simpara>\r
        Your email address to be recorded in any newly created commits.\r
        Can be overridden by the <emphasis>GIT_AUTHOR_EMAIL</emphasis>, <emphasis>GIT_COMMITTER_EMAIL</emphasis>, and\r
        <emphasis>EMAIL</emphasis> environment variables.  See <xref linkend="git-commit-tree(1)"/>.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
user.name\r
</term>\r
<listitem>\r
<simpara>\r
        Your full name to be recorded in any newly created commits.\r
        Can be overridden by the <emphasis>GIT_AUTHOR_NAME</emphasis> and <emphasis>GIT_COMMITTER_NAME</emphasis>\r
        environment variables.  See <xref linkend="git-commit-tree(1)"/>.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
user.signingkey\r
</term>\r
<listitem>\r
<simpara>\r
        If <xref linkend="git-tag(1)"/> is not selecting the key you want it to\r
        automatically when creating a signed tag, you can override the\r
        default selection with this variable.  This option is passed\r
        unchanged to gpg&#8217;s --local-user parameter, so you may specify a key\r
        using any method that gpg supports.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
web.browser\r
</term>\r
<listitem>\r
<simpara>\r
        Specify a web browser that may be used by some commands.\r
        Currently only <xref linkend="git-instaweb(1)"/> and <xref linkend="git-help(1)"/>\r
        may use it.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
</variablelist>\r
</simplesect>\r
</simplesect>\r
<simplesect id="_author">\r
<title>Author</title>\r
<simpara>Written by Johannes Schindelin &lt;<ulink url="mailto:Johannes.Schindelin@gmx.de">Johannes.Schindelin@gmx.de</ulink>&gt;</simpara>\r
</simplesect>\r
<simplesect id="_documentation">\r
<title>Documentation</title>\r
<simpara>Documentation by Johannes Schindelin, Petr Baudis and the git-list &lt;<ulink url="mailto:git@vger.kernel.org">git@vger.kernel.org</ulink>&gt;.</simpara>\r
</simplesect>\r
<simplesect id="_git">\r
<title>GIT</title>\r
<simpara>Part of the <xref linkend="git(1)"/> suite</simpara>\r
</simplesect>\r
</article>\r