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