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