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