1git-config(1) 2============= 3 4NAME 5---- 6git-config - Get and set repository or global options 7 8 9SYNOPSIS 10-------- 11[verse] 12'git-config' [--system | --global] [-z|--null] 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] [-z|--null] --get name [value_regex] 16'git-config' [--system | --global] [type] [-z|--null] --get-all name [value_regex] 17'git-config' [--system | --global] [type] [-z|--null] --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] [-z|--null] -l | --list 23 24DESCRIPTION 25----------- 26You can query/set/replace/unset options with this command. The name is 27actually the section and the key separated by a dot, and the value will be 28escaped. 29 30Multiple lines can be added to an option by using the '--add' option. 31If you want to update or unset an option which can occur on multiple 32lines, a POSIX regexp `value_regex` needs to be given. Only the 33existing values that match the regexp are updated or unset. If 34you want to handle the lines that do *not* match the regex, just 35prepend a single exclamation mark in front (see also <<EXAMPLES>>). 36 37The 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 39convert the value to the canonical form (simple decimal number for int, 40a "true" or "false" string for bool). Type specifiers currently only 41take effect for reading operations. If no type specifier is passed, 42no checks or transformations are performed on the value. 43 44This 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 55OPTIONS 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+ 83For reading options: read only from global ~/.gitconfig rather than 84from all available files. 85+ 86See also <<FILES>>. 87 88--system:: 89 For writing options: write to system-wide $(prefix)/etc/gitconfig 90 rather than the repository .git/config. 91+ 92For reading options: read only from system-wide $(prefix)/etc/gitconfig 93rather than from all available files. 94+ 95See 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-z, --null:: 122 For all options that output values and/or keys, always 123 end values with with the null character (instead of a 124 newline). Use newline instead as a delimiter between 125 key and value. This allows for secure parsing of the 126 output without getting confused e.g. by values that 127 contain line breaks. 128 129 130[[FILES]] 131FILES 132----- 133 134There are three files where git-config will search for configuration 135options: 136 137.git/config:: 138 Repository specific configuration file. (The filename is 139 of course relative to the repository root, not the working 140 directory.) 141 142~/.gitconfig:: 143 User-specific configuration file. Also called "global" 144 configuration file. 145 146$(prefix)/etc/gitconfig:: 147 System-wide configuration file. 148 149If no further options are given, all reading options will read all of these 150files that are available. If the global or the system-wide configuration 151file are not available they will be ignored. If the repository configuration 152file is not available or readable, git-config will exit with a non-zero 153error code. However, in neither case will an error message be issued. 154 155All writing options will per default write to the repository specific 156configuration file. Note that this also affects options like '--replace-all' 157and '--unset'. *git-config will only ever change one file at a time*. 158 159You can override these rules either by command line options or by environment 160variables. The '--global' and the '--system' options will limit the file used 161to the global or system-wide file respectively. The GIT_CONFIG environment 162variable has a similar effect, but you can specify any filename you want. 163 164The GIT_CONFIG_LOCAL environment variable on the other hand only changes 165the name used instead of the repository configuration file. The global and 166the system-wide configuration files will still be read. (For writing options 167this will obviously result in the same behavior as using GIT_CONFIG.) 168 169 170ENVIRONMENT 171----------- 172 173GIT_CONFIG:: 174 Take the configuration from the given file instead of .git/config. 175 Using the "--global" option forces this to ~/.gitconfig. Using the 176 "--system" option forces this to $(prefix)/etc/gitconfig. 177 178GIT_CONFIG_LOCAL:: 179 Take the configuration from the given file instead if .git/config. 180 Still read the global and the system-wide configuration files, though. 181 182See also <<FILES>>. 183 184 185[[EXAMPLES]] 186EXAMPLES 187-------- 188 189Given a .git/config like this: 190 191 # 192 # This is the config file, and 193 # a '#' or ';' character indicates 194 # a comment 195 # 196 197 ; core variables 198 [core] 199 ; Don't trust file modes 200 filemode = false 201 202 ; Our diff algorithm 203 [diff] 204 external = "/usr/local/bin/gnu-diff -u" 205 renames = true 206 207 ; Proxy settings 208 [core] 209 gitproxy="ssh" for "ssh://kernel.org/" 210 gitproxy="proxy-command" for kernel.org 211 gitproxy="myprotocol-command" for "my://" 212 gitproxy=default-proxy ; for all the rest 213 214you can set the filemode to true with 215 216------------ 217% git config core.filemode true 218------------ 219 220The hypothetical proxy command entries actually have a postfix to discern 221what URL they apply to. Here is how to change the entry for kernel.org 222to "ssh". 223 224------------ 225% git config core.gitproxy '"ssh" for kernel.org' 'for kernel.org$' 226------------ 227 228This makes sure that only the key/value pair for kernel.org is replaced. 229 230To delete the entry for renames, do 231 232------------ 233% git config --unset diff.renames 234------------ 235 236If you want to delete an entry for a multivar (like core.gitproxy above), 237you have to provide a regex matching the value of exactly one line. 238 239To query the value for a given key, do 240 241------------ 242% git config --get core.filemode 243------------ 244 245or 246 247------------ 248% git config core.filemode 249------------ 250 251or, to query a multivar: 252 253------------ 254% git config --get core.gitproxy "for kernel.org$" 255------------ 256 257If you want to know all the values for a multivar, do: 258 259------------ 260% git config --get-all core.gitproxy 261------------ 262 263If you like to live dangerous, you can replace *all* core.gitproxy by a 264new one with 265 266------------ 267% git config --replace-all core.gitproxy ssh 268------------ 269 270However, if you really only want to replace the line for the default proxy, 271i.e. the one without a "for ..." postfix, do something like this: 272 273------------ 274% git config core.gitproxy ssh '! for ' 275------------ 276 277To actually match only values with an exclamation mark, you have to 278 279------------ 280% git config section.key value '[!]' 281------------ 282 283To add a new proxy, without altering any of the existing ones, use 284 285------------ 286% git config core.gitproxy '"proxy" for example.com' 287------------ 288 289 290include::config.txt[] 291 292 293Author 294------ 295Written by Johannes Schindelin <Johannes.Schindelin@gmx.de> 296 297Documentation 298-------------- 299Documentation by Johannes Schindelin, Petr Baudis and the git-list <git@vger.kernel.org>. 300 301GIT 302--- 303Part of the gitlink:git[7] suite