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