Merge branch 'nk/config-local-doc' into maint
[git/git.git] / 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 rather than
100 the repository .git/config, write to $XDG_CONFIG_HOME/git/config file
101 if this file exists and the ~/.gitconfig file doesn't.
102 +
103 For reading options: read only from global ~/.gitconfig and from
104 $XDG_CONFIG_HOME/git/config rather than from all available files.
105 +
106 See also <<FILES>>.
107
108 --system::
109 For writing options: write to system-wide $(prefix)/etc/gitconfig
110 rather than the repository .git/config.
111 +
112 For reading options: read only from system-wide $(prefix)/etc/gitconfig
113 rather than from all available files.
114 +
115 See also <<FILES>>.
116
117 --local::
118 For writing options: write to the repository .git/config file.
119 This is the default behavior.
120 +
121 For reading options: read only from the repository .git/config rather than
122 from all available files.
123 +
124 See also <<FILES>>.
125
126 -f config-file::
127 --file config-file::
128 Use the given config file instead of the one specified by GIT_CONFIG.
129
130 --remove-section::
131 Remove the given section from the configuration file.
132
133 --rename-section::
134 Rename the given section to a new name.
135
136 --unset::
137 Remove the line matching the key from config file.
138
139 --unset-all::
140 Remove all lines matching the key from config file.
141
142 -l::
143 --list::
144 List all variables set in config file.
145
146 --bool::
147 'git config' will ensure that the output is "true" or "false"
148
149 --int::
150 'git config' will ensure that the output is a simple
151 decimal number. An optional value suffix of 'k', 'm', or 'g'
152 in the config file will cause the value to be multiplied
153 by 1024, 1048576, or 1073741824 prior to output.
154
155 --bool-or-int::
156 'git config' will ensure that the output matches the format of
157 either --bool or --int, as described above.
158
159 --path::
160 'git-config' will expand leading '{tilde}' to the value of
161 '$HOME', and '{tilde}user' to the home directory for the
162 specified user. This option has no effect when setting the
163 value (but you can use 'git config bla {tilde}/' from the
164 command line to let your shell do the expansion).
165
166 -z::
167 --null::
168 For all options that output values and/or keys, always
169 end values with the null character (instead of a
170 newline). Use newline instead as a delimiter between
171 key and value. This allows for secure parsing of the
172 output without getting confused e.g. by values that
173 contain line breaks.
174
175 --get-colorbool name [stdout-is-tty]::
176
177 Find the color setting for `name` (e.g. `color.diff`) and output
178 "true" or "false". `stdout-is-tty` should be either "true" or
179 "false", and is taken into account when configuration says
180 "auto". If `stdout-is-tty` is missing, then checks the standard
181 output of the command itself, and exits with status 0 if color
182 is to be used, or exits with status 1 otherwise.
183 When the color setting for `name` is undefined, the command uses
184 `color.ui` as fallback.
185
186 --get-color name [default]::
187
188 Find the color configured for `name` (e.g. `color.diff.new`) and
189 output it as the ANSI color escape sequence to the standard
190 output. The optional `default` parameter is used instead, if
191 there is no color configured for `name`.
192
193 -e::
194 --edit::
195 Opens an editor to modify the specified config file; either
196 '--system', '--global', or repository (default).
197
198 --[no-]includes::
199 Respect `include.*` directives in config files when looking up
200 values. Defaults to on.
201
202 [[FILES]]
203 FILES
204 -----
205
206 If not set explicitly with '--file', there are four files where
207 'git config' will search for configuration options:
208
209 $GIT_DIR/config::
210 Repository specific configuration file.
211
212 ~/.gitconfig::
213 User-specific configuration file. Also called "global"
214 configuration file.
215
216 $XDG_CONFIG_HOME/git/config::
217 Second user-specific configuration file. If $XDG_CONFIG_HOME is not set
218 or empty, $HOME/.config/git/config will be used. Any single-valued
219 variable set in this file will be overwritten by whatever is in
220 ~/.gitconfig. It is a good idea not to create this file if
221 you sometimes use older versions of Git, as support for this
222 file was added fairly recently.
223
224 $(prefix)/etc/gitconfig::
225 System-wide configuration file.
226
227 If no further options are given, all reading options will read all of these
228 files that are available. If the global or the system-wide configuration
229 file are not available they will be ignored. If the repository configuration
230 file is not available or readable, 'git config' will exit with a non-zero
231 error code. However, in neither case will an error message be issued.
232
233 All writing options will per default write to the repository specific
234 configuration file. Note that this also affects options like '--replace-all'
235 and '--unset'. *'git config' will only ever change one file at a time*.
236
237 You can override these rules either by command line options or by environment
238 variables. The '--global' and the '--system' options will limit the file used
239 to the global or system-wide file respectively. The GIT_CONFIG environment
240 variable has a similar effect, but you can specify any filename you want.
241
242
243 ENVIRONMENT
244 -----------
245
246 GIT_CONFIG::
247 Take the configuration from the given file instead of .git/config.
248 Using the "--global" option forces this to ~/.gitconfig. Using the
249 "--system" option forces this to $(prefix)/etc/gitconfig.
250
251 GIT_CONFIG_NOSYSTEM::
252 Whether to skip reading settings from the system-wide
253 $(prefix)/etc/gitconfig file. See linkgit:git[1] for details.
254
255 See also <<FILES>>.
256
257
258 [[EXAMPLES]]
259 EXAMPLES
260 --------
261
262 Given a .git/config like this:
263
264 #
265 # This is the config file, and
266 # a '#' or ';' character indicates
267 # a comment
268 #
269
270 ; core variables
271 [core]
272 ; Don't trust file modes
273 filemode = false
274
275 ; Our diff algorithm
276 [diff]
277 external = /usr/local/bin/diff-wrapper
278 renames = true
279
280 ; Proxy settings
281 [core]
282 gitproxy=proxy-command for kernel.org
283 gitproxy=default-proxy ; for all the rest
284
285 you can set the filemode to true with
286
287 ------------
288 % git config core.filemode true
289 ------------
290
291 The hypothetical proxy command entries actually have a postfix to discern
292 what URL they apply to. Here is how to change the entry for kernel.org
293 to "ssh".
294
295 ------------
296 % git config core.gitproxy '"ssh" for kernel.org' 'for kernel.org$'
297 ------------
298
299 This makes sure that only the key/value pair for kernel.org is replaced.
300
301 To delete the entry for renames, do
302
303 ------------
304 % git config --unset diff.renames
305 ------------
306
307 If you want to delete an entry for a multivar (like core.gitproxy above),
308 you have to provide a regex matching the value of exactly one line.
309
310 To query the value for a given key, do
311
312 ------------
313 % git config --get core.filemode
314 ------------
315
316 or
317
318 ------------
319 % git config core.filemode
320 ------------
321
322 or, to query a multivar:
323
324 ------------
325 % git config --get core.gitproxy "for kernel.org$"
326 ------------
327
328 If you want to know all the values for a multivar, do:
329
330 ------------
331 % git config --get-all core.gitproxy
332 ------------
333
334 If you like to live dangerously, you can replace *all* core.gitproxy by a
335 new one with
336
337 ------------
338 % git config --replace-all core.gitproxy ssh
339 ------------
340
341 However, if you really only want to replace the line for the default proxy,
342 i.e. the one without a "for ..." postfix, do something like this:
343
344 ------------
345 % git config core.gitproxy ssh '! for '
346 ------------
347
348 To actually match only values with an exclamation mark, you have to
349
350 ------------
351 % git config section.key value '[!]'
352 ------------
353
354 To add a new proxy, without altering any of the existing ones, use
355
356 ------------
357 % git config --add core.gitproxy '"proxy-command" for example.com'
358 ------------
359
360 An example to use customized color from the configuration in your
361 script:
362
363 ------------
364 #!/bin/sh
365 WS=$(git config --get-color color.diff.whitespace "blue reverse")
366 RESET=$(git config --get-color "" "reset")
367 echo "${WS}your whitespace color or blue reverse${RESET}"
368 ------------
369
370 include::config.txt[]
371
372 GIT
373 ---
374 Part of the linkgit:git[1] suite