gitweb: Make project description in projects list link to summary view
[git/dscho.git] / Documentation / git-repo-config.txt
blob8199615dde6630124c155bb4a296603dc8829c83
1 git-repo-config(1)
2 ==================
4 NAME
5 ----
6 git-repo-config - Get and set repository or global options.
9 SYNOPSIS
10 --------
11 [verse]
12 'git-repo-config' [--global] [type] name [value [value_regex]]
13 'git-repo-config' [--global] [type] --replace-all name [value [value_regex]]
14 'git-repo-config' [--global] [type] --get name [value_regex]
15 'git-repo-config' [--global] [type] --get-all name [value_regex]
16 'git-repo-config' [--global] [type] --unset name [value_regex]
17 'git-repo-config' [--global] [type] --unset-all name [value_regex]
18 'git-repo-config' [--global] -l | --list
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.
26 If you want to set/unset an option which can occur on multiple
27 lines, a POSIX regexp `value_regex` needs to be given.  Only the
28 existing values that match the regexp are updated or unset.  If
29 you want to handle the lines that do *not* match the regex, just
30 prepend a single exclamation mark in front (see EXAMPLES).
32 The 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
34 convert the value to the canonical form (simple decimal number for int,
35 a "true" or "false" string for bool). If no type specifier is passed,
36 no checks or transformations are performed on the value.
38 This command will fail if:
40 . The .git/config file is invalid,
41 . Can not write to .git/config,
42 . no section was provided,
43 . the section or key is invalid,
44 . you try to unset an option which does not exist,
45 . you try to unset/set an option for which multiple lines match, or
46 . you use --global option without $HOME being properly set.
49 OPTIONS
50 -------
52 --replace-all::
53         Default behavior is to replace at most one line. This replaces
54         all lines matching the key (and optionally the value_regex).
56 --get::
57         Get the value for a given key (optionally filtered by a regex
58         matching the value). Returns error code 1 if the key was not
59         found and error code 2 if multiple key values were found.
61 --get-all::
62         Like get, but does not fail if the number of values for the key
63         is not exactly one.
65 --get-regexp::
66         Like --get-all, but interprets the name as a regular expression.
68 --global::
69         Use global ~/.gitconfig file rather than the repository .git/config.
71 --unset::
72         Remove the line matching the key from config file.
74 --unset-all::
75         Remove all matching lines from config file.
77 -l, --list::
78         List all variables set in config file.
81 ENVIRONMENT
82 -----------
84 GIT_CONFIG::
85         Take the configuration from the given file instead of .git/config.
86         Using the "--global" option forces this to ~/.gitconfig.
88 GIT_CONFIG_LOCAL::
89         Currently the same as $GIT_CONFIG; when Git will support global
90         configuration files, this will cause it to take the configuration
91         from the global configuration file in addition to the given file.
94 EXAMPLE
95 -------
97 Given a .git/config like this:
99         #
100         # This is the config file, and
101         # a '#' or ';' character indicates
102         # a comment
103         #
105         ; core variables
106         [core]
107                 ; Don't trust file modes
108                 filemode = false
110         ; Our diff algorithm
111         [diff]
112                 external = "/usr/local/bin/gnu-diff -u"
113                 renames = true
115         ; Proxy settings
116         [core]
117                 gitproxy="ssh" for "ssh://kernel.org/"
118                 gitproxy="proxy-command" for kernel.org
119                 gitproxy="myprotocol-command" for "my://"
120                 gitproxy=default-proxy ; for all the rest
122 you can set the filemode to true with
124 ------------
125 % git repo-config core.filemode true
126 ------------
128 The hypothetical proxy command entries actually have a postfix to discern
129 what URL they apply to. Here is how to change the entry for kernel.org
130 to "ssh".
132 ------------
133 % git repo-config core.gitproxy '"ssh" for kernel.org' 'for kernel.org$'
134 ------------
136 This makes sure that only the key/value pair for kernel.org is replaced.
138 To delete the entry for renames, do
140 ------------
141 % git repo-config --unset diff.renames
142 ------------
144 If you want to delete an entry for a multivar (like core.gitproxy above),
145 you have to provide a regex matching the value of exactly one line.
147 To query the value for a given key, do
149 ------------
150 % git repo-config --get core.filemode
151 ------------
155 ------------
156 % git repo-config core.filemode
157 ------------
159 or, to query a multivar:
161 ------------
162 % git repo-config --get core.gitproxy "for kernel.org$"
163 ------------
165 If you want to know all the values for a multivar, do:
167 ------------
168 % git repo-config --get-all core.gitproxy
169 ------------
171 If you like to live dangerous, you can replace *all* core.gitproxy by a
172 new one with
174 ------------
175 % git repo-config --replace-all core.gitproxy ssh
176 ------------
178 However, if you really only want to replace the line for the default proxy,
179 i.e. the one without a "for ..." postfix, do something like this:
181 ------------
182 % git repo-config core.gitproxy ssh '! for '
183 ------------
185 To actually match only values with an exclamation mark, you have to
187 ------------
188 % git repo-config section.key value '[!]'
189 ------------
192 include::config.txt[]
195 Author
196 ------
197 Written by Johannes Schindelin <Johannes.Schindelin@gmx.de>
199 Documentation
200 --------------
201 Documentation by Johannes Schindelin, Petr Baudis and the git-list <git@vger.kernel.org>.
205 Part of the gitlink:git[7] suite