Documentation/git-repo-config.txt

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