1 git-config(1)
2 =============
4 NAME
5 ----
6 git-config - Get and set repository or global options
9 SYNOPSIS
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
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.
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>>).
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.
44 This command will fail if:
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.
55 OPTIONS
56 -------
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).
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.
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.
71 --get-all::
72 Like get, but does not fail if the number of values for the key
73 is not exactly one.
75 --get-regexp::
76 Like --get-all, but interprets the name as a regular expression.
77 Also outputs the key names.
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>>.
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>>.
97 --remove-section::
98 Remove the given section from the configuration file.
100 --rename-section::
101 Rename the given section to a new name.
103 --unset::
104 Remove the line matching the key from config file.
106 --unset-all::
107 Remove all lines matching the key from config file.
109 -l, --list::
110 List all variables set in config file.
112 --bool::
113 git-config will ensure that the output is "true" or "false"
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.
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.
130 [[FILES]]
131 FILES
132 -----
134 There are three files where git-config will search for configuration
135 options:
137 .git/config::
138 Repository specific configuration file. (The filename is
139 of course relative to the repository root, not the working
140 directory.)
142 ~/.gitconfig::
143 User-specific configuration file. Also called "global"
144 configuration file.
146 $(prefix)/etc/gitconfig::
147 System-wide configuration file.
149 If no further options are given, all reading options will read all of these
150 files that are available. If the global or the system-wide configuration
151 file are not available they will be ignored. If the repository configuration
152 file is not available or readable, git-config will exit with a non-zero
153 error code. However, in neither case will an error message be issued.
155 All writing options will per default write to the repository specific
156 configuration file. Note that this also affects options like '--replace-all'
157 and '--unset'. *git-config will only ever change one file at a time*.
159 You can override these rules either by command line options or by environment
160 variables. The '--global' and the '--system' options will limit the file used
161 to the global or system-wide file respectively. The GIT_CONFIG environment
162 variable has a similar effect, but you can specify any filename you want.
164 The GIT_CONFIG_LOCAL environment variable on the other hand only changes
165 the name used instead of the repository configuration file. The global and
166 the system-wide configuration files will still be read. (For writing options
167 this will obviously result in the same behavior as using GIT_CONFIG.)
170 ENVIRONMENT
171 -----------
173 GIT_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.
178 GIT_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.
182 See also <<FILES>>.
185 [[EXAMPLES]]
186 EXAMPLES
187 --------
189 Given a .git/config like this:
191 #
192 # This is the config file, and
193 # a '#' or ';' character indicates
194 # a comment
195 #
197 ; core variables
198 [core]
199 ; Don't trust file modes
200 filemode = false
202 ; Our diff algorithm
203 [diff]
204 external = "/usr/local/bin/gnu-diff -u"
205 renames = true
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
214 you can set the filemode to true with
216 ------------
217 % git config core.filemode true
218 ------------
220 The hypothetical proxy command entries actually have a postfix to discern
221 what URL they apply to. Here is how to change the entry for kernel.org
222 to "ssh".
224 ------------
225 % git config core.gitproxy '"ssh" for kernel.org' 'for kernel.org$'
226 ------------
228 This makes sure that only the key/value pair for kernel.org is replaced.
230 To delete the entry for renames, do
232 ------------
233 % git config --unset diff.renames
234 ------------
236 If you want to delete an entry for a multivar (like core.gitproxy above),
237 you have to provide a regex matching the value of exactly one line.
239 To query the value for a given key, do
241 ------------
242 % git config --get core.filemode
243 ------------
245 or
247 ------------
248 % git config core.filemode
249 ------------
251 or, to query a multivar:
253 ------------
254 % git config --get core.gitproxy "for kernel.org$"
255 ------------
257 If you want to know all the values for a multivar, do:
259 ------------
260 % git config --get-all core.gitproxy
261 ------------
263 If you like to live dangerous, you can replace *all* core.gitproxy by a
264 new one with
266 ------------
267 % git config --replace-all core.gitproxy ssh
268 ------------
270 However, if you really only want to replace the line for the default proxy,
271 i.e. the one without a "for ..." postfix, do something like this:
273 ------------
274 % git config core.gitproxy ssh '! for '
275 ------------
277 To actually match only values with an exclamation mark, you have to
279 ------------
280 % git config section.key value '[!]'
281 ------------
283 To add a new proxy, without altering any of the existing ones, use
285 ------------
286 % git config core.gitproxy '"proxy" for example.com'
287 ------------
290 include::config.txt[]
293 Author
294 ------
295 Written by Johannes Schindelin <Johannes.Schindelin@gmx.de>
297 Documentation
298 --------------
299 Documentation by Johannes Schindelin, Petr Baudis and the git-list <git@vger.kernel.org>.
301 GIT
302 ---
303 Part of the gitlink:git[7] suite