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