man1/git-repo-config.1

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