Merge branch 'pb/config'
[git/git.git] / Documentation / git-repo-config.txt
CommitLineData
ee72aeaf
JS
1git-repo-config(1)
2==================
2d2465c0
JS
3
4NAME
5----
7bd7f280 6git-repo-config - Get and set options in .git/config
2d2465c0
JS
7
8
9SYNOPSIS
10--------
c7569b1e 11[verse]
7162dff3
PB
12'git-repo-config' [type] name [value [value_regex]]
13'git-repo-config' [type] --replace-all name [value [value_regex]]
14'git-repo-config' [type] --get name [value_regex]
15'git-repo-config' [type] --get-all name [value_regex]
16'git-repo-config' [type] --unset name [value_regex]
17'git-repo-config' [type] --unset-all name [value_regex]
de791f15 18'git-repo-config' -l | --list
2d2465c0
JS
19
20DESCRIPTION
21-----------
4ddba79d
JS
22You can query/set/replace/unset options with this command. The name is
23actually the section and the key separated by a dot, and the value will be
24escaped.
2d2465c0 25
6fe31e2e
JH
26If you want to set/unset an option which can occur on multiple
27lines, a POSIX regexp `value_regex` needs to be given. Only the
28existing values that match the regexp are updated or unset. If
29you want to handle the lines that do *not* match the regex, just
30prepend a single exclamation mark in front (see EXAMPLES).
2d2465c0 31
7162dff3
PB
32The type specifier can be either '--int' or '--bool', which will make
33'git-repo-config' ensure that the variable(s) are of the given type and
34convert the value to the canonical form (simple decimal number for int,
35a "true" or "false" string for bool). If no type specifier is passed,
36no checks or transformations are performed on the value.
37
2b5f3ed3 38This command will fail if:
2d2465c0 39
2b5f3ed3
SE
40. The .git/config file is invalid,
41. Can not write to .git/config,
2d2465c0
JS
42. no section was provided,
43. the section or key is invalid,
44. you try to unset an option which does not exist, or
45. you try to unset/set an option for which multiple lines match.
46
47
48OPTIONS
49-------
50
4ddba79d 51--replace-all::
abda1ef5 52 Default behavior is to replace at most one line. This replaces
2fa9a0fb 53 all lines matching the key (and optionally the value_regex).
4ddba79d
JS
54
55--get::
56 Get the value for a given key (optionally filtered by a regex
57 matching the value).
58
59--get-all::
60 Like get, but does not fail if the number of values for the key
61 is not exactly one.
62
2fa9a0fb
JS
63--get-regexp::
64 Like --get-all, but interprets the name as a regular expression.
65
2d2465c0 66--unset::
4ddba79d
JS
67 Remove the line matching the key from .git/config.
68
69--unset-all::
70 Remove all matching lines from .git/config.
2d2465c0 71
de791f15
PB
72-l, --list::
73 List all variables set in .git/config.
74
2d2465c0 75
7f29f7a9
PB
76ENVIRONMENT
77-----------
78
79GIT_CONFIG::
80 Take the configuration from the given file instead of .git/config.
81
82GIT_CONFIG_LOCAL::
83 Currently the same as $GIT_CONFIG; when Git will support global
84 configuration files, this will cause it to take the configuration
85 from the global configuration file in addition to the given file.
86
87
2d2465c0
JS
88EXAMPLE
89-------
90
91Given a .git/config like this:
92
93 #
94 # This is the config file, and
95 # a '#' or ';' character indicates
96 # a comment
97 #
98
99 ; core variables
100 [core]
101 ; Don't trust file modes
102 filemode = false
103
104 ; Our diff algorithm
105 [diff]
106 external = "/usr/local/bin/gnu-diff -u"
107 renames = true
108
109 ; Proxy settings
1ab661dd
PB
110 [core]
111 gitproxy="ssh" for "ssh://kernel.org/"
112 gitproxy="proxy-command" for kernel.org
113 gitproxy="myprotocol-command" for "my://"
114 gitproxy=default-proxy ; for all the rest
2d2465c0
JS
115
116you can set the filemode to true with
117
118------------
ee72aeaf 119% git repo-config core.filemode true
2d2465c0
JS
120------------
121
122The hypothetic proxy command entries actually have a postfix to discern
123to what URL they apply. Here is how to change the entry for kernel.org
124to "ssh".
125
126------------
1ab661dd 127% git repo-config core.gitproxy '"ssh" for kernel.org' 'for kernel.org$'
2d2465c0
JS
128------------
129
130This makes sure that only the key/value pair for kernel.org is replaced.
131
132To delete the entry for renames, do
133
134------------
ee72aeaf 135% git repo-config --unset diff.renames
2d2465c0
JS
136------------
137
1ab661dd 138If you want to delete an entry for a multivar (like core.gitproxy above),
4ddba79d
JS
139you have to provide a regex matching the value of exactly one line.
140
141To query the value for a given key, do
2d2465c0
JS
142
143------------
ee72aeaf 144% git repo-config --get core.filemode
2d2465c0
JS
145------------
146
4ddba79d
JS
147or
148
149------------
ee72aeaf 150% git repo-config core.filemode
4ddba79d
JS
151------------
152
153or, to query a multivar:
154
155------------
1ab661dd 156% git repo-config --get core.gitproxy "for kernel.org$"
4ddba79d
JS
157------------
158
159If you want to know all the values for a multivar, do:
160
161------------
1ab661dd 162% git repo-config --get-all core.gitproxy
4ddba79d
JS
163------------
164
1ab661dd 165If you like to live dangerous, you can replace *all* core.gitproxy by a
4ddba79d
JS
166new one with
167
168------------
1ab661dd 169% git repo-config --replace-all core.gitproxy ssh
4ddba79d 170------------
2d2465c0 171
f98d863d
JS
172However, if you really only want to replace the line for the default proxy,
173i.e. the one without a "for ..." postfix, do something like this:
174
175------------
1ab661dd 176% git repo-config core.gitproxy ssh '! for '
f98d863d
JS
177------------
178
179To actually match only values with an exclamation mark, you have to
180
181------------
ee72aeaf 182% git repo-config section.key value '[!]'
f98d863d
JS
183------------
184
2d2465c0 185
1ab661dd
PB
186include::config.txt[]
187
188
2d2465c0
JS
189Author
190------
191Written by Johannes Schindelin <Johannes.Schindelin@gmx.de>
192
193Documentation
194--------------
1ab661dd 195Documentation by Johannes Schindelin, Petr Baudis and the git-list <git@vger.kernel.org>.
2d2465c0
JS
196
197GIT
198---
199Part of the gitlink:git[7] suite
200