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