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