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
  19 DESCRIPTION
  20 -----------
  21 You can query/set/replace/unset options with this command. The name is
  22 actually the section and the key separated by a dot, and the value will be
  23 escaped.
  24
  25 If you want to set/unset an option which can occur on multiple lines, you
  26 should provide a POSIX regex for the value. If you want to handle the lines
  27 *not* matching the regex, just prepend a single exclamation mark in front
  28 (see EXAMPLES).
  29
  30 The type specifier can be either '--int' or '--bool', which will make
  31 'git-repo-config' ensure that the variable(s) are of the given type and
  32 convert the value to the canonical form (simple decimal number for int,
  33 a "true" or "false" string for bool). If no type specifier is passed,
  34 no checks or transformations are performed on the value.
  35
  36 This command will fail if
  37
  38 . .git/config is invalid,
  39 . .git/config can not be written to,
  40 . no section was provided,
  41 . the section or key is invalid,
  42 . you try to unset an option which does not exist, or
  43 . you try to unset/set an option for which multiple lines match.
  44
  45
  46 OPTIONS
  47 -------
  48
  49 --replace-all::
  50         Default behaviour is to replace at most one line. This replaces
  51         all lines matching the key (and optionally the value_regex)
  52
  53 --get::
  54         Get the value for a given key (optionally filtered by a regex
  55         matching the value).
  56
  57 --get-all::
  58         Like get, but does not fail if the number of values for the key
  59         is not exactly one.
  60
  61 --unset::
  62         Remove the line matching the key from .git/config.
  63
  64 --unset-all::
  65         Remove all matching lines from .git/config.
  66
  67
  68 EXAMPLE
  69 -------
  70
  71 Given a .git/config like this:
  72
  73         #
  74         # This is the config file, and
  75         # a '#' or ';' character indicates
  76         # a comment
  77         #
  78
  79         ; core variables
  80         [core]
  81                 ; Don't trust file modes
  82                 filemode = false
  83
  84         ; Our diff algorithm
  85         [diff]
  86                 external = "/usr/local/bin/gnu-diff -u"
  87                 renames = true
  88
  89         ; Proxy settings
  90         [core]
  91                 gitproxy="ssh" for "ssh://kernel.org/"
  92                 gitproxy="proxy-command" for kernel.org
  93                 gitproxy="myprotocol-command" for "my://"
  94                 gitproxy=default-proxy ; for all the rest
  95
  96 you can set the filemode to true with
  97
  98 ------------
  99 % git repo-config core.filemode true
 100 ------------
 101
 102 The hypothetic proxy command entries actually have a postfix to discern
 103 to what URL they apply. Here is how to change the entry for kernel.org
 104 to "ssh".
 105
 106 ------------
 107 % git repo-config core.gitproxy '"ssh" for kernel.org' 'for kernel.org$'
 108 ------------
 109
 110 This makes sure that only the key/value pair for kernel.org is replaced.
 111
 112 To delete the entry for renames, do
 113
 114 ------------
 115 % git repo-config --unset diff.renames
 116 ------------
 117
 118 If you want to delete an entry for a multivar (like core.gitproxy above),
 119 you have to provide a regex matching the value of exactly one line.
 120
 121 To query the value for a given key, do
 122
 123 ------------
 124 % git repo-config --get core.filemode
 125 ------------
 126
 127 or
 128
 129 ------------
 130 % git repo-config core.filemode
 131 ------------
 132
 133 or, to query a multivar:
 134
 135 ------------
 136 % git repo-config --get core.gitproxy "for kernel.org$"
 137 ------------
 138
 139 If you want to know all the values for a multivar, do:
 140
 141 ------------
 142 % git repo-config --get-all core.gitproxy
 143 ------------
 144
 145 If you like to live dangerous, you can replace *all* core.gitproxy by a
 146 new one with
 147
 148 ------------
 149 % git repo-config --replace-all core.gitproxy ssh
 150 ------------
 151
 152 However, if you really only want to replace the line for the default proxy,
 153 i.e. the one without a "for ..." postfix, do something like this:
 154
 155 ------------
 156 % git repo-config core.gitproxy ssh '! for '
 157 ------------
 158
 159 To actually match only values with an exclamation mark, you have to
 160
 161 ------------
 162 % git repo-config section.key value '[!]'
 163 ------------
 164
 165
 166 include::config.txt[]
 167
 168
 169 Author
 170 ------
 171 Written by Johannes Schindelin <Johannes.Schindelin@gmx.de>
 172
 173 Documentation
 174 --------------
 175 Documentation by Johannes Schindelin, Petr Baudis and the git-list <git@vger.kernel.org>.
 176
 177 GIT
 178 ---
 179 Part of the gitlink:git[7] suite
 180