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 \fIgit\-repo\-config\fR \-l | \-\-list
  33 .fi
  34
  35 .SH "DESCRIPTION"
  36
  37
  38 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\&.
  39
  40
  41 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)\&.
  42
  43
  44 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\&.
  45
  46
  47 This command will fail if
  48
  49 .TP 3
  50 1.
  51 \&.git/config is invalid,
  52 .TP
  53 2.
  54 \&.git/config can not be written to,
  55 .TP
  56 3.
  57 no section was provided,
  58 .TP
  59 4.
  60 the section or key is invalid,
  61 .TP
  62 5.
  63 you try to unset an option which does not exist, or
  64 .TP
  65 6.
  66 you try to unset/set an option for which multiple lines match\&.
  67 .LP
  68
  69 .SH "OPTIONS"
  70
  71 .TP
  72 \-\-replace\-all
  73 Default behaviour is to replace at most one line\&. This replaces all lines matching the key (and optionally the value_regex)
  74
  75 .TP
  76 \-\-get
  77 Get the value for a given key (optionally filtered by a regex matching the value)\&.
  78
  79 .TP
  80 \-\-get\-all
  81 Like get, but does not fail if the number of values for the key is not exactly one\&.
  82
  83 .TP
  84 \-\-unset
  85 Remove the line matching the key from \&.git/config\&.
  86
  87 .TP
  88 \-\-unset\-all
  89 Remove all matching lines from \&.git/config\&.
  90
  91 .TP
  92 \-l, \-\-list
  93 List all variables set in \&.git/config\&.
  94
  95 .SH "EXAMPLE"
  96
  97
  98 Given a \&.git/config like this:
  99
 100 .nf
 101 #
 102 # This is the config file, and
 103 # a '#' or ';' character indicates
 104 # a comment
 105 #
 106 .fi
 107
 108 .nf
 109 ; core variables
 110 [core]
 111         ; Don't trust file modes
 112         filemode = false
 113 .fi
 114
 115 .nf
 116 ; Our diff algorithm
 117 [diff]
 118         external = "/usr/local/bin/gnu\-diff \-u"
 119         renames = true
 120 .fi
 121
 122 .nf
 123 ; Proxy settings
 124 [core]
 125         gitproxy="ssh" for "ssh://kernel\&.org/"
 126         gitproxy="proxy\-command" for kernel\&.org
 127         gitproxy="myprotocol\-command" for "my://"
 128         gitproxy=default\-proxy ; for all the rest
 129 .fi
 130
 131
 132 you can set the filemode to true with
 133
 134 .nf
 135 % git repo\-config core\&.filemode true
 136 .fi
 137
 138
 139 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"\&.
 140
 141 .nf
 142 % git repo\-config core\&.gitproxy '"ssh" for kernel\&.org' 'for kernel\&.org$'
 143 .fi
 144
 145
 146 This makes sure that only the key/value pair for kernel\&.org is replaced\&.
 147
 148
 149 To delete the entry for renames, do
 150
 151 .nf
 152 % git repo\-config \-\-unset diff\&.renames
 153 .fi
 154
 155
 156 If you want to delete an entry for a multivar (like core\&.gitproxy above), you have to provide a regex matching the value of exactly one line\&.
 157
 158
 159 To query the value for a given key, do
 160
 161 .nf
 162 % git repo\-config \-\-get core\&.filemode
 163 .fi
 164
 165
 166 or
 167
 168 .nf
 169 % git repo\-config core\&.filemode
 170 .fi
 171
 172
 173 or, to query a multivar:
 174
 175 .nf
 176 % git repo\-config \-\-get core\&.gitproxy "for kernel\&.org$"
 177 .fi
 178
 179
 180 If you want to know all the values for a multivar, do:
 181
 182 .nf
 183 % git repo\-config \-\-get\-all core\&.gitproxy
 184 .fi
 185
 186
 187 If you like to live dangerous, you can replace \fIall\fR core\&.gitproxy by a new one with
 188
 189 .nf
 190 % git repo\-config \-\-replace\-all core\&.gitproxy ssh
 191 .fi
 192
 193
 194 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:
 195
 196 .nf
 197 % git repo\-config core\&.gitproxy ssh '! for '
 198 .fi
 199
 200
 201 To actually match only values with an exclamation mark, you have to
 202
 203 .nf
 204 % git repo\-config section\&.key value '[!]'
 205 .fi
 206
 207 .SH "CONFIGURATION FILE"
 208
 209
 210 The git configuration file contains a number of variables that affect the git commands behaviour\&. They can be used by both the git plumbing and the porcelains\&. The variables are divided to sections, where in the fully qualified variable name the variable itself is the last dot\-separated segment and the section name is everything before the last dot\&. The variable names are case\-insensitive and only alphanumeric characters are allowed\&. Some variables may appear multiple times\&.
 211
 212
 213 The syntax is fairly flexible and permissive; whitespaces are mostly ignored\&. The \fI#\fR and \fI;\fR characters begin commends to the end of line, blank lines are ignored, lines containing strings enclosed in square brackets start sections and all the other lines are recognized as setting variables, in the form \fIname = value\fR\&. If there is no equal sign on the line, the entire line is taken as \fIname\fR and the variable is recognized as boolean "true"\&. String values may be entirely or partially enclosed in double quotes; some variables may require special value format\&.
 214
 215 .SS "Example"
 216
 217 .nf
 218 # Core variables
 219 [core]
 220         ; Don't trust file modes
 221         filemode = false
 222 .fi
 223
 224 .nf
 225 # Our diff algorithm
 226 [diff]
 227         external = "/usr/local/bin/gnu\-diff \-u"
 228         renames = true
 229 .fi
 230
 231 .SS "Variables"
 232
 233
 234 Note that this list is non\-comprehensive and not necessarily complete\&. For command\-specific variables, you will find more detailed description in the appropriate manual page\&. You will find description of non\-core porcelain configuration variables in the respective porcelain documentation\&.
 235
 236 .TP
 237 core\&.fileMode
 238 If false, the executable bit differences between the index and the working copy are ignored; useful on broken filesystems like FAT\&. See \fBgit\-update\-index\fR(1)\&. True by default\&.
 239
 240 .TP
 241 core\&.gitProxy
 242 A "proxy command" to execute (as \fIcommand host port\fR) instead of establishing direct connection to the remote server when using the git protocol for fetching\&. If the variable value is in the "COMMAND for DOMAIN" format, the command is applied only on hostnames ending with the specified domain string\&. This variable may be set multiple times and is matched in the given order; the first match wins\&.
 243
 244 .nf
 245 Can be overriden by the 'GIT_PROXY_COMMAND' environment variable
 246 (which always applies universally, without the special "for"
 247 handling)\&.
 248 .fi
 249
 250 .TP
 251 core\&.ignoreStat
 252 The working copy files are assumed to stay unchanged until you mark them otherwise manually \- Git will not detect the file changes by lstat() calls\&. This is useful on systems where those are very slow, such as Microsoft Windows\&. See \fBgit\-update\-index\fR(1)\&. False by default\&.
 253
 254 .TP
 255 core\&.onlyUseSymrefs
 256 Always use the "symref" format instead of symbolic links for HEAD and other symbolic reference files\&. True by default\&.
 257
 258 .TP
 259 core\&.repositoryFormatVersion
 260 Internal variable identifying the repository format and layout version\&.
 261
 262 .TP
 263 core\&.sharedRepository
 264 If true, the repository is made shareable between several users in a group (making sure all the files and objects are group\-writable)\&. See \fBgit\-init\-db\fR(1)\&. False by default\&.
 265
 266 .TP
 267 core\&.warnAmbiguousRefs
 268 If true, git will warn you if the ref name you passed it is ambiguous and might match multiple refs in the \&.git/refs/ tree\&. True by default\&.
 269
 270 .TP
 271 apply\&.whitespace
 272 Tells git\-apply how to handle whitespaces, in the same way as the \fI\-\-whitespace\fR option\&. See \fBgit\-apply\fR(1)\&.
 273
 274 .TP
 275 diff\&.renameLimit
 276 The number of files to consider when performing the copy/rename detection; equivalent to the git diff option \fI\-l\fR\&.
 277
 278 .TP
 279 format\&.headers
 280 Additional email headers to include in a patch to be submitted by mail\&. See \fBgit\-format\-patch\fR(1)\&.
 281
 282 .TP
 283 gitcvs\&.enabled
 284 Whether the cvs pserver interface is enabled for this repository\&. See \fBgit\-cvsserver\fR(1)\&.
 285
 286 .TP
 287 gitcvs\&.logfile
 288 Path to a log file where the cvs pserver interface well... logs various stuff\&. See \fBgit\-cvsserver\fR(1)\&.
 289
 290 .TP
 291 http\&.sslVerify
 292 Whether to verify the SSL certificate when fetching or pushing over HTTPS\&. Can be overriden by the \fIGIT_SSL_NO_VERIFY\fR environment variable\&.
 293
 294 .TP
 295 http\&.sslCert
 296 File containing the SSL certificate when fetching or pushing over HTTPS\&. Can be overriden by the \fIGIT_SSL_CERT\fR environment variable\&.
 297
 298 .TP
 299 http\&.sslKey
 300 File containing the SSL private key when fetching or pushing over HTTPS\&. Can be overriden by the \fIGIT_SSL_KEY\fR environment variable\&.
 301
 302 .TP
 303 http\&.sslCAInfo
 304 File containing the certificates to verify the peer with when fetching or pushing over HTTPS\&. Can be overriden by the \fIGIT_SSL_CAINFO\fR environment variable\&.
 305
 306 .TP
 307 http\&.sslCAPath
 308 Path containing files with the CA certificates to verify the peer with when fetching or pushing over HTTPS\&. Can be overriden by the \fIGIT_SSL_CAPATH\fR environment variable\&.
 309
 310 .TP
 311 http\&.maxRequests
 312 How many HTTP requests to launch in parallel\&. Can be overriden by the \fIGIT_HTTP_MAX_REQUESTS\fR environment variable\&. Default is 5\&.
 313
 314 .TP
 315 http\&.lowSpeedLimit, http\&.lowSpeedTime
 316 If the HTTP transfer speed is less than \fIhttp\&.lowSpeedLimit\fR for longer than \fIhttp\&.lowSpeedTime\fR seconds, the transfer is aborted\&. Can be overriden by the \fIGIT_HTTP_LOW_SPEED_LIMIT\fR and \fIGIT_HTTP_LOW_SPEED_TIME\fR environment variables\&.
 317
 318 .TP
 319 i18n\&.commitEncoding
 320 Character encoding the commit messages are stored in; git itself does not care per se, but this information is necessary e\&.g\&. when importing commits from emails or in the gitk graphical history browser (and possibly at other places in the future or in other porcelains)\&. See e\&.g\&. \fBgit\-mailinfo\fR(1)\&. Defaults to \fIutf\-8\fR\&.
 321
 322 .TP
 323 merge\&.summary
 324 Whether to include summaries of merged commits in newly created merge commit messages\&. False by default\&.
 325
 326 .TP
 327 pull\&.octopus
 328 The default merge strategy to use when pulling multiple branches at once\&.
 329
 330 .TP
 331 pull\&.twohead
 332 The default merge strategy to use when pulling a single branch\&.
 333
 334 .TP
 335 show\&.difftree
 336 The default \fBgit\-diff\-tree\fR(1) arguments to be used for \fBgit\-show\fR(1)\&.
 337
 338 .TP
 339 showbranch\&.default
 340 The default set of branches for \fBgit\-show\-branch\fR(1)\&. See \fBgit\-show\-branch\fR(1)\&.
 341
 342 .TP
 343 user\&.email
 344 Your email address to be recorded in any newly created commits\&. Can be overriden by the \fIGIT_AUTHOR_EMAIL\fR and \fIGIT_COMMITTER_EMAIL\fR environment variables\&. See \fBgit\-commit\-tree\fR(1)\&.
 345
 346 .TP
 347 user\&.name
 348 Your full name to be recorded in any newly created commits\&. Can be overriden by the \fIGIT_AUTHOR_NAME\fR and \fIGIT_COMMITTER_NAME\fR environment variables\&. See \fBgit\-commit\-tree\fR(1)\&.
 349
 350 .TP
 351 whatchanged\&.difftree
 352 The default \fBgit\-diff\-tree\fR(1) arguments to be used for \fBgit\-whatchanged\fR(1)\&.
 353
 354 .TP
 355 imap
 356 The configuration variables in the \fIimap\fR section are described in \fBgit\-imap\-send\fR(1)\&.
 357
 358 .SH "AUTHOR"
 359
 360
 361 Written by Johannes Schindelin <Johannes\&.Schindelin@gmx\&.de>
 362
 363 .SH "DOCUMENTATION"
 364
 365
 366 Documentation by Johannes Schindelin, Petr Baudis and the git\-list <git@vger\&.kernel\&.org>\&.
 367
 368 .SH "GIT"
 369
 370
 371 Part of the \fBgit\fR(7) suite
 372