Win32: move environment functions
[git/dscho.git] / Documentation / git-config.txt
blobd9463cb3874181456138d4ca54da4e3540bbeb4f
1 git-config(1)
2 =============
4 NAME
5 ----
6 git-config - Get and set repository or global options
9 SYNOPSIS
10 --------
11 [verse]
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]
25 'git config' [<file-option>] -e | --edit
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.
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
38 prepend a single exclamation mark in front (see also <<EXAMPLES>>).
40 The type specifier can be either '--int' or '--bool', to make
41 'git config' ensure that the variable(s) are of the given type and
42 convert the value to the canonical form (simple decimal number for int,
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.
47 When reading, the values are read from the system, global and
48 repository local configuration files by default, and options
49 '--system', '--global', '--local' and '--file <filename>' can be
50 used to tell the command to read from only that location (see <<FILES>>).
52 When writing, the new value is written to the repository local
53 configuration file by default, and options '--system', '--global',
54 '--file <filename>' can be used to tell the command to write to
55 that location (you can say '--local' but that is the default).
57 This command will fail (with exit code ret) if:
59 . The config file is invalid (ret=3),
60 . can not write to the config file (ret=4),
61 . no section or name was provided (ret=2),
62 . the section or key is invalid (ret=1),
63 . you try to unset an option which does not exist (ret=5),
64 . you try to unset/set an option for which multiple lines match (ret=5),
65 . you try to use an invalid regexp (ret=6), or
66 . you use '--global' option without $HOME being properly set (ret=128).
68 On success, the command returns the exit code 0.
70 OPTIONS
71 -------
73 --replace-all::
74         Default behavior is to replace at most one line. This replaces
75         all lines matching the key (and optionally the value_regex).
77 --add::
78         Adds a new line to the option without altering any existing
79         values.  This is the same as providing '^$' as the value_regex
80         in `--replace-all`.
82 --get::
83         Get the value for a given key (optionally filtered by a regex
84         matching the value). Returns error code 1 if the key was not
85         found and error code 2 if multiple key values were found.
87 --get-all::
88         Like get, but does not fail if the number of values for the key
89         is not exactly one.
91 --get-regexp::
92         Like --get-all, but interprets the name as a regular expression and
93         writes out the key names.  Regular expression matching is currently
94         case-sensitive and done against a canonicalized version of the key
95         in which section and variable names are lowercased, but subsection
96         names are not.
98 --global::
99         For writing options: write to global ~/.gitconfig file rather than
100         the repository .git/config.
102 For reading options: read only from global ~/.gitconfig rather than
103 from all available files.
105 See also <<FILES>>.
107 --system::
108         For writing options: write to system-wide $(prefix)/etc/gitconfig
109         rather than the repository .git/config.
111 For reading options: read only from system-wide $(prefix)/etc/gitconfig
112 rather than from all available files.
114 See also <<FILES>>.
116 -f config-file::
117 --file config-file::
118         Use the given config file instead of the one specified by GIT_CONFIG.
120 --remove-section::
121         Remove the given section from the configuration file.
123 --rename-section::
124         Rename the given section to a new name.
126 --unset::
127         Remove the line matching the key from config file.
129 --unset-all::
130         Remove all lines matching the key from config file.
132 -l::
133 --list::
134         List all variables set in config file.
136 --bool::
137         'git config' will ensure that the output is "true" or "false"
139 --int::
140         'git config' will ensure that the output is a simple
141         decimal number.  An optional value suffix of 'k', 'm', or 'g'
142         in the config file will cause the value to be multiplied
143         by 1024, 1048576, or 1073741824 prior to output.
145 --bool-or-int::
146         'git config' will ensure that the output matches the format of
147         either --bool or --int, as described above.
149 --path::
150         'git-config' will expand leading '{tilde}' to the value of
151         '$HOME', and '{tilde}user' to the home directory for the
152         specified user.  This option has no effect when setting the
153         value (but you can use 'git config bla {tilde}/' from the
154         command line to let your shell do the expansion).
156 -z::
157 --null::
158         For all options that output values and/or keys, always
159         end values with the null character (instead of a
160         newline). Use newline instead as a delimiter between
161         key and value. This allows for secure parsing of the
162         output without getting confused e.g. by values that
163         contain line breaks.
165 --get-colorbool name [stdout-is-tty]::
167         Find the color setting for `name` (e.g. `color.diff`) and output
168         "true" or "false".  `stdout-is-tty` should be either "true" or
169         "false", and is taken into account when configuration says
170         "auto".  If `stdout-is-tty` is missing, then checks the standard
171         output of the command itself, and exits with status 0 if color
172         is to be used, or exits with status 1 otherwise.
173         When the color setting for `name` is undefined, the command uses
174         `color.ui` as fallback.
176 --get-color name [default]::
178         Find the color configured for `name` (e.g. `color.diff.new`) and
179         output it as the ANSI color escape sequence to the standard
180         output.  The optional `default` parameter is used instead, if
181         there is no color configured for `name`.
183 -e::
184 --edit::
185         Opens an editor to modify the specified config file; either
186         '--system', '--global', or repository (default).
188 --includes::
189 --no-includes::
190         Respect `include.*` directives in config files when looking up
191         values. Defaults to on.
193 [[FILES]]
194 FILES
195 -----
197 If not set explicitly with '--file', there are three files where
198 'git config' will search for configuration options:
200 $GIT_DIR/config::
201         Repository specific configuration file.
203 ~/.gitconfig::
204         User-specific configuration file. Also called "global"
205         configuration file.
207 $(prefix)/etc/gitconfig::
208         System-wide configuration file.
210 If no further options are given, all reading options will read all of these
211 files that are available. If the global or the system-wide configuration
212 file are not available they will be ignored. If the repository configuration
213 file is not available or readable, 'git config' will exit with a non-zero
214 error code. However, in neither case will an error message be issued.
216 All writing options will per default write to the repository specific
217 configuration file. Note that this also affects options like '--replace-all'
218 and '--unset'. *'git config' will only ever change one file at a time*.
220 You can override these rules either by command line options or by environment
221 variables. The '--global' and the '--system' options will limit the file used
222 to the global or system-wide file respectively. The GIT_CONFIG environment
223 variable has a similar effect, but you can specify any filename you want.
226 ENVIRONMENT
227 -----------
229 GIT_CONFIG::
230         Take the configuration from the given file instead of .git/config.
231         Using the "--global" option forces this to ~/.gitconfig. Using the
232         "--system" option forces this to $(prefix)/etc/gitconfig.
234 See also <<FILES>>.
237 [[EXAMPLES]]
238 EXAMPLES
239 --------
241 Given a .git/config like this:
243         #
244         # This is the config file, and
245         # a '#' or ';' character indicates
246         # a comment
247         #
249         ; core variables
250         [core]
251                 ; Don't trust file modes
252                 filemode = false
254         ; Our diff algorithm
255         [diff]
256                 external = /usr/local/bin/diff-wrapper
257                 renames = true
259         ; Proxy settings
260         [core]
261                 gitproxy="proxy-command" for kernel.org
262                 gitproxy=default-proxy ; for all the rest
264 you can set the filemode to true with
266 ------------
267 % git config core.filemode true
268 ------------
270 The hypothetical proxy command entries actually have a postfix to discern
271 what URL they apply to. Here is how to change the entry for kernel.org
272 to "ssh".
274 ------------
275 % git config core.gitproxy '"ssh" for kernel.org' 'for kernel.org$'
276 ------------
278 This makes sure that only the key/value pair for kernel.org is replaced.
280 To delete the entry for renames, do
282 ------------
283 % git config --unset diff.renames
284 ------------
286 If you want to delete an entry for a multivar (like core.gitproxy above),
287 you have to provide a regex matching the value of exactly one line.
289 To query the value for a given key, do
291 ------------
292 % git config --get core.filemode
293 ------------
297 ------------
298 % git config core.filemode
299 ------------
301 or, to query a multivar:
303 ------------
304 % git config --get core.gitproxy "for kernel.org$"
305 ------------
307 If you want to know all the values for a multivar, do:
309 ------------
310 % git config --get-all core.gitproxy
311 ------------
313 If you like to live dangerously, you can replace *all* core.gitproxy by a
314 new one with
316 ------------
317 % git config --replace-all core.gitproxy ssh
318 ------------
320 However, if you really only want to replace the line for the default proxy,
321 i.e. the one without a "for ..." postfix, do something like this:
323 ------------
324 % git config core.gitproxy ssh '! for '
325 ------------
327 To actually match only values with an exclamation mark, you have to
329 ------------
330 % git config section.key value '[!]'
331 ------------
333 To add a new proxy, without altering any of the existing ones, use
335 ------------
336 % git config core.gitproxy '"proxy-command" for example.com'
337 ------------
339 An example to use customized color from the configuration in your
340 script:
342 ------------
343 #!/bin/sh
344 WS=$(git config --get-color color.diff.whitespace "blue reverse")
345 RESET=$(git config --get-color "" "reset")
346 echo "${WS}your whitespace color or blue reverse${RESET}"
347 ------------
349 include::config.txt[]
353 Part of the linkgit:git[1] suite