GIT-REPO-CONFIG(1)

NAME
git-repo-config - Get and set repository or global options.

SYNOPSIS

git-repo-config [--global] [type] name [value [value_regex]]
git-repo-config [--global] [type] --replace-all name [value [value_regex]]
git-repo-config [--global] [type] --get name [value_regex]
git-repo-config [--global] [type] --get-all name [value_regex]
git-repo-config [--global] [type] --unset name [value_regex]
git-repo-config [--global] [type] --unset-all name [value_regex]
git-repo-config [--global] -l | --list

DESCRIPTION
You can query/set/replace/unset options with this command. The name is actually the section and the key separated by a dot, and the value will be escaped. If you want to set/unset an option which can occur on multiple lines, a POSIX regexp value_regex needs to be given. Only the existing values that match the regexp are updated or unset. If you want to handle the lines that do not match the regex, just prepend a single exclamation mark in front (see EXAMPLES). The type specifier can be either --int or --bool, which will make git-repo-config ensure that the variable(s) are of the given type and convert the value to the canonical form (simple decimal number for int, a "true" or "false" string for bool). If no type specifier is passed, no checks or transformations are performed on the value. This command will fail if:

1.  The .git/config file is invalid,

2.  Can not write to .git/config,

3.  no section was provided,

4.  the section or key is invalid,

5.  you try to unset an option which does not exist,

6.  you try to unset/set an option for which multiple lines match, or

7.  you use --global option without $HOME being properly set.

OPTIONS

--replace-all
    Default behavior is to replace at most one line. This replaces all lines matching the key (and optionally the value_regex).

--get
    Get the value for a given key (optionally filtered by a regex matching the value). Returns error code 1 if the key was not found and error code 2 if multiple key values were found.

--get-all
    Like get, but does not fail if the number of values for the key is not exactly one.

--get-regexp
    Like --get-all, but interprets the name as a regular expression.

--global
    Use global ~/.gitconfig file rather than the repository .git/config.

--unset
    Remove the line matching the key from config file.

--unset-all
    Remove all matching lines from config file.

-l, --list
    List all variables set in config file.

--bool
    git-repo-config will ensure that the output is "true" or "false"

--int
    git-repo-config will ensure that the output is a simple decimal number

ENVIRONMENT

GIT_CONFIG
    Take the configuration from the given file instead of .git/config. Using the "--global" option forces this to ~/.gitconfig.

GIT_CONFIG_LOCAL
    Currently the same as $GIT_CONFIG; when Git will support global configuration files, this will cause it to take the configuration from the global configuration file in addition to the given file.

EXAMPLE
Given a .git/config like this:

#
# This is the config file, and
# a '#' or ';' character indicates
# a comment
#

; core variables
[core]
        ; Don't trust file modes
        filemode = false

; Our diff algorithm
[diff]
        external = "/usr/local/bin/gnu-diff -u"
        renames = true

; Proxy settings
[core]
        gitproxy="ssh" for "ssh://kernel.org/"
        gitproxy="proxy-command" for kernel.org
        gitproxy="myprotocol-command" for "my://"
        gitproxy=default-proxy ; for all the rest
you can set the filemode to true with

% git repo-config core.filemode true
The hypothetical proxy command entries actually have a postfix to discern what URL they apply to. Here is how to change the entry for kernel.org to "ssh".

% git repo-config core.gitproxy '"ssh" for kernel.org' 'for kernel.org$'
This makes sure that only the key/value pair for kernel.org is replaced. To delete the entry for renames, do

% git repo-config --unset diff.renames
If you want to delete an entry for a multivar (like core.gitproxy above), you have to provide a regex matching the value of exactly one line. To query the value for a given key, do

% git repo-config --get core.filemode
or

% git repo-config core.filemode
or, to query a multivar:

% git repo-config --get core.gitproxy "for kernel.org$"
If you want to know all the values for a multivar, do:

% git repo-config --get-all core.gitproxy
If you like to live dangerous, you can replace all core.gitproxy by a new one with

% git repo-config --replace-all core.gitproxy ssh
However, if you really only want to replace the line for the default proxy, i.e. the one without a "for ..." postfix, do something like this:

% git repo-config core.gitproxy ssh '! for '
To actually match only values with an exclamation mark, you have to

% git repo-config section.key value '[!]'

CONFIGURATION FILE
The git configuration file contains a number of variables that affect the git command's behavior. They can be used by both the git plumbing and the porcelains. The variables are divided into sections, where in the fully qualified variable name the variable itself is the last dot-separated segment and the section name is everything before the last dot. The variable names are case-insensitive and only alphanumeric characters are allowed. Some variables may appear multiple times. The syntax is fairly flexible and permissive; whitespaces are mostly ignored. The # and ; characters begin comments to the end of line, blank lines are ignored, lines containing strings enclosed in square brackets start sections and all the other lines are recognized as setting variables, in the form name = value. If there is no equal sign on the line, the entire line is taken as name and the variable is recognized as boolean "true". String values may be entirely or partially enclosed in double quotes; some variables may require special value format.

  Example

# Core variables
[core]
        ; Don't trust file modes
        filemode = false

# Our diff algorithm
[diff]
        external = "/usr/local/bin/gnu-diff -u"
        renames = true

  Variables
Note that this list is non-comprehensive and not necessarily complete. For command-specific variables, you will find a more detailed description in the appropriate manual page. You will find a description of non-core porcelain configuration variables in the respective porcelain documentation.

core.fileMode
    If false, the executable bit differences between the index and the working copy are ignored; useful on broken filesystems like FAT. See git-update-index(1). True by default.

core.gitProxy
    A "proxy command" to execute (as command host port) instead of establishing direct connection to the remote server when using the git protocol for fetching. If the variable value is in the "COMMAND for DOMAIN" format, the command is applied only on hostnames ending with the specified domain string. This variable may be set multiple times and is matched in the given order; the first match wins. Can be overridden by the GIT_PROXY_COMMAND environment variable (which always applies universally, without the special "for" handling).

core.ignoreStat
    The working copy files are assumed to stay unchanged until you mark them otherwise manually - Git will not detect the file changes by lstat() calls. This is useful on systems where those are very slow, such as Microsoft Windows. See git-update-index(1). False by default.

core.preferSymlinkRefs
    Instead of the default "symref" format for HEAD and other symbolic reference files, use symbolic links. This is sometimes needed to work with old scripts that expect HEAD to be a symbolic link.

core.logAllRefUpdates
    Updates to a ref <ref> is logged to the file "$GIT_DIR/logs/<ref>", by appending the new and old SHA1, the date/time and the reason of the update, but only when the file exists. If this configuration variable is set to true, missing "$GIT_DIR/logs/<ref>" file is automatically created for branch heads.

    This information can be used to determine what commit
    was the tip of a branch "2 days ago".  This value is
    false by default (no automated creation of log files).

core.repositoryFormatVersion
    Internal variable identifying the repository format and layout version.

core.sharedRepository
    When group (or true), the repository is made shareable between several users in a group (making sure all the files and objects are group-writable). When all (or world or everybody), the repository will be readable by all users, additionally to being group-shareable. When umask (or false), git will use permissions reported by umask(2). See git-init-db(1). False by default.

core.warnAmbiguousRefs
    If true, git will warn you if the ref name you passed it is ambiguous and might match multiple refs in the .git/refs/ tree. True by default.

core.compression
    An integer -1..9, indicating the compression level for objects that are not in a pack file. -1 is the zlib and git default. 0 means no compression, and 1..9 are various speed/size tradeoffs, 9 being slowest.

core.legacyheaders
    A boolean which enables the legacy object header format in case you want to interoperate with old clients accessing the object database directly (where the "http://" and "rsync://" protocols count as direct access).

alias.*
    Command aliases for the git(1) command wrapper - e.g. after defining "alias.last = cat-file commit HEAD", the invocation "git last" is equivalent to "git cat-file commit HEAD". To avoid confusion and troubles with script usage, aliases that hide existing git commands are ignored. Arguments are split by spaces, the usual shell quoting and escaping is supported. quote pair and a backslash can be used to quote them.

apply.whitespace
    Tells git-apply how to handle whitespaces, in the same way as the --whitespace option. See git-apply(1).

branch.<name>.remote
    When in branch <name>, it tells git fetch which remote to fetch.

branch.<name>.merge
    When in branch <name>, it tells git fetch the default remote branch to be merged.

pager.color
    A boolean to enable/disable colored output when the pager is in use (default is true).

diff.color
    When true (or always), always use colors in patch. When false (or never), never. When set to auto, use colors only when the output is to the terminal.

diff.color.<slot>
    Use customized color for diff colorization. <slot> specifies which part of the patch to use the specified color, and is one of plain (context text), meta (metainformation), frag (hunk header), old (removed lines), or new (added lines). The value for these configuration variables can be one of: normal, bold, dim, ul, blink, reverse, reset, black, red, green, yellow, blue, magenta, cyan, or white.

diff.renameLimit
    The number of files to consider when performing the copy/rename detection; equivalent to the git diff option -l.

diff.renames
    Tells git to detect renames. If set to any boolean value, it will enable basic rename detection. If set to "copies" or "copy", it will detect copies, as well.

format.headers
    Additional email headers to include in a patch to be submitted by mail. See git-format-patch(1).

gitcvs.enabled
    Whether the cvs pserver interface is enabled for this repository. See git-cvsserver(1).

gitcvs.logfile
    Path to a log file where the cvs pserver interface well... logs various stuff. See git-cvsserver(1).

http.sslVerify
    Whether to verify the SSL certificate when fetching or pushing over HTTPS. Can be overridden by the GIT_SSL_NO_VERIFY environment variable.

http.sslCert
    File containing the SSL certificate when fetching or pushing over HTTPS. Can be overridden by the GIT_SSL_CERT environment variable.

http.sslKey
    File containing the SSL private key when fetching or pushing over HTTPS. Can be overridden by the GIT_SSL_KEY environment variable.

http.sslCAInfo
    File containing the certificates to verify the peer with when fetching or pushing over HTTPS. Can be overridden by the GIT_SSL_CAINFO environment variable.

http.sslCAPath
    Path containing files with the CA certificates to verify the peer with when fetching or pushing over HTTPS. Can be overridden by the GIT_SSL_CAPATH environment variable.

http.maxRequests
    How many HTTP requests to launch in parallel. Can be overridden by the GIT_HTTP_MAX_REQUESTS environment variable. Default is 5.

http.lowSpeedLimit, http.lowSpeedTime
    If the HTTP transfer speed is less than http.lowSpeedLimit for longer than http.lowSpeedTime seconds, the transfer is aborted. Can be overridden by the GIT_HTTP_LOW_SPEED_LIMIT and GIT_HTTP_LOW_SPEED_TIME environment variables.

http.noEPSV
    A boolean which disables using of EPSV ftp command by curl. This can helpful with some "poor" ftp servers which doesn't support EPSV mode. Can be overridden by the GIT_CURL_FTP_NO_EPSV environment variable. Default is false (curl will use EPSV).

i18n.commitEncoding
    Character encoding the commit messages are stored in; git itself does not care per se, but this information is necessary e.g. when importing commits from emails or in the gitk graphical history browser (and possibly at other places in the future or in other porcelains). See e.g. git-mailinfo(1). Defaults to utf-8.

merge.summary
    Whether to include summaries of merged commits in newly created merge commit messages. False by default.

pack.window
    The size of the window used by git-pack-objects(1) when no window size is given on the command line. Defaults to 10.

pull.octopus
    The default merge strategy to use when pulling multiple branches at once.

pull.twohead
    The default merge strategy to use when pulling a single branch.

remote.<name>.url
    The URL of a remote repository. See git-fetch(1) or git-push(1).

remote.<name>.fetch
    The default set of "refspec" for git-fetch(1). See git-fetch(1).

remote.<name>.push
    The default set of "refspec" for git-push(1). See git-push(1).

repack.usedeltabaseoffset
    Allow git-repack(1) to create packs that uses delta-base offset. Defaults to false.

show.difftree
    The default git-diff-tree(1) arguments to be used for git-show(1).

showbranch.default
    The default set of branches for git-show-branch(1). See git-show-branch(1).

status.color
    A boolean to enable/disable color in the output of git-status(1). May be set to true (or always), false (or never) or auto, in which case colors are used only when the output is to a terminal. Defaults to false.

status.color.<slot>
    Use customized color for status colorization. <slot> is one of header (the header text of the status message), updated (files which are updated but not committed), changed (files which are changed but not updated in the index), or untracked (files which are not tracked by git). The values of these variables may be specified as in diff.color.<slot>.

tar.umask
    By default, git-tar-tree(1) sets file and directories modes to 0666 or 0777. While this is both useful and acceptable for projects such as the Linux Kernel, it might be excessive for other projects. With this variable, it becomes possible to tell git-tar-tree(1) to apply a specific umask to the modes above. The special value "user" indicates that the user's current umask will be used. This should be enough for most projects, as it will lead to the same permissions as git-checkout(1) would use. The default value remains 0, which means world read-write.

user.email
    Your email address to be recorded in any newly created commits. Can be overridden by the GIT_AUTHOR_EMAIL and GIT_COMMITTER_EMAIL environment variables. See git-commit-tree(1).

user.name
    Your full name to be recorded in any newly created commits. Can be overridden by the GIT_AUTHOR_NAME and GIT_COMMITTER_NAME environment variables. See git-commit-tree(1).

whatchanged.difftree
    The default git-diff-tree(1) arguments to be used for git-whatchanged(1).

imap
    The configuration variables in the imap section are described in git-imap-send(1).

receive.unpackLimit
    If the number of objects received in a push is below this limit then the objects will be unpacked into loose object files. However if the number of received objects equals or exceeds this limit then the received pack will be stored as a pack, after adding any missing delta bases. Storing the pack from a push can make the push operation complete faster, especially on slow filesystems.

receive.denyNonFastForwards
    If set to true, git-receive-pack will deny a ref update which is not a fast forward. Use this to prevent such an update via a push, even if that push is forced. This configuration variable is set when initializing a shared repository.

AUTHOR
Written by Johannes Schindelin <Johannes.Schindelin@gmx.de>

DOCUMENTATION
Documentation by Johannes Schindelin, Petr Baudis and the git-list <git@vger.kernel.org>.

GIT
Part of the git(7) suite