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 'git config' [<file-option>] --get-colorbool name [stdout-is-tty]
  25 'git config' [<file-option>] -e | --edit
  26
  27 DESCRIPTION
  28 -----------
  29 You can query/set/replace/unset options with this command. The name is
  30 actually the section and the key separated by a dot, and the value will be
  31 escaped.
  32
  33 Multiple lines can be added to an option by using the '--add' option.
  34 If you want to update or unset an option which can occur on multiple
  35 lines, a POSIX regexp `value_regex` needs to be given.  Only the
  36 existing values that match the regexp are updated or unset.  If
  37 you want to handle the lines that do *not* match the regex, just
  38 prepend a single exclamation mark in front (see also <<EXAMPLES>>).
  39
  40 The type specifier can be either '--int' or '--bool', to make
  41 'git config' ensure that the variable(s) are of the given type and
  42 convert the value to the canonical form (simple decimal number for int,
  43 a "true" or "false" string for bool), or '--path', which does some
  44 path expansion (see '--path' below).  If no type specifier is passed, no
  45 checks or transformations are performed on the value.
  46
  47 When reading, the values are read from the system, global and
  48 repository local configuration files by default, and options
  49 '--system', '--global', '--local' and '--file <filename>' can be
  50 used to tell the command to read from only that location (see <<FILES>>).
  51
  52 When writing, the new value is written to the repository local
  53 configuration file by default, and options '--system', '--global',
  54 '--file <filename>' can be used to tell the command to write to
  55 that location (you can say '--local' but that is the default).
  56
  57 This command will fail with non-zero status upon error.  Some exit
  58 codes are:
  59
  60 . The config file is invalid (ret=3),
  61 . can not write to the config file (ret=4),
  62 . no section or name was provided (ret=2),
  63 . the section or key is invalid (ret=1),
  64 . you try to unset an option which does not exist (ret=5),
  65 . you try to unset/set an option for which multiple lines match (ret=5), or
  66 . you try to use an invalid regexp (ret=6).
  67
  68 On success, the command returns the exit code 0.
  69
  70 OPTIONS
  71 -------
  72
  73 --replace-all::
  74         Default behavior is to replace at most one line. This replaces
  75         all lines matching the key (and optionally the value_regex).
  76
  77 --add::
  78         Adds a new line to the option without altering any existing
  79         values.  This is the same as providing '^$' as the value_regex
  80         in `--replace-all`.
  81
  82 --get::
  83         Get the value for a given key (optionally filtered by a regex
  84         matching the value). Returns error code 1 if the key was not
  85         found and the last value if multiple key values were found.
  86
  87 --get-all::
  88         Like get, but does not fail if the number of values for the key
  89         is not exactly one.
  90
  91 --get-regexp::
  92         Like --get-all, but interprets the name as a regular expression and
  93         writes out the key names.  Regular expression matching is currently
  94         case-sensitive and done against a canonicalized version of the key
  95         in which section and variable names are lowercased, but subsection
  96         names are not.
  97
  98 --global::
  99         For writing options: write to global `~/.gitconfig` file
 100         rather than the repository `.git/config`, write to
 101         `$XDG_CONFIG_HOME/git/config` file if this file exists and the
 102         `~/.gitconfig` file doesn't.
 103 +
 104 For reading options: read only from global `~/.gitconfig` and from
 105 `$XDG_CONFIG_HOME/git/config` rather than from all available files.
 106 +
 107 See also <<FILES>>.
 108
 109 --system::
 110         For writing options: write to system-wide
 111         `$(prefix)/etc/gitconfig` rather than the repository
 112         `.git/config`.
 113 +
 114 For reading options: read only from system-wide `$(prefix)/etc/gitconfig`
 115 rather than from all available files.
 116 +
 117 See also <<FILES>>.
 118
 119 --local::
 120         For writing options: write to the repository `.git/config` file.
 121         This is the default behavior.
 122 +
 123 For reading options: read only from the repository `.git/config` rather than
 124 from all available files.
 125 +
 126 See also <<FILES>>.
 127
 128 -f config-file::
 129 --file config-file::
 130         Use the given config file instead of the one specified by GIT_CONFIG.
 131
 132 --blob blob::
 133         Similar to '--file' but use the given blob instead of a file. E.g.
 134         you can use 'master:.gitmodules' to read values from the file
 135         '.gitmodules' in the master branch. See "SPECIFYING REVISIONS"
 136         section in linkgit:gitrevisions[7] for a more complete list of
 137         ways to spell blob names.
 138
 139 --remove-section::
 140         Remove the given section from the configuration file.
 141
 142 --rename-section::
 143         Rename the given section to a new name.
 144
 145 --unset::
 146         Remove the line matching the key from config file.
 147
 148 --unset-all::
 149         Remove all lines matching the key from config file.
 150
 151 -l::
 152 --list::
 153         List all variables set in config file.
 154
 155 --bool::
 156         'git config' will ensure that the output is "true" or "false"
 157
 158 --int::
 159         'git config' will ensure that the output is a simple
 160         decimal number.  An optional value suffix of 'k', 'm', or 'g'
 161         in the config file will cause the value to be multiplied
 162         by 1024, 1048576, or 1073741824 prior to output.
 163
 164 --bool-or-int::
 165         'git config' will ensure that the output matches the format of
 166         either --bool or --int, as described above.
 167
 168 --path::
 169         'git-config' will expand leading '{tilde}' to the value of
 170         '$HOME', and '{tilde}user' to the home directory for the
 171         specified user.  This option has no effect when setting the
 172         value (but you can use 'git config bla {tilde}/' from the
 173         command line to let your shell do the expansion).
 174
 175 -z::
 176 --null::
 177         For all options that output values and/or keys, always
 178         end values with the null character (instead of a
 179         newline). Use newline instead as a delimiter between
 180         key and value. This allows for secure parsing of the
 181         output without getting confused e.g. by values that
 182         contain line breaks.
 183
 184 --get-colorbool name [stdout-is-tty]::
 185
 186         Find the color setting for `name` (e.g. `color.diff`) and output
 187         "true" or "false".  `stdout-is-tty` should be either "true" or
 188         "false", and is taken into account when configuration says
 189         "auto".  If `stdout-is-tty` is missing, then checks the standard
 190         output of the command itself, and exits with status 0 if color
 191         is to be used, or exits with status 1 otherwise.
 192         When the color setting for `name` is undefined, the command uses
 193         `color.ui` as fallback.
 194
 195 --get-color name [default]::
 196
 197         Find the color configured for `name` (e.g. `color.diff.new`) and
 198         output it as the ANSI color escape sequence to the standard
 199         output.  The optional `default` parameter is used instead, if
 200         there is no color configured for `name`.
 201
 202 -e::
 203 --edit::
 204         Opens an editor to modify the specified config file; either
 205         '--system', '--global', or repository (default).
 206
 207 --[no-]includes::
 208         Respect `include.*` directives in config files when looking up
 209         values. Defaults to on.
 210
 211 [[FILES]]
 212 FILES
 213 -----
 214
 215 If not set explicitly with '--file', there are four files where
 216 'git config' will search for configuration options:
 217
 218 $(prefix)/etc/gitconfig::
 219         System-wide configuration file.
 220
 221 $XDG_CONFIG_HOME/git/config::
 222         Second user-specific configuration file. If $XDG_CONFIG_HOME is not set
 223         or empty, `$HOME/.config/git/config` will be used. Any single-valued
 224         variable set in this file will be overwritten by whatever is in
 225         `~/.gitconfig`.  It is a good idea not to create this file if
 226         you sometimes use older versions of Git, as support for this
 227         file was added fairly recently.
 228
 229 ~/.gitconfig::
 230         User-specific configuration file. Also called "global"
 231         configuration file.
 232
 233 $GIT_DIR/config::
 234         Repository specific configuration file.
 235
 236 If no further options are given, all reading options will read all of these
 237 files that are available. If the global or the system-wide configuration
 238 file are not available they will be ignored. If the repository configuration
 239 file is not available or readable, 'git config' will exit with a non-zero
 240 error code. However, in neither case will an error message be issued.
 241
 242 The files are read in the order given above, with last value found taking
 243 precedence over values read earlier.  When multiple values are taken then all
 244 values of a key from all files will be used.
 245
 246 All writing options will per default write to the repository specific
 247 configuration file. Note that this also affects options like '--replace-all'
 248 and '--unset'. *'git config' will only ever change one file at a time*.
 249
 250 You can override these rules either by command line options or by environment
 251 variables. The '--global' and the '--system' options will limit the file used
 252 to the global or system-wide file respectively. The GIT_CONFIG environment
 253 variable has a similar effect, but you can specify any filename you want.
 254
 255
 256 ENVIRONMENT
 257 -----------
 258
 259 GIT_CONFIG::
 260         Take the configuration from the given file instead of .git/config.
 261         Using the "--global" option forces this to ~/.gitconfig. Using the
 262         "--system" option forces this to $(prefix)/etc/gitconfig.
 263
 264 GIT_CONFIG_NOSYSTEM::
 265         Whether to skip reading settings from the system-wide
 266         $(prefix)/etc/gitconfig file. See linkgit:git[1] for details.
 267
 268 See also <<FILES>>.
 269
 270
 271 [[EXAMPLES]]
 272 EXAMPLES
 273 --------
 274
 275 Given a .git/config like this:
 276
 277         #
 278         # This is the config file, and
 279         # a '#' or ';' character indicates
 280         # a comment
 281         #
 282
 283         ; core variables
 284         [core]
 285                 ; Don't trust file modes
 286                 filemode = false
 287
 288         ; Our diff algorithm
 289         [diff]
 290                 external = /usr/local/bin/diff-wrapper
 291                 renames = true
 292
 293         ; Proxy settings
 294         [core]
 295                 gitproxy=proxy-command for kernel.org
 296                 gitproxy=default-proxy ; for all the rest
 297
 298 you can set the filemode to true with
 299
 300 ------------
 301 % git config core.filemode true
 302 ------------
 303
 304 The hypothetical proxy command entries actually have a postfix to discern
 305 what URL they apply to. Here is how to change the entry for kernel.org
 306 to "ssh".
 307
 308 ------------
 309 % git config core.gitproxy '"ssh" for kernel.org' 'for kernel.org$'
 310 ------------
 311
 312 This makes sure that only the key/value pair for kernel.org is replaced.
 313
 314 To delete the entry for renames, do
 315
 316 ------------
 317 % git config --unset diff.renames
 318 ------------
 319
 320 If you want to delete an entry for a multivar (like core.gitproxy above),
 321 you have to provide a regex matching the value of exactly one line.
 322
 323 To query the value for a given key, do
 324
 325 ------------
 326 % git config --get core.filemode
 327 ------------
 328
 329 or
 330
 331 ------------
 332 % git config core.filemode
 333 ------------
 334
 335 or, to query a multivar:
 336
 337 ------------
 338 % git config --get core.gitproxy "for kernel.org$"
 339 ------------
 340
 341 If you want to know all the values for a multivar, do:
 342
 343 ------------
 344 % git config --get-all core.gitproxy
 345 ------------
 346
 347 If you like to live dangerously, you can replace *all* core.gitproxy by a
 348 new one with
 349
 350 ------------
 351 % git config --replace-all core.gitproxy ssh
 352 ------------
 353
 354 However, if you really only want to replace the line for the default proxy,
 355 i.e. the one without a "for ..." postfix, do something like this:
 356
 357 ------------
 358 % git config core.gitproxy ssh '! for '
 359 ------------
 360
 361 To actually match only values with an exclamation mark, you have to
 362
 363 ------------
 364 % git config section.key value '[!]'
 365 ------------
 366
 367 To add a new proxy, without altering any of the existing ones, use
 368
 369 ------------
 370 % git config --add core.gitproxy '"proxy-command" for example.com'
 371 ------------
 372
 373 An example to use customized color from the configuration in your
 374 script:
 375
 376 ------------
 377 #!/bin/sh
 378 WS=$(git config --get-color color.diff.whitespace "blue reverse")
 379 RESET=$(git config --get-color "" "reset")
 380 echo "${WS}your whitespace color or blue reverse${RESET}"
 381 ------------
 382
 383 include::config.txt[]
 384
 385 GIT
 386 ---
 387 Part of the linkgit:git[1] suite