Code

Merge branch 'ns/pretty-format'
[git.git] / Documentation / git-config.txt
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', which will 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).  If no type specifier is passed,
44 no checks or transformations are performed on the value.
46 The file-option can be one of '--system', '--global' or '--file'
47 which specify where the values will be read from or written to.
48 The 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>>).
52 This command will fail if:
54 . The config file is invalid,
55 . Can not write to the config file,
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
60 . you use '--global' option without $HOME being properly set.
63 OPTIONS
64 -------
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).
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.
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.
79 --get-all::
80         Like get, but does not fail if the number of values for the key
81         is not exactly one.
83 --get-regexp::
84         Like --get-all, but interprets the name as a regular expression.
85         Also outputs the key names.
87 --global::
88         For writing options: write to global ~/.gitconfig file rather than
89         the repository .git/config.
90 +
91 For reading options: read only from global ~/.gitconfig rather than
92 from all available files.
93 +
94 See also <<FILES>>.
96 --system::
97         For writing options: write to system-wide $(prefix)/etc/gitconfig
98         rather than the repository .git/config.
99 +
100 For reading options: read only from system-wide $(prefix)/etc/gitconfig
101 rather than from all available files.
103 See also <<FILES>>.
105 -f config-file::
106 --file config-file::
107         Use the given config file instead of the one specified by GIT_CONFIG.
109 --remove-section::
110         Remove the given section from the configuration file.
112 --rename-section::
113         Rename the given section to a new name.
115 --unset::
116         Remove the line matching the key from config file.
118 --unset-all::
119         Remove all lines matching the key from config file.
121 -l::
122 --list::
123         List all variables set in config file.
125 --bool::
126         'git-config' will ensure that the output is "true" or "false"
128 --int::
129         'git-config' will ensure that the output is a simple
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.
134 -z::
135 --null::
136         For all options that output values and/or keys, always
137         end values with the null character (instead of a
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.
143 --get-colorbool name [stdout-is-tty]::
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.
151         When the color setting for `name` is undefined, the command uses
152         `color.ui` as fallback.
154 --get-color name default::
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`.
161 -e::
162 --edit::
163         Opens an editor to modify the specified config file; either
164         '--system', '--global', or repository (default).
166 [[FILES]]
167 FILES
168 -----
170 If not set explicitly with '--file', there are three files where
171 'git-config' will search for configuration options:
173 $GIT_DIR/config::
174         Repository specific configuration file. (The filename is
175         of course relative to the repository root, not the working
176         directory.)
178 ~/.gitconfig::
179         User-specific configuration file. Also called "global"
180         configuration file.
182 $(prefix)/etc/gitconfig::
183         System-wide configuration file.
185 If no further options are given, all reading options will read all of these
186 files that are available. If the global or the system-wide configuration
187 file are not available they will be ignored. If the repository configuration
188 file is not available or readable, 'git-config' will exit with a non-zero
189 error code. However, in neither case will an error message be issued.
191 All writing options will per default write to the repository specific
192 configuration file. Note that this also affects options like '--replace-all'
193 and '--unset'. *'git-config' will only ever change one file at a time*.
195 You can override these rules either by command line options or by environment
196 variables. The '--global' and the '--system' options will limit the file used
197 to the global or system-wide file respectively. The GIT_CONFIG environment
198 variable has a similar effect, but you can specify any filename you want.
201 ENVIRONMENT
202 -----------
204 GIT_CONFIG::
205         Take the configuration from the given file instead of .git/config.
206         Using the "--global" option forces this to ~/.gitconfig. Using the
207         "--system" option forces this to $(prefix)/etc/gitconfig.
209 See also <<FILES>>.
212 [[EXAMPLES]]
213 EXAMPLES
214 --------
216 Given a .git/config like this:
218         #
219         # This is the config file, and
220         # a '#' or ';' character indicates
221         # a comment
222         #
224         ; core variables
225         [core]
226                 ; Don't trust file modes
227                 filemode = false
229         ; Our diff algorithm
230         [diff]
231                 external = /usr/local/bin/diff-wrapper
232                 renames = true
234         ; Proxy settings
235         [core]
236                 gitproxy="proxy-command" for kernel.org
237                 gitproxy=default-proxy ; for all the rest
239 you can set the filemode to true with
241 ------------
242 % git config core.filemode true
243 ------------
245 The hypothetical proxy command entries actually have a postfix to discern
246 what URL they apply to. Here is how to change the entry for kernel.org
247 to "ssh".
249 ------------
250 % git config core.gitproxy '"ssh" for kernel.org' 'for kernel.org$'
251 ------------
253 This makes sure that only the key/value pair for kernel.org is replaced.
255 To delete the entry for renames, do
257 ------------
258 % git config --unset diff.renames
259 ------------
261 If you want to delete an entry for a multivar (like core.gitproxy above),
262 you have to provide a regex matching the value of exactly one line.
264 To query the value for a given key, do
266 ------------
267 % git config --get core.filemode
268 ------------
270 or
272 ------------
273 % git config core.filemode
274 ------------
276 or, to query a multivar:
278 ------------
279 % git config --get core.gitproxy "for kernel.org$"
280 ------------
282 If you want to know all the values for a multivar, do:
284 ------------
285 % git config --get-all core.gitproxy
286 ------------
288 If you like to live dangerously, you can replace *all* core.gitproxy by a
289 new one with
291 ------------
292 % git config --replace-all core.gitproxy ssh
293 ------------
295 However, if you really only want to replace the line for the default proxy,
296 i.e. the one without a "for ..." postfix, do something like this:
298 ------------
299 % git config core.gitproxy ssh '! for '
300 ------------
302 To actually match only values with an exclamation mark, you have to
304 ------------
305 % git config section.key value '[!]'
306 ------------
308 To add a new proxy, without altering any of the existing ones, use
310 ------------
311 % git config core.gitproxy '"proxy-command" for example.com'
312 ------------
314 An example to use customized color from the configuration in your
315 script:
317 ------------
318 #!/bin/sh
319 WS=$(git config --get-color color.diff.whitespace "blue reverse")
320 RESET=$(git config --get-color "" "reset")
321 echo "${WS}your whitespace color or blue reverse${RESET}"
322 ------------
324 include::config.txt[]
327 Author
328 ------
329 Written by Johannes Schindelin <Johannes.Schindelin@gmx.de>
331 Documentation
332 --------------
333 Documentation by Johannes Schindelin, Petr Baudis and the git-list <git@vger.kernel.org>.
335 GIT
336 ---
337 Part of the linkgit:git[1] suite