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
  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).
  31
  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.
  37
  38 This command will fail if:
  39
  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, or
  45 . you try to unset/set an option for which multiple lines match.
  46
  47
  48 OPTIONS
  49 -------
  50
  51 --replace-all::
  52         Default behavior is to replace at most one line. This replaces
  53         all lines matching the key (and optionally the value_regex).
  54
  55 --get::
  56         Get the value for a given key (optionally filtered by a regex
  57         matching the value). Returns error code 1 if the key was not
  58         found and error code 2 if multiple key values were found.
  59
  60 --get-all::
  61         Like get, but does not fail if the number of values for the key
  62         is not exactly one.
  63
  64 --get-regexp::
  65         Like --get-all, but interprets the name as a regular expression.
  66
  67 --unset::
  68         Remove the line matching the key from .git/config.
  69
  70 --unset-all::
  71         Remove all matching lines from .git/config.
  72
  73 -l, --list::
  74         List all variables set in .git/config.
  75
  76
  77 ENVIRONMENT
  78 -----------
  79
  80 GIT_CONFIG::
  81         Take the configuration from the given file instead of .git/config.
  82
  83 GIT_CONFIG_LOCAL::
  84         Currently the same as $GIT_CONFIG; when Git will support global
  85         configuration files, this will cause it to take the configuration
  86         from the global configuration file in addition to the given file.
  87
  88
  89 EXAMPLE
  90 -------
  91
  92 Given a .git/config like this:
  93
  94         #
  95         # This is the config file, and
  96         # a '#' or ';' character indicates
  97         # a comment
  98         #
  99
 100         ; core variables
 101         [core]
 102                 ; Don't trust file modes
 103                 filemode = false
 104
 105         ; Our diff algorithm
 106         [diff]
 107                 external = "/usr/local/bin/gnu-diff -u"
 108                 renames = true
 109
 110         ; Proxy settings
 111         [core]
 112                 gitproxy="ssh" for "ssh://kernel.org/"
 113                 gitproxy="proxy-command" for kernel.org
 114                 gitproxy="myprotocol-command" for "my://"
 115                 gitproxy=default-proxy ; for all the rest
 116
 117 you can set the filemode to true with
 118
 119 ------------
 120 % git repo-config core.filemode true
 121 ------------
 122
 123 The hypothetical proxy command entries actually have a postfix to discern
 124 what URL they apply to. Here is how to change the entry for kernel.org
 125 to "ssh".
 126
 127 ------------
 128 % git repo-config core.gitproxy '"ssh" for kernel.org' 'for kernel.org$'
 129 ------------
 130
 131 This makes sure that only the key/value pair for kernel.org is replaced.
 132
 133 To delete the entry for renames, do
 134
 135 ------------
 136 % git repo-config --unset diff.renames
 137 ------------
 138
 139 If you want to delete an entry for a multivar (like core.gitproxy above),
 140 you have to provide a regex matching the value of exactly one line.
 141
 142 To query the value for a given key, do
 143
 144 ------------
 145 % git repo-config --get core.filemode
 146 ------------
 147
 148 or
 149
 150 ------------
 151 % git repo-config core.filemode
 152 ------------
 153
 154 or, to query a multivar:
 155
 156 ------------
 157 % git repo-config --get core.gitproxy "for kernel.org$"
 158 ------------
 159
 160 If you want to know all the values for a multivar, do:
 161
 162 ------------
 163 % git repo-config --get-all core.gitproxy
 164 ------------
 165
 166 If you like to live dangerous, you can replace *all* core.gitproxy by a
 167 new one with
 168
 169 ------------
 170 % git repo-config --replace-all core.gitproxy ssh
 171 ------------
 172
 173 However, if you really only want to replace the line for the default proxy,
 174 i.e. the one without a "for ..." postfix, do something like this:
 175
 176 ------------
 177 % git repo-config core.gitproxy ssh '! for '
 178 ------------
 179
 180 To actually match only values with an exclamation mark, you have to
 181
 182 ------------
 183 % git repo-config section.key value '[!]'
 184 ------------
 185
 186
 187 include::config.txt[]
 188
 189
 190 Author
 191 ------
 192 Written by Johannes Schindelin <Johannes.Schindelin@gmx.de>
 193
 194 Documentation
 195 --------------
 196 Documentation by Johannes Schindelin, Petr Baudis and the git-list <git@vger.kernel.org>.
 197
 198 GIT
 199 ---
 200 Part of the gitlink:git[7] suite
 201