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