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