]>
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] | |
be52a41c AR |
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 | |
e0d10e1c TP |
23 | |
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. | |
29 | ||
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 | |
90a36e58 | 35 | prepend a single exclamation mark in front (see also <<EXAMPLES>>). |
e0d10e1c TP |
36 | |
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, | |
db1696b8 | 40 | a "true" or "false" string for bool). If no type specifier is passed, |
e0d10e1c TP |
41 | no checks or transformations are performed on the value. |
42 | ||
be52a41c AR |
43 | The file-option can be one of '--system', '--global' or '--file' |
44 | which specify where the values will be read from or written to. | |
45 | The default is to assume the config file of the current repository, | |
46 | .git/config unless defined otherwise with GIT_DIR and GIT_CONFIG | |
47 | (see <<FILES>>). | |
48 | ||
e0d10e1c TP |
49 | This command will fail if: |
50 | ||
67d454fe AR |
51 | . The config file is invalid, |
52 | . Can not write to the config file, | |
e0d10e1c TP |
53 | . no section was provided, |
54 | . the section or key is invalid, | |
55 | . you try to unset an option which does not exist, | |
56 | . you try to unset/set an option for which multiple lines match, or | |
90a36e58 | 57 | . you use '--global' option without $HOME being properly set. |
e0d10e1c TP |
58 | |
59 | ||
60 | OPTIONS | |
61 | ------- | |
62 | ||
63 | --replace-all:: | |
64 | Default behavior is to replace at most one line. This replaces | |
65 | all lines matching the key (and optionally the value_regex). | |
66 | ||
67 | --add:: | |
68 | Adds a new line to the option without altering any existing | |
69 | values. This is the same as providing '^$' as the value_regex. | |
70 | ||
71 | --get:: | |
72 | Get the value for a given key (optionally filtered by a regex | |
73 | matching the value). Returns error code 1 if the key was not | |
74 | found and error code 2 if multiple key values were found. | |
75 | ||
76 | --get-all:: | |
77 | Like get, but does not fail if the number of values for the key | |
78 | is not exactly one. | |
79 | ||
80 | --get-regexp:: | |
81 | Like --get-all, but interprets the name as a regular expression. | |
e373bb73 | 82 | Also outputs the key names. |
e0d10e1c TP |
83 | |
84 | --global:: | |
17014090 FL |
85 | For writing options: write to global ~/.gitconfig file rather than |
86 | the repository .git/config. | |
87 | + | |
88 | For reading options: read only from global ~/.gitconfig rather than | |
89 | from all available files. | |
90 | + | |
91 | See also <<FILES>>. | |
e0d10e1c | 92 | |
9bc20aa7 | 93 | --system:: |
17014090 FL |
94 | For writing options: write to system-wide $(prefix)/etc/gitconfig |
95 | rather than the repository .git/config. | |
96 | + | |
97 | For reading options: read only from system-wide $(prefix)/etc/gitconfig | |
98 | rather than from all available files. | |
99 | + | |
100 | See also <<FILES>>. | |
9bc20aa7 | 101 | |
67d454fe AR |
102 | -f config-file, --file config-file:: |
103 | Use the given config file instead of the one specified by GIT_CONFIG. | |
104 | ||
118f8b24 PB |
105 | --remove-section:: |
106 | Remove the given section from the configuration file. | |
107 | ||
108 | --rename-section:: | |
109 | Rename the given section to a new name. | |
110 | ||
e0d10e1c TP |
111 | --unset:: |
112 | Remove the line matching the key from config file. | |
113 | ||
114 | --unset-all:: | |
9debca9a | 115 | Remove all lines matching the key from config file. |
e0d10e1c TP |
116 | |
117 | -l, --list:: | |
118 | List all variables set in config file. | |
119 | ||
120 | --bool:: | |
121 | git-config will ensure that the output is "true" or "false" | |
122 | ||
123 | --int:: | |
124 | git-config will ensure that the output is a simple | |
125 | decimal number. An optional value suffix of 'k', 'm', or 'g' | |
126 | in the config file will cause the value to be multiplied | |
127 | by 1024, 1048576, or 1073741824 prior to output. | |
128 | ||
2275d502 FL |
129 | -z, --null:: |
130 | For all options that output values and/or keys, always | |
131 | end values with with the null character (instead of a | |
132 | newline). Use newline instead as a delimiter between | |
133 | key and value. This allows for secure parsing of the | |
134 | output without getting confused e.g. by values that | |
135 | contain line breaks. | |
136 | ||
e0d10e1c | 137 | |
17014090 FL |
138 | [[FILES]] |
139 | FILES | |
140 | ----- | |
141 | ||
02783075 | 142 | If not set explicitly with '--file', there are three files where |
be52a41c | 143 | git-config will search for configuration options: |
17014090 | 144 | |
7c8b5eaf | 145 | $GIT_DIR/config:: |
17014090 FL |
146 | Repository specific configuration file. (The filename is |
147 | of course relative to the repository root, not the working | |
148 | directory.) | |
149 | ||
150 | ~/.gitconfig:: | |
151 | User-specific configuration file. Also called "global" | |
152 | configuration file. | |
153 | ||
154 | $(prefix)/etc/gitconfig:: | |
155 | System-wide configuration file. | |
156 | ||
157 | If no further options are given, all reading options will read all of these | |
158 | files that are available. If the global or the system-wide configuration | |
159 | file are not available they will be ignored. If the repository configuration | |
160 | file is not available or readable, git-config will exit with a non-zero | |
161 | error code. However, in neither case will an error message be issued. | |
162 | ||
163 | All writing options will per default write to the repository specific | |
164 | configuration file. Note that this also affects options like '--replace-all' | |
165 | and '--unset'. *git-config will only ever change one file at a time*. | |
166 | ||
167 | You can override these rules either by command line options or by environment | |
168 | variables. The '--global' and the '--system' options will limit the file used | |
169 | to the global or system-wide file respectively. The GIT_CONFIG environment | |
170 | variable has a similar effect, but you can specify any filename you want. | |
171 | ||
172 | The GIT_CONFIG_LOCAL environment variable on the other hand only changes | |
173 | the name used instead of the repository configuration file. The global and | |
174 | the system-wide configuration files will still be read. (For writing options | |
175 | this will obviously result in the same behavior as using GIT_CONFIG.) | |
176 | ||
177 | ||
e0d10e1c TP |
178 | ENVIRONMENT |
179 | ----------- | |
180 | ||
181 | GIT_CONFIG:: | |
182 | Take the configuration from the given file instead of .git/config. | |
17014090 FL |
183 | Using the "--global" option forces this to ~/.gitconfig. Using the |
184 | "--system" option forces this to $(prefix)/etc/gitconfig. | |
e0d10e1c TP |
185 | |
186 | GIT_CONFIG_LOCAL:: | |
17014090 FL |
187 | Take the configuration from the given file instead if .git/config. |
188 | Still read the global and the system-wide configuration files, though. | |
e0d10e1c | 189 | |
17014090 | 190 | See also <<FILES>>. |
e0d10e1c | 191 | |
90a36e58 FL |
192 | |
193 | [[EXAMPLES]] | |
194 | EXAMPLES | |
195 | -------- | |
e0d10e1c TP |
196 | |
197 | Given a .git/config like this: | |
198 | ||
199 | # | |
200 | # This is the config file, and | |
201 | # a '#' or ';' character indicates | |
202 | # a comment | |
203 | # | |
204 | ||
205 | ; core variables | |
206 | [core] | |
207 | ; Don't trust file modes | |
208 | filemode = false | |
209 | ||
210 | ; Our diff algorithm | |
211 | [diff] | |
212 | external = "/usr/local/bin/gnu-diff -u" | |
213 | renames = true | |
214 | ||
215 | ; Proxy settings | |
216 | [core] | |
e0d10e1c | 217 | gitproxy="proxy-command" for kernel.org |
e0d10e1c TP |
218 | gitproxy=default-proxy ; for all the rest |
219 | ||
220 | you can set the filemode to true with | |
221 | ||
222 | ------------ | |
223 | % git config core.filemode true | |
224 | ------------ | |
225 | ||
226 | The hypothetical proxy command entries actually have a postfix to discern | |
227 | what URL they apply to. Here is how to change the entry for kernel.org | |
228 | to "ssh". | |
229 | ||
230 | ------------ | |
231 | % git config core.gitproxy '"ssh" for kernel.org' 'for kernel.org$' | |
232 | ------------ | |
233 | ||
234 | This makes sure that only the key/value pair for kernel.org is replaced. | |
235 | ||
236 | To delete the entry for renames, do | |
237 | ||
238 | ------------ | |
239 | % git config --unset diff.renames | |
240 | ------------ | |
241 | ||
242 | If you want to delete an entry for a multivar (like core.gitproxy above), | |
243 | you have to provide a regex matching the value of exactly one line. | |
244 | ||
245 | To query the value for a given key, do | |
246 | ||
247 | ------------ | |
248 | % git config --get core.filemode | |
249 | ------------ | |
250 | ||
251 | or | |
252 | ||
253 | ------------ | |
254 | % git config core.filemode | |
255 | ------------ | |
256 | ||
257 | or, to query a multivar: | |
258 | ||
259 | ------------ | |
260 | % git config --get core.gitproxy "for kernel.org$" | |
261 | ------------ | |
262 | ||
263 | If you want to know all the values for a multivar, do: | |
264 | ||
265 | ------------ | |
266 | % git config --get-all core.gitproxy | |
267 | ------------ | |
268 | ||
269 | If you like to live dangerous, you can replace *all* core.gitproxy by a | |
270 | new one with | |
271 | ||
272 | ------------ | |
273 | % git config --replace-all core.gitproxy ssh | |
274 | ------------ | |
275 | ||
276 | However, if you really only want to replace the line for the default proxy, | |
277 | i.e. the one without a "for ..." postfix, do something like this: | |
278 | ||
279 | ------------ | |
280 | % git config core.gitproxy ssh '! for ' | |
281 | ------------ | |
282 | ||
283 | To actually match only values with an exclamation mark, you have to | |
284 | ||
285 | ------------ | |
286 | % git config section.key value '[!]' | |
287 | ------------ | |
288 | ||
289 | To add a new proxy, without altering any of the existing ones, use | |
290 | ||
291 | ------------ | |
29093c28 | 292 | % git config core.gitproxy '"proxy-command" for example.com' |
e0d10e1c TP |
293 | ------------ |
294 | ||
295 | ||
296 | include::config.txt[] | |
297 | ||
298 | ||
299 | Author | |
300 | ------ | |
301 | Written by Johannes Schindelin <Johannes.Schindelin@gmx.de> | |
302 | ||
303 | Documentation | |
304 | -------------- | |
305 | Documentation by Johannes Schindelin, Petr Baudis and the git-list <git@vger.kernel.org>. | |
306 | ||
307 | GIT | |
308 | --- | |
309 | Part of the gitlink:git[7] suite |