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