Documentation/git-config.txt

   1 git-config(1)
   2 =============
   3
   4 NAME
   5 ----
   6 git-config - Get and set repository or global options
   7
   8
   9 SYNOPSIS
  10 --------
  11 [verse]
  12 'git-config' [--system | --global] name [value [value_regex]]
  13 'git-config' [--system | --global] --add name value
  14 'git-config' [--system | --global] --replace-all name [value [value_regex]]
  15 'git-config' [--system | --global] [type] --get name [value_regex]
  16 'git-config' [--system | --global] [type] --get-all name [value_regex]
  17 'git-config' [--system | --global] [type] --get-regexp name_regex [value_regex]
  18 'git-config' [--system | --global] --unset name [value_regex]
  19 'git-config' [--system | --global] --unset-all name [value_regex]
  20 'git-config' [--system | --global] --rename-section old_name new_name
  21 'git-config' [--system | --global] --remove-section name
  22 'git-config' [--system | --global] -l | --list
  23
  24 DESCRIPTION
  25 -----------
  26 You can query/set/replace/unset options with this command. The name is
  27 actually the section and the key separated by a dot, and the value will be
  28 escaped.
  29
  30 Multiple lines can be added to an option by using the '--add' option.
  31 If you want to update or unset an option which can occur on multiple
  32 lines, a POSIX regexp `value_regex` needs to be given.  Only the
  33 existing values that match the regexp are updated or unset.  If
  34 you want to handle the lines that do *not* match the regex, just
  35 prepend a single exclamation mark in front (see also <<EXAMPLES>>).
  36
  37 The type specifier can be either '--int' or '--bool', which will make
  38 'git-config' ensure that the variable(s) are of the given type and
  39 convert the value to the canonical form (simple decimal number for int,
  40 a "true" or "false" string for bool).  Type specifiers currently only
  41 take effect for reading operations.  If no type specifier is passed,
  42 no checks or transformations are performed on the value.
  43
  44 This command will fail if:
  45
  46 . The .git/config file is invalid,
  47 . Can not write to .git/config,
  48 . no section was provided,
  49 . the section or key is invalid,
  50 . you try to unset an option which does not exist,
  51 . you try to unset/set an option for which multiple lines match, or
  52 . you use '--global' option without $HOME being properly set.
  53
  54
  55 OPTIONS
  56 -------
  57
  58 --replace-all::
  59         Default behavior is to replace at most one line. This replaces
  60         all lines matching the key (and optionally the value_regex).
  61
  62 --add::
  63         Adds a new line to the option without altering any existing
  64         values.  This is the same as providing '^$' as the value_regex.
  65
  66 --get::
  67         Get the value for a given key (optionally filtered by a regex
  68         matching the value). Returns error code 1 if the key was not
  69         found and error code 2 if multiple key values were found.
  70
  71 --get-all::
  72         Like get, but does not fail if the number of values for the key
  73         is not exactly one.
  74
  75 --get-regexp::
  76         Like --get-all, but interprets the name as a regular expression.
  77         Also outputs the key names.
  78
  79 --global::
  80         For writing options: write to global ~/.gitconfig file rather than
  81         the repository .git/config.
  82 +
  83 For reading options: read only from global ~/.gitconfig rather than
  84 from all available files.
  85 +
  86 See also <<FILES>>.
  87
  88 --system::
  89         For writing options: write to system-wide $(prefix)/etc/gitconfig
  90         rather than the repository .git/config.
  91 +
  92 For reading options: read only from system-wide $(prefix)/etc/gitconfig
  93 rather than from all available files.
  94 +
  95 See also <<FILES>>.
  96
  97 --remove-section::
  98         Remove the given section from the configuration file.
  99
 100 --rename-section::
 101         Rename the given section to a new name.
 102
 103 --unset::
 104         Remove the line matching the key from config file.
 105
 106 --unset-all::
 107         Remove all lines matching the key from config file.
 108
 109 -l, --list::
 110         List all variables set in config file.
 111
 112 --bool::
 113         git-config will ensure that the output is "true" or "false"
 114
 115 --int::
 116         git-config will ensure that the output is a simple
 117         decimal number.  An optional value suffix of 'k', 'm', or 'g'
 118         in the config file will cause the value to be multiplied
 119         by 1024, 1048576, or 1073741824 prior to output.
 120
 121
 122 [[FILES]]
 123 FILES
 124 -----
 125
 126 There are three files where git-config will search for configuration
 127 options:
 128
 129 .git/config::
 130         Repository specific configuration file. (The filename is
 131         of course relative to the repository root, not the working
 132         directory.)
 133
 134 ~/.gitconfig::
 135         User-specific configuration file. Also called "global"
 136         configuration file.
 137
 138 $(prefix)/etc/gitconfig::
 139         System-wide configuration file.
 140
 141 If no further options are given, all reading options will read all of these
 142 files that are available. If the global or the system-wide configuration
 143 file are not available they will be ignored. If the repository configuration
 144 file is not available or readable, git-config will exit with a non-zero
 145 error code. However, in neither case will an error message be issued.
 146
 147 All writing options will per default write to the repository specific
 148 configuration file. Note that this also affects options like '--replace-all'
 149 and '--unset'. *git-config will only ever change one file at a time*.
 150
 151 You can override these rules either by command line options or by environment
 152 variables. The '--global' and the '--system' options will limit the file used
 153 to the global or system-wide file respectively. The GIT_CONFIG environment
 154 variable has a similar effect, but you can specify any filename you want.
 155
 156 The GIT_CONFIG_LOCAL environment variable on the other hand only changes
 157 the name used instead of the repository configuration file. The global and
 158 the system-wide configuration files will still be read. (For writing options
 159 this will obviously result in the same behavior as using GIT_CONFIG.)
 160
 161
 162 ENVIRONMENT
 163 -----------
 164
 165 GIT_CONFIG::
 166         Take the configuration from the given file instead of .git/config.
 167         Using the "--global" option forces this to ~/.gitconfig. Using the
 168         "--system" option forces this to $(prefix)/etc/gitconfig.
 169
 170 GIT_CONFIG_LOCAL::
 171         Take the configuration from the given file instead if .git/config.
 172         Still read the global and the system-wide configuration files, though.
 173
 174 See also <<FILES>>.
 175
 176
 177 [[EXAMPLES]]
 178 EXAMPLES
 179 --------
 180
 181 Given a .git/config like this:
 182
 183         #
 184         # This is the config file, and
 185         # a '#' or ';' character indicates
 186         # a comment
 187         #
 188
 189         ; core variables
 190         [core]
 191                 ; Don't trust file modes
 192                 filemode = false
 193
 194         ; Our diff algorithm
 195         [diff]
 196                 external = "/usr/local/bin/gnu-diff -u"
 197                 renames = true
 198
 199         ; Proxy settings
 200         [core]
 201                 gitproxy="ssh" for "ssh://kernel.org/"
 202                 gitproxy="proxy-command" for kernel.org
 203                 gitproxy="myprotocol-command" for "my://"
 204                 gitproxy=default-proxy ; for all the rest
 205
 206 you can set the filemode to true with
 207
 208 ------------
 209 % git config core.filemode true
 210 ------------
 211
 212 The hypothetical proxy command entries actually have a postfix to discern
 213 what URL they apply to. Here is how to change the entry for kernel.org
 214 to "ssh".
 215
 216 ------------
 217 % git config core.gitproxy '"ssh" for kernel.org' 'for kernel.org$'
 218 ------------
 219
 220 This makes sure that only the key/value pair for kernel.org is replaced.
 221
 222 To delete the entry for renames, do
 223
 224 ------------
 225 % git config --unset diff.renames
 226 ------------
 227
 228 If you want to delete an entry for a multivar (like core.gitproxy above),
 229 you have to provide a regex matching the value of exactly one line.
 230
 231 To query the value for a given key, do
 232
 233 ------------
 234 % git config --get core.filemode
 235 ------------
 236
 237 or
 238
 239 ------------
 240 % git config core.filemode
 241 ------------
 242
 243 or, to query a multivar:
 244
 245 ------------
 246 % git config --get core.gitproxy "for kernel.org$"
 247 ------------
 248
 249 If you want to know all the values for a multivar, do:
 250
 251 ------------
 252 % git config --get-all core.gitproxy
 253 ------------
 254
 255 If you like to live dangerous, you can replace *all* core.gitproxy by a
 256 new one with
 257
 258 ------------
 259 % git config --replace-all core.gitproxy ssh
 260 ------------
 261
 262 However, if you really only want to replace the line for the default proxy,
 263 i.e. the one without a "for ..." postfix, do something like this:
 264
 265 ------------
 266 % git config core.gitproxy ssh '! for '
 267 ------------
 268
 269 To actually match only values with an exclamation mark, you have to
 270
 271 ------------
 272 % git config section.key value '[!]'
 273 ------------
 274
 275 To add a new proxy, without altering any of the existing ones, use
 276
 277 ------------
 278 % git config core.gitproxy '"proxy" for example.com'
 279 ------------
 280
 281
 282 include::config.txt[]
 283
 284
 285 Author
 286 ------
 287 Written by Johannes Schindelin <Johannes.Schindelin@gmx.de>
 288
 289 Documentation
 290 --------------
 291 Documentation by Johannes Schindelin, Petr Baudis and the git-list <git@vger.kernel.org>.
 292
 293 GIT
 294 ---
 295 Part of the gitlink:git[7] suite