Documentation / git-repo-config.txton commit Merge branch 'maint' (73c7f5e)
   1git-repo-config(1)
   2==================
   3
   4NAME
   5----
   6git-repo-config - Get and set repository or global options.
   7
   8
   9SYNOPSIS
  10--------
  11[verse]
  12'git-repo-config' [--global] [type] name [value [value_regex]]
  13'git-repo-config' [--global] [type] --replace-all name [value [value_regex]]
  14'git-repo-config' [--global] [type] --get name [value_regex]
  15'git-repo-config' [--global] [type] --get-all name [value_regex]
  16'git-repo-config' [--global] [type] --unset name [value_regex]
  17'git-repo-config' [--global] [type] --unset-all name [value_regex]
  18'git-repo-config' [--global] -l | --list
  19
  20DESCRIPTION
  21-----------
  22You can query/set/replace/unset options with this command. The name is
  23actually the section and the key separated by a dot, and the value will be
  24escaped.
  25
  26If you want to set/unset an option which can occur on multiple
  27lines, a POSIX regexp `value_regex` needs to be given.  Only the
  28existing values that match the regexp are updated or unset.  If
  29you want to handle the lines that do *not* match the regex, just
  30prepend a single exclamation mark in front (see EXAMPLES).
  31
  32The type specifier can be either '--int' or '--bool', which will make
  33'git-repo-config' ensure that the variable(s) are of the given type and
  34convert the value to the canonical form (simple decimal number for int,
  35a "true" or "false" string for bool). If no type specifier is passed,
  36no checks or transformations are performed on the value.
  37
  38This command will fail if:
  39
  40. The .git/config file is invalid,
  41. Can not write to .git/config,
  42. no section was provided,
  43. the section or key is invalid,
  44. you try to unset an option which does not exist,
  45. you try to unset/set an option for which multiple lines match, or
  46. you use --global option without $HOME being properly set.
  47
  48
  49OPTIONS
  50-------
  51
  52--replace-all::
  53        Default behavior is to replace at most one line. This replaces
  54        all lines matching the key (and optionally the value_regex).
  55
  56--get::
  57        Get the value for a given key (optionally filtered by a regex
  58        matching the value). Returns error code 1 if the key was not
  59        found and error code 2 if multiple key values were found.
  60
  61--get-all::
  62        Like get, but does not fail if the number of values for the key
  63        is not exactly one.
  64
  65--get-regexp::
  66        Like --get-all, but interprets the name as a regular expression.
  67
  68--global::
  69        Use global ~/.gitconfig file rather than the repository .git/config.
  70
  71--unset::
  72        Remove the line matching the key from config file.
  73
  74--unset-all::
  75        Remove all matching lines from config file.
  76
  77-l, --list::
  78        List all variables set in config file.
  79
  80--bool::
  81        git-repo-config will ensure that the output is "true" or "false"
  82
  83--int::
  84        git-repo-config will ensure that the output is a simple decimal number
  85
  86
  87ENVIRONMENT
  88-----------
  89
  90GIT_CONFIG::
  91        Take the configuration from the given file instead of .git/config.
  92        Using the "--global" option forces this to ~/.gitconfig.
  93
  94GIT_CONFIG_LOCAL::
  95        Currently the same as $GIT_CONFIG; when Git will support global
  96        configuration files, this will cause it to take the configuration
  97        from the global configuration file in addition to the given file.
  98
  99
 100EXAMPLE
 101-------
 102
 103Given a .git/config like this:
 104
 105        #
 106        # This is the config file, and
 107        # a '#' or ';' character indicates
 108        # a comment
 109        #
 110
 111        ; core variables
 112        [core]
 113                ; Don't trust file modes
 114                filemode = false
 115
 116        ; Our diff algorithm
 117        [diff]
 118                external = "/usr/local/bin/gnu-diff -u"
 119                renames = true
 120
 121        ; Proxy settings
 122        [core]
 123                gitproxy="ssh" for "ssh://kernel.org/"
 124                gitproxy="proxy-command" for kernel.org
 125                gitproxy="myprotocol-command" for "my://"
 126                gitproxy=default-proxy ; for all the rest
 127
 128you can set the filemode to true with
 129
 130------------
 131% git repo-config core.filemode true
 132------------
 133
 134The hypothetical proxy command entries actually have a postfix to discern
 135what URL they apply to. Here is how to change the entry for kernel.org
 136to "ssh".
 137
 138------------
 139% git repo-config core.gitproxy '"ssh" for kernel.org' 'for kernel.org$'
 140------------
 141
 142This makes sure that only the key/value pair for kernel.org is replaced.
 143
 144To delete the entry for renames, do
 145
 146------------
 147% git repo-config --unset diff.renames
 148------------
 149
 150If you want to delete an entry for a multivar (like core.gitproxy above),
 151you have to provide a regex matching the value of exactly one line.
 152
 153To query the value for a given key, do
 154
 155------------
 156% git repo-config --get core.filemode
 157------------
 158
 159or
 160
 161------------
 162% git repo-config core.filemode
 163------------
 164
 165or, to query a multivar:
 166
 167------------
 168% git repo-config --get core.gitproxy "for kernel.org$"
 169------------
 170
 171If you want to know all the values for a multivar, do:
 172
 173------------
 174% git repo-config --get-all core.gitproxy
 175------------
 176
 177If you like to live dangerous, you can replace *all* core.gitproxy by a
 178new one with
 179
 180------------
 181% git repo-config --replace-all core.gitproxy ssh
 182------------
 183
 184However, if you really only want to replace the line for the default proxy,
 185i.e. the one without a "for ..." postfix, do something like this:
 186
 187------------
 188% git repo-config core.gitproxy ssh '! for '
 189------------
 190
 191To actually match only values with an exclamation mark, you have to
 192
 193------------
 194% git repo-config section.key value '[!]'
 195------------
 196
 197
 198include::config.txt[]
 199
 200
 201Author
 202------
 203Written by Johannes Schindelin <Johannes.Schindelin@gmx.de>
 204
 205Documentation
 206--------------
 207Documentation by Johannes Schindelin, Petr Baudis and the git-list <git@vger.kernel.org>.
 208
 209GIT
 210---
 211Part of the gitlink:git[7] suite
 212