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).
  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
  63 --get-regexp::
  64         Like --get-all, but interprets the name as a regular expression.
  65
  66 --unset::
  67         Remove the line matching the key from .git/config.
  68
  69 --unset-all::
  70         Remove all matching lines from .git/config.
  71
  72 -l, --list::
  73         List all variables set in .git/config.
  74
  75
  76 ENVIRONMENT
  77 -----------
  78
  79 GIT_CONFIG::
  80         Take the configuration from the given file instead of .git/config.
  81
  82 GIT_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
  88 EXAMPLE
  89 -------
  90
  91 Given 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
 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
 115
 116 you can set the filemode to true with
 117
 118 ------------
 119 % git repo-config core.filemode true
 120 ------------
 121
 122 The hypothetic proxy command entries actually have a postfix to discern
 123 to what URL they apply. Here is how to change the entry for kernel.org
 124 to "ssh".
 125
 126 ------------
 127 % git repo-config core.gitproxy '"ssh" for kernel.org' 'for kernel.org$'
 128 ------------
 129
 130 This makes sure that only the key/value pair for kernel.org is replaced.
 131
 132 To delete the entry for renames, do
 133
 134 ------------
 135 % git repo-config --unset diff.renames
 136 ------------
 137
 138 If you want to delete an entry for a multivar (like core.gitproxy above),
 139 you have to provide a regex matching the value of exactly one line.
 140
 141 To query the value for a given key, do
 142
 143 ------------
 144 % git repo-config --get core.filemode
 145 ------------
 146
 147 or
 148
 149 ------------
 150 % git repo-config core.filemode
 151 ------------
 152
 153 or, to query a multivar:
 154
 155 ------------
 156 % git repo-config --get core.gitproxy "for kernel.org$"
 157 ------------
 158
 159 If you want to know all the values for a multivar, do:
 160
 161 ------------
 162 % git repo-config --get-all core.gitproxy
 163 ------------
 164
 165 If you like to live dangerous, you can replace *all* core.gitproxy by a
 166 new one with
 167
 168 ------------
 169 % git repo-config --replace-all core.gitproxy ssh
 170 ------------
 171
 172 However, if you really only want to replace the line for the default proxy,
 173 i.e. the one without a "for ..." postfix, do something like this:
 174
 175 ------------
 176 % git repo-config core.gitproxy ssh '! for '
 177 ------------
 178
 179 To actually match only values with an exclamation mark, you have to
 180
 181 ------------
 182 % git repo-config section.key value '[!]'
 183 ------------
 184
 185
 186 include::config.txt[]
 187
 188
 189 Author
 190 ------
 191 Written by Johannes Schindelin <Johannes.Schindelin@gmx.de>
 192
 193 Documentation
 194 --------------
 195 Documentation by Johannes Schindelin, Petr Baudis and the git-list <git@vger.kernel.org>.
 196
 197 GIT
 198 ---
 199 Part of the gitlink:git[7] suite
 200