Add an option to specify a file to config builtin
[git/git.git] / Documentation / git-config.txt
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]
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
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
35 prepend a single exclamation mark in front (see also <<EXAMPLES>>).
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,
40 a "true" or "false" string for bool). If no type specifier is passed,
41 no checks or transformations are performed on the value.
42
43 This command will fail if:
44
45 . The config file is invalid,
46 . Can not write to the config file,
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
51 . you use '--global' option without $HOME being properly set.
52
53
54 OPTIONS
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.
76 Also outputs the key names.
77
78 --global::
79 For writing options: write to global ~/.gitconfig file rather than
80 the repository .git/config.
81 +
82 For reading options: read only from global ~/.gitconfig rather than
83 from all available files.
84 +
85 See also <<FILES>>.
86
87 --system::
88 For writing options: write to system-wide $(prefix)/etc/gitconfig
89 rather than the repository .git/config.
90 +
91 For reading options: read only from system-wide $(prefix)/etc/gitconfig
92 rather than from all available files.
93 +
94 See also <<FILES>>.
95
96 -f config-file, --file config-file::
97 Use the given config file instead of the one specified by GIT_CONFIG.
98
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
105 --unset::
106 Remove the line matching the key from config file.
107
108 --unset-all::
109 Remove all lines matching the key from config file.
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
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
131
132 [[FILES]]
133 FILES
134 -----
135
136 There are three files where git-config will search for configuration
137 options:
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
151 If no further options are given, all reading options will read all of these
152 files that are available. If the global or the system-wide configuration
153 file are not available they will be ignored. If the repository configuration
154 file is not available or readable, git-config will exit with a non-zero
155 error code. However, in neither case will an error message be issued.
156
157 All writing options will per default write to the repository specific
158 configuration file. Note that this also affects options like '--replace-all'
159 and '--unset'. *git-config will only ever change one file at a time*.
160
161 You can override these rules either by command line options or by environment
162 variables. The '--global' and the '--system' options will limit the file used
163 to the global or system-wide file respectively. The GIT_CONFIG environment
164 variable has a similar effect, but you can specify any filename you want.
165
166 The GIT_CONFIG_LOCAL environment variable on the other hand only changes
167 the name used instead of the repository configuration file. The global and
168 the system-wide configuration files will still be read. (For writing options
169 this will obviously result in the same behavior as using GIT_CONFIG.)
170
171
172 ENVIRONMENT
173 -----------
174
175 GIT_CONFIG::
176 Take the configuration from the given file instead of .git/config.
177 Using the "--global" option forces this to ~/.gitconfig. Using the
178 "--system" option forces this to $(prefix)/etc/gitconfig.
179
180 GIT_CONFIG_LOCAL::
181 Take the configuration from the given file instead if .git/config.
182 Still read the global and the system-wide configuration files, though.
183
184 See also <<FILES>>.
185
186
187 [[EXAMPLES]]
188 EXAMPLES
189 --------
190
191 Given 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
216 you can set the filemode to true with
217
218 ------------
219 % git config core.filemode true
220 ------------
221
222 The hypothetical proxy command entries actually have a postfix to discern
223 what URL they apply to. Here is how to change the entry for kernel.org
224 to "ssh".
225
226 ------------
227 % git config core.gitproxy '"ssh" for kernel.org' 'for kernel.org$'
228 ------------
229
230 This makes sure that only the key/value pair for kernel.org is replaced.
231
232 To delete the entry for renames, do
233
234 ------------
235 % git config --unset diff.renames
236 ------------
237
238 If you want to delete an entry for a multivar (like core.gitproxy above),
239 you have to provide a regex matching the value of exactly one line.
240
241 To query the value for a given key, do
242
243 ------------
244 % git config --get core.filemode
245 ------------
246
247 or
248
249 ------------
250 % git config core.filemode
251 ------------
252
253 or, to query a multivar:
254
255 ------------
256 % git config --get core.gitproxy "for kernel.org$"
257 ------------
258
259 If you want to know all the values for a multivar, do:
260
261 ------------
262 % git config --get-all core.gitproxy
263 ------------
264
265 If you like to live dangerous, you can replace *all* core.gitproxy by a
266 new one with
267
268 ------------
269 % git config --replace-all core.gitproxy ssh
270 ------------
271
272 However, if you really only want to replace the line for the default proxy,
273 i.e. the one without a "for ..." postfix, do something like this:
274
275 ------------
276 % git config core.gitproxy ssh '! for '
277 ------------
278
279 To actually match only values with an exclamation mark, you have to
280
281 ------------
282 % git config section.key value '[!]'
283 ------------
284
285 To 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
292 include::config.txt[]
293
294
295 Author
296 ------
297 Written by Johannes Schindelin <Johannes.Schindelin@gmx.de>
298
299 Documentation
300 --------------
301 Documentation by Johannes Schindelin, Petr Baudis and the git-list <git@vger.kernel.org>.
302
303 GIT
304 ---
305 Part of the gitlink:git[7] suite